ast 2.1.0 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2e3398752b5d18c8a0d8d92566ddb560f35391bc
-  data.tar.gz: 1d08b307064106e701044d3f640c5cac033148c6
+SHA256:
+  metadata.gz: 8210d16488dff96abdba806c27ddc7d9640e737050096441ec93dcff222b624c
+  data.tar.gz: e01089e2ec37377bf49160eebd8a277c4f481877e9cdfc4af977d860e7b516f0
 SHA512:
-  metadata.gz: 2dfe3fe6af1cbfc6c4ce5dde12c8c285c10a4249779e8442ecbe1a9a73301dcb7e5b6028ccf4e7a4c7686b353762475103f85c1216f7ee4a69a55d8d8b6a3169
-  data.tar.gz: 752a64d60bf8b65c20782343a653958458f224fb4b124d258e1edef86e2c7acbd95fc9c5eebabbd7ebe4ced860e6fd0280412d180a896aabe8320ec3dfdc7a30
+  metadata.gz: dc8e13d06da136e8de38ce6446f9260b35a1dbde3da47b558a256827df93a5d1bfa1130b07bc4fc326a0ac96dbdd112b330ec4b79a47cff647f7b48182803b65
+  data.tar.gz: 6afd93b25aa0d9061fdee5cebdd732303535107ecab668cc8dc37a49a0ee209d0906a9b8a415e1d4b62d4a5fd2b0f7da3263665a156aa9a57c24dd2f5ad89075

data/lib/ast/node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AST
   # Node is an immutable class, instances of which represent abstract
   # syntax tree nodes. It combines semantic information (i.e. anything
@@ -42,8 +44,17 @@ module AST
 
     # Returns the children of this node.
     # The returned value is frozen.
+    # The to_a alias is useful for decomposing nodes concisely.
+    # For example:
+    #
+    #     node = s(:gasgn, :$foo, s(:integer, 1))
+    #     var_name, value = *node
+    #     p var_name # => :$foo
+    #     p value    # => (integer 1)
+    #
     # @return [Array]
     attr_reader :children
+    alias to_a children
 
     # Returns the precomputed hash value for this node
     # @return [Fixnum]
@@ -80,7 +91,7 @@ module AST
     # By default, each entry in the `properties` hash is assigned to
     # an instance variable in this instance of Node. A subclass should define
     # attribute readers for such variables. The values passed in the hash
-    # are not frozen or whitelisted; such behavior can also be implemented\
+    # are not frozen or whitelisted; such behavior can also be implemented
     # by subclassing Node and overriding this method.
     #
     # @return [nil]
@@ -104,6 +115,7 @@ module AST
     def dup
       self
     end
+    alias :clone :dup
 
     # Returns a new instance of Node where non-nil arguments replace the
     # corresponding fields of `self`.
@@ -128,7 +140,9 @@ module AST
           properties.nil?
         self
       else
-        original_dup.send :initialize, new_type, new_children, new_properties
+        copy = original_dup
+        copy.send :initialize, new_type, new_children, new_properties
+        copy
       end
     end
 
@@ -166,58 +180,80 @@ module AST
 
     alias << append
 
-    # Converts `self` to a concise s-expression, omitting any children.
+    # Converts `self` to a pretty-printed s-expression.
     #
+    # @param  [Integer] indent Base indentation level.
     # @return [String]
-    def to_s
-      "(#{fancy_type} ...)"
-    end
+    def to_sexp(indent=0)
+      indented = "  " * indent
+      sexp = "#{indented}(#{fancy_type}"
 
-    # Returns {#children}. This is very useful in order to decompose nodes
-    # concisely. For example:
-    #
-    #     node = s(:gasgn, :$foo, s(:integer, 1))
-    #     s
-    #     var_name, value = *node
-    #     p var_name # => :$foo
-    #     p value    # => (integer 1)
-    #
-    # @return [Array]
-    def to_a
-      children
+      children.each do |child|
+        if child.is_a?(Node)
+          sexp += "\n#{child.to_sexp(indent + 1)}"
+        else
+          sexp += " #{child.inspect}"
+        end
+      end
+
+      sexp += ")"
+
+      sexp
     end
 
-    # Converts `self` to a pretty-printed s-expression.
+    alias to_s to_sexp
+
+    # Converts `self` to a s-expression ruby string.
+    # The code return will recreate the node, using the sexp module s()
     #
     # @param  [Integer] indent Base indentation level.
     # @return [String]
-    def to_sexp(indent=0)
+    def inspect(indent=0)
       indented = "  " * indent
-      sexp = "#{indented}(#{fancy_type}"
+      sexp = "#{indented}s(:#{@type}"
 
-      first_node_child = children.index do |child|
-        child.is_a?(Node) || child.is_a?(Array)
-      end || children.count
-
-      children.each_with_index do |child, idx|
-        if child.is_a?(Node) && idx >= first_node_child
-          sexp << "\n#{child.to_sexp(indent + 1)}"
+      children.each do |child|
+        if child.is_a?(Node)
+          sexp += ",\n#{child.inspect(indent + 1)}"
         else
-          sexp << " #{child.inspect}"
+          sexp += ", #{child.inspect}"
         end
       end
 
-      sexp << ")"
+      sexp += ")"
 
       sexp
     end
-    alias :inspect :to_sexp
 
     # @return [AST::Node] self
     def to_ast
       self
     end
 
+    # Converts `self` to an Array where the first element is the type as a Symbol,
+    # and subsequent elements are the same representation of its children.
+    #
+    # @return [Array<Symbol, [...Array]>]
+    def to_sexp_array
+      children_sexp_arrs = children.map do |child|
+        if child.is_a?(Node)
+          child.to_sexp_array
+        else
+          child
+        end
+      end
+
+      [type, *children_sexp_arrs]
+    end
+
+    # Enables matching for Node, where type is the first element
+    # and the children are remaining items.
+    #
+    # @return [Array]
+    def deconstruct
+      [type, *children]
+    end
+
     protected
 
     # Returns `@type` with all underscores replaced by dashes. This allows

data/lib/ast/processor/mixin.rb

@@ -23,7 +23,7 @@ module AST
     #     into a variable named `<string-literal>`,
     #   * `(load <string-literal>)`: loads value of a variable named
     #     `<string-literal>`,
-    #   * `(each <node> ...): computes each of the `<node>`s and
+    #   * `(each <node> ...)`: computes each of the `<node>`s and
     #     prints the result.
     #
     # All AST nodes have the same Ruby class, and therefore they don't
@@ -37,7 +37,7 @@ module AST
     #     require 'ast'
     #
     #     class ArithmeticsProcessor
-    #       include AST::Processor::Module
+    #       include AST::Processor::Mixin
     #       # This method traverses any binary operators such as (add)
     #       # or (multiply).
     #       def process_binary_op(node)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ast
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.4.2
 platform: ruby
 authors:
 - whitequark
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-03 00:00:00.000000000 Z
+date: 2021-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: bacon
   requirement: !ruby/object:Gem::Requirement
@@ -68,60 +68,18 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
-  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'
-- !ruby/object:Gem::Dependency
-  name: json_pure
-  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'
-- !ruby/object:Gem::Dependency
-  name: mime-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.25'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.25'
-- !ruby/object:Gem::Dependency
-  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: 0.8.23
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: 0.8.23
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -157,28 +115,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- ".yardopts"
-- CHANGELOG.md
-- Gemfile
 - LICENSE.MIT
 - README.YARD.md
-- README.md
-- Rakefile
-- ast.gemspec
 - lib/ast.rb
 - lib/ast/node.rb
 - lib/ast/processor.rb
 - lib/ast/processor/mixin.rb
 - lib/ast/sexp.rb
-- test/helper.rb
-- test/test_ast.rb
 homepage: https://whitequark.github.io/ast/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -193,10 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A library for working with Abstract Syntax Trees.
 test_files: []
-has_rdoc: 

data/.gitignore

@@ -1,8 +0,0 @@
-.bundle
-Gemfile.lock
-pkg/*
-.rbx/
-*.sublime-*
-doc/
-.yardoc/
-coverage/

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-rvm:
- - 1.8.7
- - 1.9.2
- - 1.9.3
- - 2.0
- - jruby-18mode
- - jruby-19mode
- - rbx-2

data/.yardopts

@@ -1 +0,0 @@
--r README.YARD.md -m markdown --protected

data/CHANGELOG.md

@@ -1,9 +0,0 @@
-Changelog
-=========
-
-v1.1.0 (2013-06-17)
--------------------
-
-API changes:
-
-  * AST::Processor#process will return nil if passed nil, instead of raising NoMethodError.

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in furnace.gemspec
-gemspec

data/README.md

@@ -1,23 +0,0 @@
-# AST
-
-[![Build Status](https://travis-ci.org/whitequark/ast.png?branch=master)](https://travis-ci.org/whitequark/ast)
-[![Code Climate](https://codeclimate.com/github/whitequark/ast.png)](https://codeclimate.com/github/whitequark/ast)
-[![Coverage Status](https://coveralls.io/repos/whitequark/ast/badge.png?branch=master)](https://coveralls.io/r/whitequark/ast)
-
-AST is a small library for working with immutable abstract syntax trees.
-
-## Installation
-
-    $ gem install ast
-
-## Usage
-
-See the documentation at [GitHub](http://whitequark.github.com/ast/frames.html) or [rdoc.info](http://rdoc.info/gems/ast).
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/Rakefile

@@ -1,19 +0,0 @@
-require 'bundler/gem_tasks'
-require 'bundler/setup'
-
-task :default => :test
-
-desc "Run test suite"
-task :test do
-  sh "bacon -Itest -a"
-end
-
-PAGES_REPO = 'git@github.com:whitequark/ast'
-
-desc "Build and deploy documentation to GitHub pages"
-task :pages do
-  system "git clone #{PAGES_REPO} gh-temp/ -b gh-pages; rm gh-temp/* -rf; touch gh-temp/.nojekyll" or abort
-  system "yardoc -o gh-temp/;" or abort
-  system "cd gh-temp/; git add -A; git commit -m 'Updated pages.'; git push -f origin gh-pages" or abort
-  FileUtils.rm_rf 'gh-temp'
-end

data/ast.gemspec

@@ -1,29 +0,0 @@
-Gem::Specification.new do |s|
-  s.name        = 'ast'
-  s.version     = '2.1.0'
-  s.license     = 'MIT'
-  s.authors     = ["whitequark"]
-  s.email       = ["whitequark@whitequark.org"]
-  s.homepage    = "https://whitequark.github.io/ast/"
-  s.summary     = %q{A library for working with Abstract Syntax Trees.}
-  s.description = s.summary
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.add_development_dependency 'rake',                '~> 10.0'
-
-  s.add_development_dependency 'bacon',               '~> 1.2'
-  s.add_development_dependency 'bacon-colored_output'
-  s.add_development_dependency 'simplecov'
-
-  s.add_development_dependency 'coveralls'
-  s.add_development_dependency 'json_pure' # for coveralls on 1.9.2
-  s.add_development_dependency 'mime-types', '~> 1.25' # for coveralls on 1.8.7
-  s.add_development_dependency 'rest-client', '~> 1.6.7' # 1.8.7
-
-  s.add_development_dependency 'yard'
-  s.add_development_dependency 'kramdown'
-end

data/test/helper.rb

@@ -1,17 +0,0 @@
-require 'bacon'
-require 'bacon/colored_output'
-
-require 'simplecov'
-require 'coveralls'
-
-SimpleCov.start do
-  self.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
-  ]
-
-  # Exclude the testsuite itself.
-  add_filter "/test/"
-end
-
-require 'ast'

data/test/test_ast.rb

@@ -1,243 +0,0 @@
-require 'helper'
-
-describe AST::Node do
-  extend AST::Sexp
-
-  class MetaNode < AST::Node
-    attr_reader :meta
-  end
-
-  before do
-    @node = AST::Node.new(:node, [ 0, 1 ])
-    @metanode = MetaNode.new(:node, [ 0, 1 ], :meta => 'value')
-  end
-
-  it 'should have accessors for type and children' do
-    @node.type.should.equal :node
-    @node.children.should.equal [0, 1]
-  end
-
-  it 'should set metadata' do
-    @metanode.meta.should.equal 'value'
-  end
-
-  it 'should be frozen' do
-    @node.frozen?.should.be.true
-    @node.children.frozen?.should.be.true
-  end
-
-  it 'should return self when duping' do
-    @node.dup.should.equal? @node
-  end
-
-  it 'should return an updated node, but only if needed' do
-    @node.updated().should.be.identical_to @node
-    @node.updated(:node).should.be.identical_to @node
-    @node.updated(nil, [0, 1]).should.be.identical_to @node
-
-    updated = @node.updated(:other_node)
-    updated.should.not.be.identical_to @node
-    updated.type.should.equal :other_node
-    updated.children.should.equal @node.children
-
-    updated.frozen?.should.be.true
-
-    updated = @node.updated(nil, [1, 1])
-    updated.should.not.be.identical_to @node
-    updated.type.should.equal @node.type
-    updated.children.should.equal [1, 1]
-
-    updated = @metanode.updated(nil, nil, :meta => 'other_value')
-    updated.meta.should.equal 'other_value'
-  end
-
-  it 'should use fancy type in to_s' do
-    node = AST::Node.new(:ast_node)
-    node.to_s.should.equal '(ast-node ...)'
-  end
-
-  it 'should format to_sexp correctly' do
-    AST::Node.new(:a, [ :sym, [ 1, 2 ] ]).to_sexp.should.equal '(a :sym [1, 2])'
-    AST::Node.new(:a, [ :sym, @node ]).to_sexp.should.equal "(a :sym\n  (node 0 1))"
-    AST::Node.new(:a, [ :sym,
-      AST::Node.new(:b, [ @node, @node ])
-    ]).to_sexp.should.equal "(a :sym\n  (b\n    (node 0 1)\n    (node 0 1)))"
-  end
-
-  it 'should return self in to_ast' do
-    @node.to_ast.should.be.identical_to @node
-  end
-
-  it 'should only use type and children to compute #hash' do
-    @node.hash.should.equal([@node.type, @node.children, @node.class].hash)
-  end
-
-  it 'should only use type and children in #eql? comparisons' do
-    # Not identical but equivalent
-    @node.eql?(AST::Node.new(:node, [0, 1])).should.be.true
-    # Not identical and not equivalent
-    @node.eql?(AST::Node.new(:other, [0, 1])).should.be.false
-    # Not identical and not equivalent because of differend class
-    @node.eql?(@metanode).should.be.false
-  end
-
-  it 'should only use type and children in #== comparisons' do
-    @node.should.equal @node
-    @node.should.equal @metanode
-    @node.should.not.equal :foo
-
-    mock_node = Object.new.tap do |obj|
-      def obj.to_ast
-        self
-      end
-
-      def obj.type
-        :node
-      end
-
-      def obj.children
-        [ 0, 1 ]
-      end
-    end
-    @node.should.equal mock_node
-  end
-
-  it 'should allow to decompose nodes with a, b = *node' do
-    node = s(:gasgn, :$foo, s(:integer, 1))
-
-    var_name, value = *node
-    var_name.should.equal :$foo
-    value.should.equal s(:integer, 1)
-  end
-
-  it 'should concatenate with arrays' do
-    node = s(:gasgn, :$foo)
-    (node + [s(:integer, 1)]).
-        should.equal s(:gasgn, :$foo, s(:integer, 1))
-  end
-
-  it 'should append elements' do
-    node = s(:array)
-    (node << s(:integer, 1) << s(:string, "foo")).
-        should.equal s(:array, s(:integer, 1), s(:string, "foo"))
-  end
-
-  begin
-    eval <<-CODE
-    it 'should not trigger a rubinius bug' do
-      bar = [ s(:bar, 1) ]
-      baz = s(:baz, 2)
-      s(:foo, *bar, baz).should.equal s(:foo, s(:bar, 1), s(:baz, 2))
-    end
-    CODE
-  rescue SyntaxError
-    # Running on 1.8, ignore.
-  end
-end
-
-describe AST::Processor do
-  extend AST::Sexp
-
-  def have_sexp(text)
-    text = text.lines.map { |line| line.sub /^ +\|(.+)/, '\1' }.join.rstrip
-    lambda { |ast| ast.to_sexp == text }
-  end
-
-  class MockProcessor < AST::Processor
-    attr_reader :counts
-
-    def initialize
-      @counts = Hash.new(0)
-    end
-
-    def on_root(node)
-      count_node(node)
-      node.updated(nil, process_all(node.children))
-    end
-    alias on_body on_root
-
-    def on_def(node)
-      count_node(node)
-      name, arglist, body = node.children
-      node.updated(:def, [ name, process(arglist), process(body) ])
-    end
-
-    def handler_missing(node)
-      count_node(node)
-    end
-
-    def count_node(node)
-      @counts[node.type] += 1; nil
-    end
-  end
-
-  before do
-    @ast = AST::Node.new(:root, [
-      AST::Node.new(:def, [ :func,
-        AST::Node.new(:arglist, [ :foo, :bar ]),
-        AST::Node.new(:body, [
-          AST::Node.new(:invoke, [ :puts, "Hello world" ])
-        ])
-      ]),
-      AST::Node.new(:invoke, [ :func ])
-    ])
-
-    @processor = MockProcessor.new
-  end
-
-  it 'should visit every node' do
-    @processor.process(@ast).should.equal @ast
-    @processor.counts.should.equal({
-      :root    => 1,
-      :def     => 1,
-      :arglist => 1,
-      :body    => 1,
-      :invoke  => 2,
-    })
-  end
-
-  it 'should be able to replace inner nodes' do
-    def @processor.on_arglist(node)
-      node.updated(:new_fancy_arglist)
-    end
-
-    @processor.process(@ast).should have_sexp(<<-SEXP)
-    |(root
-    |  (def :func
-    |    (new-fancy-arglist :foo :bar)
-    |    (body
-    |      (invoke :puts "Hello world")))
-    |  (invoke :func))
-    SEXP
-  end
-
-  it 'should build sexps' do
-    s(:add,
-      s(:integer, 1),
-      s(:multiply,
-        s(:integer, 2),
-        s(:integer, 3))).should have_sexp(<<-SEXP)
-    |(add
-    |  (integer 1)
-    |  (multiply
-    |    (integer 2)
-    |    (integer 3)))
-    SEXP
-  end
-
-  it 'should return nil if passed nil' do
-    @processor.process(nil).should == nil
-  end
-
-  it 'should refuse to process non-nodes' do
-    lambda { @processor.process([]) }.should.raise NoMethodError, %r|to_ast|
-  end
-
-  it 'should allow to visit nodes with process_all(node)' do
-    @processor.process_all s(:foo, s(:bar), s(:integer, 1))
-    @processor.counts.should.equal({
-      :bar =>     1,
-      :integer => 1,
-    })
-  end
-end