Parsing

Author: kddnewton

.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+test.rb

CHANGELOG.md

@@ -6,11 +6,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
-## [0.1.0] - 2020-10-09
+## [0.1.0] - 2021-11-16
 
 ### Added
 
 - 🎉 Initial release! 🎉
 
-[unreleased]: https://github.com/kddeisz/template/compare/v0.1.0...HEAD
-[0.1.0]: https://github.com/kddeisz/template/compare/39c5a7...v0.1.0
+[unreleased]: https://github.com/kddnewton/syntax_tree/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/kddnewton/syntax_tree/compare/8aa1f5...v0.1.0

Gemfile

@@ -3,3 +3,7 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'benchmark-ips'
+gem 'parser'
+gem 'ruby_parser'

Gemfile.lock

@@ -1,30 +1,41 @@
 PATH
   remote: .
   specs:
-    template (0.1.0)
+    syntax_tree (0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    docile (1.3.5)
+    ast (2.4.2)
+    benchmark-ips (2.9.2)
+    docile (1.4.0)
     minitest (5.14.4)
+    parser (3.0.3.1)
+      ast (~> 2.4.1)
     rake (13.0.6)
+    ruby_parser (3.18.1)
+      sexp_processor (~> 4.16)
+    sexp_processor (4.16.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
+    simplecov_json_formatter (0.1.3)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
+  benchmark-ips
   bundler
   minitest
+  parser
   rake
+  ruby_parser
   simplecov
-  template!
+  syntax_tree!
 
 BUNDLED WITH
-   2.2.3
+   2.2.15

README.md

@@ -1,14 +1,16 @@
-# Template
+# SyntaxTree
 
-[![Build Status](https://github.com/kddnewton/ripper-parse_tree/workflows/Main/badge.svg)](https://github.com/kddnewton/ripper-parse_tree/actions)
-[![Gem Version](https://img.shields.io/gem/v/ripper-parse_tree.svg)](https://rubygems.org/gems/ripper-parse_tree)
+[![Build Status](https://github.com/kddnewton/syntax_tree/workflows/Main/badge.svg)](https://github.com/kddnewton/syntax_tree/actions)
+[![Gem Version](https://img.shields.io/gem/v/syntax_tree.svg)](https://rubygems.org/gems/syntax_tree)
+
+A fast ripper subclass used for generating syntax trees from Ruby code.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ripper-parse_tree'
+gem 'syntax_tree'
 ```
 
 And then execute:
@@ -17,10 +19,32 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install ripper-parse_tree
+    $ gem install syntax_tree
 
 ## Usage
 
+From code:
+
+```ruby
+require 'syntax_tree'
+
+parser = SyntaxTree.new(source)
+
+node = parser.parse
+raise if parser.error?
+
+pp node
+```
+
+From the CLI:
+
+```sh
+$ stree program.rb
+(program
+  (statements
+    ...
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -29,12 +53,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kddeisz/ripper-parse_tree. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/kddnewton/ripper-parse_tree/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/kddnewton/syntax_tree. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/kddnewton/syntax_tree/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Template project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kddeisz/ripper-parse_tree/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the syntax_tree project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kddnewton/syntax_tree/blob/main/CODE_OF_CONDUCT.md).

bin/bench

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'benchmark/ips'
+
+require_relative '../lib/syntax_tree'
+require 'ruby_parser'
+require 'parser/current'
+
+def compare(filepath)
+  prefix = "#{File.expand_path('..', __dir__)}/"
+  puts "=== #{filepath.delete_prefix(prefix)} ==="
+
+  source = File.read(filepath)
+
+  Benchmark.ips do |x|
+    x.report('syntax_tree') { SyntaxTree.new(source).parse }
+    x.report('parser') { Parser::CurrentRuby.parse(source) }
+    x.report('ruby_parser') { RubyParser.new.parse(source) }
+    x.compare!
+  end  
+end
+
+filepaths = ARGV
+
+# If the user didn't supply any files to parse to benchmark, then we're going to
+# default to parsing this file and the main syntax_tree file (a small and large
+# file).
+if filepaths.empty?
+  filepaths = [
+    File.expand_path('bench', __dir__),
+    File.expand_path('../lib/syntax_tree.rb', __dir__)
+  ]
+end
+
+filepaths.each { |filepath| compare(filepath) }

bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'ripper/parse_tree'
+require 'syntax_tree'
 
 require 'irb'
 IRB.start(__FILE__)

exe/stree

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative File.expand_path('../lib/syntax_tree', __dir__)
+pp SyntaxTree.new(ARGF.read).parse