prettyrb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6627cfb70e4dee209000644f4be5d57d6794c240fda5767b4b85d877c7cb2ed5
-  data.tar.gz: ae15fc8e9b154777b0bdaad845047b8a8c6709ee0e8e7616bcabb77cf12f3f06
+  metadata.gz: ea94d815e156b5294c602a74176b57ad6d7f368dbba00e9f5435fec4921c5bb5
+  data.tar.gz: 5e58bd43571e3565dc88bf97fa5f36204f09edd68b7aa15190e1a58a2c9aa6b8
 SHA512:
-  metadata.gz: 5e0543768d14fbb1fa9715a2c1657bbcc4d376939e342cd7badc14cddde7a0b8c8354d3ead3321b0a14ad5143fae8381c4eaf55e4d3c66785ac0eb8300ae75d7
-  data.tar.gz: 7d186ac5763c031e88d4357d00cae4afe6ba002d1a82381bf8f00b8050b8c33ca9e3f9a4ca8dde1312488fba002196544ffea134bdb144cefca2a05350a55c13
+  metadata.gz: 002b78f6a4ad5b5f94c05ac6fd78e685bddc9901b8dc6d29e5170da65933b3159c04c76d5d38a2a4ec645b5936bcb44cc8fae273a39dafbef8a4fd7d1d691100
+  data.tar.gz: ba85b4cc39ace86efe1639e83e7e307ea2a7b22e0b8574fcc490e9ed848bb71dacab2040592729fe0b24c6962a9eab4031f5ccf96a78bcf35f30ebc5387642d6

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/Gemfile.lock

@@ -2,25 +2,29 @@ PATH
   remote: .
   specs:
     prettyrb (0.1.0)
-      ruby_parser (~> 3.14)
+      parser (~> 2.7.0.5)
+      thor
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
+    byebug (11.1.1)
     minitest (5.14.0)
-    rake (10.5.0)
-    ruby_parser (3.14.2)
-      sexp_processor (~> 4.9)
-    sexp_processor (4.14.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    rake (12.3.3)
+    thor (1.0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.17)
+  byebug (~> 11.1)
   minitest (~> 5.0)
   prettyrb!
-  rake (~> 10.0)
+  rake (~> 12.3.3)
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -1,6 +1,8 @@
 # Prettyrb
 
-Super experimental gem for auto-formatting Ruby files. Pronounced "pretty-erb"
+Super experimental gem for auto-formatting Ruby files. AKA the code isn't great, but things are kind of working.
+
+Pronounced "pretty-erb".
 
 ## Installation
 

data/exe/prettyrb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "prettyrb"
+require "prettyrb/cli"
+
+Prettyrb::CLI.start

data/lib/prettyrb/cli.rb

@@ -0,0 +1,11 @@
+require "thor"
+
+module Prettyrb
+  class CLI < Thor
+    desc "format FILE", "file to prettify"
+    def format(file)
+      content = File.read(file)
+      puts Prettyrb::Formatter.new(content).format
+    end
+  end
+end

data/lib/prettyrb/formatter.rb

@@ -0,0 +1,34 @@
+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)
+
+      visitor = Visitor.new
+      visitor.visit(root_node)
+
+      visitor.output
+    end
+
+    private
+
+    def format_type(node, indentation)
+      case node.node_type
+      when :if
+        IfFormatter.new(node, indentation).format
+      else
+        raise "can't handle #{node}"
+      end
+    end
+
+    attr_reader :code
+  end
+end

data/lib/prettyrb/version.rb

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

data/lib/prettyrb/visitor.rb

@@ -0,0 +1,412 @@
+module Prettyrb
+  class Visitor
+    MAX_LENGTH = 100
+
+    attr_reader :output
+
+    def initialize
+      @indent_level = 0
+      @output = ""
+
+      @newline = true
+      @multiline_conditional_level = 0
+      @__current_node = nil
+    end
+
+    def indents
+      '  ' * @indent_level
+    end
+
+    def dedent(&block)
+      old_indent_level = @indent_level
+
+      @indent_level = [0, @indent_level - 1].max
+      yield
+      @indent_level = old_indent_level
+    end
+
+    def indent(&block)
+      old_indent_level = @indent_level
+
+      @indent_level += 1
+      yield
+      @indent_level = old_indent_level
+    end
+
+    def multiline_conditional_level
+      @multiline_conditional_level
+    end
+
+    def in_multiline_conditional(&block)
+      old_multiline_condtiional_level = @multiline_conditional_level
+      @multiline_conditional_level += 1
+      @multiline_condtiional_level = 0
+      yield
+      @multiline_conditional_level = old_multiline_condtiional_level
+    end
+
+    def capture(&block)
+      old_newline = @newline
+      old_output = @output
+
+      @output = ""
+
+      yield
+
+      @output.tap do |output|
+        @output = old_output
+        @newline = old_newline
+      end
+    end
+
+    def newline
+      @output << "\n"
+      @newline = true
+    end
+
+    def write(input)
+      if @newline
+        @output << indents
+      end
+      @newline = false
+      @output << input
+    end
+
+    def visit(node)
+      @previous_node = @__current_node
+      @__current_node = node
+
+      case node.type
+      when :module
+        write "module "
+        visit node.children[0]
+        newline
+
+        indent do
+          visit node.children[1]
+        end
+
+        write "end"
+        newline
+      when :class
+        write "class "
+        visit node.children[0]
+        newline
+        # TODO handle children[1] which is inheritance
+
+        indent do
+          visit node.children[2]
+        end
+
+        newline unless @output.end_with?("\n")
+        write "end"
+        newline
+      when :const
+        write node.children[1].to_s
+      when :casgn
+        write node.children[1].to_s
+        write " = "
+        visit node.children[2]
+      when :block
+        visit node.children[0]
+        write " do"
+
+        if node.children[1].children.length > 0
+          write " |"
+          visit node.children[1]
+          write "|"
+        end
+
+        newline
+
+        indent do
+          visit node.children[2]
+        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
+          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
+            end
+            write ")"
+          end
+
+          newline if @previous_node.type == :class 
+        else
+          visit node.children[0]
+          write "."
+          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
+            end
+            write ")"
+          end
+        end
+      when :if
+        write "if"
+        indent do
+          conditions = capture do
+            visit node.children[0]
+          end
+
+          if !conditions.start_with?("\n")
+            write(" ")
+          end
+          write conditions
+
+          newline
+
+          if node.children[1]
+            visit node.children[1]
+            newline
+          end
+        end
+
+        if node.children[2]
+          if node.children[2] == :if
+            write "elsif"
+            visit node.children[2]
+          else
+            write "else"
+            newline
+
+            indent do
+              visit node.children[2]
+            end
+          end
+          newline
+        end
+
+        write "end"
+      when :true
+        write "true"
+      when :false
+        write "false"
+      when :nil
+        write "nil"
+      when :int
+        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
+          write "["
+          newline
+
+          indent do
+            node.children.map do |child|
+              visit(child)
+              write ","
+              newline
+            end
+          end
+
+          write "]"
+        else
+          write possible_output.lstrip
+        end
+      when :str
+        write '"'
+        write node.children[0].gsub("\n", "\\n")
+        write '"'
+      when :dstr
+        write "\""
+        node.children.map do |child|
+          if child.type == :str
+            write child.children[0]
+            write child.children[0].gsub("\n", "\\n")
+          else
+            write '#{'
+            visit child
+            write '}'
+          end
+        end
+        write "\""
+      when :begin
+        if @previous_node.type == :or || @previous_node.type == :and
+          write "("
+          node.children.map { |child| visit child }
+          write ")"
+        else
+          node.children.each_with_index do |child, index|
+            visit child
+            newline unless index == node.children.length - 1
+          end
+        end
+      when :or, :and
+        possible_output = capture do
+          visit node.children[0]
+          if node.type == :or
+            write " || "
+          elsif node.type == :and
+            write " && "
+          end
+          visit node.children[1]
+        end
+
+
+        if @multiline_conditional_level > 0 # TODO track and check currently level
+          write_multiline_conditional(node)
+        elsif possible_output.length > MAX_LENGTH
+          in_multiline_conditional do
+            newline
+            write_multiline_conditional(node)
+          end
+
+          dedent do
+            newline
+            write "then"
+          end
+        else
+          write possible_output
+        end
+      when :def
+        write "def "
+        write node.children[0].to_s
+        if node.children[1].children.length > 0
+          write "("
+          visit node.children[1]
+          write ")"
+        end
+        newline
+
+        indent do
+          visit node.children[2]
+        end
+
+        newline
+        write "end"
+      when :args
+        node.children.each_with_index do |child, index|
+          visit child
+          write ", " unless index == node.children.length - 1
+        end
+      when :arg
+        write node.children[0].to_s
+      when :lvar
+        write node.children[0].to_s
+      when :self
+        "self"
+      when :sym
+        write ":"
+        write node.children[0].to_s
+      when :return
+        write "return"
+
+        possible_output = capture do
+          visit node.children[0]
+        end
+
+        if !possible_output.start_with?("\n")
+          write " "
+        end
+      when :case
+        write "case "
+        visit node.children[0]
+        newline
+        node.children[1..-1].each do |child|
+          if child.type != :when
+            write "else"
+            newline
+
+            indent do
+              visit child
+            end
+          else
+            visit child
+            newline
+          end
+        end
+        write "end"
+      when :when
+        write "when "
+        visit node.children[0]
+        newline
+        indent do
+          visit node.children[1]
+        end
+      when :or_asgn
+        visit node.children[0]
+        write " ||= " # TODO handle long lines here too
+        visit node.children[1]
+      when :ivasgn
+        write node.children[0].to_s
+      when :ivar
+        write node.children[0].to_s
+      when :blockarg
+        write node.children[0].to_s
+      when :yield
+        write "yield"
+      when :op_asgn
+        visit node.children[0]
+        write " "
+        write node.children[1].to_s
+        write " "
+        visit node.children[2]
+      when :lvasgn
+        write node.children[0].to_s
+        write " = "
+
+        visit node.children[1]
+      when :irange
+        visit node.children[0]
+        write ".."
+        visit node.children[1]
+      else
+        raise "unhandled node type `#{node.type}`\nnode: #{node}"
+      end
+    end
+
+    def write_multiline_conditional(node)
+      visit node.children[0]
+
+      if node.type == :or
+        write " ||"
+      elsif node.type == :and
+        write " &&"
+      end
+
+      newline
+
+      visit node.children[1]
+    end
+  end
+end

data/lib/prettyrb.rb

@@ -1,191 +1,11 @@
-require "ruby_parser"
+require "parser/current"
 require "prettyrb/version"
 
-module Prettyrb
-  class Error < StandardError; end
-
-  class Formatter
-    def self.for(sexp)
-      case sexp.sexp_type
-      when :if
-        IfFormatter
-      when :str
-        StringFormatter
-      when :or
-        OrFormatter
-      when :and
-        AndFormatter
-      when :lit
-        LitFormatter
-      when :call
-        CallFormatter
-      when :class
-        ClassFormatter
-      when :cdecl
-        CdeclFormatter
-      when :array
-        ArrayFormatter
-      else
-        raise "can't handle #{sexp}"
-      end
-    end
-
-    def initialize(code)
-      @code = code
-    end
-
-    def format
-      sexp_tree = RubyParser.new.parse(@code)
-
-      self.class.for(sexp_tree).new(sexp_tree, 0, nil).format
-    end
-
-    private
-
-    def format_type(sexp, indentation)
-      case sexp.sexp_type
-      when :if
-        IfFormatter.new(sexp, indentation).format
-      else
-        raise "can't handle #{sexp}"
-      end
-    end
-
-    attr_reader :code
-  end
-
-  class BaseFormatter
-    attr_reader :sexp, :indentation, :parent
-
-    def initialize(sexp, indentation, parent)
-      @sexp = sexp
-      @indentation = indentation
-      @parent = parent
-    end
-
-    def type
-      sexp.sexp_type
-    end
-
-    def indents
-      ' ' * indentation
-    end
-  end
-
-  class LitFormatter < BaseFormatter
-    def format
-      sexp[1]
-    end
-  end
-
-  class StringFormatter < BaseFormatter
-    def format
-      if parent.type == :array
-        "\"#{sexp[1]}\""
-      else
-        "#{indents}\"#{sexp[1]}\""
-      end
-    end
-  end
-
-  class IfFormatter < BaseFormatter
-    def format
-      start = "#{' ' * @indentation}if "
-      condition = Formatter.for(sexp[1]).new(@sexp[1], @indentation + 2, self).format
-      body = Formatter.for(sexp[2]).new(@sexp[2], @indentation + 2, self).format
-      ending = "#{' ' * @indentation}end"
-
-      "#{start}#{condition}\n#{body}\n#{ending}"
-    end
-  end
+require "prettyrb/formatter"
+require "prettyrb/visitor"
 
-  class OrFormatter < BaseFormatter
-    def format
-      left = Formatter.for(sexp[1]).new(sexp[1], @indentation, self).format
-      right = Formatter.for(sexp[2]).new(sexp[2], @indentation, self).format
+require "prettyrb/cli"
 
-      if needs_parens?
-        "(#{left} || #{right})"
-      else
-        "#{left} || #{right}"
-      end
-    end
-
-    private
-
-    def needs_parens?
-      parent&.type == :or || parent&.type == :and
-    end
-  end
-
-  class AndFormatter < BaseFormatter
-    def format
-      left = Formatter.for(sexp[1]).new(sexp[1], @indentation, self).format
-      right = Formatter.for(sexp[2]).new(sexp[2], @indentation, self).format
-
-      if needs_parens?
-        "(#{left} && #{right})"
-      else
-        "#{left} && #{right}"
-      end
-    end
-
-    private
-
-    def needs_parens?
-      parent&.type == :or || parent&.type == :and
-    end
-  end
-
-  class CallFormatter < BaseFormatter
-    def format
-      if infix?
-        left = Formatter.for(sexp[1]).new(sexp[1], @indentation, self).format
-        right = Formatter.for(sexp[3]).new(sexp[3], @indentation, self).format
-
-        if needs_parens?
-          "(#{left} #{sexp[2]} #{right})"
-        else
-          "#{left} #{sexp[2]} #{right}"
-        end
-      else
-        content = Formatter.for(sexp[1]).new(sexp[1], @indentation, self).format
-        "#{content}.#{sexp[2]}"
-      end
-    end
-
-    private
-
-    def infix?
-      sexp.length == 4
-    end
-
-    def needs_parens?
-      parent&.type == :or || parent&.type == :and
-    end
-  end
-
-  class ClassFormatter < BaseFormatter
-    def format
-      content = Formatter.for(sexp[3]).new(sexp[3], indentation + 2, self).format
-      "#{indents}class #{sexp[1]}\n#{content}\n#{indents}end" # TODO handle inheritance
-    end
-  end
-
-  class CdeclFormatter < BaseFormatter
-    def format
-      content = Formatter.for(sexp[2]).new(sexp[2], indentation + 2, self).format
-      "#{indents}#{sexp[1]} = #{content}"
-    end
-  end
-
-  class ArrayFormatter < BaseFormatter
-    def format
-      elements = sexp[1..-1].map do |nested_sexp|
-        Formatter.for(nested_sexp).new(nested_sexp, indentation + 2, self).format
-      end
-
-      "[#{elements.join(", ")}]"
-    end
-  end
+module Prettyrb
+  class Error < StandardError; end
 end

data/prettyrb.gemspec

@@ -32,9 +32,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "ruby_parser", "~> 3.14"
+  spec.add_dependency "parser", "~> 2.7.0.5"
+  spec.add_dependency "thor"
 
   spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "byebug", "~> 11.1"
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: prettyrb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Blake Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-28 00:00:00.000000000 Z
+date: 2020-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ruby_parser
+  name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: 2.7.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: 2.7.0.5
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,13 +80,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
 description: Ruby source code formatter
 email:
 - blake@blakewilliams.me
-executables: []
+executables:
+- prettyrb
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -82,8 +112,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/prettyrb
 - lib/prettyrb.rb
+- lib/prettyrb/cli.rb
+- lib/prettyrb/formatter.rb
 - lib/prettyrb/version.rb
+- lib/prettyrb/visitor.rb
 - prettyrb.gemspec
 homepage: https://github.com/blakewilliams/prettyrb
 licenses: