syntax_tree-translator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fff2de442626d6c24ef93737c1f5c67378c0ae6cc6e6178fc37f0bf8b7e481c2
+  data.tar.gz: cf26490e749feff3973697e6430315745531d2422bbfad968b4a16e82048f3dc
+SHA512:
+  metadata.gz: 0cb26c6e535bb0c9ac35f8cc70e8731aab49cf00877ed11ceb9b5603b4b49c65f6a0c5ba0d08a560daf06c860380cbf3dba37b13aa04db7caeed3e4742aba572
+  data.tar.gz: f164933fc32106a8dbd0787b847066c47277b3f81b54dbf2703bd1d1f340c00d0fb7e4982ce7313a22e81a11d8804d1e5c2005a06b32579281c7b05401f97aa2

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,34 @@
+name: Main
+on:
+- push
+- pull_request_target
+jobs:
+  ci:
+    name: CI
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+    - uses: actions/checkout@master
+      with:
+        submodules: recursive
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: '3.1'
+    - 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,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/rdocs/
+/spec/reports/
+/tmp/
+/vendor/
+
+test.rb

data/.gitmodules

@@ -0,0 +1,6 @@
+[submodule "suites/parser"]
+	path = suites/parser
+	url = https://github.com/whitequark/parser
+[submodule "suites/ruby_parser"]
+	path = suites/ruby_parser
+	url = https://github.com/seattlerb/ruby_parser

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] - 2022-04-20
+
+### Added
+
+- 🎉 Initial release! 🎉
+
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree-translator/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/ruby-syntax-tree/syntax_tree-translator/compare/d80468...v0.1.0

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    syntax_tree-translator (0.1.0)
+      parser
+      rubocop-ast
+      ruby_parser
+      syntax_tree
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    docile (1.4.0)
+    minitest (5.15.0)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rake (13.0.6)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby_parser (3.19.1)
+      sexp_processor (~> 4.16)
+    sexp_processor (4.16.1)
+    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.4)
+    syntax_tree (2.2.0)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  minitest
+  rake
+  simplecov
+  syntax_tree-translator!
+
+BUNDLED WITH
+   2.3.6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-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,74 @@
+# SyntaxTree::Translator
+
+[![Build Status](https://github.com/ruby-syntax-tree/syntax_tree-translator/actions/workflows/main.yml/badge.svg)](https://github.com/ruby-syntax-tree/syntax_tree-translator/actions/workflows/main.yml)
+[![Gem Version](https://img.shields.io/gem/v/syntax_tree-translator.svg)](https://rubygems.org/gems/syntax_tree-translator)
+
+Translate [Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree) syntax trees into other Ruby parser syntax trees.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "syntax_tree-translator"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install syntax_tree-translator
+
+## Usage
+
+First, you need to get the source code that you'd like to translate into a syntax tree. Then you need to parse it using Syntax Tree's parse method, as in:
+
+```ruby
+source = ARGF.read
+program = SyntaxTree.parse(source)
+```
+
+From there, you now have a `SyntaxTree::Program` node representing the top of your syntax tree. You can translate that into another format by using one of the provided visitors. Each is detailed below.
+
+### parser
+
+To translate into the [whitequark/parser](https://github.com/whitequark/parser) gem's syntax tree, instantiate a new source buffer, pass that along with the filename and line number into a new visitor, and call visit.
+
+```ruby
+buffer = Parser::Source::Buffer.new("(string)")
+buffer.source = source
+
+visitor = SyntaxTree::Translator::Parser.new(buffer)
+node = visitor.visit(program)
+```
+
+### rubocop-ast
+
+To translate into the [rubocop/rubocop-ast](https://github.com/rubocop/rubocop-ast) gem's syntax tree (the one used internally by rubocop), you do pretty much the exact same thing as `parser`, except that it generates more specific node types with helper methods.
+
+```ruby
+buffer = Parser::Source::Buffer.new("(string)")
+buffer.source = source
+
+visitor = SyntaxTree::Translator::RuboCop.new(buffer)
+node = visitor.visit(program)
+```
+
+### ruby_parser
+
+To translate into the [seattlerb/ruby_parser](https://github.com/seattlerb/ruby_parser) gem's syntax tree you instantiate a new visitor and pass it the program instance.
+
+```ruby
+visitor = SyntaxTree::Translator::RubyParser.new
+node = visitor.visit(program)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby-syntax-tree/syntax_tree-translator.
+
+## 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,22 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+
+  # This is the list of tests from our translator gem itself.
+  file_list = FileList["test/**/*_test.rb"]
+
+  # This is a big test file from the parser gem that tests its functionality.
+  file_list << "suites/parser/test/test_parser.rb"
+
+  # This is a big test file from the ruby_parser gem that tests its
+  # functionality.
+  file_list << "suites/ruby_parser/test/test_ruby_parser.rb"
+
+  t.test_files = file_list
+end
+
+task default: :test

data/bin/compare-p

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "parser/current"
+
+$:.unshift(File.expand_path("../lib", __dir__))
+require "syntax_tree/translator"
+
+# First, opt in to every AST feature.
+Parser::Builders::Default.modernize
+
+# Modify the source map == check so that it doesn't check against the node
+# itself so we don't get into a recursive loop.
+# Parser::Source::Map.prepend(
+#   Module.new {
+#     def ==(other)
+#       self.class == other.class &&
+#         (instance_variables - %i[@node]).map do |ivar|
+#           instance_variable_get(ivar) == other.instance_variable_get(ivar)
+#         end.reduce(:&)
+#     end
+#   }
+# )
+
+# Next, ensure that we're comparing the nodes and also comparing the source
+# ranges so that we're getting all of the necessary information.
+# Parser::AST::Node.prepend(
+#   Module.new {
+#     def ==(other)
+#       super && (location == other.location)
+#     end
+#   }
+# )
+
+source = ARGF.read
+
+parser = Parser::CurrentRuby.new
+parser.diagnostics.all_errors_are_fatal = true
+
+buffer = Parser::Source::Buffer.new("(string)", 1)
+buffer.source = source.dup.force_encoding(parser.default_encoding)
+
+visitor = SyntaxTree::Translator::Parser.new(buffer)
+stree = visitor.visit(SyntaxTree.parse(source))
+ptree = parser.parse(buffer)
+
+if stree == ptree
+  puts "Syntax trees are equivalent."
+else
+  warn "Syntax trees are different."
+
+  warn "syntax_tree:"
+  pp stree
+
+  warn "parser:"
+  pp ptree
+end

data/bin/compare-rp

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+$:.unshift(File.expand_path("../lib", __dir__))
+require "syntax_tree/translator"
+require "ruby_parser"
+
+source = ARGF.read
+
+visitor = SyntaxTree::Translator::RubyParser.new
+stree = visitor.visit(SyntaxTree.parse(source))
+rptree = RubyParser.for_current_ruby.parse(source)
+
+if stree == rptree
+  puts "Syntax trees are equivalent."
+else
+  warn "Syntax trees are different."
+
+  warn "syntax_tree:"
+  pp stree
+
+  warn "ruby_parser:"
+  pp rptree
+end

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+$:.unshift(File.expand_path("../lib", __dir__))
+require "syntax_tree/translator"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rubocop

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/inline"
+gemfile do
+  source "https://rubygems.org"
+  gem "rubocop"
+  gem "syntax_tree"
+end
+
+$:.unshift File.expand_path("../lib", __dir__)
+require "syntax_tree/translator"
+
+class RuboCop::AST::ProcessedSource
+  private
+
+  def tokenize(parser)
+    visitor = SyntaxTree::Translator::RuboCop.new(@buffer, "(string)", 1)
+
+    ast = visitor.visit(SyntaxTree.parse(@buffer.source))
+    ast.complete!
+
+    _, comments, tokens = parser.tokenize(@buffer)
+    tokens.map! { |t| RuboCop::AST::Token.from_parser_token(t) }
+
+    [ast, comments, tokens]
+  rescue Parser::SyntaxError
+    [nil, [], []]
+  end
+end
+
+exit(RuboCop::CLI.new.run)