rufo 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ff839772b1723bf26c212207ec9f3d1f597e3fb
-  data.tar.gz: cd06f569d4abe3e4f1e7420be35b621e7707111a
+  metadata.gz: 50d15a24f09ec9bd78016c6e572736daae323c7c
+  data.tar.gz: 3043fa80ffc0e2d5693f64ae66f0d9778fa60216
 SHA512:
-  metadata.gz: '07186d0a3e149837f9f0397e0553827d7de865147f41c8c112b5c8983594cbbae4d76f2a829be4d1c97afb0c22f8a20749dca9fc11d506789ba6e05b8dab5328'
-  data.tar.gz: 479ab2c8a97ad8bb926481677a035e2130bc546e4ac4a0050e6c324e521bd4ef8363a0f795a82b123c7dd61617c5f658ef3a41f36a9918a587e7bd551f9ae80a
+  metadata.gz: 43d21b3b6966469feaf5eea5179de28248b973669b994a57d3a0fb84204c09cfee06edc88aab5d84a16f6dc7e1a953aa12603ede252cf07e7aacf1fec20bc3f1
+  data.tar.gz: 0a08b865224b3ae14c74aca6898790b9aa5bc8d094fe3423d90bce186b84eb26400041a53f610b74c5b28b7d30dc432b2b47b9a0476818c25350d0fb51be295e

data/.rufo

@@ -1,5 +1,4 @@
 align_comments      true
 align_assignments   true
 align_hash_keys     true
-convert_brace_to_do true
 indent_size         2

data/.travis.yml

@@ -1,5 +1,8 @@
 sudo: false
 language: ruby
+cache: bundler
 rvm:
   - 2.4.1
 before_install: gem install bundler -v 1.15.1
+script:
+  - bundle exec rake ci

data/README.md

@@ -67,9 +67,6 @@ align_assignments   true
 # Whether to align successive hash keys (default: true)
 align_hash_keys     true
 
-# Whether to convert multiline `{ ... }` block to `do ... end` (default: true)
-convert_brace_to_do true
-
 # The indent size (default: 2)
 indent_size         2
 ```
@@ -90,7 +87,7 @@ Rufo is a **real** formatter, not a simple find and replace one. It works by emp
 a Ruby parser and a Ruby lexer. The parser is used for the shape of the program. The program
 is traversed and the lexer is used to sync this structure to tokens. This is why comments
 can be handled well, because they are provided by the lexer (comments are not returned by
-a parser). 
+a parser).
 
 To parse and lex, [Ripper](https://ruby-doc.org/stdlib-2.4.0/libdoc/ripper/rdoc/Ripper.html) is used.
 

data/exe/rufo

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 require "rufo"
 
-Rufo::Command.run
+Rufo::Command.run(ARGV)

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
@@ -26,4 +26,4 @@ module Rufo::Backport
 
     results
   end
-end
+end

data/lib/rufo/command.rb

@@ -1,13 +1,13 @@
 require "optionparser"
 
 module Rufo::Command
-  def self.run
-    want_check = parse_options
+  def self.run(argv)
+    want_check = parse_options(argv)
 
-    if ARGV.empty?
+    if argv.empty?
       format_stdin want_check
     else
-      format_args ARGV, want_check
+      format_args argv, want_check
     end
   end
 
@@ -55,7 +55,15 @@ module Rufo::Command
 
   def self.format_file(filename, want_check)
     code   = File.read(filename)
-    result = format(code, File.dirname(filename))
+
+    begin
+      result = format(code, File.dirname(filename))
+    rescue Rufo::SyntaxError
+      # We ignore syntax errors as these might be template files
+      # with .rb extension
+      STDERR.puts "Error: #{filename} has syntax errors"
+      return true
+    end
 
     if code != result
       if want_check
@@ -110,7 +118,7 @@ module Rufo::Command
     find_dot_rufo(parent_dir)
   end
 
-  def self.parse_options
+  def self.parse_options(argv)
     want_check = false
 
     OptionParser.new do |opts|
@@ -124,7 +132,7 @@ module Rufo::Command
         puts opts
         exit
       end
-    end.parse!
+    end.parse!(argv)
 
     want_check
   end

data/lib/rufo/formatter.rb

@@ -26,7 +26,7 @@ class Rufo::Formatter
     # calls to that dot
     @dot_column = nil
 
-    # Heredocs list, associated with calls ([call, heredoc, tilde])
+    # Heredocs list, associated with calls ([heredoc, tilde])
     @heredocs = []
 
     # Current node, to be able to associate it to heredocs
@@ -55,7 +55,6 @@ class Rufo::Formatter
     # Settings
     @indent_size         = options.fetch(:indent_size, 2)
     @align_comments      = options.fetch(:align_comments, true)
-    @convert_brace_to_do = options.fetch(:convert_brace_to_do, true)
     @align_assignments   = options.fetch(:align_assignments, true)
     @align_hash_keys     = options.fetch(:align_hash_keys, true)
   end
@@ -70,12 +69,6 @@ class Rufo::Formatter
     @align_comments = value
   end
 
-  # Whether to convert multiline `{ ... }` block
-  # to `do ... end` (default: true)
-  def convert_brace_to_do(value)
-    @convert_brace_to_do = value
-  end
-
   # Whether to align successive assignments (default: true)
   def align_assignments(value)
     @align_assignments = value
@@ -143,6 +136,9 @@ class Rufo::Formatter
       # [:@backref, "$1", [1, 0]]
       write node[1]
       next_token
+    when :@backtick
+      # [:@backtick, "`", [1, 4]]
+      consume_token :on_backtick
     when :string_literal, :xstring_literal
       visit_string_literal node
     when :string_concat
@@ -399,7 +395,7 @@ class Rufo::Formatter
 
       skip_space
       if newline? || comment?
-        check_heredocs_at_call_end(exp)
+        check_pending_heredocs
       end
 
       line_before_endline = @line
@@ -437,14 +433,12 @@ class Rufo::Formatter
       next_token
       skip_space
 
-      # A comma after a heredoc means the heredoc contents
-      # come after an argument list, so put it in a list
-      # for later.
-      # The same happens if we already have a heredoc in
-      # the list, which means this will come after other
-      # heredocs.
-      if comma? || (current_token_kind == :on_period) || !@heredocs.empty?
-        @heredocs << [@current_node, node, tilde]
+      # 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
     elsif current_token_kind == :on_backtick
@@ -748,7 +742,11 @@ class Rufo::Formatter
       skip_space_or_newline
     end
 
-    visit call
+    if call == :call
+      # :call means it's .()
+    else
+      visit call
+    end
 
     # Only set it after we visit the call after the dot,
     # so we remember the outmost dot position
@@ -843,8 +841,6 @@ class Rufo::Formatter
     end
 
     consume_token :on_rparen
-
-    check_heredocs_at_call_end(node)
   end
 
   def visit_command(node)
@@ -871,16 +867,13 @@ class Rufo::Formatter
     push_call(node) do
       visit_command_args(args)
     end
-
-    check_heredocs_at_call_end(node)
   end
 
-  def check_heredocs_at_call_end(node)
+  def check_pending_heredocs
     printed = false
 
     until @heredocs.empty?
-      scope, heredoc, tilde = @heredocs.first
-      break unless scope.equal?(node)
+      heredoc, tilde = @heredocs.first
 
       # Need to print a line between consecutive heredoc ends
       write_line if printed
@@ -960,7 +953,7 @@ class Rufo::Formatter
       return
     end
 
-    closing_brace_token = find_closing_brace_token
+    closing_brace_token, index = find_closing_brace_token
 
     # If the whole block fits into a single line, use braces
     if current_token[0][0] == closing_brace_token[0][0]
@@ -976,31 +969,12 @@ class Rufo::Formatter
       return
     end
 
-    # Otherwise, use `do` (if told so)
-    check :on_lbrace
-
-    if @convert_brace_to_do
-      write "do"
-    else
-      write "{"
-    end
-
-    next_token
-
+    # Otherwise it's multiline
+    consume_token :on_lbrace
     consume_block_args args
-
     indent_body body
-
     write_indent
-
-    check :on_rbrace
-    next_token
-
-    if @convert_brace_to_do
-      write "end"
-    else
-      write "}"
-    end
+    consume_token :on_rbrace
   end
 
   def visit_do_block(node)
@@ -1029,16 +1003,29 @@ class Rufo::Formatter
   end
 
   def visit_block_arguments(node)
-    # [:block_var, params, ??]
-    _, params = node
+    # [:block_var, params, blockarg]
+    _, params, blockarg = node
 
-    consume_op "|"
-    skip_space_or_newline
+    check :on_op
 
-    visit params
+    # check for ||
+    if blockarg.nil?
+      # Don't write || as it's meaningless
+      next_token
+    else
+      next_token
+      skip_space_or_newline
 
-    skip_space_or_newline
-    consume_op "|"
+      # This means it's an empty | |, so we remove it
+      if current_token_kind == :on_op && current_token_value == "|"
+        next_token
+      else
+        write "|"
+        visit params
+        skip_space_or_newline
+        consume_op "|"
+      end
+    end
   end
 
   def visit_call_args(node)
@@ -1156,13 +1143,15 @@ class Rufo::Formatter
     # Multiple exception types
     # [:mrhs_new_from_args, exps, final_exp]
     _, exps, final_exp = node
+
     if final_exp
-      nodes = [*node[1], node[2]]
-      visit_comma_separated_list(nodes)
+      visit_comma_separated_list exps
+      write_params_comma
+      visit final_exp
     elsif exps[0].is_a?(Symbol)
       visit exps
     else
-      visit_exps exps, false, false
+      visit_comma_separated_list exps
     end
   end
 
@@ -1251,7 +1240,7 @@ class Rufo::Formatter
     consume_keyword(keyword)
     consume_space
 
-    closing_brace_token = find_closing_brace_token
+    closing_brace_token, _index = find_closing_brace_token
 
     # If the whole block fits into a single line, format
     # in a single line
@@ -1330,7 +1319,7 @@ class Rufo::Formatter
     consume_op "*"
     skip_space_or_newline
 
-    visit star
+    visit star if star
 
     if after && !after.empty?
       write_params_comma
@@ -1345,11 +1334,11 @@ class Rufo::Formatter
     consume_op_or_keyword op
 
     if op == :not
-      consume_space 
+      consume_space
     else
       skip_space_or_newline
     end
-    
+
     visit exp
   end
 
@@ -1584,14 +1573,18 @@ class Rufo::Formatter
     end
 
     if rest_param
-      # [:rest_param, [:@ident, "x", [1, 15]]]
-      _, rest = rest_param
-
-      write_params_comma if needs_comma
-      consume_op "*"
-      skip_space_or_newline
-      visit rest if rest
-      needs_comma = true
+      # check for trailing , |x, |
+      if rest_param == 0
+        write_params_comma
+      else
+        # [:rest_param, [:@ident, "x", [1, 15]]]
+        _, rest = rest_param
+        write_params_comma if needs_comma
+        consume_op "*"
+        skip_space_or_newline
+        visit rest if rest
+        needs_comma = true
+      end
     end
 
     if post_rest_params
@@ -1672,6 +1665,7 @@ class Rufo::Formatter
 
     if elements
       if elements[0].is_a?(Symbol)
+        skip_space_or_newline
         visit elements
         skip_space_or_newline
       else
@@ -2024,7 +2018,7 @@ class Rufo::Formatter
     brace = current_token_value == "{"
 
     if brace
-      closing_brace_token = find_closing_brace_token
+      closing_brace_token, index = find_closing_brace_token
 
       # Check if the whole block fits into a single line
       if current_token[0][0] == closing_brace_token[0][0]
@@ -2321,6 +2315,7 @@ class Rufo::Formatter
 
     indent(@column) do
       visit_comma_separated_list conds
+      skip_space
     end
 
     then_keyword = keyword?("then")
@@ -2486,9 +2481,9 @@ 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)
-    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?
 
     while true
@@ -2501,7 +2496,7 @@ class Rufo::Formatter
         # can appear with nil as the "text", and that's wrong
         if current_token[2] == nil
           next_token
-          next 
+          next
         end
 
         if last == :newline
@@ -2563,7 +2558,7 @@ class Rufo::Formatter
         write_line if multilple_lines
 
         consume_embedded_comment
-        last = :comment
+        last                     = :comment
         last_comment_has_newline = true
       else
         break
@@ -2755,19 +2750,39 @@ class Rufo::Formatter
 
   def find_closing_brace_token
     count = 0
-    @tokens.reverse_each do |token|
+    i = @tokens.size - 1
+    while i >= 0
+      token = @tokens[i]
       (line, column), kind = token
       case kind
       when :on_lbrace, :on_tlambeg
         count += 1
       when :on_rbrace
         count -= 1
-        return token if count == 0
+        return [token, i] if count == 0
       end
+      i -= 1
     end
     nil
   end
 
+  def newline_follows_token(index)
+    index -= 1
+    while index >= 0
+      token = @tokens[index]
+      case current_token_kind
+      when :on_sp
+        # OK
+      when :on_nl, :on_ignored_nl
+        return true
+      else
+        return false
+      end
+      index -= 1
+    end
+    true
+  end
+
   def next_token
     @tokens.pop
   end

data/lib/rufo/version.rb

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

data/rakelib/ci.rake

@@ -0,0 +1,4 @@
+desc "Run tasks on CI"
+task :ci => :spec do
+  Rake::Task["rufo:check"].invoke("lib spec")
+end

data/rakelib/rufo.rake

@@ -0,0 +1,22 @@
+desc "Alias for `rake rufo:run`"
+task :rufo => ["rufo:run"]
+
+namespace :rufo do
+  require "rufo"
+
+  def rufo_command(*switches, rake_args)
+    files_or_dirs = rake_args[:files_or_dirs] || "."
+    args = switches + files_or_dirs.split(" ")
+    Rufo::Command.run(args)
+  end
+
+  desc "Format Ruby code in current directory"
+  task :run, [:files_or_dirs] do |task, rake_args|
+    rufo_command(rake_args)
+  end
+
+  desc "Check that no formatting changes are produced"
+  task :check, [:files_or_dirs] do |task, rake_args|
+    rufo_command("--check", rake_args)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rufo
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Ary Borenszweig
@@ -76,6 +76,8 @@ files:
 - lib/rufo/command.rb
 - lib/rufo/formatter.rb
 - lib/rufo/version.rb
+- rakelib/ci.rake
+- rakelib/rufo.rake
 - rufo.gemspec
 homepage: https://github.com/asterite/rufo
 licenses: