rufo 0.0.35 → 0.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8f842894649d7c49344b5fb5facbaf7be70325b
-  data.tar.gz: da16188e943e329386aa0c9ac945c7d71c15dc56
+  metadata.gz: 217daf75d51d00f8dc47f3b98c8e4403d10a4d99
+  data.tar.gz: c95e8308df7067fb8221f99e4a19804b3c82c09d
 SHA512:
-  metadata.gz: 3f03c1fe682b3eb4a2e2b5c073bc18108854bea07781a06910eede1a1c7388ef2f2604c86b6b6721fa49d3574cf83a2d45d32b2eab981089da9e664609580190
-  data.tar.gz: cec6e4a31328301bfaaf61e304a523af85c2c8fdd79ae7939a3506320af836084bed546fdd33b82e953a9fb720c30a29abf7a2658bb3a03d848280dcbf39303c
+  metadata.gz: 623c8db7e7e98ae87904f55cc6661beabc119adac24593fc533f82e03893deff64328a2a2ecb6db46d39e43e477c0b74da8e7d8f1556c394c7105a21792e3666
+  data.tar.gz: 229519b8ba228f3924b4b1340a48fdcbd1dd97bebaf1604702b57a1faf1bfa3ab29844d31e50a4d5f1f94cbaa46b3b2ed28e363d36a6fc486f4d3b6c90676f05

data/.travis.yml

@@ -5,6 +5,7 @@ rvm:
   - 2.4.1
   - 2.3.4
   - 2.2.7
+  - ruby-head
 before_install: gem install bundler -v 1.15.1
 script:
   - bundle exec rake ci

data/README.md

@@ -144,11 +144,12 @@ according to **rufo**, and will exit with exit code 1.
 
 ## Editor support
 
-- Sublime Text: [sublime-rufo](https://github.com/asterite/sublime-rufo)
-- Visual Studio Code: [rufo-vscode](https://marketplace.visualstudio.com/items?itemName=siliconsenthil.rufo-vscode)
-- Vim: [rufo-vim](https://github.com/splattael/rufo-vim) :construction:
 - Atom: [rufo-atom](https://github.com/bmulvihill/rufo-atom) :construction:
 - Emacs [emacs-rufo](https://github.com/aleandros/emacs-rufo) :construction: or [rufo-mode.el](https://github.com/danielma/rufo-mode.el) :construction:
+- Sublime Text: [sublime-rufo](https://github.com/asterite/sublime-rufo)
+- Vim: [rufo-vim](https://github.com/splattael/rufo-vim)
+- Visual Studio Code: [rufo-vscode](https://marketplace.visualstudio.com/items?itemName=siliconsenthil.rufo-vscode)
+
 
 Did you write a plugin for your favorite editor? That's great! Let me know about it and
 I will list it here.
@@ -194,7 +195,7 @@ Allow spaces inside hash braces?
 With `:always`, hashes will look like this:
 
 ```ruby
-{ :foo => 1, :bar => 2}
+{ :foo => 1, :bar => 2 }
 ```
 
 With `:never`, hashes will look like this:
@@ -268,7 +269,7 @@ With `:dynamic` it won't modify it.
 If `align_assignments` is `true`, then this setting has no effect and `:one`
 will be used when no other assignments are above/below an assignment.
 
-### spaces_around_ternary
+### spaces_in_ternary
 
 How to format spaces around a ternary (`cond ? then : else`) operator?
 
@@ -545,7 +546,30 @@ before the operator, a space is added after it.
 
 With `:dynamic` it won't modify it.
 
-### parens_in_defs
+### spaces_after_method_name
+
+How to format spaces after a method name?
+
+- `:dynamic`: (default) allow any number of spaces
+- `:no`: no spaces after a method name
+
+Given this code:
+
+```ruby
+def plus_one   (x) x + 1 end
+def plus_twenty(x) x + 20 end
+```
+
+With `:no` the formatter will change it to:
+
+```ruby
+def plus_one(x) x + 1 end
+def plus_twenty(x) x + 20 end
+```
+
+With `:dynamic` it won't modify it.
+
+### parens_in_def
 
 Use parentheses in defs?
 

data/lib/rufo/backport.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rufo::Backport
   # Implement Enumerable#chunk_while
   # if it's not available in the current Ruby version

data/lib/rufo/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "optparse"
 
 class Rufo::Command

data/lib/rufo/dot_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Rufo::DotFile
   def initialize
     @cache = {}

data/lib/rufo/formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "ripper"
 
 class Rufo::Formatter
@@ -20,7 +22,7 @@ class Rufo::Formatter
     @line = 0
     @column = 0
     @last_was_newline = true
-    @output = ""
+    @output = "".dup
 
     # The column of a `obj.method` call, so we can align
     # calls to that dot
@@ -144,13 +146,15 @@ class Rufo::Formatter
     # Case when positions
     @case_when_positions = []
 
-    # Methods that were writte in a single line, like:
+    # Declarations that are written in a single line, like:
     #
     #    def foo; 1; end
     #
     # We want to track these because we allow consecutive inline defs
     # to be together (without an empty line between them)
-    @one_line_defs = []
+    #
+    # This is [[line, original_line], ...]
+    @inline_declarations = []
 
     # Settings
     indent_size                 options.fetch(:indent_size,                 2)
@@ -168,6 +172,7 @@ class Rufo::Formatter
     spaces_after_lambda_arrow   options.fetch(:spaces_after_lambda_arrow,   :dynamic)
     spaces_around_unary         options.fetch(:spaces_around_unary,         :dynamic)
     spaces_around_binary        options.fetch(:spaces_around_binary,        :dynamic)
+    spaces_after_method_name    options.fetch(:spaces_after_method_name,    :dynamic)
     parens_in_def               options.fetch(:parens_in_def,               :dynamic)
     double_newline_inside_type  options.fetch(:double_newline_inside_type,  :dynamic)
     visibility_indent           options.fetch(:visibility_indent,           :dynamic)
@@ -241,6 +246,10 @@ class Rufo::Formatter
     @spaces_around_binary = one_dynamic("spaces_around_binary", value)
   end
 
+  def spaces_after_method_name(value)
+    @spaces_after_method_name = no_dynamic("spaces_after_method_name", value)
+  end
+
   def parens_in_def(value)
     @parens_in_def = yes_dynamic("parens_in_def", value)
   end
@@ -351,7 +360,7 @@ class Rufo::Formatter
     do_align_hash_keys if @align_hash_keys
     do_align_case_when if @align_case_when
     do_align_comments if @align_comments
-    remove_lines_before_one_line_defs
+    remove_lines_before_inline_declarations
   end
 
   def visit(node)
@@ -416,9 +425,12 @@ class Rufo::Formatter
       # For heredocs with tilde we sometimes need to align the contents
       if heredoc && tilde && @last_was_newline
         write_indent(next_indent) unless current_token_value == "\n"
-        check :on_tstring_content
-        consume_token_value(current_token_value)
-        next_token
+        skip_ignored_space
+        if current_token_kind == :on_tstring_content
+          check :on_tstring_content
+          consume_token_value(current_token_value)
+          next_token
+        end
       else
         consume_token :on_tstring_content
       end
@@ -553,6 +565,8 @@ class Rufo::Formatter
       visit_mrhs_new_from_args(node)
     when :mlhs_paren
       visit_mlhs_paren(node)
+    when :mlhs
+      visit_mlhs(node)
     when :mrhs_add_star
       visit_mrhs_add_star(node)
     when :def
@@ -620,6 +634,8 @@ class Rufo::Formatter
       visit_undef(node)
     when :mlhs_add_star
       visit_mlhs_add_star(node)
+    when :rest_param
+      visit_rest_param(node)
     when :retry
       # [:retry]
       consume_keyword "retry"
@@ -659,13 +675,14 @@ class Rufo::Formatter
       end
 
       line_before_exp = @line
+      original_line = current_token_line
 
       push_node(exp) do
         visit exp
       end
 
-      if def?(exp) && @line == line_before_exp
-        @one_line_defs << @line
+      if declaration?(exp) && @line == line_before_exp
+        @inline_declarations << [@line, original_line]
       end
 
       is_last = last?(i, exps)
@@ -716,8 +733,13 @@ class Rufo::Formatter
     false
   end
 
-  def def?(exp)
-    exp[0] == :def
+  def declaration?(exp)
+    case exp[0]
+    when :def, :class, :module
+      true
+    else
+      false
+    end
   end
 
   def visit_string_literal(node)
@@ -1396,11 +1418,7 @@ class Rufo::Formatter
 
     # We align call parameters to the first paramter
     indent(needed_indent) do
-      if args[0].is_a?(Symbol)
-        visit args
-      else
-        visit_exps args, with_lines: false
-      end
+      visit_exps to_ary(args), with_lines: false
     end
 
     if call_info && call_info.size > 2
@@ -1512,10 +1530,13 @@ class Rufo::Formatter
 
     consume_block_args args
 
-    indent_body body
-
-    write_indent if @line != line
-    consume_keyword "end"
+    if body.first == :bodystmt
+      visit_bodystmt body
+    else
+      indent_body body
+      write_indent unless @line == line
+      consume_keyword "end"
+    end
   end
 
   def consume_block_args(args)
@@ -1705,11 +1726,7 @@ class Rufo::Formatter
   end
 
   def visit_rescue_types(node)
-    if node[0].is_a?(Symbol)
-      visit node
-    else
-      visit_exps node, with_lines: false
-    end
+    visit_exps to_ary(node), with_lines: false
   end
 
   def visit_mrhs_new_from_args(node)
@@ -1721,10 +1738,8 @@ class Rufo::Formatter
       visit_comma_separated_list exps
       write_params_comma
       visit final_exp
-    elsif exps[0].is_a?(Symbol)
-      visit exps
     else
-      visit_comma_separated_list exps
+      visit_comma_separated_list to_ary(exps)
     end
   end
 
@@ -1734,8 +1749,18 @@ class Rufo::Formatter
     # ]
     _, args = node
 
-    # For :mlsh_paren, sometimes a paren comes,
-    # some times not, so act accordingly.
+    visit_mlhs_or_mlhs_paren(args)
+  end
+
+  def visit_mlhs(node)
+    # [:mlsh, *args]
+    _, *args = node
+
+    visit_mlhs_or_mlhs_paren(args)
+  end
+
+  def visit_mlhs_or_mlhs_paren(args)
+    # Sometimes a paren comes, some times not, so act accordingly.
     has_paren = current_token_kind == :on_lparen
     if has_paren
       consume_token :on_lparen
@@ -1792,11 +1817,7 @@ class Rufo::Formatter
     consume_keyword "for"
     consume_space
 
-    if var[0].is_a?(Symbol)
-      visit var
-    else
-      visit_comma_separated_list var
-    end
+    visit_comma_separated_list to_ary(var)
 
     consume_space
     consume_keyword "in"
@@ -1844,13 +1865,6 @@ class Rufo::Formatter
   end
 
   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)
-      visit nodes
-      return
-    end
-
     needs_indent = false
 
     if newline? || comment?
@@ -1862,6 +1876,7 @@ class Rufo::Formatter
       base_column = @column
     end
 
+    nodes = to_ary(nodes)
     nodes.each_with_index do |exp, i|
       maybe_indent(needs_indent, base_column) do
         if block_given?
@@ -1907,11 +1922,7 @@ class Rufo::Formatter
       if current_token_kind == :on_op && current_token_value == "*"
         before, star, after = nil, before, after
       else
-        if before[0].is_a?(Symbol)
-          visit before
-        else
-          visit_comma_separated_list before
-        end
+        visit_comma_separated_list to_ary(before)
         write_params_comma
       end
     end
@@ -1929,6 +1940,19 @@ class Rufo::Formatter
     end
   end
 
+  def visit_rest_param(node)
+    # [:rest_param, name]
+
+    _, name = node
+
+    consume_op "*"
+
+    if name
+      skip_space_or_newline
+      visit name
+    end
+  end
+
   def visit_unary(node)
     # [:unary, :-@, [:vcall, [:@ident, "x", [1, 2]]]]
     _, op, exp = node
@@ -2128,7 +2152,9 @@ class Rufo::Formatter
       params = params[1]
     end
 
+    first_space = space? ? current_token : nil
     skip_space
+
     if current_token_kind == :on_lparen
       next_token
       skip_space
@@ -2142,9 +2168,17 @@ class Rufo::Formatter
 
         # () needs to be preserved if some content follows
         unless newline? || comment?
+          if first_space && @spaces_after_method_name == :dynamic
+            write_space first_space[2]
+          end
+
           write "()"
         end
       else
+        if first_space && @spaces_after_method_name == :dynamic
+          write_space first_space[2]
+        end
+
         write "("
 
         if newline? || comment?
@@ -2195,11 +2229,7 @@ class Rufo::Formatter
     skip_space_or_newline
 
     if exps
-      if exps[0].is_a?(Symbol)
-        visit exps
-      else
-        visit_exps exps, with_lines: false
-      end
+      visit_exps to_ary(exps), with_lines: false
     end
 
     skip_space_or_newline
@@ -2330,13 +2360,7 @@ class Rufo::Formatter
     next_token
 
     if elements
-      if elements[0].is_a?(Symbol)
-        skip_space_or_newline
-        visit elements
-        skip_space_or_newline
-      else
-        visit_literal_elements elements, inside_array: true, token_column: token_column
-      end
+      visit_literal_elements to_ary(elements), inside_array: true, token_column: token_column
     else
       skip_space_or_newline
     end
@@ -2678,12 +2702,7 @@ class Rufo::Formatter
       consume_space if space?
 
       indent(@column) do
-        # For `return a b` there comes many nodes, not just one... (see #8)
-        if node[1][0].is_a?(Symbol)
-          visit node[1]
-        else
-          visit_exps node[1], with_lines: false
-        end
+        visit_exps to_ary(node[1]), with_lines: false
       end
     end
   end
@@ -3183,6 +3202,9 @@ class Rufo::Formatter
         skip_space
 
         if newline? || semicolon? || comment?
+          # Cancel tracking of `else` on a nelwine.
+          @case_when_positions.pop
+
           indent_body next_exp[1]
         else
           if @spaces_around_when == :one || @align_case_when || !first_space
@@ -3245,6 +3267,10 @@ class Rufo::Formatter
     next_token while space?
   end
 
+  def skip_ignored_space
+    next_token while current_token_kind == :on_ignored_sp
+  end
+
   def skip_space_no_heredoc_check
     while space?
       next_token_no_heredoc_check
@@ -3539,15 +3565,15 @@ class Rufo::Formatter
   end
 
   def consume_embedded_comment
-    write current_token_value
+    consume_token_value current_token_value
     next_token
 
     while current_token_kind != :on_embdoc_end
-      write current_token_value
+      consume_token_value current_token_value
       next_token
     end
 
-    write current_token_value.rstrip
+    consume_token_value current_token_value.rstrip
     next_token
   end
 
@@ -3821,7 +3847,7 @@ class Rufo::Formatter
       if last_newline_index
         # Remove extra indent if we are indenting inside private/protected/public
         # and we just found another one.
-        @output = "#{@output[0..last_newline_index]}#{@output[last_newline_index + 1 + @indent_size..-1]}"
+        @output = "#{@output[0..last_newline_index]}#{@output[last_newline_index + 1 + @indent_size..-1]}".dup
         @indent -= @indent_size
         @visibility_indent_in_action.delete @current_type
       end
@@ -3946,6 +3972,10 @@ class Rufo::Formatter
     @current_type = old_type
   end
 
+  def to_ary(node)
+    node[0].is_a?(Symbol) ? [node] : node
+  end
+
   def dedent_calls
     return if @line_to_call_info.empty?
 
@@ -4094,13 +4124,13 @@ class Rufo::Formatter
     end
   end
 
-  def remove_lines_before_one_line_defs
-    return if @one_line_defs.empty?
+  def remove_lines_before_inline_declarations
+    return if @inline_declarations.empty?
 
     lines = @output.lines
 
-    @one_line_defs.reverse.each_cons(2) do |after, before|
-      if before + 2 == after && lines[before + 1].strip.empty?
+    @inline_declarations.reverse.each_cons(2) do |(after, after_original), (before, before_original)|
+      if before + 2 == after && before_original + 1 == after_original && lines[before + 1].strip.empty?
         lines.delete_at(before + 1)
       end
     end

data/lib/rufo/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rufo
-  VERSION = "0.0.35"
+  VERSION = "0.0.36"
 end

data/lib/rufo.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rufo
   class Bug < StandardError; end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rufo
 version: !ruby/object:Gem::Version
-  version: 0.0.35
+  version: 0.0.36
 platform: ruby
 authors:
 - Ary Borenszweig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-05 00:00:00.000000000 Z
+date: 2017-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Ruby code formatter