rufo 0.0.34 → 0.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d722fed549e79c6f97a6ec76c94574aa7b644520
-  data.tar.gz: d4f1a92c881618644dd8c8b2aa71b6261b969014
+  metadata.gz: c8f842894649d7c49344b5fb5facbaf7be70325b
+  data.tar.gz: da16188e943e329386aa0c9ac945c7d71c15dc56
 SHA512:
-  metadata.gz: c18dfd73b6ce027e04402131ec960ec4162b8d0a7b8ba91f70c7793ad5c2e17f1c847435d37ab5226580c358383a9c9eb507b6bbfa0551d4ce73a079e28fe004
-  data.tar.gz: fda9a82998eea248c95efa63523ae67931b582acb12bcd9a3ef1023a8e58b8b36246a8a9235c50e08343ca27b5e455390ed540f7d158db46db910c6c9bc6554b
+  metadata.gz: 3f03c1fe682b3eb4a2e2b5c073bc18108854bea07781a06910eede1a1c7388ef2f2604c86b6b6721fa49d3574cf83a2d45d32b2eab981089da9e664609580190
+  data.tar.gz: cec6e4a31328301bfaaf61e304a523af85c2c8fdd79ae7939a3506320af836084bed546fdd33b82e953a9fb720c30a29abf7a2658bb3a03d848280dcbf39303c

data/README.md

@@ -189,6 +189,7 @@ Allow spaces inside hash braces?
 - `:dynamic`: (default) if there's a space, keep it. Otherwise don't add it.
 - `:always`: always add a space
 - `:never`: never add a space
+- `:match`: if there's a leading space, keep it (just one) and match the closing brace with one space before it
 
 With `:always`, hashes will look like this:
 
@@ -202,7 +203,14 @@ With `:never`, hashes will look like this:
 {:foo => 1, :bar => 2}
 ```
 
-With `:dynamic`, any of the above choices is fine.
+With `:match`, hashes will look like any of these:
+
+```ruby
+{ :foo => 1, :bar => 2 }
+{:foo => 1, :bar => 2}
+```
+
+With `:dynamic`, any of the above choices is fine, and any amount of space (or zero) is preserved.
 
 ### spaces_inside_array_bracket
 
@@ -211,6 +219,7 @@ Allow spaces inside array brackets?
 - `:dynamic`: (default) if there's a space, keep it. Otherwise don't add it.
 - `:always`: always add a space
 - `:never`: never add a space
+- `:match`: if there's a leading space, keep it (just one) and match the closing bracket with one space before it
 
 With `:always`, arrays will look like this:
 
@@ -224,6 +233,13 @@ With `:never`, arrays will look like this:
 [1, 2]
 ```
 
+With `:match`, arrays will look like any of these:
+
+```ruby
+[ 1, 2 ]
+[1, 2]
+```
+
 With `:dynamic`, any of the above choices is fine.
 
 ### spaces_around_equal

data/lib/rufo/command.rb

@@ -1,4 +1,4 @@
-require "optionparser"
+require "optparse"
 
 class Rufo::Command
   def self.run(argv)

data/lib/rufo/formatter.rb

@@ -144,6 +144,14 @@ class Rufo::Formatter
     # Case when positions
     @case_when_positions = []
 
+    # Methods that were writte 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 = []
+
     # Settings
     indent_size                 options.fetch(:indent_size,                 2)
     spaces_inside_hash_brace    options.fetch(:spaces_inside_hash_brace,    :dynamic)
@@ -178,11 +186,11 @@ class Rufo::Formatter
   end
 
   def spaces_inside_hash_brace(value)
-    @spaces_inside_hash_brace = dynamic_always_never("spaces_inside_hash_brace", value)
+    @spaces_inside_hash_brace = dynamic_always_never_match("spaces_inside_hash_brace", value)
   end
 
   def spaces_inside_array_bracket(value)
-    @spaces_inside_array_bracket = dynamic_always_never("spaces_inside_array_bracket", value)
+    @spaces_inside_array_bracket = dynamic_always_never_match("spaces_inside_array_bracket", value)
   end
 
   def spaces_around_equal(value)
@@ -259,6 +267,15 @@ class Rufo::Formatter
     end
   end
 
+  def dynamic_always_never_match(name, value)
+    case value
+    when :dynamic, :always, :never, :match
+      value
+    else
+      raise ArgumentError.new("invalid value for #{name}: #{value}. Valid values are: :dynamic, :always, :never, :match")
+    end
+  end
+
   def one_dynamic(name, value)
     case value
     when :one, :dynamic
@@ -334,6 +351,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
   end
 
   def visit(node)
@@ -640,13 +658,17 @@ class Rufo::Formatter
         end
       end
 
+      line_before_exp = @line
+
       push_node(exp) do
         visit exp
       end
 
-      is_last = last?(i, exps)
+      if def?(exp) && @line == line_before_exp
+        @one_line_defs << @line
+      end
 
-      skip_space unless is_last
+      is_last = last?(i, exps)
 
       line_before_endline = @line
 
@@ -694,6 +716,10 @@ class Rufo::Formatter
     false
   end
 
+  def def?(exp)
+    exp[0] == :def
+  end
+
   def visit_string_literal(node)
     # [:string_literal, [:string_content, exps]]
     heredoc = current_token_kind == :on_heredoc_beg
@@ -1008,7 +1034,9 @@ class Rufo::Formatter
     end
 
     @line_to_alignments_positions[@line] << [key, @column, target, target.size]
-    target << [@line, @column, @indent, id, offset]
+    info = [@line, @column, @indent, id, offset]
+    target << info
+    info
   end
 
   def visit_ternary_if(node)
@@ -1430,7 +1458,7 @@ class Rufo::Formatter
     if void_exps?(body)
       consume_token :on_lbrace
       consume_block_args args
-      consume_one_dynamic_space_no_more_than_one @spaces_around_block_brace
+      consume_one_dynamic_space @spaces_around_block_brace
       consume_token :on_rbrace
       return
     end
@@ -1441,14 +1469,14 @@ class Rufo::Formatter
     if current_token_line == closing_brace_token[0][0]
       consume_token :on_lbrace
       consume_block_args args
-      consume_one_dynamic_space_no_more_than_one @spaces_around_block_brace
+      consume_one_dynamic_space @spaces_around_block_brace
       visit_exps body, with_lines: false
 
       while semicolon?
         next_token
       end
 
-      consume_one_dynamic_space_no_more_than_one @spaces_around_block_brace
+      consume_one_dynamic_space @spaces_around_block_brace
 
       consume_token :on_rbrace
       return
@@ -1492,7 +1520,7 @@ class Rufo::Formatter
 
   def consume_block_args(args)
     if args
-      consume_one_dynamic_space_no_more_than_one @spaces_around_block_brace
+      consume_one_dynamic_space_or_newline @spaces_around_block_brace
       # + 1 because of |...|
       #                ^
       indent(@column + 1) do
@@ -1855,14 +1883,14 @@ class Rufo::Formatter
 
       if newline? || comment?
         indent(base_column || @indent) do
-          consume_end_of_line(want_multiline: false)
+          consume_end_of_line(want_multiline: false, first_space: first_space)
           write_indent
         end
       elsif first_space && @spaces_after_comma == :dynamic
         write_space first_space[2]
         skip_space_or_newline
       else
-        write_space
+        write_space if @spaces_after_comma == :one
         skip_space_or_newline
       end
     end
@@ -2195,11 +2223,9 @@ class Rufo::Formatter
       write_params_comma if needs_comma
       visit_comma_separated_list(args_with_default) do |arg, default|
         visit arg
-        skip_space
-        write_space
+        consume_one_dynamic_space @spaces_around_equal
         consume_op "="
-        skip_space_or_newline
-        write_space
+        consume_one_dynamic_space @spaces_around_equal
         visit default
       end
       needs_comma = true
@@ -2280,7 +2306,7 @@ class Rufo::Formatter
       write_space first_space[2]
       skip_space_or_newline
     else
-      write_space
+      write_space if @spaces_after_comma == :one
       skip_space_or_newline
     end
   end
@@ -2511,6 +2537,7 @@ class Rufo::Formatter
 
     column = @column
 
+    first_space = space? ? current_token : nil
     skip_space
 
     # Sometimes args comes with an array...
@@ -2526,6 +2553,9 @@ class Rufo::Formatter
           skip_space_or_newline
         end
       else
+        if first_space && @spaces_inside_array_bracket == :dynamic
+          write first_space[2]
+        end
         needed_indent = column
       end
 
@@ -2536,7 +2566,13 @@ class Rufo::Formatter
       end
     end
 
-    skip_space_or_newline
+    first_space = space? ? current_token : nil
+    skip_space
+    if newline? || comment?
+      skip_space_or_newline
+    elsif first_space && @spaces_inside_array_bracket == :dynamic
+      write first_space[2]
+    end
 
     check :on_rbracket
     write "]"
@@ -2789,6 +2825,7 @@ class Rufo::Formatter
   def visit_literal_elements(elements, inside_hash: false, inside_array: false, token_column:)
     base_column = @column
     base_line = @line
+    first_space = current_token if space?
     needs_final_space = (inside_hash || inside_array) && space?
     skip_space
 
@@ -2813,7 +2850,13 @@ class Rufo::Formatter
     if newline? || comment?
       needs_final_space = false
     elsif needs_final_space
-      consume_space
+      if inside_hash && first_space && @spaces_inside_hash_brace == :dynamic
+        write first_space[2]
+      elsif inside_array && first_space && @spaces_inside_array_bracket == :dynamic
+        write first_space[2]
+      else
+        consume_space
+      end
       base_column = @column
     end
 
@@ -2835,6 +2878,7 @@ class Rufo::Formatter
 
     wrote_comma = false
     last_has_comma = false
+    first_space = nil
 
     elements.each_with_index do |elem, i|
       is_last = last?(i, elements)
@@ -2847,11 +2891,24 @@ class Rufo::Formatter
         visit elem
       end
 
+      first_space = space? ? current_token : nil
+
       # We have to be careful not to aumatically write a heredoc on next_token,
       # because we miss the chance to write a comma to separate elements
       skip_space_no_heredoc_check
       wrote_comma = check_heredocs_in_literal_elements(is_last, needs_trailing_comma, wrote_comma)
 
+      if is_last && !comma? && !wrote_comma && !needs_trailing_comma && !comment?
+        if (inside_hash && @spaces_inside_hash_brace == :dynamic) ||
+           (inside_array && @spaces_inside_array_bracket == :dynamic)
+          if first_space
+            write first_space[2]
+          else
+            needs_final_space = false
+          end
+        end
+      end
+
       next unless comma?
 
       last_has_comma = true
@@ -2865,7 +2922,7 @@ class Rufo::Formatter
       # because we miss the chance to write a comma to separate elements
       next_token_no_heredoc_check
 
-      first_space = current_token if space?
+      first_space = space? ? current_token : nil
 
       skip_space_no_heredoc_check
       wrote_comma = check_heredocs_in_literal_elements(is_last, needs_trailing_comma, wrote_comma)
@@ -2874,12 +2931,14 @@ class Rufo::Formatter
         if is_last
           # Nothing
         else
-          consume_end_of_line
-          write_indent(needed_indent)
+          indent(needed_indent) do
+            consume_end_of_line(first_space: first_space)
+            write_indent
+          end
         end
       elsif !is_last && first_space && @spaces_after_comma == :dynamic
         write_space first_space[2]
-      else
+      elsif @spaces_after_comma == :one
         write_space unless is_last
       end
     end
@@ -2894,10 +2953,10 @@ class Rufo::Formatter
         write "," if last_has_comma && !wrote_comma
       end
 
-      consume_end_of_line
+      consume_end_of_line(first_space: first_space)
       write_indent
     elsif comment?
-      consume_end_of_line
+      consume_end_of_line(first_space: first_space)
     else
       if needs_final_space
         consume_space
@@ -3053,10 +3112,10 @@ class Rufo::Formatter
       space_after_then = current_token if space? && preserve_whitespace
       skip_space
 
-      track_case_when
+      info = track_case_when
       skip_semicolons
 
-      if newline? || comment?
+      if newline?
         inline = false
 
         # Cancel tracking of `case when ... then` on a nelwine.
@@ -3070,6 +3129,23 @@ class Rufo::Formatter
 
         write "then"
 
+        # We adjust the column and offset from:
+        #
+        #     when 1 then 2
+        #           ^ (with offset 0)
+        #
+        # to:
+        #
+        #     when 1 then 2
+        #                ^ (with offset 5)
+        #
+        # In that way we can align this with an `else` clause.
+        if info
+          offset = @column - info[1]
+          info[1] = @column
+          info[-1] = offset
+        end
+
         if space_after_then
           write_space space_after_then[2]
         else
@@ -3102,12 +3178,18 @@ class Rufo::Formatter
       if next_exp[0] == :else
         # [:else, body]
         consume_keyword "else"
+        first_space = current_token if space?
+        track_case_when
         skip_space
 
         if newline? || semicolon? || comment?
           indent_body next_exp[1]
         else
-          write_space
+          if @spaces_around_when == :one || @align_case_when || !first_space
+            write_space
+          else
+            write_space first_space[2]
+          end
           visit_exps next_exp[1]
         end
       else
@@ -3146,14 +3228,6 @@ class Rufo::Formatter
     end
   end
 
-  def consume_one_dynamic_space_no_more_than_one(setting)
-    if setting == :one
-      consume_space
-    else
-      consume_space if space?
-    end
-  end
-
   def consume_one_dynamic_space_or_newline(setting)
     first_space = current_token if space?
     skip_space
@@ -3285,18 +3359,20 @@ 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, needs_two_lines_on_comment: false)
+  def consume_end_of_line(at_prefix: false, want_semicolon: false, want_multiline: true, needs_two_lines_on_comment: false, first_space: nil)
     found_newline = false               # Did we find any newline during this method?
     found_comment_after_newline = false # Did we find a comment after some newline?
     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
+    last_space = first_space            # Last found space
 
     loop do
       case current_token_kind
       when :on_sp
         # Ignore spaces
+        last_space = current_token
         next_token
       when :on_nl, :on_ignored_nl
         # I don't know why but sometimes a on_ignored_nl
@@ -3384,7 +3460,14 @@ class Rufo::Formatter
           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
+            unless at_prefix
+              # Preserve whitespace before comment unless we need to align them
+              if last_space && !@align_comments
+                write last_space[2]
+              else
+                write_space
+              end
+            end
 
             # First we check if the comment was aligned to the previous comment
             # in the previous line, in order to keep them like that.
@@ -3870,6 +3953,8 @@ class Rufo::Formatter
 
     while line_to_call_info = @line_to_call_info.shift
       first_line, call_info = line_to_call_info
+      next unless call_info.size == 5
+
       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
@@ -4009,6 +4094,20 @@ class Rufo::Formatter
     end
   end
 
+  def remove_lines_before_one_line_defs
+    return if @one_line_defs.empty?
+
+    lines = @output.lines
+
+    @one_line_defs.reverse.each_cons(2) do |after, before|
+      if before + 2 == after && lines[before + 1].strip.empty?
+        lines.delete_at(before + 1)
+      end
+    end
+
+    @output = lines.join
+  end
+
   def result
     @output
   end

data/lib/rufo/version.rb

@@ -1,3 +1,3 @@
 module Rufo
-  VERSION = "0.0.34"
+  VERSION = "0.0.35"
 end

data/rufo.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["asterite@gmail.com"]
 
   spec.summary       = %q{Ruby code formatter}
-  spec.description   = %q{Ruby code formatter}
+  spec.description   = %q{Fast and unobtrusive Ruby code formatter}
   spec.homepage      = "https://github.com/asterite/rufo"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rufo
 version: !ruby/object:Gem::Version
-  version: 0.0.34
+  version: 0.0.35
 platform: ruby
 authors:
 - Ary Borenszweig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-03 00:00:00.000000000 Z
+date: 2017-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Ruby code formatter
+description: Fast and unobtrusive Ruby code formatter
 email:
 - asterite@gmail.com
 executables: