rufo 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 568bbd1f6cd032ca58647141b94d48748688a1af
-  data.tar.gz: f4d143cd048591f4a98869d7709384fdfd8b362c
+  metadata.gz: 68781ad7a9acb9d0469157827d84c19a3c43582d
+  data.tar.gz: 8dd6f678a49a8e26bd01f534ca0b3c060b88d8a9
 SHA512:
-  metadata.gz: '0854453cd81dbaaa44175c794c595ce171de33320b2c51ba2e5a6f61dec76f175e82c0a0c572d1826aca71ff289f777d01c2ea283ba9713a7bed643123a31f30'
-  data.tar.gz: 1c6469b61a0f9601a48a93811df18131fae20ff226965cbd7962f92b7427d17d7d98a8fb9c157cb2074794707d671126377573b3329aa1936b4d18045a9e5470
+  metadata.gz: 82a80a462d83f51b449a64c6b12c6a49fdd658b3321bc720a24239613ca375e5340585e2e81bd667c9c88eb956bf5d5dae557434186924817b8e9ef3c8f9ec9d
+  data.tar.gz: df226a82d72e7ec562b6b002e9c89956a6add4a8b5f2933c7e4f53ea53140f270acbf21e50ab297689dab1a0dad2e71fc671ee5fa24a2a638a6756cec8762dbd

data/.travis.yml

@@ -2,10 +2,14 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
+  - 2.5.0
   - 2.4.2
   - 2.3.5
   - 2.2.8
   - ruby-head
-before_install: gem install bundler -v 1.15.4
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+before_install: gem install bundler -v 1.16.1
 script:
   - bundle exec rake ci

data/CHANGELOG.md

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.3.0] - 2018-03-24
+
+### Added
+- Added Idempotency check to source_specs/ tester.
+- Normalize string quotes according to quote_style, which defaults to :double.
+
+## Fixed
+- Fix printing of extraneous trailing semicolons from inline classes, modules, methods (issue [#59](https://github.com/ruby-formatter/rufo/issues/59))
+- Fix unhandled white space between array getter/setters `x[0] [0]` (issue [#62](https://github.com/ruby-formatter/rufo/issues/62))
+- Fix comma printing for heredocs when inside a hash (issue [#61](https://github.com/ruby-formatter/rufo/issues/61))
+- Fix array literals against changes to Ruby 2.5.0
+
 ## [0.2.0] - 2017-11-13
 ### Changed
 Config parsing and handling:

data/README.md

@@ -1,6 +1,6 @@
 # Rufo
 
-[![Build Status](https://travis-ci.org/ruby-formatter/rufo.svg)](https://travis-ci.org/ruby-formatter/rufo)
+[![Build Status](https://api.travis-ci.org/ruby-formatter/rufo.svg?branch=master)](https://travis-ci.org/ruby-formatter/rufo)
 [![Gem](https://img.shields.io/gem/v/rufo.svg)](https://rubygems.org/gems/rufo)
 
 **Ru**by **fo**rmatter

data/lib/rufo/command.rb

@@ -65,7 +65,7 @@ class Rufo::Command
 
     args.each do |arg|
       if Dir.exist?(arg)
-        files.concat Dir[File.join(arg, '**', '*.rb')].select(&File.method(:file?))
+        files.concat Dir[File.join(arg, "**", "*.rb")].select(&File.method(:file?))
       elsif File.exist?(arg)
         files << arg
       else
@@ -109,7 +109,7 @@ Rufo Warning!
   end
 
   def squiggly_warning_files
-    @squiggly_warning_files.join(', ')
+    @squiggly_warning_files.join(", ")
   end
 
   def backported_version

data/lib/rufo/dot_file.rb

@@ -22,12 +22,12 @@ class Rufo::DotFile
     file_contents.lines
                  .map { |s| s.strip.split(/\s+/, 2) }
                  .each_with_object({}) do |(name, value), acc|
-      value ||= ''
-      if value.start_with?(':')
+      value ||= ""
+      if value.start_with?(":")
         value = value[1..-1].to_sym
-      elsif value == 'true'
+      elsif value == "true"
         value = true
-      elsif value == 'false'
+      elsif value == "false"
         value = false
       else
         $stderr.puts "Unknown config value=#{value.inspect} for #{name.inspect}"

data/lib/rufo/formatter.rb

@@ -159,7 +159,20 @@ class Rufo::Formatter
     # This is [[line, original_line], ...]
     @inline_declarations = []
 
+    # This is used to track how far deep we are in the AST.
+    # This is useful as it allows you to check if you are inside an array
+    # when dealing with heredocs.
+    @node_level = 0
+
+    # This represents the node level of the most recent literal elements list.
+    # It is used to track if we are in a list of elements so that commas
+    # can be added appropriately for heredocs for example.
+    @literal_elements_level = nil
+
     init_settings(options)
+
+    # Which quote character are we using?
+    @quote_char = (quote_style == :double) ? '"' : "'"
   end
 
   def format
@@ -175,6 +188,7 @@ class Rufo::Formatter
   end
 
   def visit(node)
+    @node_level += 1
     unless node.is_a?(Array)
       bug "unexpected node: #{node} at #{current_token}"
     end
@@ -473,6 +487,8 @@ class Rufo::Formatter
     else
       bug "Unhandled node: #{node.first}"
     end
+  ensure
+    @node_level -= 1
   end
 
   def visit_exps(exps, with_indent: false, with_lines: true, want_trailing_multiline: false)
@@ -574,32 +590,96 @@ class Rufo::Formatter
       # Accumulate heredoc: we'll write it once
       # we find a newline.
       @heredocs << [node, tilde]
-      next_token
+      # Get the next_token while capturing any output.
+      # This is needed so that we can add a comma if one is not already present.
+      captured_output = capture_output { next_token }
+
+      inside_literal_elements_list = !@literal_elements_level.nil? &&
+                                     (@node_level - @literal_elements_level) == 2
+      needs_comma = !comma? && trailing_commas
+
+      if inside_literal_elements_list && needs_comma
+        write ","
+        @last_was_heredoc = true
+      end
+
+      @output << captured_output
       return
     elsif current_token_kind == :on_backtick
       consume_token :on_backtick
     else
+      return if format_simple_string(node)
       consume_token :on_tstring_beg
     end
 
     visit_string_literal_end(node)
   end
 
-  def visit_string_literal_end(node)
+  # For simple string formatting, look for nodes like:
+  #  [:string_literal, [:string_content, [:@tstring_content, "abc", [...]]]]
+  # and return the simple string inside.
+  def simple_string(node)
+    inner = node[1][1..-1]
+    return if inner.length > 1
+    inner = inner[0]
+    return "" if !inner
+    return if inner[0] != :@tstring_content
+    string = inner[1]
+    string
+  end
+
+  # should we format this string according to :quote_style?
+  def should_format_string?(string)
+    # don't format %q or %Q
+    return unless current_token_value == "'" || current_token_value == '"'
+    # don't format strings containing slashes
+    return if string.include?("\\")
+    # don't format strings that contain our quote character
+    return if string.include?(@quote_char)
+    true
+  end
+
+  def format_simple_string(node)
+    # is it a simple string node?
+    string = simple_string(node)
+    return if !string
+
+    # is it eligible for formatting?
+    return if !should_format_string?(string)
+
+    # success!
+    write @quote_char
+    next_token
+    with_unmodifiable_string_lines do
+      inner = node[1][1..-1]
+      visit_exps(inner, with_lines: false)
+    end
+    write @quote_char
+    next_token
+
+    true
+  end
+
+  # 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.
+  def with_unmodifiable_string_lines(&block)
     line = @line
+    yield
+    (line + 1..@line).each do |i|
+      @unmodifiable_string_lines[i] = true
+    end
+  end
 
+  def visit_string_literal_end(node)
     inner = node[1]
     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
+    with_unmodifiable_string_lines do
+      visit_exps(inner, with_lines: false)
     end
 
     case current_token_kind
@@ -1256,11 +1336,7 @@ class Rufo::Formatter
 
     visit call
 
-    if block[0] == :brace_block
-      consume_space
-    else
-      consume_space
-    end
+    consume_space
 
     old_dot_column = @dot_column
     old_original_dot_column = @original_dot_column
@@ -1619,7 +1695,7 @@ class Rufo::Formatter
     skip_space
     if comma?
       check :on_comma
-      write ','
+      write ","
       next_token
       skip_space_or_newline
     end
@@ -2139,14 +2215,26 @@ class Rufo::Formatter
     has_space = current_token_value.end_with?(" ")
     write current_token_value.strip
 
-    # If there's a newline after `%w(`, write line and indent
-    if current_token_value.include?("\n") && elements
+    # (pre 2.5.0) If there's a newline after `%w(`, write line and indent
+    if current_token_value.include?("\n") && elements # "%w[\n"
       write_line
-      write_indent(next_indent)
+      write_indent next_indent
     end
 
     next_token
 
+    # fix for 2.5.0 ripper change
+    if current_token_kind == :on_words_sep && elements && !elements.empty?
+      value = current_token_value
+      has_space = value.start_with?(" ")
+      if value.include?("\n") && elements # "\n "
+        write_line
+        write_indent next_indent
+      end
+      next_token
+      has_space = true if current_token_value.start_with?(" ")
+    end
+
     if elements && !elements.empty?
       write_space if has_space
       column = @column
@@ -2310,6 +2398,7 @@ class Rufo::Formatter
 
     token_column = current_token_column
 
+    skip_space
     check :on_lbracket
     write "["
     next_token
@@ -2600,6 +2689,8 @@ class Rufo::Formatter
     first_space = nil
 
     elements.each_with_index do |elem, i|
+      @literal_elements_level = @node_level
+
       is_last = last?(i, elements)
       wrote_comma = false
 
@@ -2641,9 +2732,10 @@ class Rufo::Formatter
         write_space unless is_last
       end
     end
+    @literal_elements_level = nil
 
     if needs_trailing_comma
-      write "," unless wrote_comma || !trailing_commas
+      write "," unless wrote_comma || !trailing_commas || @last_was_heredoc
 
       consume_end_of_line(first_space: first_space)
       write_indent
@@ -2675,7 +2767,7 @@ class Rufo::Formatter
 
   def check_heredocs_in_literal_elements(is_last, needs_trailing_comma, wrote_comma)
     if (newline? || comment?) && !@heredocs.empty?
-      if !is_last || needs_trailing_comma
+      if is_last && trailing_commas
         write "," unless wrote_comma
         wrote_comma = true
       end
@@ -3075,9 +3167,12 @@ class Rufo::Formatter
         # print it, but only if it's not followed by a newline
         if !found_newline && want_semicolon && last != :semicolon
           skip_space
-          case current_token_kind
+          kind = current_token_kind
+          case kind
           when :on_ignored_nl, :on_eof
           else
+            return if (kind == :on_kw) &&
+                      (%w[class module def].include?(current_token_value))
             write "; "
             last = :semicolon
           end
@@ -3335,6 +3430,15 @@ class Rufo::Formatter
     end
   end
 
+  def capture_output
+    old_output = @output
+    @output = "".dup
+    yield
+    result = @output
+    @output = old_output
+    result
+  end
+
   def write(value)
     @output << value
     @last_was_newline = false

data/lib/rufo/settings.rb

@@ -4,6 +4,7 @@ module Rufo::Settings
     align_case_when: [false, true],
     align_chained_calls: [false, true],
     trailing_commas: [true, false],
+    quote_style: [:double, :single],
   }
 
   attr_accessor *OPTIONS.keys
@@ -14,7 +15,7 @@ module Rufo::Settings
       value = options.fetch(name, default)
       unless valid_options.include?(value)
         $stderr.puts "Invalid value for #{name}: #{value.inspect}. Valid " \
-                     "values are: #{valid_options.map(&:inspect).join(', ')}"
+                     "values are: #{valid_options.map(&:inspect).join(", ")}"
         value = default
       end
       self.public_send("#{name}=", value)

data/lib/rufo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rufo
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ary Borenszweig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-13 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Ruby code formatter