rufo 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82f3fd868e4d701c1e505e16a057d8d8e494a925
-  data.tar.gz: de7c89b69cac54b2640d899310623539d9ec7e25
+  metadata.gz: 37581d331f99c0a339a02883d5eee479441a51c7
+  data.tar.gz: 5f65749a69f3d7542630b8509bb75b8925be48d1
 SHA512:
-  metadata.gz: 28620000e4f9723f908da738c364c35390ae9308aa79590b3485eed9bc30aa0bba7e709927b2357dcd691bfc14552a209d478d38cce03677d0788b23aafdd18e
-  data.tar.gz: cece98ad578f1a43dadb98791773c062208b40953394b484315b15268293ae50a0766898c644aeb9dfee36bae2a3dfc9b53ad672ea46cc32bf6f1992ef44a3dd
+  metadata.gz: 987ae28a14a0c618bed6d037607d698931b71ce3b2757f59078ec68c58b0f239d66077931d9b53a65aa94c75309961fe5834f6dde425889a24165d55b47fb79f
+  data.tar.gz: 7070cc3d2d44f9fc55d1029458cf7145d36b7bf97c438ac2cda077f8c670521d5516d3b817e8cc32d483e3799766650327223c7431eca65a3d96a4dd8b3e9608

data/.rufo

@@ -1,4 +1,5 @@
-align_comments      true
-align_assignments   true
-align_hash_keys     true
-indent_size         2
+space_after_hash_brace :dynamic
+align_comments         true
+align_assignments      false
+align_hash_keys        true
+indent_size            2

data/README.md

@@ -58,17 +58,24 @@ 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 a hash brace. Valid values are:
+#
+# * :dynamic: if there's a space, keep it. If not, don't keep 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
+
 # Whether to align successive comments (default: true)
-align_comments      true
+align_comments true
 
-# Whether to align successive assignments (default: true)
-align_assignments   true
+# Whether to align successive assignments (default: false)
+align_assignments false
 
 # Whether to align successive hash keys (default: true)
-align_hash_keys     true
+align_hash_keys true
 
 # The indent size (default: 2)
-indent_size         2
+indent_size 2
 ```
 
 As time passes there might be more configurations available. Please open an

data/lib/rufo/backport.rb

@@ -4,8 +4,8 @@ module Rufo::Backport
   def self.chunk_while(array)
     results = []
     current = []
-    first   = true
-    last    = nil
+    first = true
+    last = nil
 
     array.each do |elem|
       if first

data/lib/rufo/command.rb

@@ -1,21 +1,30 @@
 require "optionparser"
 
-module Rufo::Command
+class Rufo::Command
   def self.run(argv)
-    want_check = parse_options(argv)
+    want_check, filename_for_dot_rufo = parse_options(argv)
+    new(want_check, filename_for_dot_rufo).run(argv)
+  end
+
+  def initialize(want_check, filename_for_dot_rufo)
+    @want_check = want_check
+    @filename_for_dot_rufo = filename_for_dot_rufo
+    @dot_file = Rufo::DotFile.new
+  end
 
+  def run(argv)
     if argv.empty?
-      format_stdin want_check
+      format_stdin
     else
-      format_args argv, want_check
+      format_args argv
     end
   end
 
-  def self.format_stdin(want_check)
-    code   = STDIN.read
-    result = format(code, Dir.getwd)
+  def format_stdin
+    code = STDIN.read
+    result = format(code, @filename_for_dot_rufo || Dir.getwd)
 
-    if want_check
+    if @want_check
       exit 1 if result != code
     else
       print result
@@ -30,12 +39,12 @@ module Rufo::Command
     raise ex
   end
 
-  def self.format_args(args, want_check)
+  def format_args(args)
     files = []
 
     args.each do |arg|
       if Dir.exist?(arg)
-        files.concat Dir["#{arg}/**/*.rb"]
+        files.concat Dir["#{arg}/**/*.rb"].select(&File.method(:file?))
       elsif File.exist?(arg)
         files << arg
       else
@@ -46,14 +55,14 @@ module Rufo::Command
     changed = false
 
     files.each do |file|
-      success   = format_file file, want_check
+      success = format_file file
       changed ||= success
     end
 
     exit 1 if changed
   end
 
-  def self.format_file(filename, want_check)
+  def format_file(filename)
     code = File.read(filename)
 
     begin
@@ -66,7 +75,7 @@ module Rufo::Command
     end
 
     if code != result
-      if want_check
+      if @want_check
         STDERR.puts "Error: formatting #{filename} produced changes"
       else
         File.write(filename, result)
@@ -88,13 +97,13 @@ module Rufo::Command
     raise ex
   end
 
-  def self.format(code, dir)
+  def format(code, dir)
     formatter = Rufo::Formatter.new(code)
 
-    dot_rufo = find_dot_rufo(dir)
+    dot_rufo = @dot_file.find_in(dir)
     if dot_rufo
       begin
-        formatter.instance_eval(File.read(dot_rufo))
+        formatter.instance_eval(dot_rufo)
       rescue => ex
         STDERR.puts "Error evaluating #{dot_rufo}"
         raise ex
@@ -105,21 +114,9 @@ module Rufo::Command
     formatter.result
   end
 
-  def self.find_dot_rufo(dir)
-    dir  = File.expand_path(dir)
-    file = File.join(dir, ".rufo")
-    if File.exist?(file)
-      return file
-    end
-
-    parent_dir = File.dirname(dir)
-    return if parent_dir == dir
-
-    find_dot_rufo(parent_dir)
-  end
-
   def self.parse_options(argv)
     want_check = false
+    filename_for_dot_rufo = nil
 
     OptionParser.new do |opts|
       opts.banner = "Usage: rufo files or dirs [options]"
@@ -128,12 +125,16 @@ module Rufo::Command
         want_check = true
       end
 
+      opts.on("--filename=value", "Filename to use to lookup .rufo (useful for STDIN formatting)") do |value|
+        filename_for_dot_rufo = value
+      end
+
       opts.on("-h", "--help", "Show this help") do
         puts opts
         exit
       end
     end.parse!(argv)
 
-    want_check
+    [want_check, filename_for_dot_rufo]
   end
 end

data/lib/rufo/dot_file.rb

@@ -0,0 +1,24 @@
+class Rufo::DotFile
+  def initialize
+    @cache = {}
+  end
+
+  def find_in(dir)
+    @cache.fetch(dir) do
+      @cache[dir] = internal_find_in(dir)
+    end
+  end
+
+  def internal_find_in(dir)
+    dir = File.expand_path(dir)
+    file = File.join(dir, ".rufo")
+    if File.exist?(file)
+      return File.read(file)
+    end
+
+    parent_dir = File.dirname(dir)
+    return if parent_dir == dir
+
+    find_in(parent_dir)
+  end
+end

data/lib/rufo/formatter.rb

@@ -8,19 +8,19 @@ class Rufo::Formatter
   end
 
   def initialize(code, **options)
-    @code   = code
+    @code = code
     @tokens = Ripper.lex(code).reverse!
-    @sexp   = Ripper.sexp(code)
+    @sexp = Ripper.sexp(code)
 
     unless @sexp
       raise ::Rufo::SyntaxError.new
     end
 
-    @indent           = 0
-    @line             = 0
-    @column           = 0
+    @indent = 0
+    @line = 0
+    @column = 0
     @last_was_newline = false
-    @output           = ""
+    @output = ""
 
     # The column of a `obj.method` call, so we can align
     # calls to that dot
@@ -53,10 +53,11 @@ 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)
+    space_after_hash_brace options.fetch(:space_after_hash_brace, :dynamic)
+    align_comments options.fetch(:align_comments, true)
+    align_assignments options.fetch(:align_assignments, false)
+    align_hash_keys options.fetch(:align_hash_keys, true)
   end
 
   # The indent size (default: 2)
@@ -64,12 +65,26 @@ class Rufo::Formatter
     @indent_size = value
   end
 
+  # 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)
+  # * :always: always put a space after a hash brace
+  # * :never: never put a space after a hash brace
+  def space_after_hash_brace(value)
+    case value
+    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")
+    end
+  end
+
   # Whether to align successive comments (default: true)
   def align_comments(value)
     @align_comments = value
   end
 
-  # Whether to align successive assignments (default: true)
+  # Whether to align successive assignments (default: false)
   def align_assignments(value)
     @align_assignments = value
   end
@@ -146,7 +161,7 @@ class Rufo::Formatter
     when :@tstring_content
       # [:@tstring_content, "hello ", [1, 1]]
       heredoc, tilde = @current_heredoc
-      column         = node[2][0]
+      column = node[2][0]
 
       # For heredocs with tilde we sometimes need to align the contents
       if heredoc && tilde && @last_was_newline
@@ -435,7 +450,7 @@ class Rufo::Formatter
   def visit_string_literal(node)
     # [:string_literal, [:string_content, exps]]
     heredoc = current_token_kind == :on_heredoc_beg
-    tilde   = current_token_value.include?("~")
+    tilde = current_token_value.include?("~")
 
     if heredoc
       write current_token_value.rstrip
@@ -590,7 +605,7 @@ class Rufo::Formatter
     check :on_op
 
     before = op[1][0...-1]
-    after  = op[1][-1]
+    after = op[1][-1]
 
     write before
     track_assignment before.size
@@ -618,15 +633,25 @@ class Rufo::Formatter
 
   def visit_assign_value(value)
     skip_space
-    indent_after_space value, indentable_keyword?
+
+    indent_after_space value, indentable_value?(value)
   end
 
-  def indentable_keyword?
+  def indentable_value?(value)
     return unless current_token_kind == :on_kw
 
     case current_token_value
     when "if", "unless", "case"
       true
+    when "begin"
+      # Only indent if it's begin/rescue
+      return false unless value[0] == :begin
+
+      body = value[1]
+      return false unless body[0] == :bodystmt
+
+      _, body, rescue_body, else_body, ensure_body = body
+      rescue_body || else_body || ensure_body
     else
       false
     end
@@ -874,7 +899,7 @@ class Rufo::Formatter
       @current_heredoc = [heredoc, tilde]
       visit_string_literal_end(heredoc)
       @current_heredoc = nil
-      printed          = true
+      printed = true
     end
   end
 
@@ -1132,7 +1157,7 @@ class Rufo::Formatter
       consume_keyword "rescue"
       if type
         skip_space
-        write_space " "
+        write_space
         indent(@column) do
           visit_rescue_types(type)
         end
@@ -1140,10 +1165,10 @@ class Rufo::Formatter
 
       if name
         skip_space
-        write_space " "
+        write_space
         consume_op "=>"
         skip_space
-        write_space " "
+        write_space
         visit name
       end
 
@@ -1308,7 +1333,7 @@ class Rufo::Formatter
 
     if newline? || comment?
       needs_indent = true
-      base_column  = next_indent
+      base_column = next_indent
       consume_end_of_line
       write_indent(base_column)
     else
@@ -1336,7 +1361,7 @@ class Rufo::Formatter
             write_indent
           end
         else
-          write_space " "
+          write_space
           skip_space_or_newline
         end
       end
@@ -1395,7 +1420,7 @@ class Rufo::Formatter
       write_line
       write_indent(next_indent)
     else
-      write_space " " if needs_space
+      write_space if needs_space
     end
 
     consume_op_or_keyword op
@@ -1421,15 +1446,15 @@ class Rufo::Formatter
 
     consume_keyword "class"
     skip_space_or_newline
-    write_space " "
+    write_space
     visit name
 
     if superclass
       skip_space_or_newline
-      write_space " "
+      write_space
       consume_op "<"
       skip_space_or_newline
-      write_space " "
+      write_space
       visit superclass
     end
 
@@ -1444,7 +1469,7 @@ class Rufo::Formatter
 
     consume_keyword "module"
     skip_space_or_newline
-    write_space " "
+    write_space
     visit name
     maybe_inline_body body
   end
@@ -1599,10 +1624,10 @@ class Rufo::Formatter
       visit_comma_separated_list(args_with_default) do |arg, default|
         visit arg
         skip_space
-        write_space " "
+        write_space
         consume_op "="
         skip_space_or_newline
-        write_space " "
+        write_space
         visit default
       end
       needs_comma = true
@@ -1678,7 +1703,7 @@ class Rufo::Formatter
       consume_end_of_line
       write_indent
     else
-      write_space " "
+      write_space
       skip_space_or_newline
     end
   end
@@ -1753,14 +1778,14 @@ class Rufo::Formatter
             write_indent(next_indent)
           else
             next_token
-            write_space " "
+            write_space
           end
         end
       end
     end
 
     has_newline = false
-    last_token  = nil
+    last_token = nil
 
     while current_token_kind == :on_words_sep
       has_newline ||= current_token_value.include?("\n")
@@ -1830,7 +1855,7 @@ class Rufo::Formatter
     if symbol || !(key[0] == :@label || key[0] == :dyna_symbol)
       consume_op "=>"
       skip_space_or_newline
-      write_space " "
+      write_space
     end
 
     visit value
@@ -2152,10 +2177,17 @@ class Rufo::Formatter
   end
 
   def visit_literal_elements(elements, inside_hash = false)
-    base_column       = @column
+    base_column = @column
     needs_final_space = inside_hash && space?
     skip_space
 
+    case @space_after_hash_brace
+    when :never
+      needs_final_space = false
+    when :always
+      needs_final_space = true
+    end
+
     if newline? || comment?
       needs_final_space = false
     elsif needs_final_space
@@ -2198,7 +2230,7 @@ class Rufo::Formatter
             write_indent(needed_indent)
           end
         else
-          write_space " " unless is_last
+          write_space unless is_last
         end
       end
     end
@@ -2290,7 +2322,7 @@ class Rufo::Formatter
 
     # Keep `while cond; end` as is
     semicolon = semicolon?
-    is_do     = keyword?("do")
+    is_do = keyword?("do")
 
     if (semicolon || is_do) && void_exps?(body)
       next_token
@@ -2366,7 +2398,7 @@ class Rufo::Formatter
     end
 
     then_keyword = keyword?("then")
-    inline       = then_keyword || semicolon?
+    inline = then_keyword || semicolon?
     if then_keyword
       next_token
       skip_space
@@ -2406,7 +2438,7 @@ class Rufo::Formatter
         if newline? || semicolon? || comment?
           indent_body next_exp[1]
         else
-          write_space " "
+          write_space
           visit_exps next_exp[1]
         end
       else
@@ -2417,7 +2449,7 @@ class Rufo::Formatter
 
   def consume_space
     skip_space_or_newline
-    write_space " " unless @output[-1] == " "
+    write_space unless @output[-1] == " "
   end
 
   def skip_space
@@ -2436,10 +2468,10 @@ class Rufo::Formatter
   end
 
   def skip_space_or_newline(want_semicolon = false, write_first_semicolon = false)
-    found_newline   = false
-    found_comment   = false
+    found_newline = false
+    found_comment = false
     found_semicolon = false
-    last            = nil
+    last = nil
 
     while true
       case current_token_kind
@@ -2447,14 +2479,14 @@ class Rufo::Formatter
         next_token
       when :on_nl, :on_ignored_nl
         next_token
-        last          = :newline
+        last = :newline
         found_newline = true
       when :on_semicolon
         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
@@ -2468,7 +2500,7 @@ class Rufo::Formatter
         end
         next_token
         found_comment = true
-        last          = :comment
+        last = :comment
       else
         break
       end
@@ -2501,9 +2533,9 @@ class Rufo::Formatter
     # If the value has newlines, we need to adjust line and column
     number_of_lines = value.count("\n")
     if number_of_lines > 0
-      @line            += number_of_lines
-      last_line_index   = value.rindex("\n")
-      @column           = value.size - (last_line_index + 1)
+      @line += number_of_lines
+      last_line_index = value.rindex("\n")
+      @column = value.size - (last_line_index + 1)
       @last_was_newline = @column == 0
     end
   end
@@ -2532,11 +2564,11 @@ class Rufo::Formatter
   # - 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)
-    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?
+    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
+    newline_count = 0                # Number of newlines we passed
 
     while true
       case current_token_kind
@@ -2568,7 +2600,7 @@ class Rufo::Formatter
         end
         found_newline = true
         next_token
-        last           = :newline
+        last = :newline
         newline_count += 1
       when :on_semicolon
         next_token
@@ -2608,20 +2640,20 @@ 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
+            write_space unless at_prefix
             track_comment
           end
         end
         last_comment_has_newline = current_token_value.end_with?("\n")
         write current_token_value.rstrip
         next_token
-        last            = :comment
+        last = :comment
         multilple_lines = false
       when :on_embdoc_beg
         write_line if multilple_lines
 
         consume_embedded_comment
-        last                     = :comment
+        last = :comment
         last_comment_has_newline = true
       else
         break
@@ -2670,7 +2702,7 @@ class Rufo::Formatter
   def indent(value = nil)
     if value
       old_indent = @indent
-      @indent    = value
+      @indent = value
       yield
       @indent = old_indent
     else
@@ -2710,26 +2742,24 @@ class Rufo::Formatter
   def write(value)
     @output << value
     @last_was_newline = false
-    @column          += value.size
+    @column += value.size
   end
 
-  def write_space(value)
-    @output << value
-    @column += value.size
+  def write_space
+    @output << " "
+    @column += 1
   end
 
   def write_line
     @output << "\n"
     @last_was_newline = true
-    @column           = 0
-    @line            += 1
+    @column = 0
+    @line += 1
   end
 
   def write_indent(indent = @indent)
-    indent.times do
-      @output << " "
-    end
-    @column          += indent
+    @output << " " * indent
+    @column += indent
     @last_was_newline = false
   end
 
@@ -2743,7 +2773,7 @@ class Rufo::Formatter
         visit node
       end
     else
-      write_space " " if want_space
+      write_space if want_space
       if sticky
         indent(@column) do
           visit node
@@ -2813,9 +2843,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
@@ -2869,7 +2899,7 @@ class Rufo::Formatter
   end
 
   def push_node(node)
-    old_node      = @current_node
+    old_node = @current_node
     @current_node = node
 
     yield
@@ -2878,7 +2908,7 @@ class Rufo::Formatter
   end
 
   def push_hash(node)
-    old_hash      = @current_hash
+    old_hash = @current_hash
     @current_hash = node
     yield
     @current_hash = old_hash
@@ -2893,10 +2923,10 @@ class Rufo::Formatter
   end
 
   def do_align_hash_keys
-    do_align @hash_keys_positions
+    do_align @hash_keys_positions, true, true
   end
 
-  def do_align(elements, adjust_comments = true)
+  def do_align(elements, adjust_comments = true, hash_keys = false)
     lines = @output.lines
 
     elements.reject! { |l, c, indent, id, off, ignore| ignore == :ignore }
@@ -2909,21 +2939,38 @@ class Rufo::Formatter
     chunks.each do |comments|
       next if comments.size == 1
 
+      if hash_keys
+        # Don't indent successive hash keys if any of them is in turn a hash
+        # or array literal that is formatted in separate lines.
+        has_brace_newline = comments.any? do |(l, c)|
+          line_end = lines[l][c..-1]
+          line_end.start_with?("=> {\n") ||
+            line_end.start_with?("=> [\n") ||
+            line_end.start_with?("=> [ #") ||
+            line_end.start_with?("=> { #") ||
+            line_end.start_with?("[\n") ||
+            line_end.start_with?("{\n") ||
+            line_end.start_with?("[ #") ||
+            line_end.start_with?("{ #")
+        end
+        next if has_brace_newline
+      end
+
       max_column = comments.map { |l, c| c }.max
 
       comments.each do |(line, column, _, _, offset)|
         next if column == max_column
 
-        split_index  = column
+        split_index = column
         split_index -= offset if offset
 
         target_line = lines[line]
 
         before = target_line[0...split_index]
-        after  = target_line[split_index..-1]
+        after = target_line[split_index..-1]
 
         filler_size = max_column - column
-        filler      = " " * filler_size
+        filler = " " * filler_size
 
         if adjust_comments && (index = @line_to_comments_position_index[line])
           @comments_positions[index][1] += filler_size

data/lib/rufo/version.rb

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

data/lib/rufo.rb

@@ -10,5 +10,6 @@ end
 
 require_relative "rufo/backport"
 require_relative "rufo/command"
+require_relative "rufo/dot_file"
 require_relative "rufo/formatter"
 require_relative "rufo/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rufo
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Ary Borenszweig
@@ -74,6 +74,7 @@ files:
 - lib/rufo.rb
 - lib/rufo/backport.rb
 - lib/rufo/command.rb
+- lib/rufo/dot_file.rb
 - lib/rufo/formatter.rb
 - lib/rufo/version.rb
 - rakelib/ci.rake