prettyrb 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea94d815e156b5294c602a74176b57ad6d7f368dbba00e9f5435fec4921c5bb5
-  data.tar.gz: 5e58bd43571e3565dc88bf97fa5f36204f09edd68b7aa15190e1a58a2c9aa6b8
+  metadata.gz: 6cdbfca887166eb0de5bb781abd2203f4b888459a49a7248462898cb002a368c
+  data.tar.gz: 57e3b5eb278aeb405f19a4aa77ac2eec0cd6f3fc824fcb7da0780b9403b500bb
 SHA512:
-  metadata.gz: 002b78f6a4ad5b5f94c05ac6fd78e685bddc9901b8dc6d29e5170da65933b3159c04c76d5d38a2a4ec645b5936bcb44cc8fae273a39dafbef8a4fd7d1d691100
-  data.tar.gz: ba85b4cc39ace86efe1639e83e7e307ea2a7b22e0b8574fcc490e9ed848bb71dacab2040592729fe0b24c6962a9eab4031f5ccf96a78bcf35f30ebc5387642d6
+  metadata.gz: 83d80892f95ed1b7c081a2325f36aa5462bd065e4b8d6e636b65bf0cd77a2b7566da1c7f1d119995281da6dbaa33897ae76b41e0429a2d71276ac25ad5e1a2bc
+  data.tar.gz: 61a4e582bd7eb20f409b96fbb69f559d645bb9563d22cf07cd4b2a69e54664814e256cf8241a6fe7d8ab10f1e07bb81d7fb08d3239c726fcf2441bf25d9ca1d2

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+coverage

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prettyrb (0.1.0)
+    prettyrb (0.2.0)
       parser (~> 2.7.0.5)
       thor
 
@@ -10,10 +10,15 @@ GEM
   specs:
     ast (2.4.0)
     byebug (11.1.1)
+    docile (1.3.2)
     minitest (5.14.0)
     parser (2.7.0.5)
       ast (~> 2.4.0)
     rake (12.3.3)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
     thor (1.0.1)
 
 PLATFORMS
@@ -25,6 +30,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   prettyrb!
   rake (~> 12.3.3)
+  simplecov (~> 0.18)
 
 BUNDLED WITH
    1.17.2

data/lib/prettyrb/formatter.rb

@@ -2,18 +2,15 @@ module Prettyrb
   MAX_LINE_LENGTH = 100
 
   class Formatter
-    def self.for(node)
-    end
-
     def initialize(code)
       @code = code
     end
 
     def format
-      root_node, comments = Parser::CurrentRuby.parse_with_comments(@code)
+      root_node, _comments = Parser::CurrentRuby.parse_with_comments(@code)
 
       visitor = Visitor.new
-      visitor.visit(root_node)
+      visitor.visit(root_node, nil)
 
       visitor.output
     end

data/lib/prettyrb/version.rb

@@ -1,3 +1,3 @@
 module Prettyrb
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/prettyrb/visitor.rb

@@ -1,6 +1,37 @@
 module Prettyrb
   class Visitor
     MAX_LENGTH = 100
+    SINGLE_LINE = "single_line"
+    MULTI_LINE = "multi_line"
+
+    FNAMES = [
+      "..",
+      "|",
+      "ˆ",
+      "&",
+      "<=>",
+      "==",
+      "===",
+      "=˜",
+      ">",
+      ">=",
+      "<",
+      "<=",
+      "+",
+      "-",
+      "*",
+      "/",
+      "%",
+      "**",
+      "<<",
+      ">>",
+      "~",
+      "+@",
+      "-@",
+      "[]",
+      "[]="
+    ]
+    VALID_SYMBOLS = FNAMES + ["!", "!="]
 
     attr_reader :output
 
@@ -10,7 +41,8 @@ module Prettyrb
 
       @newline = true
       @multiline_conditional_level = 0
-      @__current_node = nil
+      @previous_node = nil
+      @current_line = ''
     end
 
     def indents
@@ -27,10 +59,14 @@ module Prettyrb
 
     def indent(&block)
       old_indent_level = @indent_level
+      old_previous_node = @previous_node
 
+      @previous_node = nil
       @indent_level += 1
-      yield
+      value = yield
       @indent_level = old_indent_level
+      @previous_node = old_previous_node
+      value
     end
 
     def multiline_conditional_level
@@ -48,7 +84,9 @@ module Prettyrb
     def capture(&block)
       old_newline = @newline
       old_output = @output
+      old_current_line = @current_line
 
+      @current_line = ""
       @output = ""
 
       yield
@@ -56,109 +94,115 @@ module Prettyrb
       @output.tap do |output|
         @output = old_output
         @newline = old_newline
+        @current_line = old_current_line
       end
     end
 
     def newline
       @output << "\n"
       @newline = true
+      @current_line = ''
     end
 
     def write(input)
       if @newline
         @output << indents
+        @current_line << indents
       end
       @newline = false
       @output << input
+      @current_line << input
     end
 
-    def visit(node)
-      @previous_node = @__current_node
-      @__current_node = node
-
+    def visit(node, parent_node)
       case node.type
       when :module
         write "module "
-        visit node.children[0]
+        visit node.children[0], node
         newline
 
         indent do
-          visit node.children[1]
+          visit node.children[1], node
         end
 
         write "end"
         newline
       when :class
+        newline unless @previous_node.nil?
         write "class "
-        visit node.children[0]
+        visit node.children[0], node
         newline
         # TODO handle children[1] which is inheritance
 
         indent do
-          visit node.children[2]
+          visit node.children[2], node
         end
 
         newline unless @output.end_with?("\n")
         write "end"
         newline
       when :const
+        visit node.children[0] if node.children[0]
         write node.children[1].to_s
       when :casgn
         write node.children[1].to_s
         write " = "
-        visit node.children[2]
+        visit node.children[2], node
       when :block
-        visit node.children[0]
+        newline unless @previous_node.nil?
+        visit node.children[0], node
         write " do"
 
         if node.children[1].children.length > 0
           write " |"
-          visit node.children[1]
+          visit node.children[1], node
           write "|"
         end
 
         newline
 
         indent do
-          visit node.children[2]
+          visit node.children[2], node
         end
 
         newline
 
         write "end"
-        newline
       when :send
-        if [:!=, :==, :+, :-, :*, :/, :<<].include?(node.children[1])
-          visit node.children[0]
-          write " "
-          write node.children[1].to_s
-          write " "
-          visit node.children[2]
-        elsif node.children[1] == :[]
-          visit node.children[0]
-          write "["
-          visit node.children[2]
-          write "]"
-        elsif node.children[1] == :!
-          write "!"
-          visit node.children[0]
-        elsif node.children[0] == nil
+        newline if parent_node&.type == :begin && @previous_node && @previous_node&.type != :send
+        if node.children[0] == nil
           write node.children[1].to_s
 
           # TODO possible > MAX via `capture`
           arguments = node.children[2..-1]
           if arguments.length > 0
             write "("
-            arguments.each_with_index do |node, index|
-              visit node
-              write ", " unless index == arguments.length - 1
+            indent do
+              if splittable_separated_map(node, arguments) == MULTI_LINE
+                newline
+              end
             end
             write ")"
           end
 
-          newline if @previous_node.type == :class 
+          newline if @previous_node&.type == :class 
+        elsif node.children[1] == :[]
+          visit node.children[0], node
+          write "["
+          visit node.children[2], node
+          write "]"
+        elsif node.children[1] == :!
+          write "!"
+          visit node.children[0], node
+        elsif !node.children[1].to_s.match?(/[a-zA-Z]/)
+        # if [:!=, :==, :+, :-, :*, :/, :<<, :<].include?(node.children[1])
+          visit node.children[0], node
+          write " "
+          write node.children[1].to_s
+          write " "
+          visit node.children[2], node
         else
-          visit node.children[0]
+          visit node.children[0], node
           write "."
           write node.children[1].to_s
 
@@ -166,123 +210,166 @@ module Prettyrb
           arguments = node.children[2..-1]
           if arguments.length > 0
             write "("
-            arguments.each_with_index do |node, index|
-              visit node
+            arguments.each_with_index do |child_node, index|
+              visit child_node, node
               write ", " unless index == arguments.length - 1
             end
             write ")"
           end
         end
       when :if
-        write "if"
-        indent do
+        newline if @previous_node && parent_node&.type != :if
+
+        if parent_node&.type == :if
+          conditions_node = node.children[0]
+          body_node = node.children[1]
+          else_body_node = node.children[2]
+
+          write "elsif"
+
           conditions = capture do
-            visit node.children[0]
+            visit conditions_node, node
           end
 
           if !conditions.start_with?("\n")
             write(" ")
           end
+
           write conditions
+          newline
+
+          if body_node.type == :if
+            visit body_node, node
+          else
+            indent do
+              visit body_node, node
+            end
+          end
 
           newline
 
-          if node.children[1]
-            visit node.children[1]
+          if else_body_node&.type == :if
+            visit else_body_node, node
+          elsif else_body_node
+            write "else"
             newline
+            indent do
+              visit else_body_node, node
+            end
           end
-        end
+        else
+          is_unless = node.children[1].nil? && node.children[2]&.type != :if
+          conditions = node.children[0]
 
-        if node.children[2]
-          if node.children[2] == :if
-            write "elsif"
-            visit node.children[2]
+          if is_unless
+            write "unless"
+            body_node = node.children[2]
+            else_body_node = nil
           else
-            write "else"
+            write "if" unless parent_node&.type == :if
+            body_node = node.children[1]
+            else_body_node = node.children[2]
+          end
+
+          indent do
+            conditions = capture do
+              visit node.children[0], node
+            end
+
+            if !conditions.start_with?("\n")
+              write(" ")
+            end
+
+            write conditions
             newline
 
-            indent do
-              visit node.children[2]
+            if body_node
+              visit body_node, node
+              newline
             end
           end
-          newline
-        end
 
-        write "end"
+          if else_body_node
+            if else_body_node.type == :if
+              visit else_body_node, node
+            else
+              write "else"
+              newline
+
+              indent do
+                visit else_body_node, node
+              end
+            end
+            newline
+          end
+
+          write "end" unless parent_node&.type == :if
+        end
       when :true
         write "true"
       when :false
         write "false"
       when :nil
         write "nil"
-      when :int
+      when :int, :float
         write node.children[0].to_s
       when :array
-        possible_output = capture do
-          write "["
-          node.children.each_with_index do |child, index|
-            visit(child)
-            write ", " unless index == node.children.length - 1
-          end
-          write "]"
-        end
-
-        if possible_output.length > MAX_LENGTH
+        if node.children[0].type == :splat
+          visit node.children[0], node
+        else
           write "["
-          newline
-
           indent do
-            node.children.map do |child|
-              visit(child)
-              write ","
-              newline
-            end
+            result = splittable_separated_map(node, node.children)
+            newline if result == MULTI_LINE
           end
-
           write "]"
-        else
-          write possible_output.lstrip
         end
       when :str
         write '"'
-        write node.children[0].gsub("\n", "\\n")
+        write format_string(node)
         write '"'
       when :dstr
         write "\""
         node.children.map do |child|
           if child.type == :str
-            write child.children[0]
-            write child.children[0].gsub("\n", "\\n")
+            write child.children[0] # TODO better handling
           else
             write '#{'
-            visit child
+            visit child, node
             write '}'
           end
         end
         write "\""
       when :begin
-        if @previous_node.type == :or || @previous_node.type == :and
+        if @previous_node&.type == :or || @previous_node&.type == :and
           write "("
-          node.children.map { |child| visit child }
+          @previous_node = nil
+          node.children.map do |child|
+            visit child, node
+            @previous_node = child
+          end
+          @previous_node = nil
           write ")"
         else
+          @previous_node = nil
           node.children.each_with_index do |child, index|
-            visit child
+            visit child, node
             newline unless index == node.children.length - 1
+            @previous_node = child
           end
+          @previous_node = nil
         end
       when :or, :and
+        write "(" if parent_node&.type == :begin
         possible_output = capture do
-          visit node.children[0]
+          visit node.children[0], node
           if node.type == :or
             write " || "
           elsif node.type == :and
             write " && "
           end
-          visit node.children[1]
+          visit node.children[1], node
         end
-
-
         if @multiline_conditional_level > 0 # TODO track and check currently level
           write_multiline_conditional(node)
         elsif possible_output.length > MAX_LENGTH
@@ -298,41 +385,72 @@ module Prettyrb
         else
           write possible_output
         end
-      when :def
-        write "def "
-        write node.children[0].to_s
-        if node.children[1].children.length > 0
+        write ")" if parent_node&.type == :begin
+      when :def, :defs
+        newline unless @previous_node&.type.nil?
+        if node.type == :defs
+          write "def self."
+          method_name_node = node.children[1]
+          arguments_node = node.children[2]
+          body_node = node.children[3]
+        else
+          write "def "
+          method_name_node = node.children[0]
+          arguments_node = node.children[1]
+          body_node = node.children[2]
+        end
+
+        write method_name_node.to_s
+
+        if arguments_node.children.length > 0 || arguments_node.type != :args
           write "("
-          visit node.children[1]
+          visit arguments_node, node
           write ")"
         end
         newline
 
-        indent do
-          visit node.children[2]
+        if body_node
+          indent do
+            visit body_node, node
+          end
+
+          newline
         end
 
-        newline
         write "end"
       when :args
         node.children.each_with_index do |child, index|
-          visit child
+          visit child, node
           write ", " unless index == node.children.length - 1
         end
       when :arg
         write node.children[0].to_s
-      when :lvar
+      when :lvar, :gvar
         write node.children[0].to_s
       when :self
         "self"
       when :sym
-        write ":"
-        write node.children[0].to_s
+        content = node.children[0].to_s
+
+        # TODO handle already quoted symbols
+        if !VALID_SYMBOLS.include?(content) && !content.match?(/\A[a-zA-Z_]{1}[a-zA-Z0-9_!?]*\z/)
+          content = "'#{content}'"
+          write ":"
+          write content
+        else
+          if parent_node&.type == :pair
+            write content
+            write ": "
+          else
+            write ":"
+            write content
+          end
+        end
       when :return
         write "return"
 
         possible_output = capture do
-          visit node.children[0]
+          visit node.children[0], node
         end
 
         if !possible_output.start_with?("\n")
@@ -340,63 +458,193 @@ module Prettyrb
         end
       when :case
         write "case "
-        visit node.children[0]
+        visit node.children[0], node
         newline
         node.children[1..-1].each do |child|
-          if child.type != :when
+          if child && child.type != :when
             write "else"
             newline
 
             indent do
-              visit child
+              visit child, node
             end
           else
-            visit child
-            newline
+            if child
+              visit child, node
+              newline
+            end
           end
         end
         write "end"
+      when :regexp
+        write '/'
+        node.children[0...-1].map do |child_node|
+          if child_node.type == :str
+            write child_node.children[0].to_s
+          else
+            visit child_node, node
+          end
+        end
+        write '/'
+        visit node.children[-1], node
+      when :regopt
+        node.children.map { |child| child.to_s }.join('')
       when :when
-        write "when "
-        visit node.children[0]
+        write "when"
+
+        indent do
+          splittable_separated_map(node, node.children[0..-2], skip_last_multiline_separator: true, write_space_if_single_line: true)
+        end
+
         newline
         indent do
-          visit node.children[1]
+          visit node.children[-1], node
+        end
+      when :or_asgn, :and_asgn
+        newline if @previous_node && ![:ivasgn, :or_asgn, :lvasgn, :op_asgn].include?(@previous_node.type)
+        visit node.children[0], node
+        if node.type == :or_asgn
+          write " ||= " # TODO handle long lines here too
+        elsif node.type == :and_asgn
+          write " &&= " # TODO handle long lines here too
         end
-      when :or_asgn
-        visit node.children[0]
-        write " ||= " # TODO handle long lines here too
-        visit node.children[1]
+        visit node.children[1], node
       when :ivasgn
+        newline if @previous_node && ![:ivasgn, :or_asgn, :lvasgn, :op_asgn].include?(@previous_node.type)
         write node.children[0].to_s
+
+        if node.children[1]
+          write " = "
+          visit node.children[1], node
+        end
+      when :csend
+        visit node.children[0], node
+        write "&."
+        write node.children[1].to_s
       when :ivar
         write node.children[0].to_s
       when :blockarg
+        write '&'
         write node.children[0].to_s
       when :yield
+        newline unless @previous_node.nil? || [:op_asgn, :lvasgn, :or_asgn, :and_asgn].include?(@previous_node.type)
         write "yield"
       when :op_asgn
-        visit node.children[0]
+        newline if @previous_node && ![:ivasgn, :or_asgn, :lvasgn, :op_asgn].include?(@previous_node.type)
+        visit node.children[0], node
         write " "
         write node.children[1].to_s
+        write "="
         write " "
-        visit node.children[2]
+        visit node.children[2], node
       when :lvasgn
+        newline if @previous_node && ![:ivasgn, :or_asgn, :lvasgn, :op_asgn].include?(@previous_node.type)
         write node.children[0].to_s
-        write " = "
-
-        visit node.children[1]
+        if node.children[1]
+          write " = "
+          visit node.children[1], node
+        end
       when :irange
-        visit node.children[0]
+        visit node.children[0], node unless node.children[0].nil?
         write ".."
-        visit node.children[1]
+        visit node.children[1], node unless node.children[1].nil?
+      when :erange
+        visit node.children[0], node unless node.children[0].nil?
+        write "..."
+        visit node.children[1], node unless node.children[1].nil?
+      when :hash
+        if node.children.length == 0
+          write "{}"
+        else
+          write "{"
+
+          result = indent do
+            splittable_separated_map(node, node.children, write_space_if_single_line: true)
+          end
+
+          if result == MULTI_LINE
+            newline
+            write "}"
+          else
+            write " }"
+          end
+        end
+      when :pair
+        visit node.children[0], node
+        if node.children[0].type != :sym
+          write " => "
+        end
+        visit node.children[1], node
+      when :splat
+        write "*"
+        visit node.children[0], node
+      when :defined?
+        write "defined?("
+        visit node.children[0], node
+        write ")"
+      when :complex,
+        :dsym,
+        :xstr,
+        :'nth-ref',
+        :'back-ref',
+        :gvasgn,
+        :mlhs,
+        :procarg0,
+        :shadowarg
+        raise "implement me, #{node.inspect}"
+      when :sclass
+        write "class << "
+        visit node.children[0], node
+        newline
+
+        indent do
+          visit node.children[1], node if node.children[1]
+        end
+
+        newline if node.children[1]
+        write "end"
+      when :undef
+        write "undef "
+        node.children.each_with_index do |child_node, index|
+          visit child_node, node
+          write ", " unless index == node.children.length - 1
+        end
+      when :alias
+        write 'alias '
+        visit node.children[0], node
+        write ' '
+        visit node.children[1], node
+      when :restarg
+        write "*"
+        write node.children[0].to_s
+      when :optarg
+        write node.children[0].to_s
+        write " = "
+        visit node.children[1], node
+      when :kwsplat
+        write "**"
+        visit node.children[0], node
+      when :kwarg
+        write node.children[0].to_s
+        write ":"
+      when :forward_args, :forwarded_args
+        write "..."
+      when :kwoptarg
+        write node.children[0].to_s
+        write ": "
+        visit node.children[1], node
+      when :kwrestarg
+        write "**"
+        write node.children[0].to_s if node.children[0]
+      when :kwnilarg
+        write "**nil"
       else
         raise "unhandled node type `#{node.type}`\nnode: #{node}"
       end
     end
 
     def write_multiline_conditional(node)
-      visit node.children[0]
+      visit node.children[0], node
 
       if node.type == :or
         write " ||"
@@ -406,7 +654,40 @@ module Prettyrb
 
       newline
 
-      visit node.children[1]
+      visit node.children[1], node
+    end
+
+    def format_string(string)
+      raw_content = string.loc.expression.source
+      content = raw_content[1...-1]
+
+      if raw_content[0] == "'"
+        content.gsub('"', '\\"').gsub('#{', '\\#{')
+      else
+        content.gsub("\\", "\\\\")
+      end
+    end
+
+    def splittable_separated_map(current_node, mappable, separator: ", ", skip_last_multiline_separator: false, write_space_if_single_line: false)
+      one_line = capture do
+        mappable.each_with_index do |child_node, index|
+          visit child_node, current_node
+          write separator unless index == mappable.length - 1
+        end
+      end
+
+      if @current_line.length + one_line.length > MAX_LENGTH
+        mappable.each_with_index do |child_node, index|
+          newline
+          visit child_node, current_node
+          write separator.rstrip unless skip_last_multiline_separator && index == mappable.length - 1
+        end
+        MULTI_LINE
+      else
+        write ' ' if write_space_if_single_line
+        write one_line
+        SINGLE_LINE
+      end
     end
   end
 end

data/prettyrb.gemspec

@@ -39,4 +39,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "byebug", "~> 11.1"
+  spec.add_development_dependency "simplecov", "~> 0.18"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prettyrb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Blake Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-29 00:00:00.000000000 Z
+date: 2020-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
 description: Ruby source code formatter
 email:
 - blake@blakewilliams.me
@@ -104,6 +118,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -139,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby source code formatter