esprima 1.1.0 → 1.2.0

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.2.0
+
+*  Added intermediate AST class that offers a few convenience methods like `each`.
+
 === 1.1.0
 
 *  Fix the require path for the parser.

data/esprima.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'therubyracer', '~> 0.9.10'
   s.add_dependency 'commonjs', '~> 0.2.6'
+  s.add_dependency 'escodegen', '~> 1.0.0'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 2.11.0'

data/lib/esprima.rb

@@ -2,11 +2,22 @@
 
 require 'v8'
 require 'commonjs'
+require 'escodegen'
 
 require 'esprima/parser'
+require 'esprima/ast'
+
+# hack for inconsistency between Ruby 1.8 and 1.9
+Enumerator = Enumerable::Enumerator unless defined?(Enumerator)
 
 module Esprima
   def self.load_path
     @load_path ||= File.expand_path(File.join(File.dirname(__FILE__), "../vendor"))
   end
+
+  def self.new_environment
+    context = V8::Context.new
+    env = CommonJS::Environment.new(context, :path => Esprima.load_path)
+    env.require("esprima")
+  end
 end

data/lib/esprima/ast.rb

@@ -0,0 +1,60 @@
+# encoding: UTF-8
+
+module Esprima
+  class AST
+    include Enumerable
+
+    attr_reader :tree, :esprima
+
+    def initialize(tree, environment = nil)
+      @esprima = @environment || Esprima.new_environment
+      @tree = tree
+    end
+
+    def to_ecma(options = {})
+      Escodegen::Generator.new.generate(@tree, options)
+    end
+
+    def is_list?
+      @tree.is_a?(Array)
+    end
+
+    def is_hash?
+      @tree.is_a?(Hash)
+    end
+
+    def [](key)
+      @tree[key]
+    end
+
+    def each
+      if block_given?
+        each_node { |node| yield Esprima::AST.new(node, @esprima) }
+      else
+        nodes = []
+        each_node { |node| nodes << Esprima::AST.new(node, @esprima) }
+        nodes.to_enum
+      end
+    end
+
+    protected
+
+    def each_node
+      if tree.is_a?(Array)
+        tree.each do |t|
+          yield t if yieldable?(t)
+          Esprima::AST.new(t, @esprima).each_node { |sub_t| yield sub_t if yieldable?(sub_t) }
+        end
+      elsif tree.is_a?(Hash)
+        tree.each_pair do |_, t|
+          yield t if yieldable?(t)
+          Esprima::AST.new(t, @esprima).each_node { |sub_t| yield sub_t if yieldable?(sub_t) }
+        end
+      end
+    end
+
+    def yieldable?(obj)
+      obj.is_a?(Hash) || obj.is_a?(Array)
+    end
+  end
+end

data/lib/esprima/parser.rb

@@ -3,13 +3,11 @@
 module Esprima
   class Parser
     def initialize
-      @context = V8::Context.new
-      @env = CommonJS::Environment.new(@context, :path => Esprima.load_path)
-      @esprima = @env.require("esprima")
+      @esprima = Esprima.new_environment
     end
 
     def parse(code)
-      to_ruby(@esprima.parse(code))
+      Esprima::AST.new(to_ruby_hash(@esprima.parse(code)), @esprima)
     end
 
     def parse_file(file)
@@ -23,11 +21,11 @@ module Esprima
       File.read(file)
     end
 
-    def to_ruby(obj)
+    def to_ruby_hash(obj)
       if obj.is_a?(V8::Array)
-        obj.map { |val| to_ruby(val) }
+        obj.map { |val| to_ruby_hash(val) }
       elsif obj.is_a?(V8::Object)
-        obj.inject({}) { |ret, (key, val)| ret[key.to_sym] = to_ruby(val); ret }
+        obj.inject({}) { |ret, (key, val)| ret[key.to_sym] = to_ruby_hash(val); ret }
       else
         obj
       end

data/lib/esprima/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Esprima
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/spec/ast_spec.rb

@@ -0,0 +1,78 @@
+# encoding: UTF-8
+
+require "spec_helper"
+
+AST = [{
+  :type => "ExpressionStatement",
+  :expression => {
+    :left => {
+      :type => "Literal",
+      :value => 7
+    },
+    :type => "BinaryExpression",
+    :right => {
+      :type => "Literal",
+      :value => 8
+    },
+    :operator => "+"
+  }
+}]
+
+describe Esprima::AST do
+  describe "#yieldable?" do
+    it "esprima parser should only yield arrays and hashes" do
+      ast = Esprima::AST.new({})
+      ast.send(:'yieldable?', {}).should be_true
+      ast.send(:'yieldable?', []).should be_true
+      ast.send(:'yieldable?', "").should be_false
+    end
+  end
+
+  context "with an ast" do
+    before(:each) do
+      @ast = Esprima::Parser.new.parse("7 + 8;")
+    end
+
+    describe "#each" do
+      it "yields if a block is given" do
+        @ast.each { |a| a.should be_a(Esprima::AST) }
+      end
+
+      it "returns an array of parse nodes" do
+        result = @ast.each.map(&:tree)
+        result.size.should == 5
+        result.should include(AST)
+        result.should include(AST.first)
+        result.should include(AST.first[:expression])
+        result.should include(AST.first[:expression][:left])
+        result.should include(AST.first[:expression][:right])
+      end
+    end
+
+    describe "#[]" do
+      it "allows access to the internal tree with [] syntax" do
+        @ast[:body][0][:type].should == "ExpressionStatement"
+      end
+    end
+
+    describe "#is_hash?" do
+      it "should return true if the underlying tree is a hash, false otherwise" do
+        @ast.is_hash?.should be_true
+        Esprima::AST.new(@ast.tree[:body], @ast.esprima).is_hash?.should be_false
+      end
+    end
+
+    describe "#is_list?" do
+      it "should return true if the underlying tree is an array, false otherwise" do
+        @ast.is_list?.should be_false
+        Esprima::AST.new(@ast.tree[:body], @ast.esprima).is_list?.should be_true
+      end
+    end
+
+    describe "#to_ecma" do
+      it "should build JavaScript code from the AST" do
+        @ast.to_ecma.should == "7 + 8;"
+      end
+    end
+  end
+end

data/spec/esprima_spec.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-require File.join(File.dirname(__FILE__), "spec_helper")
+require "spec_helper"
 
 describe Esprima do
   describe "#load_path" do
@@ -8,4 +8,11 @@ describe Esprima do
       File.should exist(File.join(Esprima.load_path, "esprima.js"))
     end
   end
+
+  describe "#new_environment" do
+    it "creates a new environment that can be used to parse javascript code" do
+      env = Esprima.new_environment
+      env.parse("1 + 1").should_not be_nil
+    end
+  end
 end

data/spec/parser_spec.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-require File.join(File.dirname(__FILE__), "spec_helper")
+require "spec_helper"
 
 EXPRESSION = "7 + 8"
 AST_RESULT = [{
@@ -23,6 +23,7 @@ describe Esprima::Parser do
   describe "#parse" do
     it "should parse a basic js expression" do
       result = Esprima::Parser.new.parse(EXPRESSION)
+      result.should be_a(Esprima::AST)
       result[:body].should == AST_RESULT
     end
   end
@@ -31,7 +32,9 @@ describe Esprima::Parser do
     it "should parse a basic js file" do
       parser = Esprima::Parser.new
       mock(parser).read_file("my_file.js") { EXPRESSION }
-      parser.parse_file("my_file.js")[:body].should == AST_RESULT
+      result = parser.parse_file("my_file.js")
+      result.should be_a(Esprima::AST)
+      result[:body].should == AST_RESULT
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 # encoding: UTF-8
 
+$:.push(File.dirname(__FILE__))
+
 require 'rspec'
 require 'esprima'
 

metadata

@@ -1,108 +1,100 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: esprima
-version: !ruby/object:Gem::Version
-  version: 1.1.0
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 1.2.0
 platform: ruby
-authors:
+authors: 
 - Cameron Dutro
 - Ariya Hidayat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-17 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-11-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: therubyracer
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.10
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 0.9.10
-- !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: commonjs
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 0.2.6
   type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: escodegen
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.2.6
-- !ruby/object:Gem::Dependency
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.11.0
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 2.11.0
-- !ruby/object:Gem::Dependency
-  name: rr
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.4
   type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rr
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 1.0.4
+  type: :development
+  version_requirements: *id006
 description: Ruby wrapper around the Esprima static code analyzer for JavaScript.
-email:
+email: 
 - cdutro@twitter.com
 - ariya.hidayat@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
+- lib/esprima/ast.rb
 - lib/esprima/parser.rb
 - lib/esprima/version.rb
 - lib/esprima.rb
+- spec/ast_spec.rb
 - spec/esprima_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
@@ -116,32 +108,30 @@ files:
 - esprima.gemspec
 homepage: http://esprima.org
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -4557661203188248061
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -4557661203188248061
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper around the Esprima static code analyzer for JavaScript.
 test_files: []
+