rufo 0.0.37 → 0.0.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb66c78ddab7f72ff2c62ea1a6c8d268ee07871a
-  data.tar.gz: cdb227d8ae51899ffe33bf2468f7dccbe95f5b2a
+  metadata.gz: eb5d79057ba5a76559fc6ff7f243a8d490794700
+  data.tar.gz: 1d35a7183d666b212916b860e55f922ef265c6e4
 SHA512:
-  metadata.gz: 6bebee1f9ef22fa4a3589cf0000f187e94da9f0224819922ca48cc13dbccd0c5349756956626c02230cda2e0f4fd4f91b7c2db1c287f5421d92c78151a5d0046
-  data.tar.gz: d7485eaa65ed1783c83f8134f5f97b298380f969c0600490d9d5f6e697f4ef3ff3fa5f32b2de5661823a5910fb21ba4e1c56fab5b2b65db4dab810a3c1de4024
+  metadata.gz: f0f992361ccd2b36c155d7fa4c157f48be8d877774e0b6b69d2b110412caeae47ee8984c680ae2f8850c3866c311b56a70925cff5dfded4eee22f4f789ddcc59
+  data.tar.gz: 8f6ed9ee0a58328c73fefa468d8832e80b49d656480a582f3fbc7551c8c158f0fe5c1233d683e143cbfbdbc09c2e7d558392b4f48620782fbcd98d89698ec426

data/README.md

@@ -53,17 +53,17 @@ this choice.
 Another example is aligning call parameters:
 
 ```ruby
-# Align with respect to the first parameter
+# Align with respect to the first parameter:
 foo 1, 2,
     3, 4,
     5
 
-# Align by regular indent (2 spaces)
+# Align by regular indent (2 spaces):
 foo 1, 2,
   3, 4,
   5
 
-# Align arrays
+# Align arrays:
 foo 1, [
          2,
          3,
@@ -75,12 +75,12 @@ foo 1, [
   3,
 ]
 
-# Aling trailing calls
+# Align trailing calls:
 assert foo(
          1
        )
 
-# Don't extra align trailing calls
+# Don't extra align trailing calls:
 assert foo(
   1
 )
@@ -101,7 +101,8 @@ If Rufo does not change these things by default, what does it do? Well, it makes
 - no trailing whitespace remains
 - a trailing newline at the end of the file remains
 
-And of course it can be configured to do more. Check the settings section below.
+And of course it can be configured to do much more.
+Check the [Settings](https://github.com/asterite/rufo/wiki/Settings) section in the [Wiki](https://github.com/asterite/rufo/wiki) for more details.
 
 ## Installation
 
@@ -140,7 +141,15 @@ $ 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.
+according to **Rufo**, and will exit with exit code 3.
+
+### Exit codes
+
+| Code | Result |
+| ---- | ---- |
+| `0` | No errors, but also no formatting changes |
+| `1` | Error. Either `Ripper` could not parse syntax or input file is missing |
+| `3` | Input changed. Formatted code differs from input |
 
 ## Editor support
 
@@ -148,24 +157,23 @@ according to **rufo**, and will exit with exit code 1.
 - Emacs [emacs-rufo](https://github.com/aleandros/emacs-rufo) :construction: or [rufo.el](https://github.com/danielma/rufo.el)
 - Sublime Text: [sublime-rufo](https://github.com/asterite/sublime-rufo)
 - Vim: [rufo-vim](https://github.com/splattael/rufo-vim)
-- Visual Studio Code: [rufo-vscode](https://marketplace.visualstudio.com/items?itemName=siliconsenthil.rufo-vscode)
+- Visual Studio Code: [rufo-vscode](https://marketplace.visualstudio.com/items?itemName=siliconsenthil.rufo-vscode) or [vscode-rufo](https://marketplace.visualstudio.com/items?itemName=mbessey.vscode-rufo)
 
 
 Did you write a plugin for your favorite editor? That's great! Let me know about it and
 I will list it here.
 
-### Tips for editor plugins implementors
+### Tips for editor plugin implementors
 
-Rufo works best, and it's incredibly convenient, when code is automatically
-formatted on save. In this way you can for example surround a piece of code with
-`if ... end` and it gets automatically indented, or unindented when you remove
-such code.
+It is especially convenient if your code is automatically _formatted on save_.
+For example, surrounding a piece of code with `if ... end` will automatically indent
+the code when you save. Likewise, it will be automatically unindented should you remove it.
 
 For this to work best, the cursor position must be preserved, otherwise it becomes
-pretty annoying if the cursor is reset at the top of the editor.
+pretty annoying if the cursor is reset to the top of the editor.
 
 You should compute a diff between the old content and new content
-and apply the necessary editions. You can check out how this is done in the
+and apply the necessary changes. You can check out how this is done in the
 [Sublime Text plugin for Rufo](https://github.com/asterite/sublime-rufo):
 
 - [diff_match_patch.py](https://github.com/asterite/sublime-rufo/blob/master/diff_match_patch.py) contains the diff algorithm (you can port it to other languages or try to search for a similar algorithm online)
@@ -173,8 +181,8 @@ and apply the necessary editions. You can check out how this is done in the
 
 ## Configuration
 
-To configure Rufo, 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.
+To configure Rufo, place a `.rufo` file in your project. Then when you format a file or a directory,
+Rufo will look for a `.rufo` file in that directory or parent directories and apply the configuration.
 
 The `.rufo` file is a Ruby file that is evaluated in the context of the formatter.
 The available settings are listed [here](https://github.com/asterite/rufo/wiki/Settings).
@@ -191,8 +199,8 @@ To parse and lex, [Ripper](https://ruby-doc.org/stdlib-2.4.0/libdoc/ripper/rdoc/
 
 As a reference, this was implemented in a similar fashion to [Crystal](https://github.com/crystal-lang/crystal)'s formatter.
 
-And as a side note, rufo has **no dependencies**. It only depends on `rspec` for tests, but that's it.
-That means it loads very fast (no need to read many Ruby files), and because `Ripper` is mostly written
+And as a side note, Rufo has **no dependencies**. To run Rufo's specs you will require [rspec](https://github.com/rspec/rspec), but that's it.
+This means Rufo loads very fast (no need to read many Ruby files), and since [Ripper](https://ruby-doc.org/stdlib-2.4.0/libdoc/ripper/rdoc/Ripper.html) is mostly written
 in C (uses Ruby's lexer and parser) it formats files pretty fast too.
 
 ## Development

data/lib/rufo/command.rb

@@ -3,6 +3,10 @@
 require "optparse"
 
 class Rufo::Command
+  CODE_OK = 0
+  CODE_ERROR = 1
+  CODE_CHANGE = 3
+
   def self.run(argv)
     want_check, filename_for_dot_rufo = parse_options(argv)
     new(want_check, filename_for_dot_rufo).run(argv)
@@ -15,25 +19,26 @@ class Rufo::Command
   end
 
   def run(argv)
-    if argv.empty?
-      format_stdin
-    else
-      format_args argv
-    end
+    status_code = if argv.empty?
+                    format_stdin
+                  else
+                    format_args argv
+                  end
+
+    exit status_code
   end
 
   def format_stdin
     code = STDIN.read
+
     result = format(code, @filename_for_dot_rufo || Dir.getwd)
 
-    if @want_check
-      exit 1 if result != code
-    else
-      print result
-    end
+    print(result) if !@want_check
+
+    code == result ? CODE_OK : CODE_CHANGE
   rescue Rufo::SyntaxError
     STDERR.puts "Error: the given text is not a valid ruby program (it has syntax errors)"
-    exit 1
+    CODE_ERROR
   rescue => ex
     STDERR.puts "You've found a bug!"
     STDERR.puts "Please report it to https://github.com/asterite/rufo/issues with code that triggers it"
@@ -54,13 +59,23 @@ class Rufo::Command
       end
     end
 
+    return CODE_ERROR if files.empty?
+
     changed = false
+    syntax_error = false
 
     files.each do |file|
-      changed |= format_file file
+      result = format_file(file)
+
+      changed |= result == CODE_CHANGE
+      syntax_error |= result == CODE_ERROR
     end
 
-    exit 1 if changed
+    case
+    when syntax_error then CODE_ERROR
+    when changed      then CODE_CHANGE
+    else                   CODE_OK
+    end
   end
 
   def format_file(filename)
@@ -72,24 +87,22 @@ class Rufo::Command
       # We ignore syntax errors as these might be template files
       # with .rb extension
       STDERR.puts "Error: #{filename} has syntax errors"
-      return true
+      return CODE_ERROR
     end
 
     if code.force_encoding(result.encoding) != result
       if @want_check
-        STDERR.puts "Error: formatting #{filename} produced changes"
+        STDERR.puts "Formatting #{filename} produced changes"
       else
         File.write(filename, result)
         puts "Format: #{filename}"
       end
 
-      return true
+      return CODE_CHANGE
     end
-
-    false
   rescue Rufo::SyntaxError
     STDERR.puts "Error: the given text in #{filename} is not a valid ruby program (it has syntax errors)"
-    exit 1
+    CODE_ERROR
   rescue => ex
     STDERR.puts "You've found a bug!"
     STDERR.puts "It happened while trying to format the file #{filename}"

data/lib/rufo/formatter.rb

@@ -939,14 +939,7 @@ class Rufo::Formatter
 
     consume_call_dot
 
-    first_space = skip_space
-
-    if newline? || comment?
-      consume_end_of_line
-      write_indent(next_indent)
-    else
-      write_space_using_setting(first_space, @spaces_around_dot)
-    end
+    skip_space_or_newline_using_setting(@spaces_around_dot, next_indent)
 
     if name == :call
       # :call means it's .()
@@ -1695,17 +1688,7 @@ class Rufo::Formatter
       check :on_comma
       write ","
       next_token
-
-      first_space = skip_space
-
-      if newline? || comment?
-        indent(base_column || @indent) do
-          consume_end_of_line(want_multiline: false, first_space: first_space)
-          write_indent
-        end
-      else
-        write_space_using_setting(first_space, @spaces_after_comma)
-      end
+      skip_space_or_newline_using_setting(@spaces_after_comma, base_column || @indent)
     end
   end
 
@@ -2108,15 +2091,7 @@ class Rufo::Formatter
     check :on_comma
     write ","
     next_token
-
-    first_space = skip_space
-
-    if newline? || comment?
-      consume_end_of_line
-      write_indent
-    else
-      write_space_using_setting(first_space, @spaces_after_comma)
-    end
+    skip_space_or_newline_using_setting(@spaces_after_comma)
   end
 
   def visit_array(node)
@@ -2365,12 +2340,7 @@ class Rufo::Formatter
       end
     end
 
-    first_space = skip_space
-    if newline? || comment?
-      skip_space_or_newline
-    else
-      write_space_using_setting(first_space, @spaces_inside_array_bracket)
-    end
+    skip_space_or_newline_using_setting(@spaces_inside_array_bracket)
 
     check :on_rbracket
     write "]"
@@ -2407,15 +2377,7 @@ class Rufo::Formatter
 
     visit receiver
 
-    first_space = skip_space
-
-    if newline? || comment?
-      consume_end_of_line
-
-      write_indent(@dot_column || next_indent)
-    else
-      write_space_using_setting(first_space, @spaces_around_dot)
-    end
+    skip_space_or_newline_using_setting(@spaces_around_dot, @dot_column || next_indent)
 
     # Remember dot column
     dot_column = @column
@@ -2423,15 +2385,7 @@ class Rufo::Formatter
 
     consume_call_dot
 
-    first_space = skip_space
-
-    if newline? || comment?
-      consume_end_of_line
-      write_indent(next_indent)
-    else
-      skip_space_or_newline
-      write_space_using_setting(first_space, @spaces_around_dot)
-    end
+    skip_space_or_newline_using_setting(@spaces_around_dot, next_indent)
 
     visit name
 
@@ -2483,14 +2437,8 @@ class Rufo::Formatter
     write "->"
     next_token
 
-    if space? && @spaces_after_lambda_arrow == :dynamic
-      consume_space(want_preserve_whitespace: true)
-    elsif @spaces_after_lambda_arrow == :one
-      skip_space
-      write_space
-    else
-      skip_space_or_newline
-    end
+    first_space = skip_space
+    write_space_using_setting(first_space, @spaces_after_lambda_arrow)
 
     if empty_params?(params)
       if current_token_kind == :on_lparen
@@ -3481,6 +3429,18 @@ class Rufo::Formatter
     end
   end
 
+  def skip_space_or_newline_using_setting(setting, indent_size = @indent)
+    indent(indent_size) do
+      first_space = skip_space
+      if newline? || comment?
+        consume_end_of_line(want_multiline: false, first_space: first_space)
+        write_indent
+      else
+        write_space_using_setting(first_space, setting)
+      end
+    end
+  end
+
   def write_line
     @output << "\n"
     @last_was_newline = true

data/lib/rufo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rufo
-  VERSION = "0.0.37"
+  VERSION = "0.0.38"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rufo
 version: !ruby/object:Gem::Version
-  version: 0.0.37
+  version: 0.0.38
 platform: ruby
 authors:
 - Ary Borenszweig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-09 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler