astarisk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89c3ad862d9e7f790afd1b44a6d596f6fd1a8e26fe112513af7cff6babffdc3c
+  data.tar.gz: f63aa540c158fc02fdec3e4000afa68a6b5b2b319cc658ef59c0ace2a8d40733
+SHA512:
+  metadata.gz: d53e9fcd2d09bbd110807fe414940b9e84512107576336b08cb5cc340c37328ccd4133c2ac78ee5c6104cf87414a855c8264492c43180992c68bf3a222f9541f
+  data.tar.gz: 0eac090ddb93559896f5df6bd70ef18d90102ee11a8c135d02522373c0e3d34db22afc20f056cc772233359fc528b9dde49d89ea3193e6808c54cc2ad6f667fc

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*~
+Gemfile.lock
+.ruby-version

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 astarisk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TAGOMORI Satoshi
+
+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,95 @@
+# Astarisk
+
+Astarisk is a tool to visualize `RubyVM::AbstractSyntaxTree` nodes on console.
+
+That is named as "AST a risk".
+
+NOTE: `RubyVM::AbstractSyntaxTree` is defined as `RubyVM::AST` in Ruby 2.6.0 preview3, but it'll be renamed to `RubyVM::AbstractSyntaxTree` in later versions.
+
+## Usage
+
+**NOTE: Use Ruby 2.6.0 preview3 or later**
+
+1. Get an AST using methods blow:
+ * `RubyVM::AbstractSyntaxTree#parse` (from ruby code)
+ * `RubyVM::AbstractSyntaxTree#parse_file` (from file path)
+ * `RubyVM::AbstractSyntaxTree#of` (from an object of Method or Proc)
+2. Get a graph string
+ * `Astarisk.draw_graph(ast)`
+3. Or draw graph on STDERR (in default)
+ * `Astarisk.draw(ast)`
+
+Output example from a blank Proc object:
+
+```
+[NODE_SCOPE]
+ |
+ +--[]
+ |
+ +--[NODE_ARGS]
+ |   |
+ |   +--Integer(0)
+ |   |
+ |   +--NilClass(nil)
+ |   |
+ |   +--NilClass(nil)
+ |   |
+ |   +--NilClass(nil)
+ |   |
+ |   +--Integer(0)
+ |   |
+ |   +--NilClass(nil)
+ |   |
+ |   +--NilClass(nil)
+ |   |
+ |   +--NilClass(nil)
+ |   |
+ |   +--NilClass(nil)
+ |   |
+ |   +--NilClass(nil)
+ |
+ +--[NODE_BEGIN]
+     |
+     +--NilClass(nil)
+```
+
+Output example in compact format:
+
+```
+[NODE_SCOPE]
+ +--[]
+ +--[NODE_ARGS]
+ |   +--Integer(0)
+ |   +--NilClass(nil)
+ |   +--NilClass(nil)
+ |   +--NilClass(nil)
+ |   +--Integer(0)
+ |   +--NilClass(nil)
+ |   +--NilClass(nil)
+ |   +--NilClass(nil)
+ |   +--NilClass(nil)
+ |   +--NilClass(nil)
+ +--[NODE_BEGIN]
+     +--NilClass(nil)
+```
+
+## Methods
+
+### Astarisk.draw
+
+Draw a graph on specified I/O destination (default: STDERR)
+
+Arguments:
+ * AST node (an instance of `RubyVM::AbstractSyntaxTree::Node`)
+
+Keyword arguments:
+ * out: output I/O to draw graph (default: `STDERR`)
+ * mode: symbol to specify `:compact` mode (default: `:normal`)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tagomoris/astarisk.
+
+## 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,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/**/test_*.rb']
+  test.warning = true
+  test.verbose = true
+end
+
+task :default => :test

data/astarisk.gemspec

@@ -0,0 +1,25 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "astarisk/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "astarisk"
+  spec.version       = Astarisk::VERSION
+  spec.authors       = ["TAGOMORI Satoshi"]
+  spec.email         = ["tagomoris@gmail.com"]
+
+  spec.summary       = %q{AST visualizer}
+  spec.description   = %q{Draw a graph of node tree of RubyVM::AbstractSyntaxTree}
+  spec.homepage      = "https://github.com/tagomoris/astarisk"
+  spec.license       = "MIT"
+
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit"
+end

data/lib/astarisk.rb

@@ -0,0 +1,58 @@
+require "astarisk/version"
+
+if !RubyVM.const_defined?("AbstractSyntaxTree") && !RubyVM.const_defined?("AST")
+  raise "use Ruby 2.6.0-preview3 or later"
+end
+
+if !RubyVM.const_defined?("AbstractSyntaxTree") && RubyVM.const_defined?("AST")
+  RubyVM.const_set("AbstractSyntaxTree", RubyVM::AST)
+end
+
+module Astarisk
+  def self.draw(node, out: STDERR, mode: :normal)
+    STDERR.print draw_graph(node, mode: mode)
+  end
+
+  def self.stringify_node(node)
+    case node
+    when RubyVM::AbstractSyntaxTree::Node
+      "[#{node.type}]\n"
+    when Array
+      node.to_s + "\n"
+    else
+      "#{node.class.to_s}(#{node.inspect})\n"
+    end
+  end
+
+  BAR_TOKEN  = " |\n".freeze
+  NODE_TOKEN = " +--".freeze
+  BAR_SPACE  = " |  ".freeze
+  JUST_SPACE = "    ".freeze
+
+  def self.draw_graph(node, mode: :normal)
+    if !node.is_a?(RubyVM::AbstractSyntaxTree::Node)
+      return stringify_node(node)
+    end
+    if node.children.empty?
+      return stringify_node(node)
+    end
+
+    buffer = String.new(encoding: Encoding::UTF_8)
+    buffer << stringify_node(node)
+
+    num_children = node.children.size
+    num_children.times do |i|
+      terminal = (num_children == i + 1)
+      child_graph_lines = draw_graph(node.children[i], mode: mode).lines
+      buffer << BAR_TOKEN unless mode == :compact
+      buffer << NODE_TOKEN + child_graph_lines.shift
+      if terminal
+        buffer << child_graph_lines.map{|line| JUST_SPACE + line }.join
+      else
+        buffer << child_graph_lines.map{|line| BAR_SPACE + line }.join
+      end
+    end
+
+    buffer
+  end
+end

data/lib/astarisk/version.rb

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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: astarisk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Draw a graph of node tree of RubyVM::AbstractSyntaxTree
+email:
+- tagomoris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- astarisk.gemspec
+- lib/astarisk.rb
+- lib/astarisk/version.rb
+homepage: https://github.com/tagomoris/astarisk
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: AST visualizer
+test_files: []