rufo 0.0.30 → 0.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d993ab0deff7da557c3e35bac8271ad6c60d43c
-  data.tar.gz: 669c9785a3ef39403dc0b6746ad0e5c8c7196e15
+  metadata.gz: 208020c1cfc4ae639637febda545a3c3752980fe
+  data.tar.gz: 17da5ed34f7765ff9e08daa305965e41c568a6ac
 SHA512:
-  metadata.gz: e6bcf974f8c95767a9a70a1f24acad264d6facb5040e466709a3b15fcfc11f5ecf8c0de1f8cbf02d9b34e051f0487711ad7f79639b9908a6cff99207dc4f2e19
-  data.tar.gz: 0e2f04958a659060263e4e1dfa15748e2b70bbce178f91db46a278aeec5cc8671ed207ec3b053aee609edbc5881bba78b313bc431925826c82e7081351e621c2
+  metadata.gz: 696a53c1d4d30504a01c677fe87f54db384c68c8e8e38f510184c7bd2fd1bb4e9b18a04171b75318f722356bdcca93eef28e96feafb21d403336b0432d2821cc
+  data.tar.gz: a5783f444cb5b20a2ef8d0b8eadd4a7e62502f4782e98bf5938ac484d6abbeda167384749a47b81ca10949c548e737a967706b420f64424225f94180bc753fb6

data/lib/rufo/formatter.rb

@@ -19,7 +19,7 @@ class Rufo::Formatter
     @indent = 0
     @line = 0
     @column = 0
-    @last_was_newline = false
+    @last_was_newline = true
     @output = ""
 
     # The column of a `obj.method` call, so we can align
@@ -74,6 +74,12 @@ class Rufo::Formatter
     # Position of comments that occur at the end of a line
     @comments_positions = []
 
+    # Token for the last comment found
+    @last_comment = nil
+
+    # Actual column of the last comment written
+    @last_comment_column = nil
+
     # Associate lines to alignments
     # Associate a line to an index inside @comments_position
     # becuase when aligning something to the left of a comment
@@ -205,7 +211,8 @@ class Rufo::Formatter
   def format
     visit @sexp
     consume_end
-    write_line unless @last_was_newline
+    write_line if !@last_was_newline || @output == ""
+    @output.chomp! if @output.end_with?("\n\n")
 
     dedent_calls
     do_align_assignments if @align_assignments
@@ -275,7 +282,7 @@ class Rufo::Formatter
 
       # For heredocs with tilde we sometimes need to align the contents
       if heredoc && tilde && @last_was_newline
-        write_indent(next_indent)
+        write_indent(next_indent) unless current_token_value == "\n"
         check :on_tstring_content
         consume_token_value(current_token_value)
         next_token
@@ -797,9 +804,19 @@ class Rufo::Formatter
     end
   end
 
-  def track_comment
+  def current_comment_aligned_to_previous_one?
+    @last_comment &&
+      @last_comment[0][0] + 1 == current_token[0][0] &&
+      @last_comment[0][1] == current_token[0][1]
+  end
+
+  def track_comment(id: nil, match_previous_id: false)
+    if match_previous_id && !@comments_positions.empty?
+      id = @comments_positions.last[3]
+    end
+
     @line_to_alignments_positions[@line] << [:comment, @column, @comments_positions, @comments_positions.size]
-    @comments_positions << [@line, @column, 0, nil, 0]
+    @comments_positions << [@line, @column, 0, id, 0]
   end
 
   def track_assignment(offset = 0)
@@ -1056,18 +1073,7 @@ class Rufo::Formatter
 
     push_call(node) do
       visit name
-
-      has_backslash, first_space = skip_space_backslash
-      if has_backslash
-        write " \\"
-        write_line
-        write_indent(next_indent)
-      elsif first_space && @preserve_whitespace
-        write_space first_space[2]
-        skip_space_or_newline
-      else
-        consume_space
-      end
+      consume_space_after_command_name
     end
 
     visit_command_end(node, args)
@@ -1128,8 +1134,7 @@ class Rufo::Formatter
     end
 
     visit name
-    consume_space
-
+    consume_space_after_command_name
     visit_command_args(args)
 
     # Only set it after we visit the call after the dot,
@@ -1137,6 +1142,20 @@ class Rufo::Formatter
     @dot_column = dot_column
   end
 
+  def consume_space_after_command_name
+    has_backslash, first_space = skip_space_backslash
+    if has_backslash
+      write " \\"
+      write_line
+      write_indent(next_indent)
+    elsif first_space && @preserve_whitespace
+      write_space first_space[2]
+      skip_space_or_newline
+    else
+      consume_space
+    end
+  end
+
   def visit_command_args(args)
     needed_indent = @column
 
@@ -1481,7 +1500,16 @@ class Rufo::Formatter
       visit args
     end
 
-    consume_token :on_rparen if has_paren
+    if has_paren
+      # Ripper has a bug where parsing `|(w, *x, y), z|`,
+      # the "y" isn't returned. In this case we just consume
+      # all tokens until we find a `)`.
+      while current_token_kind != :on_rparen
+        consume_token current_token_kind
+      end
+
+      consume_token :on_rparen
+    end
   end
 
   def visit_mrhs_add_star(node)
@@ -1639,13 +1667,34 @@ class Rufo::Formatter
 
     consume_op_or_keyword op
 
-    if op == :not
-      consume_space(want_preserve_whitespace: true)
+    has_space = space?
+
+    if has_space
+      consume_space(want_preserve_whitespace: @preserve_whitespace)
     else
       skip_space_or_newline
     end
 
-    visit exp
+    if op == :not
+      has_paren = current_token_kind == :on_lparen
+
+      if has_paren && !has_space
+        write "("
+        next_token
+        skip_space_or_newline
+      end
+
+      visit exp
+
+      if has_paren && !has_space
+        skip_space_or_newline
+        check :on_rparen
+        write ")"
+        next_token
+      end
+    else
+      visit exp
+    end
   end
 
   def visit_binary(node)
@@ -2312,7 +2361,12 @@ class Rufo::Formatter
     check :on_tlambda
     write "->"
     next_token
-    skip_space_or_newline
+
+    if space? && @preserve_whitespace
+      consume_space(want_preserve_whitespace: true)
+    else
+      skip_space_or_newline
+    end
 
     if empty_params?(params)
       if current_token_kind == :on_lparen
@@ -2386,27 +2440,25 @@ class Rufo::Formatter
     _, exp = node
 
     consume_keyword "defined?"
-    skip_space_or_newline
+    has_space = space?
+
+    if has_space
+      consume_space(want_preserve_whitespace: @preserve_whitespace)
+    else
+      skip_space_or_newline
+    end
 
     has_paren = current_token_kind == :on_lparen
 
-    if has_paren
+    if has_paren && !has_space
       write "("
       next_token
       skip_space_or_newline
-    else
-      consume_space
-    end
-
-    # exp can be [:paren, exp] if there's a parentheses,
-    # though not always (only if there's a space after `defined?`)
-    if exp[0] == :paren
-      exp = exp[1]
     end
 
     visit exp
 
-    if has_paren
+    if has_paren && !has_space
       skip_space_or_newline
       check :on_rparen
       write ")"
@@ -2866,8 +2918,6 @@ class Rufo::Formatter
     multilple_lines = false          # Did we pass through more than one newline?
     last_comment_has_newline = false # Does the last comment has a newline?
     newline_count = 0                # Number of newlines we passed
-    last_comment = nil               # Token for the last comment found
-    last_comment_column = nil        # Actual column of the last comment written
 
     loop do
       case current_token_kind
@@ -2936,11 +2986,9 @@ class Rufo::Formatter
           # a = 1 # some comment
           # # that continues here
           # ```
-          if last_comment &&
-             last_comment[0][0] + 1 == current_token[0][0] &&
-             last_comment[0][1] == current_token[0][1]
-            write_indent(last_comment_column)
-            track_comment
+          if current_comment_aligned_to_previous_one?
+            write_indent(@last_comment_column)
+            track_comment(match_previous_id: true)
           else
             write_indent
           end
@@ -2959,15 +3007,50 @@ class Rufo::Formatter
             # Write line or second line if needed
             write_line if last != :newline || multilple_lines
             write_indent
+            track_comment(id: @last_was_newline ? true : nil)
           else
             # If we didn't find any newline yet, this is the first comment,
             # so append a space if needed (for example after an expression)
             write_space unless at_prefix
-            track_comment
+
+            # First we check if the comment was aligned to the previous comment
+            # in the previous line, in order to keep them like that.
+            if current_comment_aligned_to_previous_one?
+              track_comment(match_previous_id: true)
+            else
+              # We want to distinguish comments that appear at the beginning
+              # of a line (which means the line has only a comment) and comments
+              # that appear after some expression. We don't want to align these
+              # and consider them separate entities. So, we use `@last_was_newline`
+              # as an id to distinguish that.
+              #
+              # For example, this:
+              #
+              #     # comment 1
+              #       # comment 2
+              #     call # comment 3
+              #
+              # Should format to:
+              #
+              #     # comment 1
+              #     # comment 2
+              #     call # comment 3
+              #
+              # Instead of:
+              #
+              #          # comment 1
+              #          # comment 2
+              #     call # comment 3
+              #
+              # We still want to track the first two comments to align to the
+              # beginning of the line according to indentation in case they
+              # are not already there.
+              track_comment(id: @last_was_newline ? true : nil)
+            end
           end
         end
-        last_comment = current_token
-        last_comment_column = @column
+        @last_comment = current_token
+        @last_comment_column = @column
         last_comment_has_newline = current_token_value.end_with?("\n")
         last = :comment
         multilple_lines = false
@@ -3140,7 +3223,6 @@ class Rufo::Formatter
   def write_indent(indent = @indent)
     @output << " " * indent
     @column += indent
-    @last_was_newline = false
   end
 
   def indent_after_space(node, sticky: false, want_space: true, first_space: nil, needed_indent: next_indent)

data/lib/rufo/version.rb

@@ -1,3 +1,3 @@
 module Rufo
-  VERSION = "0.0.30"
+  VERSION = "0.0.31"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rufo
 version: !ruby/object:Gem::Version
-  version: 0.0.30
+  version: 0.0.31
 platform: ruby
 authors:
 - Ary Borenszweig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-29 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler