syntax_tree 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/dependabot.yml +6 -0
- data/.github/workflows/main.yml +32 -0
- data/.gitignore +10 -0
- data/CHANGELOG.md +16 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +10 -0
- data/Gemfile.lock +43 -0
- data/LICENSE +21 -0
- data/README.md +68 -0
- data/Rakefile +12 -0
- data/bin/bench +37 -0
- data/bin/console +8 -0
- data/bin/profile +19 -0
- data/bin/setup +6 -0
- data/exe/stree +84 -0
- data/lib/syntax_tree/prettyprint.rb +1132 -0
- data/lib/syntax_tree/version.rb +7 -0
- data/lib/syntax_tree.rb +13191 -0
- data/syntax_tree.gemspec +30 -0
- metadata +120 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: e3977b8a9642c86ca56b63f93e541a7b9bdee08eef9d705f0540e4c1d6e95222
|
4
|
+
data.tar.gz: b550f2a31561c3a06ca456005419a0743f5d62e60360797e70fa42cc075a603e
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 1cab71763cb9cb537fb209fb175bc36074e58da9c7535d788911bb4d0e36a8ce28628eeae283d468d957c6c38549b33245dd7e6e07c749c725609fb53bd8ef5c
|
7
|
+
data.tar.gz: b49ee91795fa64acd80d8cb5c244ff30fbbacc711da907c14f81f4f9cb7632c71cc3a6ae9d609224c4adcbdc54bfa89bb5f1b47ec17601653cdf059b8389feae
|
@@ -0,0 +1,32 @@
|
|
1
|
+
name: Main
|
2
|
+
on:
|
3
|
+
- push
|
4
|
+
- pull_request_target
|
5
|
+
jobs:
|
6
|
+
ci:
|
7
|
+
name: CI
|
8
|
+
runs-on: ubuntu-latest
|
9
|
+
env:
|
10
|
+
CI: true
|
11
|
+
steps:
|
12
|
+
- uses: actions/checkout@master
|
13
|
+
- uses: ruby/setup-ruby@v1
|
14
|
+
with:
|
15
|
+
bundler-cache: true
|
16
|
+
ruby-version: 3.0
|
17
|
+
- name: Test
|
18
|
+
run: bundle exec rake test
|
19
|
+
automerge:
|
20
|
+
name: AutoMerge
|
21
|
+
needs: ci
|
22
|
+
runs-on: ubuntu-latest
|
23
|
+
if: github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]'
|
24
|
+
steps:
|
25
|
+
- uses: actions/github-script@v3
|
26
|
+
with:
|
27
|
+
script: |
|
28
|
+
github.pulls.merge({
|
29
|
+
owner: context.payload.repository.owner.login,
|
30
|
+
repo: context.payload.repository.name,
|
31
|
+
pull_number: context.payload.pull_request.number
|
32
|
+
})
|
data/.gitignore
ADDED
data/CHANGELOG.md
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
# Changelog
|
2
|
+
|
3
|
+
All notable changes to this project will be documented in this file.
|
4
|
+
|
5
|
+
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).
|
6
|
+
|
7
|
+
## [Unreleased]
|
8
|
+
|
9
|
+
## [0.1.0] - 2021-11-16
|
10
|
+
|
11
|
+
### Added
|
12
|
+
|
13
|
+
- 🎉 Initial release! 🎉
|
14
|
+
|
15
|
+
[unreleased]: https://github.com/kddnewton/syntax_tree/compare/v0.1.0...HEAD
|
16
|
+
[0.1.0]: https://github.com/kddnewton/syntax_tree/compare/8aa1f5...v0.1.0
|
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at kddnewton@gmail.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [https://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: https://contributor-covenant.org
|
74
|
+
[version]: https://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,43 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
syntax_tree (0.1.0)
|
5
|
+
|
6
|
+
GEM
|
7
|
+
remote: https://rubygems.org/
|
8
|
+
specs:
|
9
|
+
ast (2.4.2)
|
10
|
+
benchmark-ips (2.9.2)
|
11
|
+
docile (1.4.0)
|
12
|
+
minitest (5.14.4)
|
13
|
+
parser (3.0.3.1)
|
14
|
+
ast (~> 2.4.1)
|
15
|
+
rake (13.0.6)
|
16
|
+
ruby_parser (3.18.1)
|
17
|
+
sexp_processor (~> 4.16)
|
18
|
+
sexp_processor (4.16.0)
|
19
|
+
simplecov (0.21.2)
|
20
|
+
docile (~> 1.1)
|
21
|
+
simplecov-html (~> 0.11)
|
22
|
+
simplecov_json_formatter (~> 0.1)
|
23
|
+
simplecov-html (0.12.3)
|
24
|
+
simplecov_json_formatter (0.1.3)
|
25
|
+
stackprof (0.2.17)
|
26
|
+
|
27
|
+
PLATFORMS
|
28
|
+
x86_64-darwin-19
|
29
|
+
x86_64-linux
|
30
|
+
|
31
|
+
DEPENDENCIES
|
32
|
+
benchmark-ips
|
33
|
+
bundler
|
34
|
+
minitest
|
35
|
+
parser
|
36
|
+
rake
|
37
|
+
ruby_parser
|
38
|
+
simplecov
|
39
|
+
stackprof
|
40
|
+
syntax_tree!
|
41
|
+
|
42
|
+
BUNDLED WITH
|
43
|
+
2.2.15
|
data/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2021-present Kevin Newton
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,68 @@
|
|
1
|
+
# SyntaxTree
|
2
|
+
|
3
|
+
[![Build Status](https://github.com/kddnewton/syntax_tree/workflows/Main/badge.svg)](https://github.com/kddnewton/syntax_tree/actions)
|
4
|
+
[![Gem Version](https://img.shields.io/gem/v/syntax_tree.svg)](https://rubygems.org/gems/syntax_tree)
|
5
|
+
|
6
|
+
A fast ripper subclass used for parsing and formatting Ruby code.
|
7
|
+
|
8
|
+
## Installation
|
9
|
+
|
10
|
+
Add this line to your application's Gemfile:
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
gem "syntax_tree"
|
14
|
+
```
|
15
|
+
|
16
|
+
And then execute:
|
17
|
+
|
18
|
+
$ bundle install
|
19
|
+
|
20
|
+
Or install it yourself as:
|
21
|
+
|
22
|
+
$ gem install syntax_tree
|
23
|
+
|
24
|
+
## Usage
|
25
|
+
|
26
|
+
From code:
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require "syntax_tree"
|
30
|
+
|
31
|
+
pp SyntaxTree.parse(source) # print out the AST
|
32
|
+
puts SyntaxTree.format(source) # format the AST
|
33
|
+
```
|
34
|
+
|
35
|
+
From the CLI:
|
36
|
+
|
37
|
+
```sh
|
38
|
+
$ stree ast program.rb
|
39
|
+
(program
|
40
|
+
(statements
|
41
|
+
...
|
42
|
+
```
|
43
|
+
|
44
|
+
or
|
45
|
+
|
46
|
+
```sh
|
47
|
+
$ stree format program.rb
|
48
|
+
class MyClass
|
49
|
+
...
|
50
|
+
```
|
51
|
+
|
52
|
+
## Development
|
53
|
+
|
54
|
+
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.
|
55
|
+
|
56
|
+
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).
|
57
|
+
|
58
|
+
## Contributing
|
59
|
+
|
60
|
+
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).
|
61
|
+
|
62
|
+
## License
|
63
|
+
|
64
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
65
|
+
|
66
|
+
## Code of Conduct
|
67
|
+
|
68
|
+
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
ADDED
data/bin/bench
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
require 'bundler/setup'
|
5
|
+
require 'benchmark/ips'
|
6
|
+
|
7
|
+
require_relative '../lib/syntax_tree'
|
8
|
+
require 'ruby_parser'
|
9
|
+
require 'parser/current'
|
10
|
+
|
11
|
+
def compare(filepath)
|
12
|
+
prefix = "#{File.expand_path('..', __dir__)}/"
|
13
|
+
puts "=== #{filepath.delete_prefix(prefix)} ==="
|
14
|
+
|
15
|
+
source = File.read(filepath)
|
16
|
+
|
17
|
+
Benchmark.ips do |x|
|
18
|
+
x.report('syntax_tree') { SyntaxTree.new(source).parse }
|
19
|
+
x.report('parser') { Parser::CurrentRuby.parse(source) }
|
20
|
+
x.report('ruby_parser') { RubyParser.new.parse(source) }
|
21
|
+
x.compare!
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
filepaths = ARGV
|
26
|
+
|
27
|
+
# If the user didn't supply any files to parse to benchmark, then we're going to
|
28
|
+
# default to parsing this file and the main syntax_tree file (a small and large
|
29
|
+
# file).
|
30
|
+
if filepaths.empty?
|
31
|
+
filepaths = [
|
32
|
+
File.expand_path('bench', __dir__),
|
33
|
+
File.expand_path('../lib/syntax_tree.rb', __dir__)
|
34
|
+
]
|
35
|
+
end
|
36
|
+
|
37
|
+
filepaths.each { |filepath| compare(filepath) }
|
data/bin/console
ADDED
data/bin/profile
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
require 'bundler/setup'
|
5
|
+
require 'stackprof'
|
6
|
+
|
7
|
+
filepath = File.expand_path('../lib/syntax_tree', __dir__)
|
8
|
+
require_relative filepath
|
9
|
+
|
10
|
+
GC.disable
|
11
|
+
|
12
|
+
StackProf.run(mode: :cpu, out: "tmp/profile.dump", raw: true) do
|
13
|
+
SyntaxTree.format(File.read("#{filepath}.rb"))
|
14
|
+
end
|
15
|
+
|
16
|
+
GC.enable
|
17
|
+
|
18
|
+
`bundle exec stackprof --d3-flamegraph tmp/profile.dump > tmp/flamegraph.html`
|
19
|
+
puts "open tmp/flamegraph.html"
|
data/bin/setup
ADDED
data/exe/stree
ADDED
@@ -0,0 +1,84 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
require_relative File.expand_path("../lib/syntax_tree", __dir__)
|
5
|
+
|
6
|
+
help = <<~EOF
|
7
|
+
stree MDOE FILE
|
8
|
+
|
9
|
+
MODE: one of "a", "ast", "d", "doc", "f", "format", "w", or "write"
|
10
|
+
FILE: one or more paths to files to parse
|
11
|
+
EOF
|
12
|
+
|
13
|
+
if ARGV.length < 2
|
14
|
+
warn(help)
|
15
|
+
exit(1)
|
16
|
+
end
|
17
|
+
|
18
|
+
module SyntaxTree::CLI
|
19
|
+
class AST
|
20
|
+
def run(filepath)
|
21
|
+
pp SyntaxTree.parse(File.read(filepath))
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
class Doc
|
26
|
+
def run(filepath)
|
27
|
+
formatter = SyntaxTree::Formatter.new([])
|
28
|
+
SyntaxTree.parse(File.read(filepath)).format(formatter)
|
29
|
+
pp formatter.groups.first
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
class Format
|
34
|
+
def run(filepath)
|
35
|
+
puts SyntaxTree.format(File.read(filepath))
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
class Write
|
40
|
+
def run(filepath)
|
41
|
+
File.write(filepath, SyntaxTree.format(File.read(filepath)))
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
mode =
|
47
|
+
case ARGV.shift
|
48
|
+
when "a", "ast"
|
49
|
+
SyntaxTree::CLI::AST.new
|
50
|
+
when "d", "doc"
|
51
|
+
SyntaxTree::CLI::Doc.new
|
52
|
+
when "f", "format"
|
53
|
+
SyntaxTree::CLI::Format.new
|
54
|
+
when "w", "write"
|
55
|
+
SyntaxTree::CLI::Write.new
|
56
|
+
else
|
57
|
+
warn(help)
|
58
|
+
exit(1)
|
59
|
+
end
|
60
|
+
|
61
|
+
queue = Queue.new
|
62
|
+
ARGV.each { |pattern| Dir[pattern].each { |filepath| queue << filepath } }
|
63
|
+
|
64
|
+
if queue.size <= 1
|
65
|
+
filepath = queue.shift
|
66
|
+
mode.run(filepath) if File.file?(filepath)
|
67
|
+
return
|
68
|
+
end
|
69
|
+
|
70
|
+
count = [8, queue.size].min
|
71
|
+
threads =
|
72
|
+
count.times.map do
|
73
|
+
Thread.new do
|
74
|
+
loop do
|
75
|
+
filepath = queue.shift
|
76
|
+
break if filepath == :exit
|
77
|
+
|
78
|
+
mode.run(filepath) if File.file?(filepath)
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
82
|
+
|
83
|
+
count.times { queue << :exit }
|
84
|
+
threads.each(&:join)
|