ast-navigator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2be55ad8331e21211a9c0cc73920f14750fb2c2
+  data.tar.gz: b165047e2a37bfef73a6ffe5ea37023cc05f96e3
+SHA512:
+  metadata.gz: 88f2ea7c6a193b92960471b556a28c237835b1c9dc07e663e86e66fd085ea114bab5e9c7756ede8a63832250896543fd9ce2d1f2eece9728a6b9bb1cd4fe3a52
+  data.tar.gz: d7c12d814e4ad802c707fbed91b9c973c8d9a7cd8390a33556fb4f6b0261851d2dfe6c67dc5259e3fb0e0e9b879384437829e8b1415e3363e4f0d52097cf2da4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ast-navigator.gemspec
+gemspec

data/README.md

@@ -0,0 +1,53 @@
+# AST::Navigator
+
+`AST::Navigator` provides some utility functions for `AST::Node` objects, including *parent(node)*, *ancestors(node)*, *siblings(node)*.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ast-navigator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ast-navigator
+
+## Usage
+
+```rb
+require "ast/navigator"
+
+navigator = AST::Navigator.new()
+
+# Add root node to navigator
+navigator.add_root_node(node)
+
+# Returns parent node or nil
+navigator.parent(node.children[0])
+
+# Returns array of ancestor nodes
+navigator.ancestors(node.children[0].children[1].children[3])
+
+# Yields child node of given node, non AST::Node children will be ignored
+navigator.each_child(node) do ... end
+
+# Yields sibling nodes of given node, non AST::Node siblings will be ignored
+navigator.each_sibling(node) do ... end
+```
+
+## 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/soutaro/ast-navigator.
+

data/Rakefile

@@ -0,0 +1,10 @@
+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/ast-navigator.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ast/navigator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ast-navigator"
+  spec.version       = AST::Navigator::VERSION
+  spec.authors       = ["Soutaro Matsumoto"]
+  spec.email         = ["matsumoto@soutaro.com"]
+
+  spec.summary       = %q{Utility functions for AST::Node}
+  spec.description   = %q{Utility functions for AST::Node}
+  spec.homepage      = "https://github.com/soutaro/ast-navigator"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "ast", "~> 2.3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ast/navigator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ast/navigator.rb

@@ -0,0 +1,102 @@
+require "ast/navigator/version"
+
+require "set"
+
+module AST
+  class Navigator
+    attr_reader :parents
+    attr_reader :roots
+
+    def initialize()
+      @parents = {}
+      @roots = {}
+    end
+
+    def add_root_node(node)
+      roots[node.__id__] = node
+
+      node.children.each do |child|
+        if child.is_a?(AST::Node)
+          add_node(child, node)
+        end
+      end
+    end
+
+    def parent(node)
+      parents[node.__id__]
+    end
+
+    def ancestors(node)
+      ancestors = []
+
+      current_node = node
+      while current_node
+        ancestors.unshift current_node
+        current_node = parent(current_node)
+      end
+
+      ancestors
+    end
+
+    def each_subnode(node, &block)
+      if block_given?
+        each_child(node) do |child|
+          yield child
+          each_subnode child, &block
+        end
+      else
+        enum_for :each_subnode, node
+      end
+    end
+
+    def root?(node)
+      roots.key?(node.__id__)
+    end
+
+    def member?(node)
+      parent(node) || root?(node)
+    end
+
+    def each_root(&block)
+      if block_given?
+        roots.values.each(&block)
+      else
+        enum_for :each_root
+      end
+    end
+
+    def each_child(node, &block)
+      if block_given?
+        node.children.select {|child| child.is_a?(AST::Node) }.each(&block)
+      else
+        enum_for :each_child, node
+      end
+    end
+
+    def each_sibling(node, &block)
+      if block_given?
+        parent = parent(node)
+
+        if parent
+          each_child(parent, &block)
+        else
+          []
+        end
+      else
+        enum_for :each_sibling, node
+      end
+    end
+
+    private
+
+    def add_node(node, parent)
+      parents[node.__id__] = parent
+
+      node.children.each do |child|
+        if child.is_a?(AST::Node)
+          add_node(child, node)
+        end
+      end
+    end
+  end
+end

data/lib/ast/navigator/version.rb

@@ -0,0 +1,5 @@
+module AST
+  class Navigator
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: ast-navigator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Soutaro Matsumoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Utility functions for AST::Node
+email:
+- matsumoto@soutaro.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- ast-navigator.gemspec
+- bin/console
+- bin/setup
+- lib/ast/navigator.rb
+- lib/ast/navigator/version.rb
+homepage: https://github.com/soutaro/ast-navigator
+licenses: []
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Utility functions for AST::Node
+test_files: []