rufo 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50d15a24f09ec9bd78016c6e572736daae323c7c
-  data.tar.gz: 3043fa80ffc0e2d5693f64ae66f0d9778fa60216
+  metadata.gz: 82f3fd868e4d701c1e505e16a057d8d8e494a925
+  data.tar.gz: de7c89b69cac54b2640d899310623539d9ec7e25
 SHA512:
-  metadata.gz: 43d21b3b6966469feaf5eea5179de28248b973669b994a57d3a0fb84204c09cfee06edc88aab5d84a16f6dc7e1a953aa12603ede252cf07e7aacf1fec20bc3f1
-  data.tar.gz: 0a08b865224b3ae14c74aca6898790b9aa5bc8d094fe3423d90bce186b84eb26400041a53f610b74c5b28b7d30dc432b2b47b9a0476818c25350d0fb51be295e
+  metadata.gz: 28620000e4f9723f908da738c364c35390ae9308aa79590b3485eed9bc30aa0bba7e709927b2357dcd691bfc14552a209d478d38cce03677d0788b23aafdd18e
+  data.tar.gz: cece98ad578f1a43dadb98791773c062208b40953394b484315b15268293ae50a0766898c644aeb9dfee36bae2a3dfc9b53ad672ea46cc32bf6f1992ef44a3dd

data/README.md

@@ -76,8 +76,8 @@ issue if you need something else to be configurable.
 
 ## Status
 
-The formatter was tested on some big files with many Ruby
-syntax and idioms, but since it's so new there might be some missing stuff. Don't hesitate
+The formatter is able to format `rails` and other projects, so at this point
+it's pretty mature. There might still be some bugs. Don't hesitate
 to open an issue if you find something is not working well. In any case, if the formatter
 chokes on some valid input you will get an error prompting you to submit a bug report here :-)
 

data/lib/rufo/command.rb

@@ -54,7 +54,7 @@ module Rufo::Command
   end
 
   def self.format_file(filename, want_check)
-    code   = File.read(filename)
+    code = File.read(filename)
 
     begin
       result = format(code, File.dirname(filename))

data/lib/rufo/formatter.rb

@@ -53,10 +53,10 @@ class Rufo::Formatter
     @hash_keys_positions = []
 
     # Settings
-    @indent_size         = options.fetch(:indent_size, 2)
-    @align_comments      = options.fetch(:align_comments, true)
-    @align_assignments   = options.fetch(:align_assignments, true)
-    @align_hash_keys     = options.fetch(:align_hash_keys, true)
+    @indent_size       = options.fetch(:indent_size, 2)
+    @align_comments    = options.fetch(:align_comments, true)
+    @align_assignments = options.fetch(:align_assignments, true)
+    @align_hash_keys   = options.fetch(:align_hash_keys, true)
   end
 
   # The indent size (default: 2)
@@ -394,18 +394,17 @@ class Rufo::Formatter
       end
 
       skip_space
-      if newline? || comment?
-        check_pending_heredocs
-      end
 
       line_before_endline = @line
 
       is_last = last?(i, exps)
       if with_lines
-        consume_end_of_line(false, !is_last, !is_last)
+        exp_needs_two_lines = needs_two_lines?(exp)
+
+        consume_end_of_line(false, !is_last, !is_last, exp_needs_two_lines)
 
         # Make sure to put two lines before defs, class and others
-        if !is_last && (needs_two_lines?(exp_kind) || needs_two_lines?(exps[i + 1][0])) && @line <= line_before_endline + 1
+        if !is_last && (exp_needs_two_lines || needs_two_lines?(exps[i + 1])) && @line <= line_before_endline + 1
           write_line
         end
       else
@@ -414,13 +413,23 @@ class Rufo::Formatter
     end
   end
 
-  def needs_two_lines?(exp_kind)
-    case exp_kind
+  def needs_two_lines?(exp)
+    kind = exp[0]
+    case kind
     when :def, :class, :module
-      true
-    else
-      false
+      return true
+    when :vcall
+      # Check if it's private/protected/public
+      nested = exp[1]
+      if nested[0] == :@ident
+        case nested[1]
+        when "private", "protected", "public"
+          return true
+        end
+      end
     end
+
+    false
   end
 
   def visit_string_literal(node)
@@ -430,30 +439,18 @@ class Rufo::Formatter
 
     if heredoc
       write current_token_value.rstrip
+      # Accumulate heredoc: we'll write it once
+      # we find a newline.
+      @heredocs << [node, tilde]
       next_token
-      skip_space
-
-      # If something other than a newline follows the heredoc
-      # beginning it means some other code follows and
-      # we have to accumulate the heredoc and print it
-      # later, when the line ends.
-      if !newline? || !@heredocs.empty?
-        @heredocs << [node, tilde]
-        return
-      end
+      return
     elsif current_token_kind == :on_backtick
       consume_token :on_backtick
     else
       consume_token :on_tstring_beg
     end
 
-    if heredoc
-      @current_heredoc = [node, tilde]
-    end
-
     visit_string_literal_end(node)
-
-    @current_heredoc = nil if heredoc
   end
 
   def visit_string_literal_end(node)
@@ -473,10 +470,8 @@ class Rufo::Formatter
       next_token
       skip_space
 
-      if newline?
-        write_line
-        write_indent
-      end
+      # Simulate a newline after the heredoc
+      @tokens << [[0, 0], :on_ignored_nl, "\n"]
     when :on_backtick
       consume_token :on_backtick
     else
@@ -869,15 +864,12 @@ class Rufo::Formatter
     end
   end
 
-  def check_pending_heredocs
+  def flush_heredocs
     printed = false
 
     until @heredocs.empty?
       heredoc, tilde = @heredocs.first
 
-      # Need to print a line between consecutive heredoc ends
-      write_line if printed
-
       @heredocs.shift
       @current_heredoc = [heredoc, tilde]
       visit_string_literal_end(heredoc)
@@ -921,7 +913,26 @@ class Rufo::Formatter
   end
 
   def visit_command_args(args)
-    indent(@column) do
+    needed_indent = @column
+
+    # Check if there's a single argument and it's
+    # a def, class or module. In that case we don't
+    # want to align the content to the position of
+    # that keyword.
+    if args[0] == :args_add_block
+      nested_args = args[1]
+      if nested_args.is_a?(Array) && nested_args.size == 1
+        first = nested_args[0]
+        if first.is_a?(Array)
+          case first[0]
+          when :def, :class, :module
+            needed_indent = @indent
+          end
+        end
+      end
+    end
+
+    indent(needed_indent) do
       if args[0].is_a?(Symbol)
         visit args
       else
@@ -1003,29 +1014,56 @@ class Rufo::Formatter
   end
 
   def visit_block_arguments(node)
-    # [:block_var, params, blockarg]
-    _, params, blockarg = node
+    # [:block_var, params, local_params]
+    _, params, local_params = node
+
+    empty_params = empty_params?(params)
 
     check :on_op
 
     # check for ||
-    if blockarg.nil?
+    if empty_params && !local_params
       # Don't write || as it's meaningless
-      next_token
-    else
-      next_token
-      skip_space_or_newline
-
-      # This means it's an empty | |, so we remove it
-      if current_token_kind == :on_op && current_token_value == "|"
+      if current_token_value == "|"
         next_token
-      else
-        write "|"
-        visit params
         skip_space_or_newline
-        consume_op "|"
+        check :on_op
+        next_token
+      else
+        next_token
       end
+      return
+    end
+
+    consume_token :on_op
+    found_semicolon = skip_space_or_newline(true, true)
+
+    if found_semicolon
+      # Nothing
+    elsif empty_params && local_params
+      consume_token :on_semicolon
+      found_semicolon = true
+    end
+
+    skip_space_or_newline
+
+    unless empty_params
+      visit params
+      skip_space
     end
+
+    if local_params
+      if semicolon?
+        consume_token :on_semicolon
+        consume_space
+      end
+
+      visit_comma_separated_list local_params
+    else
+      skip_space_or_newline
+    end
+
+    consume_op "|"
   end
 
   def visit_call_args(node)
@@ -1036,7 +1074,7 @@ class Rufo::Formatter
       # arg1, ..., *star
       visit args
     else
-      visit_comma_separated_list args, true
+      visit_comma_separated_list args
     end
 
     if block_arg
@@ -1258,7 +1296,7 @@ class Rufo::Formatter
     end
   end
 
-  def visit_comma_separated_list(nodes, inside_call = false)
+  def visit_comma_separated_list(nodes)
     # When there's *x inside a left hand side assignment
     # or a case when, it comes as [:op, ...]
     if nodes[0].is_a?(Symbol)
@@ -1268,15 +1306,13 @@ class Rufo::Formatter
 
     needs_indent = false
 
-    if inside_call
-      if newline? || comment?
-        needs_indent = true
-        base_column  = next_indent
-        consume_end_of_line
-        write_indent(base_column)
-      else
-        base_column = @column
-      end
+    if newline? || comment?
+      needs_indent = true
+      base_column  = next_indent
+      consume_end_of_line
+      write_indent(base_column)
+    else
+      base_column = @column
     end
 
     nodes.each_with_index do |exp, i|
@@ -1760,7 +1796,7 @@ class Rufo::Formatter
     if elements
       # [:assoclist_from_args, elements]
       push_hash(node) do
-        visit_literal_elements(elements[1])
+        visit_literal_elements(elements[1], true)
       end
     else
       skip_space_or_newline
@@ -2115,11 +2151,18 @@ class Rufo::Formatter
     visit_comma_separated_list exps
   end
 
-  def visit_literal_elements(elements)
-    base_column = @column
-
+  def visit_literal_elements(elements, inside_hash = false)
+    base_column       = @column
+    needs_final_space = inside_hash && space?
     skip_space
 
+    if newline? || comment?
+      needs_final_space = false
+    elsif needs_final_space
+      consume_space
+      base_column = @column
+    end
+
     # If there's a newline right at the beginning,
     # write it, and we'll indent element and always
     # add a trailing comma to the last element
@@ -2167,7 +2210,11 @@ class Rufo::Formatter
     elsif comment?
       consume_end_of_line
     else
-      skip_space_or_newline
+      if needs_final_space
+        consume_space
+      else
+        skip_space_or_newline
+      end
     end
   end
 
@@ -2388,10 +2435,11 @@ class Rufo::Formatter
     has_slash_newline
   end
 
-  def skip_space_or_newline(want_semicolon = false)
-    found_newline = false
-    found_comment = false
-    last          = nil
+  def skip_space_or_newline(want_semicolon = false, write_first_semicolon = false)
+    found_newline   = false
+    found_comment   = false
+    found_semicolon = false
+    last            = nil
 
     while true
       case current_token_kind
@@ -2402,11 +2450,12 @@ class Rufo::Formatter
         last          = :newline
         found_newline = true
       when :on_semicolon
-        if !found_newline && !found_comment
+        if (!found_newline && !found_comment) || (!found_semicolon && write_first_semicolon)
           write "; "
         end
         next_token
-        last = :semicolon
+        last            = :semicolon
+        found_semicolon = true
       when :on_comment
         write_line if last == :newline
 
@@ -2424,6 +2473,8 @@ class Rufo::Formatter
         break
       end
     end
+
+    found_semicolon
   end
 
   def skip_semicolons
@@ -2480,11 +2531,12 @@ class Rufo::Formatter
   # - at_prefix: are we at a point before an expression? (if so, we don't need a space before the first comment)
   # - want_semicolon: do we want do print a semicolon to separate expressions?
   # - want_multiline: do we want multiple lines to appear, or at most one?
-  def consume_end_of_line(at_prefix = false, want_semicolon = false, want_multiline = true)
+  def consume_end_of_line(at_prefix = false, want_semicolon = false, want_multiline = true, needs_two_lines_on_comment = false)
     found_newline            = false # Did we find any newline during this method?
     last                     = nil   # Last token kind found
     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
 
     while true
       case current_token_kind
@@ -2516,7 +2568,8 @@ class Rufo::Formatter
         end
         found_newline = true
         next_token
-        last = :newline
+        last           = :newline
+        newline_count += 1
       when :on_semicolon
         next_token
         # If we want to print semicolons and we didn't find a newline yet,
@@ -2539,6 +2592,16 @@ class Rufo::Formatter
           write_indent
         else
           if found_newline
+            if newline_count == 1 && needs_two_lines_on_comment
+              if multilple_lines
+                write_line
+                multilple_lines = false
+              else
+                multilple_lines = true
+              end
+              needs_two_lines_on_comment = false
+            end
+
             # Write line or second line if needed
             write_line if last != :newline || multilple_lines
             write_indent
@@ -2750,9 +2813,9 @@ class Rufo::Formatter
 
   def find_closing_brace_token
     count = 0
-    i = @tokens.size - 1
+    i     = @tokens.size - 1
     while i >= 0
-      token = @tokens[i]
+      token                = @tokens[i]
       (line, column), kind = token
       case kind
       when :on_lbrace, :on_tlambeg
@@ -2785,6 +2848,10 @@ class Rufo::Formatter
 
   def next_token
     @tokens.pop
+
+    if newline? && !@heredocs.empty?
+      flush_heredocs
+    end
   end
 
   def last?(i, array)

data/lib/rufo/version.rb

@@ -1,3 +1,3 @@
 module Rufo
-  VERSION = "0.0.17"
+  VERSION = "0.0.18"
 end

metadata

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