Fix missing scopes on separators and `self`, differentiate `->` #224

chbk · 2017-12-06T21:28:11Z

Description of the Change

Added a separators entry to the repository
Rewrote the grammar for class and module declarations with begin/end patterns:
- Included separators
- Renamed punctuation.separator.inheritance.ruby to punctuation.separator.namespace.ruby for consistency
- Changed entity.name.type.class.ruby, entity.name.type.module.ruby and entity.other.inherited-class.module.ruby to start with an uppercase letter and to exclude separators
This is now scoped properly:
```
class A::B::C < ::D::E
```
```
class << A::B
```
```
module A::B::C
```
Scoped commas in function declarations:
```
def method(a, b)
```
Scoped self and separators in function declarations:
```
class A
    def self.method
```
Unfortunately, I wasn't able to rewrite the grammar for function declarations with begin/end patterns. I used existing regular expressions to capture separators. Since the captures are placed inside repetition patterns ()*, only the last separator will be scoped. Not perfect, but still an improvement.
Changed scopes for ->: support.function.kernel.arrow.ruby
Added specs

Applicable Issues

#221 Missing scope on commas
#222 Differentiate -> from other keywords
#223 Namespace separator :: not scoped in class definition

Interdictor · 2018-03-02T23:37:09Z

Please review and approve this!

winstliu · 2018-03-05T16:49:10Z

grammars/ruby.cson

@@ -60,60 +60,88 @@
 '''
 'patterns': [
  {
+    'begin': '\\bclass\\b'


Do classes need to be at the start of the line per the previous ^\\s*class\\s* regex?

No, classes can be declared after another statement on the same line.

winstliu · 2018-03-05T16:49:57Z

grammars/ruby.cson

+      }
+      {
+        'begin': '<<'
+        'captures':


beginCaptures

winstliu · 2018-03-05T16:50:04Z

grammars/ruby.cson

@@ -60,60 +60,88 @@
 '''
 'patterns': [
  {
+    'begin': '\\bclass\\b'
    'captures':


beginCaptures

winstliu · 2018-03-05T16:53:09Z

grammars/ruby.cson

+        'include': '#separators'
+      }
+      {
+        'begin': '<<'


Seems like you could redo this as (<<)\\s* and directly add a contentName here to get rid of the inner pattern.

winstliu · 2018-03-05T16:53:20Z

grammars/ruby.cson

+        ]
+      }
+      {
+        'begin': '<'


Same as concerns as above.

winstliu · 2018-03-05T16:53:45Z

grammars/ruby.cson

  }
  {
+    'begin': '\\bmodule\\b'


Same concerns as above.

winstliu · 2018-03-05T16:55:26Z

grammars/ruby.cson

+      }
+      {
+        'match': ';'
+        'name': 'punctuation.separator.statement.ruby'


Generally tokenized as punctuation.terminator.statement

winstliu · 2018-03-05T16:56:13Z

grammars/ruby.cson

+      }
+      {
+        'match': ','
+        'name': 'punctuation.separator.object.ruby'


Generally tokenized as punctuation.separator.delimiter. Is , only for objects in Ruby?

There are also commas in hashes so punctuation.separator.delimiter is indeed better.

Is it okay if I replace all instances of punctuation.separator.object by the generic punctuation.separator.delimiter? Commas in method calls are tokenized by line 2325 but commas in method definitions have their own regexes.

winstliu · 2018-03-05T16:56:37Z

grammars/ruby.cson

+        'name': 'punctuation.separator.object.ruby'
+      }
+      {
+        'match': '(::)\\s*(?=[A-Z])'


The \\s* can be in the lookahead.

For some reason I thought lookaheads could only have a fixed number of characters.

grammars/ruby.cson

chbk · 2018-03-13T10:41:57Z

@50Wliu I have a commit pending for punctuation.separator.delimiter, is my suggestion okay to you?

winstliu · 2018-03-16T14:18:50Z

Yes, I think what you're saying is fine.

chbk · 2018-10-17T20:25:47Z

@50Wliu Do you have any other comments on this pull request? It looks ready to merge for me.

rsese · 2018-10-17T23:42:38Z

Sorry for the delay @chbk, someone from the team will take a look as soon as they can.

darangi · 2021-02-04T21:10:25Z

Thanks for the contribution 🙇🏾 @chbk

winstliu added the needs-review label Dec 7, 2017

winstliu suggested changes Mar 5, 2018

View reviewed changes

ckanayama mentioned this pull request Oct 27, 2018

OSS Gate Workshop: Tokyo: 2018-10-27: kanayama: language-ruby: Work log oss-gate/workshop#978

Closed

lee-dohm added the text-mate label Nov 19, 2018

chbk added 12 commits February 4, 2021 21:33

Add separators to repository

8d2a8a7

Tokenize commas in function declarations

7185bae

Rewrite grammar for class and module declarations

51690ca

Tokenize self and separators in function declarations

670cf19

Differentiate -> from other keywords

d86d8d4

Add specs

0890205

Lint

ea85a37

Unnecessary ^

aa3c55b

Simplify begin/end patterns

2fb5650

Rewrite regex for namespace separator

974810a

Change semicolon scope name

db12c23

Change comma scope name

43d4aa0

darangi force-pushed the separators branch from 920bff7 to 43d4aa0 Compare February 4, 2021 20:34

darangi merged commit 3717f1d into atom:master Feb 4, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix missing scopes on separators and `self`, differentiate `->` #224

Fix missing scopes on separators and `self`, differentiate `->` #224

chbk commented Dec 6, 2017

Interdictor commented Mar 2, 2018

winstliu Mar 5, 2018

chbk Mar 7, 2018

winstliu Mar 5, 2018

winstliu Mar 5, 2018

winstliu Mar 5, 2018

winstliu Mar 5, 2018

winstliu Mar 5, 2018

winstliu Mar 5, 2018

winstliu Mar 5, 2018

chbk Mar 7, 2018

chbk Mar 7, 2018

winstliu Mar 5, 2018

chbk Mar 7, 2018 •

edited

Loading

chbk commented Mar 13, 2018 •

edited

Loading

winstliu commented Mar 16, 2018

chbk commented Oct 17, 2018

rsese commented Oct 17, 2018

darangi commented Feb 4, 2021

Fix missing scopes on separators and self, differentiate -> #224

Fix missing scopes on separators and self, differentiate -> #224

Conversation

chbk commented Dec 6, 2017

Description of the Change

Applicable Issues

Interdictor commented Mar 2, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chbk Mar 7, 2018 • edited Loading

Choose a reason for hiding this comment

chbk commented Mar 13, 2018 • edited Loading

winstliu commented Mar 16, 2018

chbk commented Oct 17, 2018

rsese commented Oct 17, 2018

darangi commented Feb 4, 2021

Fix missing scopes on separators and `self`, differentiate `->` #224

Fix missing scopes on separators and `self`, differentiate `->` #224

chbk Mar 7, 2018 •

edited

Loading

chbk commented Mar 13, 2018 •

edited

Loading