rufo 0.0.22 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4bd80b45163ec985e39e5755663d53b0931911e
-  data.tar.gz: 97891fb7b41a5ecfad21e2de5a3b2e173225f23e
+  metadata.gz: bd6cf27bd7b2fb2451482dff10c6fe5a3930311e
+  data.tar.gz: 7a4eebf1d5df0dc1ae9e05f9a04030cef866cdf2
 SHA512:
-  metadata.gz: aa93f77d18292af45a8bc6778c15a61aca17abaf90e512e5226a683f2c91d6d06f02073f16eabf95f10b073b649685b02358ae448c76c5b63a899701ee12ee2f
-  data.tar.gz: 5ca62d116346c59054241b98f1f944b4fb6e9a7a252d10b19d8960894adb8db1d940f98d3a2d5889dac5c9760a0f4e217a6d00537547706ba7f5ab1bb74b1cb5
+  metadata.gz: bd58dc896ab51bc57c5901fd5d1b46f29784d8f934de72176e21723bf542889520dc1a03f741ca14d2eddf618bbf66522ef758bd4612c1276937d533855d7ced
+  data.tar.gz: a0e7d72efa0b67fc29bb893eac4be54dfdd3dfb9b90700aaef306e34de7303c947f86c3116cad7b0a3c06357a8eaf4ee786954cb6862e83d2998e429f0c3187c

data/README.md

@@ -49,7 +49,7 @@ according to **rufo**, and will exit with exit code 1.
 
 ## 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.
+Rufo follows most 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.
@@ -94,6 +94,31 @@ indent_size 2
 As time passes there might be more configurations available. Please open an
 issue if you need something else to be configurable.
 
+## Formatting rules
+
+Rufo follows most of the conventions found in this [Ruby style guide](https://github.com/bbatsov/ruby-style-guide).
+
+However, there are some differences. Some of them are:
+
+### `*`, `/` and `**` don't require spaces around them
+
+All of these are good:
+
+```ruby
+# First option
+2*x + 3*y + z
+
+# Second option
+2 * x + 3 * y + z
+
+# Another option
+2 * x + 3*y + z
+```
+
+Rufo will leave them as they are. The reason is that the first format looks
+good mathematically. If you do insert a space before the `*` operator,
+a space will be inserted afterwards.
+
 ## Status
 
 The formatter is able to format `rails` and other projects, so at this point

data/lib/rufo/command.rb

@@ -55,8 +55,7 @@ class Rufo::Command
     changed = false
 
     files.each do |file|
-      success = format_file file
-      changed ||= success
+      changed |= format_file file
     end
 
     exit 1 if changed
@@ -119,6 +118,7 @@ class Rufo::Command
     filename_for_dot_rufo = nil
 
     OptionParser.new do |opts|
+      opts.version = Rufo::VERSION
       opts.banner = "Usage: rufo files or dirs [options]"
 
       opts.on("-c", "--check", "Only check formating changes") do

data/lib/rufo/formatter.rb

@@ -41,14 +41,31 @@ class Rufo::Formatter
     # Position of comments that occur at the end of a line
     @comments_positions = []
 
+    # Associate lines to alignments
     # Associate a line to an index inside @comments_position
     # becuase when aligning something to the left of a comment
     # we need to adjust the relative comment
-    @line_to_comments_position_index = {}
+    @line_to_alignments_positions = Hash.new { |h, k| h[k] = [] }
 
     # Position of assignments
     @assignments_positions = []
 
+    # Range of assignment (line => end_line)
+    #
+    # We need this because when we have to format:
+    #
+    # ```
+    # abc = 1
+    # a = foo bar: 2
+    #         baz: #
+    # ```
+    #
+    # Because we'll insert two spaces after `a`, this will
+    # result in a mis-alignment for baz (and possibly other lines
+    # below it). So, we remember the line ranges of an assignment,
+    # and once we align the first one we fix the other ones.
+    @assignments_ranges = {}
+
     # Hash keys positions
     @hash_keys_positions = []
 
@@ -613,11 +630,15 @@ class Rufo::Formatter
     # [:assign, target, value]
     _, target, value = node
 
+    line = @line
+
     visit target
     consume_space(!@align_assignments)
     track_assignment
     consume_op "="
     visit_assign_value value
+
+    @assignments_ranges[line] = @line if @line != line
   end
 
   def visit_op_assign(node)
@@ -625,6 +646,9 @@ class Rufo::Formatter
     #
     # [:opassign, target, op, value]
     _, target, op, value = node
+
+    line = @line
+
     visit target
     consume_space(!@align_assignments)
 
@@ -640,6 +664,8 @@ class Rufo::Formatter
     next_token
 
     visit_assign_value value
+
+    @assignments_ranges[line] = @line if @line != line
   end
 
   def visit_multiple_assign(node)
@@ -686,31 +712,32 @@ class Rufo::Formatter
   end
 
   def track_comment
-    @line_to_comments_position_index[@line] = @comments_positions.size
+    @line_to_alignments_positions[@line] << [:comment, @column, @comments_positions, @comments_positions.size]
     @comments_positions << [@line, @column, 0, nil, 0]
   end
 
   def track_assignment(offset = 0)
-    track_alignment @assignments_positions, offset
+    track_alignment :assign, @assignments_positions, offset
   end
 
   def track_hash_key
     return unless @current_hash
 
-    track_alignment @hash_keys_positions, 0, @current_hash.object_id
+    track_alignment :hash_key, @hash_keys_positions, 0, @current_hash.object_id
   end
 
   def track_case_when
-    track_alignment @case_when_positions
+    track_alignment :case_whem, @case_when_positions
   end
 
-  def track_alignment(target, offset = 0, id = nil)
+  def track_alignment(key, target, offset = 0, id = nil)
     last = target.last
     if last && last[0] == @line
       # Track only the first alignment in a line
       return
     end
 
+    @line_to_alignments_positions[@line] << [key, @column, target, target.size]
     target << [@line, @column, @indent, id, offset]
   end
 
@@ -885,6 +912,8 @@ class Rufo::Formatter
 
       if newline? || comment?
         if needs_trailing_newline
+          write "," unless found_comma
+
           indent(next_indent) do
             consume_end_of_line
           end
@@ -894,6 +923,7 @@ class Rufo::Formatter
         end
       else
         if needs_trailing_newline && !found_comma
+          write ","
           consume_end_of_line
           write_indent
         end
@@ -2792,6 +2822,14 @@ class Rufo::Formatter
       consume_end_of_line(false, false, false)
     end
 
+    # A then keyword can appear after a newline after an `if`, `unless`, etc.
+    # Since that's a super weird formatting for if, probably way too obsolete
+    # by now, we just remove it.
+    if keyword?("then")
+      next_token
+      skip_space_or_newline
+    end
+
     # If the body is [[:void_stmt]] it's an empty body
     # so there's nothing to write
     if exps.size == 1 && exps[0][0] == :void_stmt
@@ -2998,22 +3036,22 @@ class Rufo::Formatter
   end
 
   def do_align_comments
-    do_align @comments_positions, false
+    do_align @comments_positions, :comment
   end
 
   def do_align_assignments
-    do_align @assignments_positions
+    do_align @assignments_positions, :assign
   end
 
   def do_align_hash_keys
-    do_align @hash_keys_positions, true, true
+    do_align @hash_keys_positions, :hash_key
   end
 
   def do_align_case_when
-    do_align @case_when_positions
+    do_align @case_when_positions, :case
   end
 
-  def do_align(elements, adjust_comments = true, hash_keys = false)
+  def do_align(elements, scope)
     lines = @output.lines
 
     # Chunk comments that are in consecutive lines
@@ -3024,7 +3062,7 @@ class Rufo::Formatter
     chunks.each do |comments|
       next if comments.size == 1
 
-      if hash_keys
+      if scope == :hash_key
         # 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)|
@@ -3050,8 +3088,19 @@ class Rufo::Formatter
         filler_size = max_column - column
         filler = " " * filler_size
 
-        if adjust_comments && (index = @line_to_comments_position_index[line])
-          @comments_positions[index][1] += filler_size
+        # Move all lines affected by the assignment shift
+        if scope == :assign && (range = @assignments_ranges[line])
+          (line + 1..range).each do |line_number|
+            lines[line_number] = "#{filler}#{lines[line_number]}"
+
+            # And move other elements too if applicable
+            adjust_other_alignments scope, line_number, column, filler_size
+          end
+        end
+
+        # Move comments to the right if a change happened
+        if scope != :comment
+          adjust_other_alignments scope, line, column, filler_size
         end
 
         lines[line] = "#{before}#{filler}#{after}"
@@ -3061,6 +3110,18 @@ class Rufo::Formatter
     @output = lines.join
   end
 
+  def adjust_other_alignments(scope, line, column, offset)
+    adjustments = @line_to_alignments_positions[line]
+    return unless adjustments
+
+    adjustments.each do |key, adjustment_column, target, index|
+      next if adjustment_column <= column
+      next if scope == key
+
+      target[index][1] += offset
+    end
+  end
+
   def chunk_while(array, &block)
     if array.respond_to?(:chunk_while)
       array.chunk_while(&block)

data/lib/rufo/version.rb

@@ -1,3 +1,3 @@
 module Rufo
-  VERSION = "0.0.22"
+  VERSION = "0.0.24"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rufo
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.0.24
 platform: ruby
 authors:
 - Ary Borenszweig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-25 00:00:00.000000000 Z
+date: 2017-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler