rufo 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4254f11d5e797cb76d947f8e5ae0e9fddd0fc281
-  data.tar.gz: b3937d7d503a7faf716e6deebf2f228feae26a36
+  metadata.gz: f651b0e7deb5c6d36cbe7632aa761954e7d49939
+  data.tar.gz: 20b7c26c352e682cf72547fdeebf25d31b467aa4
 SHA512:
-  metadata.gz: 2b7110b0fc44a623f5c473b6be8b6a80bb7dede05a551a5fa8b1408f264c18281ceba1078ff991f0cda1deffa15b92369676c42254414af9ac46f3b2f3f4a07a
-  data.tar.gz: 80d832ba0b8798af6de39fe9adeaa10c6ab0c4f09350c5b3205684e2e34b658d54cbb64f9723240833f46eaa111c44da87c165a46ab80da823e69a99be8a221d
+  metadata.gz: b9f40a5d0fd5ad07143ccc49fafddce8bd72cad15ada182f8cdf03b239a956f5a4072fe0df639d53a3c88d928a12058a360158b1a3b61462e073b2d9973cdfb1
+  data.tar.gz: 122c69242308b0999954d684ae4cfb4a0020d5ec9b68de7f76ce449a47076d659d8062f8c69fe9da80057031e07caddcc19f8a0fb653cd1e7ee0be3619d990c9

data/.rufo

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

data/README.md

@@ -1,6 +1,6 @@
 # Rufo
 
-**Ru**by **fo**rmatter (in development)
+**Ru**by **fo**rmatter
 
 ## Installation
 
@@ -20,10 +20,61 @@ Or install it yourself as:
 
 ## Usage
 
+### Format files or directories
+
+```
+$ rufo file names or dir names
+```
+
+### Format STDIN
+
+```
+$ cat file.rb | rufo
 ```
-$ rufo file.rb
+
+### Check that no formatting changes are produced
+
+```
+$ rufo --check file names or dir names
+```
+
+This will print one line for each file that isn't correctly formatted
+according to **rufo**, and will exit with exit code 1.
+
+## Editor support
+
+- Sublime Text: [sublime-rufo](https://github.com/asterite/sublime-rufo)
+
+## Configuration
+
+Rufo follows most (if not all) of the conventions found in this [Ruby style guide](https://github.com/bbatsov/ruby-style-guide). It does a bit more than that, and it can also be configured a bit.
+
+To configure it, place a `.rufo` file in your project. When formatting a file or a directory
+via the `rufo` program, a `.rufo` file will try to be found in that directory or parent directories.
+
+The `.rufo` file is a Ruby file that is evaluated in the context of the formatter. These are the
+available configurations:
+
+```ruby
+# Whether to align successive comments (default: true)
+align_comments      true
+
+# Whether to align successive assignments (default: true)
+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
 ```
 
+As time passes there might be more configurations available. Please open an
+issue if you need something else to be configurable.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rufo.rb

@@ -2,6 +2,7 @@ require "rufo/version"
 
 module Rufo
   class Bug < Exception; end
+
   class SyntaxError < Exception; end
 
   def self.format(code, **options)

data/lib/rufo/command.rb

@@ -1,27 +1,127 @@
+require "optionparser"
+
 module Rufo::Command
   def self.run
+    want_check = parse_options
+
     if ARGV.empty?
-      format_stdin
+      format_stdin want_check
+    else
+      format_args ARGV, want_check
+    end
+  rescue Rufo::SyntaxError
+    STDERR.puts "Error: the given text is not a valid ruby program (it has syntax errors)"
+    exit 1
+  end
+
+  def self.format_stdin(want_check)
+    code   = STDIN.read
+    result = format(code, Dir.getwd)
+
+    if want_check
+      exit 1 if result != code
     else
-      format_file ARGV[0]
+      print result
     end
   rescue Rufo::Bug => ex
-    STDERR.puts "You've found a bug! Please report it to https://github.com/asterite/rufo/issues with code that triggers it"
+    STDERR.puts "You've found a bug!"
+    STDERR.puts "Please report it to https://github.com/asterite/rufo/issues with code that triggers it"
+    STDERR.puts
+    raise ex
+  end
+
+  def self.format_args(args, want_check)
+    files = []
+
+    args.each do |arg|
+      if Dir.exist?(arg)
+        files.concat Dir["#{arg}/**/*.rb"]
+      elsif File.exist?(arg)
+        files << arg
+      else
+        STDERR.puts "Error: file or directory not found: #{arg}"
+      end
+    end
+
+    changed = false
+
+    files.each do |file|
+      changed ||= format_file file, want_check
+    end
+
+    exit 1 if changed
+  end
+
+  def self.format_file(filename, want_check)
+    code   = File.read(filename)
+    result = format(code, File.dirname(filename))
+
+    if code != result
+      if want_check
+        STDERR.puts "Error: formatting #{filename} produced changes"
+      else
+        File.write(filename, result)
+        puts "Format: #{filename}"
+      end
+
+      return true
+    end
+
+    false
+  rescue Rufo::Bug => ex
+    STDERR.puts "You've found a bug!"
+    STDERR.puts "It happened while trying to format the file #{filename}"
+    STDERR.puts "Please report it to https://github.com/asterite/rufo/issues with code that triggers it"
     STDERR.puts
     raise ex
-  rescue Rufo::SyntaxError
-    STDERR.puts "Error: the given text is not a valid ruby program (it has syntax errors)" 
   end
 
-  def self.format_stdin
-    code = STDIN.read
-    result = Rufo.format(code)
-    print result
+  def self.format(code, dir)
+    formatter = Rufo::Formatter.new(code)
+
+    dot_rufo = find_dot_rufo(dir)
+    if dot_rufo
+      begin
+        formatter.instance_eval(File.read(dot_rufo))
+      rescue => ex
+        STDERR.puts "Error evaluating #{dot_rufo}"
+        raise ex
+      end
+    end
+
+    formatter.format
+    formatter.result
   end
 
-  def self.format_file(filename)
-    code = File.read(filename)
-    result = Rufo.format(code)
-    File.write(filename, result)
+  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
+    want_check = false
+
+    OptionParser.new do |opts|
+      opts.banner = "Usage: rufo files or dirs [options]"
+
+      opts.on("-c", "--check", "Only check formating changes") do
+        want_check = true
+      end
+
+      opts.on("-h", "--help", "Show this help") do
+        puts opts
+        exit
+      end
+    end.parse!
+
+    want_check
   end
 end

data/lib/rufo/formatter.rb

@@ -7,36 +7,20 @@ class Rufo::Formatter
     formatter.result
   end
 
-  # The indent size (default: 2)
-  attr_accessor :indent_size
-
-  # Whether to align successive comments (default: true)
-  attr_accessor :align_comments
-
-  # Whether to convert multiline `{ ... }` block 
-  # to `do ... end` (default: true)
-  attr_accessor :convert_brace_to_do
-
-  # Whether to align successive assignments (default: true)
-  attr_accessor :align_assignments
-
-  # Whether to align successive hash keys (default: true)
-  attr_accessor :align_hash_keys
-
   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
@@ -64,11 +48,37 @@ class Rufo::Formatter
     @hash_keys_positions = []
 
     # Settings
-    @indent_size = options.fetch(:indent_size, 2)
-    @align_comments = options.fetch(:align_comments, true)
+    @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)
+    @align_assignments   = options.fetch(:align_assignments, true)
+    @align_hash_keys     = options.fetch(:align_hash_keys, true)
+  end
+
+  # The indent size (default: 2)
+  def indent_size(value)
+    @indent_size = value
+  end
+
+  # Whether to align successive comments (default: true)
+  def align_comments(value)
+    @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
+  end
+
+  # Whether to align successive hash keys (default: true)
+  def align_hash_keys(value)
+    @align_hash_keys = value
   end
 
   def format
@@ -105,7 +115,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
@@ -306,7 +316,7 @@ class Rufo::Formatter
         # Don't indent if this exp is in the same line as the previous
         # one (this happens when there's a semicolon between the exps)
         unless line_before_endline && line_before_endline == @line
-          write_indent 
+          write_indent
         end
       end
 
@@ -340,7 +350,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
@@ -423,7 +433,7 @@ class Rufo::Formatter
     pieces.each_with_index do |piece, i|
       visit piece
       unless last?(i, pieces)
-        consume_op "::" 
+        consume_op "::"
         skip_space_or_newline
       end
     end
@@ -454,7 +464,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
@@ -491,6 +501,10 @@ class Rufo::Formatter
     end
   end
 
+  def track_comment
+    @comments_positions << [@line, @column, 0, nil, 0]
+  end
+
   def track_assignment(offset = 0)
     track_alignment @assignments_positions, offset
   end
@@ -607,8 +621,8 @@ class Rufo::Formatter
   def visit_call_without_receiver(node)
     # foo(arg1, ..., argN)
     #
-    # [:method_add_arg, 
-    #   [:fcall, [:@ident, "foo", [1, 0]]], 
+    # [:method_add_arg,
+    #   [:fcall, [:@ident, "foo", [1, 0]]],
     #   [:arg_paren, [:args_add_block, [[:@int, "1", [1, 6]]], false]]]
     _, name, args = node
 
@@ -724,7 +738,7 @@ class Rufo::Formatter
       @current_heredoc = [heredoc, tilde]
       visit_string_literal_end(heredoc)
       @current_heredoc = nil
-      printed = true
+      printed          = true
     end
   end
 
@@ -987,7 +1001,7 @@ class Rufo::Formatter
   end
 
   def visit_mlhs_paren(node)
-    # [:mlhs_paren, 
+    # [:mlhs_paren,
     #   [[:mlhs_paren, [:@ident, "x", [1, 12]]]]
     # ]
     _, args = node
@@ -1026,7 +1040,7 @@ class Rufo::Formatter
     if inside_call
       if newline? || comment?
         needs_indent = true
-        base_column = next_indent
+        base_column  = next_indent
         consume_end_of_line
         write_indent(base_column)
       else
@@ -1431,7 +1445,7 @@ class Rufo::Formatter
             write_indent(next_indent)
           else
             next_token
-            write_space " " 
+            write_space " "
           end
         end
       end
@@ -1482,11 +1496,11 @@ class Rufo::Formatter
     _, key, value = node
 
     visit key
-    
+
     skip_space_or_newline
     consume_space
 
-    track_hash_key 
+    track_hash_key
 
     # Don't output `=>` for keys that are `label: value`
     unless key[0] == :@label
@@ -1577,7 +1591,7 @@ class Rufo::Formatter
 
     if args
       indent(needed_indent) do
-        visit args 
+        visit args
       end
     end
 
@@ -1603,7 +1617,7 @@ class Rufo::Formatter
   end
 
   def visit_setter(node)
-    # foo.bar 
+    # foo.bar
     # (followed by `=`, though not included in this node)
     #
     # [:field, receiver, :".", name]
@@ -1926,7 +1940,7 @@ class Rufo::Formatter
     end
 
     then_keyword = keyword?("then")
-    inline = then_keyword || semicolon?
+    inline       = then_keyword || semicolon?
     if then_keyword
       next_token
       skip_space
@@ -1989,7 +2003,7 @@ class Rufo::Formatter
   def skip_space_or_newline(want_semicolon = false)
     found_newline = false
     found_comment = false
-    last = nil
+    last          = nil
 
     while true
       case current_token_kind
@@ -1997,7 +2011,7 @@ 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
@@ -2017,7 +2031,7 @@ class Rufo::Formatter
         end
         next_token
         found_comment = true
-        last = :comment
+        last          = :comment
       else
         break
       end
@@ -2048,9 +2062,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
@@ -2074,15 +2088,15 @@ class Rufo::Formatter
   end
 
   # Consume and print an end of line, handling semicolons and comments
-  # 
+  #
   # - 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)
-    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?
+    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
       case current_token_kind
@@ -2137,13 +2151,13 @@ class Rufo::Formatter
             # 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
-            @comments_positions << [@line, @column, @indent, nil]
+            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
       else
         break
@@ -2154,17 +2168,17 @@ class Rufo::Formatter
     # either we didn't find a newline and we are at the end of a line (and we didn't just pass a semicolon),
     # or the last thing was a comment (from which we removed the newline)
     # or we just passed multiple lines (but printed only one)
-    if (!found_newline && !at_prefix && !(want_semicolon && last == :semicolon)) || 
-       last == :comment || 
-       (multilple_lines && want_multiline)
-      write_line 
+    if (!found_newline && !at_prefix && !(want_semicolon && last == :semicolon)) ||
+      last == :comment ||
+      (multilple_lines && want_multiline)
+      write_line
     end
   end
 
   def indent(value = nil)
     if value
       old_indent = @indent
-      @indent = value
+      @indent    = value
       yield
       @indent = old_indent
     else
@@ -2204,7 +2218,7 @@ class Rufo::Formatter
   def write(value)
     @output << value
     @last_was_newline = false
-    @column += value.size
+    @column          += value.size
   end
 
   def write_space(value)
@@ -2215,15 +2229,15 @@ class Rufo::Formatter
   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
+    @column          += indent
     @last_was_newline = false
   end
 
@@ -2328,7 +2342,7 @@ class Rufo::Formatter
   end
 
   def push_call(call)
-    old_call = @current_call
+    old_call      = @current_call
     @current_call = call
 
     # A call can specify hash arguments so it acts as a
@@ -2341,7 +2355,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
@@ -2373,18 +2387,19 @@ class Rufo::Formatter
       next if comments.size == 1
 
       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 = " " * (max_column - column)
+        filler      = " " * (max_column - column)
         lines[line] = "#{before}#{filler}#{after}"
       end
     end
@@ -2395,4 +2410,4 @@ class Rufo::Formatter
   def result
     @output
   end
-end
+end

data/lib/rufo/version.rb

@@ -1,3 +1,3 @@
 module Rufo
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rufo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ary Borenszweig
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rufo"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt