prettyrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6627cfb70e4dee209000644f4be5d57d6794c240fda5767b4b85d877c7cb2ed5
+  data.tar.gz: ae15fc8e9b154777b0bdaad845047b8a8c6709ee0e8e7616bcabb77cf12f3f06
+SHA512:
+  metadata.gz: 5e0543768d14fbb1fa9715a2c1657bbcc4d376939e342cd7badc14cddde7a0b8c8354d3ead3321b0a14ad5143fae8381c4eaf55e4d3c66785ac0eb8300ae75d7
+  data.tar.gz: 7d186ac5763c031e88d4357d00cae4afe6ba002d1a82381bf8f00b8050b8c33ca9e3f9a4ca8dde1312488fba002196544ffea134bdb144cefca2a05350a55c13

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in prettyrb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    prettyrb (0.1.0)
+      ruby_parser (~> 3.14)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.0)
+    rake (10.5.0)
+    ruby_parser (3.14.2)
+      sexp_processor (~> 4.9)
+    sexp_processor (4.14.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  prettyrb!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Blake Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Prettyrb
+
+Super experimental gem for auto-formatting Ruby files. Pronounced "pretty-erb"
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prettyrb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prettyrb
+
+## Usage
+
+```ruby
+PrettyRb.new(source_code).format
+```
+
+CLI helper coming soon™
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "prettyrb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/prettyrb/version.rb

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

data/lib/prettyrb.rb

@@ -0,0 +1,191 @@
+require "ruby_parser"
+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
+
+  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
+
+      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
+end

data/prettyrb.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "prettyrb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "prettyrb"
+  spec.version       = Prettyrb::VERSION
+  spec.authors       = ["Blake Williams"]
+  spec.email         = ["blake@blakewilliams.me"]
+
+  spec.summary       = %q{Ruby source code formatter}
+  spec.description   = %q{Ruby source code formatter}
+  spec.homepage      = "https://github.com/blakewilliams/prettyrb"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ruby_parser", "~> 3.14"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: prettyrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Blake Williams
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Ruby source code formatter
+email:
+- blake@blakewilliams.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/prettyrb.rb
+- lib/prettyrb/version.rb
+- prettyrb.gemspec
+homepage: https://github.com/blakewilliams/prettyrb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/blakewilliams/prettyrb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Ruby source code formatter
+test_files: []