syntax_tree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3977b8a9642c86ca56b63f93e541a7b9bdee08eef9d705f0540e4c1d6e95222
+  data.tar.gz: b550f2a31561c3a06ca456005419a0743f5d62e60360797e70fa42cc075a603e
+SHA512:
+  metadata.gz: 1cab71763cb9cb537fb209fb175bc36074e58da9c7535d788911bb4d0e36a8ce28628eeae283d468d957c6c38549b33245dd7e6e07c749c725609fb53bd8ef5c
+  data.tar.gz: b49ee91795fa64acd80d8cb5c244ff30fbbacc711da907c14f81f4f9cb7632c71cc3a6ae9d609224c4adcbdc54bfa89bb5f1b47ec17601653cdf059b8389feae

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/main.yml

@@ -0,0 +1,32 @@
+name: Main
+on:
+- push
+- pull_request_target
+jobs:
+  ci:
+    name: CI
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+    - uses: actions/checkout@master
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: 3.0
+    - name: Test
+      run: bundle exec rake test
+  automerge:
+    name: AutoMerge
+    needs: ci
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]'
+    steps:
+    - uses: actions/github-script@v3
+      with:
+        script: |
+          github.pulls.merge({
+            owner: context.payload.repository.owner.login,
+            repo: context.payload.repository.name,
+            pull_number: context.payload.pull_request.number
+          })

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2021-11-16
+
+### Added
+
+- 🎉 Initial release! 🎉
+
+[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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kddnewton@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "benchmark-ips"
+gem "parser"
+gem "ruby_parser"
+gem "stackprof"

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    syntax_tree (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    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.3)
+    stackprof (0.2.17)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  benchmark-ips
+  bundler
+  minitest
+  parser
+  rake
+  ruby_parser
+  simplecov
+  stackprof
+  syntax_tree!
+
+BUNDLED WITH
+   2.2.15

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021-present Kevin Newton
+
+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,68 @@
+# SyntaxTree
+
+[![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 parsing and formatting Ruby code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "syntax_tree"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install syntax_tree
+
+## Usage
+
+From code:
+
+```ruby
+require "syntax_tree"
+
+pp SyntaxTree.parse(source) # print out the AST
+puts SyntaxTree.format(source) # format the AST
+```
+
+From the CLI:
+
+```sh
+$ stree ast program.rb
+(program
+  (statements
+    ...
+```
+
+or
+
+```sh
+$ stree format program.rb
+class MyClass
+  ...
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+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 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).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+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/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) }

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'syntax_tree'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/profile

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'stackprof'
+
+filepath = File.expand_path('../lib/syntax_tree', __dir__)
+require_relative filepath
+
+GC.disable
+
+StackProf.run(mode: :cpu, out: "tmp/profile.dump", raw: true) do
+  SyntaxTree.format(File.read("#{filepath}.rb"))
+end
+
+GC.enable
+
+`bundle exec stackprof --d3-flamegraph tmp/profile.dump > tmp/flamegraph.html`
+puts "open tmp/flamegraph.html"

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/stree

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative File.expand_path("../lib/syntax_tree", __dir__)
+
+help = <<~EOF
+  stree MDOE FILE
+
+  MODE: one of "a", "ast", "d", "doc", "f", "format", "w", or "write"
+  FILE: one or more paths to files to parse
+EOF
+
+if ARGV.length < 2
+  warn(help)
+  exit(1)
+end
+
+module SyntaxTree::CLI
+  class AST
+    def run(filepath)
+      pp SyntaxTree.parse(File.read(filepath))
+    end
+  end
+
+  class Doc
+    def run(filepath)
+      formatter = SyntaxTree::Formatter.new([])
+      SyntaxTree.parse(File.read(filepath)).format(formatter)
+      pp formatter.groups.first
+    end
+  end
+
+  class Format
+    def run(filepath)
+      puts SyntaxTree.format(File.read(filepath))
+    end
+  end
+
+  class Write
+    def run(filepath)
+      File.write(filepath, SyntaxTree.format(File.read(filepath)))
+    end
+  end
+end
+
+mode =
+  case ARGV.shift
+  when "a", "ast"
+    SyntaxTree::CLI::AST.new
+  when "d", "doc"
+    SyntaxTree::CLI::Doc.new
+  when "f", "format"
+    SyntaxTree::CLI::Format.new
+  when "w", "write"
+    SyntaxTree::CLI::Write.new
+  else
+    warn(help)
+    exit(1)
+  end
+
+queue = Queue.new
+ARGV.each { |pattern| Dir[pattern].each { |filepath| queue << filepath } }
+
+if queue.size <= 1
+  filepath = queue.shift
+  mode.run(filepath) if File.file?(filepath)
+  return
+end
+
+count = [8, queue.size].min
+threads =
+  count.times.map do
+    Thread.new do
+      loop do
+        filepath = queue.shift
+        break if filepath == :exit
+
+        mode.run(filepath) if File.file?(filepath)
+      end
+    end
+  end
+
+count.times { queue << :exit }
+threads.each(&:join)