rufo 0.0.33 → 0.0.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3fd395a366e561d4a5196bd66a89e84488ca699
-  data.tar.gz: b1e5f7872f193254a8287a0778a9c6a747c4532a
+  metadata.gz: d722fed549e79c6f97a6ec76c94574aa7b644520
+  data.tar.gz: d4f1a92c881618644dd8c8b2aa71b6261b969014
 SHA512:
-  metadata.gz: abef0e942b850cbfbd21a032f63dd1f7a9d487ae4d1dd2fbc071232f7ff434f5dddb855faba972773e6d0a1747e15d59ab11e85e3920c838d5c2afb4b7135498
-  data.tar.gz: 701c57b9d9bdca0a1e5bd121f6abd33b1ecff4cdeb6c1449905bd77d3064fc4facdb2381d472043b25a09e898be12972ab89ea016e7010bb35ff398f6dca1db9
+  metadata.gz: c18dfd73b6ce027e04402131ec960ec4162b8d0a7b8ba91f70c7793ad5c2e17f1c847435d37ab5226580c358383a9c9eb507b6bbfa0551d4ce73a079e28fe004
+  data.tar.gz: fda9a82998eea248c95efa63523ae67931b582acb12bcd9a3ef1023a8e58b8b36246a8a9235c50e08343ca27b5e455390ed540f7d158db46db910c6c9bc6554b

data/.travis.yml

@@ -3,6 +3,8 @@ language: ruby
 cache: bundler
 rvm:
   - 2.4.1
+  - 2.3.4
+  - 2.2.7
 before_install: gem install bundler -v 1.15.1
 script:
   - bundle exec rake ci

data/README.md

@@ -98,6 +98,8 @@ If Rufo does not change these things by default, what does it do? Well, it makes
 - there are no more than one consecutive empty lines
 - methods are separated by an empty line
 - no trailing semicolons remain
+- 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.
 
@@ -143,13 +145,31 @@ according to **rufo**, and will exit with exit code 1.
 ## Editor support
 
 - Sublime Text: [sublime-rufo](https://github.com/asterite/sublime-rufo)
+- Visual Studio Code: [rufo-vscode](https://marketplace.visualstudio.com/items?itemName=siliconsenthil.rufo-vscode)
 - Vim: [rufo-vim](https://github.com/splattael/rufo-vim) :construction:
 - Atom: [rufo-atom](https://github.com/bmulvihill/rufo-atom) :construction:
-- Emacs [emacs-rufo](https://github.com/aleandros/emacs-rufo) :construction:
+- Emacs [emacs-rufo](https://github.com/aleandros/emacs-rufo) :construction: or [rufo-mode.el](https://github.com/danielma/rufo-mode.el) :construction:
 
 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
+
+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.
+
+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.
+
+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
+[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)
+- [rufo_format.py](https://github.com/asterite/sublime-rufo/blob/master/rufo_format.py#L46-L53) consumes the diff result and applies it chunk by chunk in the editor's view
+
 ## Configuration
 
 To configure Rufo, place a `.rufo` file in your project. When formatting a file or a directory
@@ -585,13 +605,13 @@ Given this code:
 
 ```ruby
 class Foo
-	private
+  private
 
-	def foo
-	end
+  def foo
+  end
 
-	  def bar
-	  end
+    def bar
+    end
 end
 
 class Bar
@@ -609,10 +629,10 @@ With `:dynamic`, the formatter will change it to:
 
 ```ruby
 class Foo
-	private
+  private
 
-	def foo
-	end
+  def foo
+  end
 
   def bar
   end
@@ -624,8 +644,8 @@ class Bar
     def foo
     end
 
-	  def bar
-	  end
+    def bar
+    end
 end
 ```
 
@@ -637,10 +657,10 @@ With `:align`, the formatter will change it to:
 
 ```ruby
 class Foo
-	private
+  private
 
-	def foo
-	end
+  def foo
+  end
 
   def bar
   end
@@ -661,23 +681,23 @@ With `:indent`, the formatter will change it to:
 
 ```ruby
 class Foo
-	private
+  private
 
-		def foo
-		end
+  def foo
+  end
 
-	  def bar
-	  end
+    def bar
+    end
 end
 
 class Bar
   private
 
-	  def foo
-	  end
+    def foo
+    end
 
-	  def bar
-	  end
+    def bar
+    end
 end
 ```
 
@@ -685,8 +705,8 @@ end
 
 ```ruby
 class Foo
-	def foo
-	end
+  def foo
+  end
 
 private
 
@@ -754,13 +774,13 @@ Given this code:
 
 ```ruby
 {
-	foo: 1,
-	barbaz: 2,
+  foo: 1,
+  barbaz: 2,
 }
 
 {
-	:foo => 1,
-	:barbaz => 2,
+  :foo => 1,
+  :barbaz => 2,
 }
 
 method foo: 1,
@@ -771,13 +791,13 @@ With `true`, the formatter will change it to:
 
 ```ruby
 {
-	foo:    1,
-	barbaz: 2,
+  foo:    1,
+  barbaz: 2,
 }
 
 {
-	:foo =>    1,
-	:barbaz => 2,
+  :foo =>    1,
+  :barbaz => 2,
 }
 
 method foo:    1,
@@ -856,33 +876,33 @@ Given this code:
 
 ```ruby
 [
-	1,
-	2
+  1,
+  2
 ]
 
 [
-	1,
-	2,
+  1,
+  2,
 ]
 
 {
-	foo: 1,
-	bar: 2
+  foo: 1,
+  bar: 2
 }
 
 {
-	foo: 1,
-	bar: 2,
+  foo: 1,
+  bar: 2,
 }
 
 foo(
-	x: 1,
-	y: 2
+  x: 1,
+  y: 2
 )
 
 foo(
-	x: 1,
-	y: 2,
+  x: 1,
+  y: 2,
 )
 ```
 
@@ -890,68 +910,68 @@ With `:always`, the formatter will change it to:
 
 ```ruby
 [
-	1,
-	2,
+  1,
+  2,
 ]
 
 [
-	1,
-	2,
+  1,
+  2,
 ]
 
 {
-	foo: 1,
-	bar: 2,
+  foo: 1,
+  bar: 2,
 }
 
 {
-	foo: 1,
-	bar: 2,
+  foo: 1,
+  bar: 2,
 }
 
 foo(
-	x: 1,
-	y: 2,
+  x: 1,
+  y: 2,
 )
 
 foo(
-	x: 1,
-	y: 2,
+  x: 1,
+  y: 2,
 )
 ```
 With `:never`, the formatter will change it to:
 
 ```ruby
 [
-	1,
-	2
+  1,
+  2
 ]
 
 [
-	1,
-	2
+  1,
+  2
 ]
 
 {
-	foo: 1,
-	bar: 2
+  foo: 1,
+  bar: 2
 }
 
 {
-	foo: 1,
-	bar: 2
+  foo: 1,
+  bar: 2
 }
 
 foo(
-	x: 1,
-	y: 2
+  x: 1,
+  y: 2
 )
 
 foo(
-	x: 1,
-	y: 2
+  x: 1,
+  y: 2
 )
-``
+```
 
 With `:dynamic` it won't modify it.
 

data/lib/rufo/command.rb

@@ -44,7 +44,7 @@ class Rufo::Command
 
     args.each do |arg|
       if Dir.exist?(arg)
-        files.concat Dir["#{arg}/**/*.rb"].select(&File.method(:file?))
+        files.concat Dir[File.join(arg, '**', '*.rb')].select(&File.method(:file?))
       elsif File.exist?(arg)
         files << arg
       else
@@ -73,7 +73,7 @@ class Rufo::Command
       return true
     end
 
-    if code != result
+    if code.force_encoding(result.encoding) != result
       if @want_check
         STDERR.puts "Error: formatting #{filename} produced changes"
       else

data/lib/rufo/formatter.rb

@@ -100,8 +100,9 @@ class Rufo::Formatter
     # Do we want to compute the above?
     @want_first_token_in_line = false
 
-    # Each line that belongs to a heredoc content is put here
-    @heredoc_lines = {}
+    # Each line that belongs to a string literal besides the first
+    # go here, so we don't break them when indenting/dedenting stuff
+    @unmodifiable_string_lines = {}
 
     # Position of comments that occur at the end of a line
     @comments_positions = []
@@ -721,12 +722,18 @@ class Rufo::Formatter
     inner = inner[1..-1] unless node[0] == :xstring_literal
     visit_exps(inner, with_lines: false)
 
+    # Every line between the first line and end line of this
+    # string (excluding the first line) must remain like it is
+    # now (we don't want to mess with that when indenting/dedenting)
+    #
+    # This can happen with heredocs, but also with string literals
+    # spanning multiple lines.
+    (line + 1..@line).each do |i|
+      @unmodifiable_string_lines[i] = true
+    end
+
     case current_token_kind
     when :on_heredoc_end
-      (line + 1..@line).each do |i|
-        @heredoc_lines[i] = true
-      end
-
       heredoc, tilde = @current_heredoc
       if heredoc && tilde
         write_indent
@@ -751,13 +758,27 @@ class Rufo::Formatter
     # [:string_concat, string1, string2]
     _, string1, string2 = node
 
+    token_column = current_token_column
+    base_column = @column
+
     visit string1
 
     has_backslash, first_space = skip_space_backslash
     if has_backslash
       write " \\"
       write_line
-      write_indent
+
+      # If the strings are aligned, like in:
+      #
+      # foo bar, "hello" \
+      #          "world"
+      #
+      # then keep it aligned.
+      if token_column == current_token_column
+        write_indent(base_column)
+      else
+        write_indent
+      end
     else
       consume_space
     end
@@ -900,21 +921,34 @@ class Rufo::Formatter
       write_space first_space[2]
     end
 
-    # consume_space(want_preserve_whitespace: !@align_assignments)
     track_assignment
     consume_op "="
     visit_assign_value right
   end
 
   def visit_assign_value(value)
+    base_column = @column
+
     first_space = current_token if space?
-    skip_space
+    has_slash_newline, _ = skip_space_backslash
+
+    sticky = indentable_value?(value)
 
-    want_space = first_space || @spaces_around_equal == :one
-    indent_after_space value, sticky: indentable_value?(value),
-                              want_space: want_space,
-                              first_space: first_space,
-                              preserve_whitespace: @spaces_around_equal == :dynamic && !@align_assignments
+    # Remove backslash after equal + newline (it's useless)
+    if has_slash_newline
+      skip_space_or_newline
+      write_line
+      indent(next_indent) do
+        write_indent
+        visit(value)
+      end
+    else
+      want_space = first_space || @spaces_around_equal == :one
+      indent_after_space value, sticky: sticky,
+                                want_space: want_space,
+                                first_space: first_space,
+                                preserve_whitespace: @spaces_around_equal == :dynamic && !@align_assignments
+    end
   end
 
   def indentable_value?(value)
@@ -1855,9 +1889,11 @@ class Rufo::Formatter
     end
 
     consume_op "*"
-    skip_space_or_newline
 
-    visit star if star
+    if star
+      skip_space_or_newline
+      visit star
+    end
 
     if after && !after.empty?
       write_params_comma
@@ -3396,7 +3432,9 @@ class Rufo::Formatter
         write current_token_value.rstrip
         next_token
       when :on_embdoc_beg
-        write_line if multilple_lines
+        if multilple_lines || last == :comment
+          write_line
+        end
 
         consume_embedded_comment
         last = :comment
@@ -3435,7 +3473,7 @@ class Rufo::Formatter
 
     line = current_token_line
 
-    write_line
+    write_line unless @output.empty?
     consume_token :on___end__
 
     lines = @code.lines[line..-1]
@@ -3840,7 +3878,7 @@ class Rufo::Formatter
       (first_line + 1..last_line).each do |line|
         @line_to_call_info.delete(line)
 
-        next if @heredoc_lines[line]
+        next if @unmodifiable_string_lines[line]
 
         current_line = lines[line]
         current_line = current_line[diff..-1]
@@ -3864,7 +3902,7 @@ class Rufo::Formatter
 
     @literal_indents.each do |first_line, last_line, indent|
       (first_line + 1..last_line).each do |line|
-        next if @heredoc_lines[line]
+        next if @unmodifiable_string_lines[line]
 
         current_line = lines[line]
         current_line = "#{" " * indent}#{current_line}"

data/lib/rufo/version.rb

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

metadata

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