rufo 0.0.25 → 0.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 200fb638506091280a985b092c7f56d51cc78ee6
-  data.tar.gz: fa2aa0c202892a85c4683b5fe50c39f7fdc9f440
+  metadata.gz: 2da6aac7c9ee2daf498d8131afd7e77717a9ebb7
+  data.tar.gz: 1fbb0734dec03fc709b615fae32f6c52bfcb1df1
 SHA512:
-  metadata.gz: 461fd9e0fc701a914e1c5d8a8174f913ed1b1cb7c2d820d8b451c584558058b3bcd249e8cb8cd7dc0d2ecade21111cbdf4ac63e5246daf71374a860c32699331
-  data.tar.gz: 4ec02ecd32126046a380e6fff1a521605013b585320cbadc76f909aacbbed6af2c56cdbf20a289519d7c6be3d462bb14b3188b2d7688d2b74f9478a319120f07
+  metadata.gz: d21c78d0b4287cc04e5121c91631dacebcbf7f860c0398335e39f885da82de0a08676048b44c0964e8480253d86ebc78f699e23499931398318ba2a54e7dfc27
+  data.tar.gz: 23800db7fbb6224f5be334fab2141ef022d87906bc27926d6744debfd2d1751538ad9d189f956cf0a8e7c382c8cf0c801a5d6672dba49652117b041a615161ef

data/.rufo

@@ -1,7 +1,10 @@
-space_after_hash_brace :dynamic
-preserve_whitespace    true
-align_comments         true
-align_assignments      false
-align_hash_keys        true
-align_case_when        true
-indent_size            2
+space_after_array_bracket :never
+space_after_hash_brace    :dynamic
+preserve_whitespace       true
+align_comments            true
+align_assignments         false
+align_hash_keys           true
+align_case_when           true
+align_chained_calls       false
+indent_size               2
+trailing_commas           :always

data/README.md

@@ -61,12 +61,13 @@ according to **rufo**, and will exit with exit code 1.
 ## Editor support
 
 - Sublime Text: [sublime-rufo](https://github.com/asterite/sublime-rufo)
+- Vim: [rufo-vim](https://github.com/splattael/rufo-vim) :construction:
+- Atom: [rufo-atom](https://github.com/bmulvihill/rufo-atom) :construction:
 
 Did you write a plugin for your favorite editor? That's great! Let me know about it and
 I will list it here.
 
-Right now it would be great to have [Vim](http://www.vim.org/),
-[Atom](https://atom.io/) and [Emacs](https://www.gnu.org/software/emacs/) plugins :-)
+Right now it would be great to have an [Emacs](https://www.gnu.org/software/emacs/) plugin :-)
 
 ## Configuration
 
@@ -79,9 +80,16 @@ The `.rufo` file is a Ruby file that is evaluated in the context of the formatte
 available configurations:
 
 ```ruby
+# Whether to put a space after an array bracket. Valid values are:
+#
+# * :dynamic: if there's a space, keep it. If not, don't add it
+# * :always: always put a space after an array bracket (default)
+# * :never: never put a space after an array bracket
+space_after_array_bracket :never
+
 # Whether to put a space after a hash brace. Valid values are:
 #
-# * :dynamic: if there's a space, keep it. If not, don't keep it (default)
+# * :dynamic: if there's a space, keep it. If not, don't add it (default)
 # * :always: always put a space after a hash brace
 # * :never: never put a space after a hash brace
 space_after_hash_brace :dynamic
@@ -98,6 +106,9 @@ align_hash_keys true
 # Whether to align successive case when (default: true)
 align_case_when true
 
+# Whether to align chained calls to the dot (default: true)
+align_chained_calls true
+
 # Preserve whitespace after assignments target and values,
 # after calls that start with a space, hash arrows and commas (default: true).
 #
@@ -110,6 +121,13 @@ preserve_whitespace true
 
 # The indent size (default: 2)
 indent_size 2
+
+# Whether to place commas at the end of a multi-line list
+#
+# * :dynamic: if there's a comma, keep it. If not, don't add it
+# * :always: always put a comma (default)
+# * :never: never put a comma
+trailing_commas :always
 ```
 
 As time passes there might be more configurations available. Please open an

data/lib/rufo/formatter.rb

@@ -26,6 +26,10 @@ class Rufo::Formatter
     # calls to that dot
     @dot_column = nil
 
+    # The column of a `obj.method` call, but only the name part,
+    # so we can also align arguments accordingly
+    @name_dot_column = nil
+
     # Heredocs list, associated with calls ([heredoc, tilde])
     @heredocs = []
 
@@ -38,6 +42,32 @@ class Rufo::Formatter
     # The current hash or call or method that has hash-like parameters
     @current_hash = nil
 
+    # Map lines to commands that start at the begining of a line with the following info:
+    # - line indent
+    # - first param indent
+    # - first line ends with '(', '[' or '{'?
+    # - line of matching pair of the previous item
+    # - last line of that call
+    #
+    # This is needed to dedent some calls that look like this:
+    #
+    # foo bar(
+    #   2,
+    # )
+    #
+    # Without the dedent it would normally look like this:
+    #
+    # foo bar(
+    #       2,
+    #     )
+    #
+    # Because the formatter aligns this to the first parameter in the call.
+    # However, for these cases it's better to not align it like that.
+    @line_to_call_info = {}
+
+    # Each line that belongs to a heredoc content is put here
+    @heredoc_lines = {}
+
     # Position of comments that occur at the end of a line
     @comments_positions = []
 
@@ -75,11 +105,14 @@ class Rufo::Formatter
     # Settings
     indent_size options.fetch(:indent_size, 2)
     space_after_hash_brace options.fetch(:space_after_hash_brace, :dynamic)
+    space_after_array_bracket options.fetch(:space_after_array_bracket, :never)
     align_comments options.fetch(:align_comments, true)
     align_assignments options.fetch(:align_assignments, false)
     align_hash_keys options.fetch(:align_hash_keys, true)
     align_case_when options.fetch(:align_case_when, true)
+    align_chained_calls options.fetch(:align_chained_calls, true)
     preserve_whitespace options.fetch(:preserve_whitespace, true)
+    trailing_commas options.fetch(:trailing_commas, :always)
   end
 
   # The indent size (default: 2)
@@ -97,7 +130,21 @@ class Rufo::Formatter
     when :dynamic, :always, :never
       @space_after_hash_brace = value
     else
-      raise ArgumentError.new("invalid value for #{space_after_hash_brace}: #{value}. Valid values are: :dynamic, :always, :never")
+      raise ArgumentError.new("invalid value for space_after_hash_brace: #{value}. Valid values are: :dynamic, :always, :never")
+    end
+  end
+
+  # Whether to put a space after an array bracket. Valid values are:
+  #
+  # * :dynamic: if there's a space, keep it. If not, don't keep it
+  # * :always: always put a space after an array bracket
+  # * :never: never put a space after an array bracket (default)
+  def space_after_array_bracket(value)
+    case value
+    when :dynamic, :always, :never
+      @space_after_array_bracket = value
+    else
+      raise ArgumentError.new("invalid value for space_after_array_bracket: #{value}. Valid values are: :dynamic, :always, :never")
     end
   end
 
@@ -121,6 +168,11 @@ class Rufo::Formatter
     @align_case_when = value
   end
 
+  # Whether to align chained calls to the dot (default: true)
+  def align_chained_calls(value)
+    @align_chained_calls = value
+  end
+
   # Preserve whitespace after assignments target and values,
   # after calls that start with a space, hash arrows and commas.
   #
@@ -133,11 +185,26 @@ class Rufo::Formatter
     @preserve_whitespace = value
   end
 
+  # Whether to place commas at the end of a multi-line list
+  #
+  # * :dynamic: if there's a comma, keep it. If not, don't add it
+  # * :always: always put a comma (default)
+  # * :never: never put a comma
+  def trailing_commas(value)
+    case value
+    when :dynamic, :always, :never
+      @trailing_commas = value
+    else
+      raise ArgumentError.new("invalid value for trailing_commas: #{value}. Valid values are: :dynamic, :always, :never")
+    end
+  end
+
   def format
     visit @sexp
     consume_end
     write_line unless @last_was_newline
 
+    dedent_calls
     do_align_assignments if @align_assignments
     do_align_hash_keys if @align_hash_keys
     do_align_case_when if @align_case_when
@@ -512,12 +579,18 @@ class Rufo::Formatter
   end
 
   def visit_string_literal_end(node)
+    line = @line
+
     inner = node[1]
     inner = inner[1..-1] unless node[0] == :xstring_literal
     visit_exps(inner, with_lines: false)
 
     case current_token_kind
     when :on_heredoc_end
+      (line+1..@line).each do |i|
+        @heredoc_lines[i] = true
+      end
+
       heredoc, tilde = @current_heredoc
       if heredoc && tilde
         write_indent
@@ -803,8 +876,8 @@ class Rufo::Formatter
   end
 
   def visit_call_with_receiver(node)
-    # [:call, obj, :".", call]
-    _, obj, text, call = node
+    # [:call, obj, :".", name]
+    _, obj, text, name = node
 
     @dot_column = nil
     visit obj
@@ -814,7 +887,13 @@ class Rufo::Formatter
     if newline? || comment?
       consume_end_of_line
 
-      write_indent(@dot_column || next_indent)
+      if @align_chained_calls
+        @name_dot_column = @dot_column || next_indent
+        write_indent(@dot_column || next_indent)
+      else
+        @name_dot_column = next_indent
+        write_indent(next_indent)
+      end
     end
 
     # Remember dot column
@@ -830,10 +909,10 @@ class Rufo::Formatter
       skip_space_or_newline
     end
 
-    if call == :call
+    if name == :call
       # :call means it's .()
     else
-      visit call
+      visit name
     end
 
     # Only set it after we visit the call after the dot,
@@ -845,9 +924,7 @@ class Rufo::Formatter
     if current_token_kind == :on_op
       consume_token :on_op
     else
-      check :on_period
-      next_token
-      write "."
+      consume_token :on_period
     end
   end
 
@@ -859,6 +936,7 @@ class Rufo::Formatter
     #   [:arg_paren, [:args_add_block, [[:@int, "1", [1, 6]]], false]]]
     _, name, args = node
 
+    @name_dot_column = nil
     visit name
 
     # Some times a call comes without parens (should probably come as command, but well...)
@@ -866,8 +944,11 @@ class Rufo::Formatter
 
     # Remember dot column so it's not affected by args
     dot_column = @dot_column
+    want_indent = @name_dot_column && @name_dot_column > @indent
 
-    visit_call_at_paren(node, args)
+    maybe_indent(want_indent, @name_dot_column) do
+      visit_call_at_paren(node, args)
+    end
 
     # Restore dot column so it's not affected by args
     @dot_column = dot_column
@@ -888,6 +969,9 @@ class Rufo::Formatter
       skip_space
 
       needs_trailing_newline = newline? || comment?
+      if needs_trailing_newline && (call_info = @line_to_call_info[@line])
+        call_info << true
+      end
 
       push_call(node) do
         visit args_node
@@ -898,7 +982,8 @@ class Rufo::Formatter
 
       if found_comma
         if needs_trailing_newline
-          write ","
+          write "," if @trailing_commas != :never
+
           next_token
           indent(next_indent) do
             consume_end_of_line
@@ -912,7 +997,7 @@ class Rufo::Formatter
 
       if newline? || comment?
         if needs_trailing_newline
-          write "," unless found_comma
+          write "," if @trailing_commas == :always
 
           indent(next_indent) do
             consume_end_of_line
@@ -923,7 +1008,7 @@ class Rufo::Formatter
         end
       else
         if needs_trailing_newline && !found_comma
-          write ","
+          write "," if @trailing_commas == :always
           consume_end_of_line
           write_indent
         end
@@ -932,6 +1017,8 @@ class Rufo::Formatter
       skip_space_or_newline
     end
 
+    call_info << @line if call_info
+
     consume_token :on_rparen
   end
 
@@ -1044,6 +1131,14 @@ class Rufo::Formatter
       end
     end
 
+    call_info = @line_to_call_info[@line]
+    if call_info
+      call_info = nil
+    else
+      call_info = [@indent, @column]
+      @line_to_call_info[@line] = call_info
+    end
+
     indent(needed_indent) do
       if args[0].is_a?(Symbol)
         visit args
@@ -1051,6 +1146,10 @@ class Rufo::Formatter
         visit_exps args, with_lines: false
       end
     end
+
+    if call_info && call_info.size > 2
+      call_info << @line
+    end
   end
 
   def visit_call_with_block(node)
@@ -1095,8 +1194,16 @@ class Rufo::Formatter
     # Otherwise it's multiline
     consume_token :on_lbrace
     consume_block_args args
+
+    if call_info = @line_to_call_info[@line]
+      call_info << true
+    end
+
     indent_body body
     write_indent
+
+    call_info << @line if call_info
+
     consume_token :on_rbrace
   end
 
@@ -1312,27 +1419,28 @@ class Rufo::Formatter
     # ]
     _, args = node
 
+    # For :mlsh_paren, sometimes a paren comes,
+    # some times not, so act accordingly.
+    has_paren = current_token_kind == :on_lparen
+    if has_paren
+      consume_token :on_lparen
+      skip_space_or_newline
+    end
+
     # For some reason there's nested :mlhs_paren for
     # a single parentheses. It seems when there's
     # a nested array we need parens, otherwise we
     # just output whatever's inside `args`.
     if args.is_a?(Array) && args[0].is_a?(Array)
-      check :on_lparen
-      write "("
-      next_token
-      skip_space_or_newline
-
       indent(@column) do
         visit_comma_separated_list args
         skip_space_or_newline
       end
-
-      check :on_rparen
-      write ")"
-      next_token
     else
       visit args
     end
+
+    consume_token :on_rparen if has_paren
   end
 
   def visit_mrhs_add_star(node)
@@ -1687,21 +1795,21 @@ class Rufo::Formatter
     # ( exps )
     #
     # [:paren, exps]
-    check :on_lparen
-    write "("
-    next_token
+    _, exps = node
+
+    consume_token :on_lparen
     skip_space_or_newline
 
-    if node[1][0].is_a?(Symbol)
-      visit node[1]
-    else
-      visit_exps node[1], with_lines: false
+    if exps
+      if exps[0].is_a?(Symbol)
+        visit exps
+      else
+        visit_exps exps, with_lines: false
+      end
     end
 
     skip_space_or_newline
-    check :on_rparen
-    write ")"
-    next_token
+    consume_token :on_rparen
   end
 
   def visit_params(node)
@@ -1833,7 +1941,7 @@ class Rufo::Formatter
         visit elements
         skip_space_or_newline
       else
-        visit_literal_elements elements
+        visit_literal_elements elements, inside_array: true
       end
     else
       skip_space_or_newline
@@ -1853,6 +1961,7 @@ class Rufo::Formatter
       elements = elements.flat_map { |x| x }
     end
 
+    has_space = current_token_value.end_with?(" ")
     write current_token_value.strip
 
     # If there's a newline after `%w(`, write line and indent
@@ -1863,7 +1972,9 @@ class Rufo::Formatter
 
     next_token
 
-    if elements
+    if elements && !elements.empty?
+      write_space if has_space
+
       elements.each_with_index do |elem, i|
         if elem[0] == :@tstring_content
           # elem is [:@tstring_content, string, [1, 5]
@@ -1903,6 +2014,8 @@ class Rufo::Formatter
     if has_newline
       write_line
       write_indent
+    elsif has_space && elements && !elements.empty?
+      write_space
     end
 
     if last_token
@@ -2277,16 +2390,27 @@ class Rufo::Formatter
     visit_comma_separated_list exps
   end
 
-  def visit_literal_elements(elements, inside_hash: false)
+  def visit_literal_elements(elements, inside_hash: false, inside_array: false)
     base_column = @column
-    needs_final_space = inside_hash && space?
+    needs_final_space = (inside_hash || inside_array) && space?
     skip_space
 
-    case @space_after_hash_brace
-    when :never
-      needs_final_space = false
-    when :always
-      needs_final_space = true
+    if inside_hash
+      case @space_after_hash_brace
+      when :never
+        needs_final_space = false
+      when :always
+        needs_final_space = true
+      end
+    end
+
+    if inside_array
+      case @space_after_array_bracket
+      when :never
+        needs_final_space = false
+      when :always
+        needs_final_space = true
+      end
     end
 
     if newline? || comment?
@@ -2301,6 +2425,10 @@ class Rufo::Formatter
     # add a trailing comma to the last element
     needs_trailing_comma = newline? || comment?
     if needs_trailing_comma
+      if (call_info = @line_to_call_info[@line])
+        call_info << true
+      end
+
       needed_indent = next_indent
       indent { consume_end_of_line }
       write_indent(needed_indent)
@@ -2309,10 +2437,12 @@ class Rufo::Formatter
     end
 
     wrote_comma = false
+    last_has_comma = false
 
     elements.each_with_index do |elem, i|
       is_last = last?(i, elements)
       wrote_comma = false
+      last_has_comma = false
 
       if needs_trailing_comma
         indent(needed_indent) { visit elem }
@@ -2327,6 +2457,8 @@ class Rufo::Formatter
 
       next unless comma?
 
+      last_has_comma = true
+
       unless is_last
         write ","
         wrote_comma = true
@@ -2351,7 +2483,14 @@ class Rufo::Formatter
     end
 
     if needs_trailing_comma
-      write "," unless wrote_comma
+      case @trailing_commas
+      when :always
+        write "," unless wrote_comma
+      when :never
+        # Nothing
+      when :dynamic
+        write "," if last_has_comma && !wrote_comma
+      end
 
       consume_end_of_line
       write_indent
@@ -2364,6 +2503,8 @@ class Rufo::Formatter
         skip_space_or_newline
       end
     end
+
+    call_info << @line if call_info
   end
 
   def check_heredocs_in_literal_elements(is_last, needs_trailing_comma, wrote_comma)
@@ -2904,7 +3045,7 @@ class Rufo::Formatter
 
   def write_space(value = " ")
     @output << value
-    @column += 1
+    @column += value.size
   end
 
   def write_line
@@ -3083,6 +3224,34 @@ class Rufo::Formatter
     @current_hash = old_hash
   end
 
+  def dedent_calls
+    return if @line_to_call_info.empty?
+
+    lines = @output.lines
+
+    while line_to_call_info = @line_to_call_info.shift
+      first_line, call_info = line_to_call_info
+      indent, first_param_indent, needs_dedent, first_paren_end_line, last_line = call_info
+      next unless needs_dedent
+      next unless first_paren_end_line == last_line
+
+      diff = first_param_indent - indent
+      (first_line+1..last_line).each do |line|
+        @line_to_call_info.delete(line)
+
+        next if @heredoc_lines[line]
+
+        current_line = lines[line]
+        current_line = current_line[diff..-1]
+        lines[line] = current_line
+
+        adjust_other_alignments nil, line, 0, -diff
+      end
+    end
+
+    @output = lines.join
+  end
+
   def do_align_comments
     do_align @comments_positions, :comment
   end

data/lib/rufo/version.rb

@@ -1,3 +1,3 @@
 module Rufo
-  VERSION = "0.0.25"
+  VERSION = "0.0.26"
 end

metadata

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