node_visitor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a596ef648c5a209a47fa0355a8956a14df436f9b82d178560323809387a235aa
+  data.tar.gz: 98d3fe4e938c5d841c9d1e34c037cdfa1f1c209cf521c005f732d07cefc8da65
+SHA512:
+  metadata.gz: beb38d152e58c83c48c7a1d714b4ba635e6ce226e804d04e00b38568afc6b10f6f4a82e9074ac1e998d30ebd0ff2cdcb271c09748cdb2e3993a132d3e9f4ab06
+  data.tar.gz: 5ad89b6ee986b7ac6a7d4ff7834905633a5302018a2e23de16769dab74bd3798ac4ace624f6c5641db3f2ef26de833914b710ca7bc744f7ddb65255c01460732

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 1.0.0 (2024-04-27)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in node_visitor.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem 'parser_node_ext'
+gem 'prism_ext'
+gem 'syntax_tree_ext'

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    node_visitor (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.1)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    parser_node_ext (1.3.2)
+      parser
+    prettier_print (1.2.1)
+    prism (0.27.0)
+    prism_ext (0.3.2)
+      prism
+    racc (1.7.3)
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    syntax_tree (6.2.0)
+      prettier_print (>= 1.2.0)
+    syntax_tree_ext (0.8.2)
+      syntax_tree
+
+PLATFORMS
+  ruby
+  x86_64-darwin-23
+
+DEPENDENCIES
+  node_visitor!
+  parser_node_ext
+  prism_ext
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  syntax_tree_ext
+
+BUNDLED WITH
+   2.3.7

data/README.md

@@ -0,0 +1,68 @@
+# NodeVisitor
+
+[![Build Status](https://github.com/synvert-hq/node-visitor-ruby/actions/workflows/main.yml/badge.svg)](https://github.com/synvert-hq/node-visitor-ruby/actions/workflows/main.yml)
+[![Gem Version](https://img.shields.io/gem/v/node_visitor.svg)](https://rubygems.org/gems/node_visitor)
+
+NodeVisitor allows you to define callbacks based on node type, then visit the AST nodes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'node_visitor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install node_visitor
+
+## Usage
+
+1. initialize the visitor
+
+```ruby
+visitor = NodeVisitor.new(adapter: 'prism')
+```
+
+2. add callbacks
+
+```ruby
+# this will be triggered when it starts to visit class_node
+visitor.add_callback(:class_node, at: 'start') do |node|
+  node.name # get the name of class node
+end
+
+# this will be triggered after it finishes to visit class_node
+visitor.add_callback(:class_node, at: 'end') do |node|
+  node.name # get the name of class node
+end
+```
+
+There is a special node type, `:all`, which is triggered before or after visiting all nodes.
+
+```ruby
+# this will be triggered after it finishes to visit all nodes
+visitor.add_callback(:class_node, at: 'end') do
+end
+```
+
+3. visit the AST node
+
+```ruby
+visitor.visit(node)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/synvert-hq/node_visitor.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/node_visitor/adapter/parser.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'parser'
+require 'parser_node_ext'
+
+class NodeVisitor::ParserAdapter
+  def is_node?(node)
+    node.is_a?(Parser::AST::Node)
+  end
+
+  def get_node_type(node)
+    node.type
+  end
+
+  def get_children(node)
+    node.children
+  end
+end

data/lib/node_visitor/adapter/prism.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'prism'
+require 'prism_ext'
+
+class NodeVisitor::PrismAdapter
+  def is_node?(node)
+    node.is_a?(Prism::Node)
+  end
+
+  def get_node_type(node)
+    node.type
+  end
+
+  def get_children(node)
+    keys = []
+    children = []
+    node.deconstruct_keys([]).each do |key, value|
+      next if [:flags, :location].include?(key)
+
+      if key.to_s.end_with?('_loc')
+        new_key = key.to_s[0..-5]
+        unless keys.include?(new_key)
+          keys << new_key
+          children << node.send(new_key)
+        end
+      else
+        unless keys.include?(key.to_s)
+          keys << key.to_s
+          children << value
+        end
+      end
+    end
+    children
+  end
+end

data/lib/node_visitor/adapter/syntax_tree.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'syntax_tree'
+require 'syntax_tree_ext'
+
+class NodeVisitor::SyntaxTreeAdapter
+  def is_node?(node)
+    node.is_a?(SyntaxTree::Node)
+  end
+
+  def get_node_type(node)
+    node.class.name.split('::').last.to_sym
+  end
+
+  def get_children(node)
+    node.deconstruct_keys([]).filter { |key, _value| ![:location, :comments].include?(key) }
+        .values
+  end
+end

data/lib/node_visitor/adapter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Abstract Adapter class
+class NodeVisitor::Adapter
+  # Check if it is a node
+  # @return [Boolean]
+  def is_node?(node)
+    raise NotImplementedError, 'get_node_type is not implemented'
+  end
+
+  # Get the type of node
+  # @param node [Node] ast node
+  # @return [Symbol] node type
+  def get_node_type(node)
+    raise NotImplementedError, 'get_node_type is not implemented'
+  end
+
+  # Get the children of node
+  # @param node [Node] ast node
+  # @return [Array<Node>] node children
+  def get_children(node)
+    raise NotImplementedError, 'get_children is not implemented'
+  end
+end

data/lib/node_visitor/version.rb

@@ -0,0 +1,3 @@
+class NodeVisitor
+  VERSION = "1.0.0"
+end

data/lib/node_visitor.rb

@@ -0,0 +1,55 @@
+require_relative "node_visitor/version"
+
+class NodeVisitor
+  class InvalidAdapterError < StandardError; end
+
+  autoload :Adapter, "node_visitor/adapter"
+  autoload :ParserAdapter, "node_visitor/adapter/parser"
+  autoload :PrismAdapter, "node_visitor/adapter/prism"
+  autoload :SyntaxTreeAdapter, "node_visitor/adapter/syntax_tree"
+
+  def initialize(adapter:)
+    @adapter = get_adapter_instance(adapter)
+    @callbacks = {}
+  end
+
+  def add_callback(node_type, at:, &block)
+    @callbacks[node_type] ||= []
+    @callbacks[node_type] << { block: block, at: at }
+  end
+
+  def visit(node, block_context = self)
+    callbacks = @callbacks[:all]
+    callbacks.each { |callback| block_context.instance_exec(node, &callback[:block]) if callback[:at] == 'start' } if callbacks
+    visit_node(node)
+    callbacks.each { |callback| block_context.instance_exec(node, &callback[:block]) if callback[:at] == 'end' } if callbacks
+  end
+
+  private
+
+  def get_adapter_instance(adapter)
+    case adapter.to_sym
+    when :parser
+      ParserAdapter.new
+    when :syntax_tree
+      SyntaxTreeAdapter.new
+    when :prism
+      PrismAdapter.new
+    else
+      raise InvalidAdapterError, "adapter #{adapter} is not supported"
+    end
+  end
+
+  def visit_node(node)
+    if node.is_a?(Array)
+      node.each { |child_node| visit_node(child_node) }
+      return
+    end
+    return unless @adapter.is_node?(node)
+
+    callbacks = @callbacks[@adapter.get_node_type(node)]
+    callbacks.each { |callback| instance_exec(node, &callback[:block]) if callback[:at] == 'start' } if callbacks
+    @adapter.get_children(node).each { |child_node| visit_node(child_node) }
+    callbacks.each { |callback| instance_exec(node, &callback[:block]) if callback[:at] == 'end' } if callbacks
+  end
+end

data/node_visitor.gemspec

@@ -0,0 +1,32 @@
+
+require_relative "lib/node_visitor/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "node_visitor"
+  spec.version = NodeVisitor::VERSION
+  spec.authors = ["Richard Huang"]
+  spec.email = ["flyerhzm@gmail.com"]
+
+  spec.summary = "visit ast nodes"
+  spec.description = "visit ast nodes"
+  spec.homepage = "https://github.com/synvert-hq/node-visitor-ruby"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/synvert-hq/node-visitor-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/synvert-hq/node-visitor-ruby/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: node_visitor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Richard Huang
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-27 00:00:00.000000000 Z
+dependencies: []
+description: visit ast nodes
+email:
+- flyerhzm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/node_visitor.rb
+- lib/node_visitor/adapter.rb
+- lib/node_visitor/adapter/parser.rb
+- lib/node_visitor/adapter/prism.rb
+- lib/node_visitor/adapter/syntax_tree.rb
+- lib/node_visitor/version.rb
+- node_visitor.gemspec
+homepage: https://github.com/synvert-hq/node-visitor-ruby
+licenses: []
+metadata:
+  homepage_uri: https://github.com/synvert-hq/node-visitor-ruby
+  source_code_uri: https://github.com/synvert-hq/node-visitor-ruby
+  changelog_uri: https://github.com/synvert-hq/node-visitor-ruby/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: visit ast nodes
+test_files: []