rufo 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f651b0e7deb5c6d36cbe7632aa761954e7d49939
-  data.tar.gz: 20b7c26c352e682cf72547fdeebf25d31b467aa4
+  metadata.gz: 447a4661f121c8ffd43ba8fc6e5e7267ab5dc3d5
+  data.tar.gz: a69acf6a569e48b611a51d6105bc3081b47742fe
 SHA512:
-  metadata.gz: b9f40a5d0fd5ad07143ccc49fafddce8bd72cad15ada182f8cdf03b239a956f5a4072fe0df639d53a3c88d928a12058a360158b1a3b61462e073b2d9973cdfb1
-  data.tar.gz: 122c69242308b0999954d684ae4cfb4a0020d5ec9b68de7f76ce449a47076d659d8062f8c69fe9da80057031e07caddcc19f8a0fb653cd1e7ee0be3619d990c9
+  metadata.gz: 9e0df262618cf4ff4e6b6b4ddd9b241b734e52a2fe35c170ee70c4dbabc7d48df15e39c9432574982886dc19631a7263fb0d53f00e7deb45e50d7173fbe75275
+  data.tar.gz: 1aaf628a9c1ee5d2405b518048d1ae1524d5f673798c511751675cfe38680041619286f0e5056e59c81cc4deabb5e39f54775b87af31f041a8c65119b79befb4

data/README.md

@@ -1,5 +1,7 @@
 # Rufo
 
+[![Build Status](https://travis-ci.org/asterite/rufo.svg)](https://travis-ci.org/asterite/rufo)
+
 **Ru**by **fo**rmatter
 
 ## Installation
@@ -75,6 +77,29 @@ indent_size         2
 As time passes there might be more configurations available. Please open an
 issue if you need something else to be configurable.
 
+## Status
+
+The current version is 0.0.3. The formatter was tested on some big files with many Ruby
+syntax and idioms, but since it's so new there might be some missing stuff. Don't hesitate
+to open an issue if you find something is not working well. In any case, if the formatter
+chokes on some valid input you will get an error prompting you to submit a bug report here :-)
+
+## How it works
+
+Rufo is a **real** formatter, not a simple find and replace one. It works by employing
+a Ruby parser and a Ruby lexer. The parser is used for the shape of the program. The program
+is traversed and the lexer is used to sync this structure to tokens. This is why comments
+can be handled well, because they are provided by the lexer (comments are not returned by
+a parser). 
+
+To parse and lex, [Ripper](https://ruby-doc.org/stdlib-2.4.0/libdoc/ripper/rdoc/Ripper.html) is used.
+
+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
+in C (uses Ruby's lexer and parser) it formats files pretty fast too.
+
 ## 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/command.rb

@@ -9,9 +9,6 @@ module Rufo::Command
     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)
@@ -23,6 +20,9 @@ module Rufo::Command
     else
       print result
     end
+  rescue Rufo::SyntaxError
+    STDERR.puts "Error: the given text is not a valid ruby program (it has syntax errors)"
+    exit 1
   rescue Rufo::Bug => 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"
@@ -68,6 +68,9 @@ module Rufo::Command
     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
   rescue Rufo::Bug => ex
     STDERR.puts "You've found a bug!"
     STDERR.puts "It happened while trying to format the file #{filename}"

data/lib/rufo/formatter.rb

@@ -110,8 +110,18 @@ class Rufo::Formatter
       #
       # [:@int, "123", [1, 0]]
       consume_token :on_int
+    when :@gvar
+      # [:@gvar, "$abc", [1, 0]]
+      write node[1]
+      next_token
+    when :@backref
+      # [:@backref, "$1", [1, 0]]
+      write node[1]
+      next_token
     when :string_literal
       visit_string_literal node
+    when :string_concat
+      visit_string_concat node
     when :@tstring_content
       # [:@tstring_content, "hello ", [1, 1]]
       heredoc, tilde = @current_heredoc
@@ -294,6 +304,8 @@ class Rufo::Formatter
       consume_keyword "super"
     when :super
       visit_super(node)
+    when :defined
+      visit_defined(node)
     else
       bug "Unhandled node: #{node.first}"
     end
@@ -397,6 +409,16 @@ class Rufo::Formatter
     end
   end
 
+  def visit_string_concat(node)
+    # string1 string2
+    # [:string_concat, string1, string2]
+    _, string1, string2 = node
+
+    visit string1
+    consume_space
+    visit string2
+  end
+
   def visit_string_interpolation(node)
     # [:string_embexpr, exps]
     consume_token :on_embexpr_beg
@@ -610,7 +632,7 @@ class Rufo::Formatter
 
   def consume_call_dot
     if current_token_kind == :on_op
-      consume_op "::"
+      consume_token :on_op
     else
       check :on_period
       next_token
@@ -942,9 +964,9 @@ class Rufo::Formatter
     _, body, rescue_body, else_body, ensure_body = node
     indent_body body
 
-    if rescue_body
-      # [:rescue, type, name, body, nil]
-      _, type, name, body = rescue_body
+    while rescue_body
+      # [:rescue, type, name, body, more_rescue]
+      _, type, name, body, more_rescue = rescue_body
       write_indent
       consume_keyword "rescue"
       if type
@@ -965,6 +987,7 @@ class Rufo::Formatter
       end
 
       indent_body body
+      rescue_body = more_rescue
     end
 
     if else_body
@@ -1452,9 +1475,15 @@ class Rufo::Formatter
     end
 
     has_newline = false
+    last_token  = nil
 
     while current_token_kind == :on_words_sep
       has_newline ||= current_token_value.include?("\n")
+
+      unless current_token[2].strip.empty?
+        last_token = current_token
+      end
+
       next_token
     end
 
@@ -1463,8 +1492,12 @@ class Rufo::Formatter
       write_indent(next_indent)
     end
 
-    write ")"
-    return
+    if last_token
+      write last_token[2].strip
+    else
+      write current_token_value.strip
+      next_token
+    end
   end
 
   def visit_hash(node)
@@ -1683,7 +1716,12 @@ class Rufo::Formatter
       consume_space if space?
 
       indent(@column) do
-        visit node[1]
+        # For `return a b` there comes many nodes, not just one... (see #8)
+        if node[1][0].is_a?(Symbol)
+          visit node[1]
+        else
+          visit_exps node[1], false, false
+        end
       end
     end
   end
@@ -1764,6 +1802,39 @@ class Rufo::Formatter
     end
   end
 
+  def visit_defined(node)
+    # [:defined, exp]
+    _, exp = node
+
+    consume_keyword "defined?"
+    skip_space_or_newline
+
+    has_paren = current_token_kind == :on_lparen
+
+    if has_paren
+      write "("
+      next_token
+      skip_space_or_newline
+    else
+      consume_space
+    end
+
+    # exp can be [:paren, exp] if there's a parentheses,
+    # though not always (only if there's a space after `defined?`)
+    if exp[0] == :paren
+      exp = exp[1]
+    end
+
+    visit exp
+
+    if has_paren
+      skip_space_or_newline
+      check :on_rparen
+      write ")"
+      next_token
+    end
+  end
+
   def visit_literal_elements(elements)
     base_column = @column
 
@@ -1891,20 +1962,47 @@ class Rufo::Formatter
     skip_space
 
     # Keep `while cond; end` as is
-    if semicolon? && void_exps?(body)
+    semicolon = semicolon?
+    is_do     = keyword?("do")
+
+    if (semicolon || is_do) && void_exps?(body)
       next_token
       skip_space
 
       if keyword?("end")
-        write "; end"
+        if is_do
+          write " do end"
+        else
+          write "; end"
+        end
         next_token
         return
       end
     end
 
-    indent_body body
+    if semicolon || is_do
+      next_token
+      skip_space
+      skip_semicolons
+
+      if newline? || comment?
+        indent_body body
+        write_indent
+      else
+        skip_space_or_newline
+        if semicolon
+          write "; "
+        else
+          write " do "
+        end
+        visit_exps body, false, false
+        consume_space
+      end
+    else
+      indent_body body
+      write_indent
+    end
 
-    write_indent
     consume_keyword "end"
   end
 
@@ -1991,7 +2089,7 @@ class Rufo::Formatter
 
   def consume_space
     skip_space_or_newline
-    write_space " "
+    write_space " " unless @output[-1] == " "
   end
 
   def skip_space

data/lib/rufo/version.rb

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

metadata

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