rkelly-remix 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0735c3a4887540bf2decb0e3212c0402bb0e8a7e
+  data.tar.gz: d546a14e99056db30d3e3f66664f52efbbc733cc
+SHA512:
+  metadata.gz: 1d2912446c29a7af0698985a20b87a245f9f310ece9fbde5df6db4e14479699faa7345e9c6f206fc0b46f757fc78b8cc08255001a72230a8be896828b29e46b7
+  data.tar.gz: 9a18576dfb4323215987fd68216c49dd9f32b206f6d52cc74d9bd93a090f0b803cf8646e5475b120df84ed386346283aeb5c01bf07b9dc2adf5126f78f836eee

data/CHANGELOG.rdoc

@@ -1,5 +1,10 @@
 = RKelly-Remix CHANGELOG
 
+=== 0.0.5
+
+* Update list of reserved words to match ECMAScript 5
+* Fix ecma visitor for function expressions with name
+
 === 0.0.4
 
 * Allow use of keywords in property names.

data/README.rdoc

@@ -1,11 +1,114 @@
 = RKelly Remix
 
+https://github.com/nene/rkelly-remix
+
 == DESCRIPTION
 
-Fork of the RKelly library to make it suitable as the JavaScript parser
-in JSDuck.
+RKelly Remix is a fork of the
+RKelly[https://github.com/tenderlove/rkelly] JavaScript parser.
+
+== Install
+
+  gem install rkelly-remix
+
+Note that you can't have rkelly and rkelly-remix both installed at the
+same time.  That would cause a conflict since they're both included
+with:
+
+  require 'rkelly'
+
+== Example
+
+  # Iterate over and modify a JavaScript AST.  Then print the modified
+  # AST as JavaScript.
+  require 'rkelly'
+
+  parser = RKelly::Parser.new
+  ast    = parser.parse(
+    "for(var i = 0; i < 10; i++) { var x = 5 + 5; }"
+  )
+
+  ast.each do |node|
+    node.value  = 'hello' if node.value == 'i'
+    node.name   = 'hello' if node.respond_to?(:name) && node.name == 'i'
+  end
+  puts ast.to_ecma # => awesome javascript
+
+== Why fork?
+
+Currently the original RKelly project is unmaintained.  The latest
+release was in late 2012, and since then the author has not responded
+to bug reports or pull requests.
+
+I created this fork mainly to satisfy the needs of my
+JSDuck[https://github.com/senchalabs/jsduck] project, but you too
+should consider using it, as it fixes several problems in the original
+RKelly:
+
+=== Much improved speed
+
+* 20 x faster in Ruby 1.8.
+* 2 x faster in Ruby 1.9 and 2.0.
+
+=== Correct start/end position data for all syntax nodes
+
+Original RKelly only had a rudimentary support for getting the line
+number of an AST node, and even that was often wrong.
+
+In RKelly Remix each AST node has a range property, which contains
+granular data about the exact location of the node in source code:
+
+  parser = RKelly::Parser.new
+  ast = parser.parse(<<-eojs)
+    function aaron() {
+      var x = 10;
+      return 1 + 1;
+    }
+  eojs
+
+  node = ast.pointcut(ReturnNode).matches.first
+
+  node.range.to_s  # <{line:3 char:5 (41)}...{line:3 char:17 (53)}>
+
+  node.range.from.line   # 3
+  node.range.from.char   # 5
+  node.range.from.index  # 41
+
+  node.range.to.line     # 3
+  node.range.to.char     # 17
+  node.range.to.index    # 53
+
+=== Sensible comments handling
+
+Original RKelly attempted to associate each comment with a related AST
+node, but failed to correctly do so, which is understandable, as there
+is no standard way to do such a mapping.  RKelly Remix abandons this
+and just lists all commenst in the root node, leaving the user with
+the task of associating them with AST nodes if he desires so (the same
+approach is taken by another JS parser: Esprima[http://esprima.org] ).
+
+  parser = RKelly::Parser.new
+  ast = parser.parse(<<-eojs)
+    /**
+     * This is an awesome test comment.
+     */
+    function aaron() { // This is a side comment
+      var x = 10;
+      return 1 + 1; // Equals two!
+    }
+  eojs
+
+  # print out all the comments
+  ast.comments.each do |c|
+    puts c.value
+  end
+
+=== Improved parser
 
-* http://rkelly.rubyforge.org/
+* List of reserved words matches with ECMAScript 5.1.
+* Keywords are allowed in property names.
+* Multibyte characters are supported in Ruby >= 1.9.
+* Correct parsing of regexes like /[/]/
 
 == License
 

data/lib/rkelly/constants.rb

@@ -1,3 +1,3 @@
 module RKelly
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/rkelly/generated_parser.rb

@@ -1,6 +1,6 @@
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.4.8
+# This file is automatically generated by Racc 1.4.9
 # from Racc grammer file "".
 #
 

data/lib/rkelly/nodes/node.rb

@@ -27,6 +27,13 @@ module RKelly
         other.is_a?(self.class) && @value === other.value
       end
 
+      # Matches nodes with the given pattern (usually a class name of
+      # the node) and returns an instance of PointcutVisitor on which
+      # #matches can be invoked to get the list of AST nodes that
+      # matched.
+      #
+      #     ast.pointcut(RKelly::Nodes::IfNode).matches --> array of nodes
+      #
       def pointcut(pattern)
         case pattern
         when String
@@ -44,14 +51,24 @@ module RKelly
       end
       alias :/ :pointcut
 
+      # Generates an s-expression data structure like so:
+      #
+      #     "var x = 10;" --> [:var, [[:var_decl, :x, [:assign, [:lit, 10]]]]]]
+      #
       def to_sexp
         SexpVisitor.new.accept(self)
       end
 
+      # Generates formatted and intented JavaScript source code.
       def to_ecma
         ECMAVisitor.new.accept(self)
       end
 
+      # Generates a graph description in DOT language.  This can be
+      # fed into the dot program to generate a graph of the AST:
+      #
+      #     $ dot -Tpng generated-graph.dot -o graph.png
+      #
       def to_dots
         visitor = DotVisitor.new
         visitor.accept(self)
@@ -74,10 +91,13 @@ edge [ ];
         "#{header}\n#{nodes}\n#{arrows}\n}"
       end
 
+      # Loops through all the syntax nodes.
       def each(&block)
         EnumerableVisitor.new(block).accept(self)
       end
 
+      # This CRASHES!
+      # It calls method #s which is nowhere to be found.
       def to_real_sexp
         RealSexpVisitor.new.accept(self)
       end

data/lib/rkelly/tokenizer.rb

@@ -12,11 +12,15 @@ module RKelly
       const true false null debugger
     }.map {|kw| [kw, kw.upcase.to_sym] }]
 
+    # First 6 are always reserved in ECMAScript 5.1
+    # Others are only reserved in strict mode.
+    # http://www.ecma-international.org/ecma-262/5.1/#sec-7.6.1.2
+    # https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Reserved_Words
     RESERVED = Hash[%w{
-      abstract boolean byte char class double enum export extends
-      final float goto implements import int interface long native package
-      private protected public short static super synchronized throws
-      transient volatile
+      class enum export extends import super
+
+      implements interface package private protected public static
+      let yield
     }.map {|kw| [kw, true] }]
 
     LITERALS = {

data/lib/rkelly/visitors/ecma_visitor.rb

@@ -87,9 +87,7 @@ module RKelly
       end
 
       def visit_FunctionDeclNode(o)
-        "#{indent}function #{o.value}(" +
-          "#{o.arguments.map { |x| x.accept(self) }.join(', ')})" +
-          "#{o.function_body.accept(self)}"
+        "#{indent}function #{o.value}" + function_params_and_body(o)
       end
 
       def visit_ParameterNode(o)
@@ -269,15 +267,21 @@ module RKelly
       end
 
       def visit_GetterPropertyNode(o)
-        "get #{o.name}#{o.value.accept(self)}"
+        "get #{o.name}" + function_params_and_body(o.value)
       end
 
       def visit_SetterPropertyNode(o)
-        "set #{o.name}#{o.value.accept(self)}"
+        "set #{o.name}" + function_params_and_body(o.value)
       end
 
       def visit_FunctionExprNode(o)
-        "#{o.value}(#{o.arguments.map { |x| x.accept(self) }.join(', ')}) " +
+        name = (o.value == 'function') ? '' : ' '+o.value
+        "function" + name + function_params_and_body(o)
+      end
+
+      # Helper for all the various function nodes
+      def function_params_and_body(o)
+        "(#{o.arguments.map { |x| x.accept(self) }.join(', ')}) " +
           "#{o.function_body.accept(self)}"
       end
 

data/test/expressions/test_11_4_6.rb

@@ -62,7 +62,12 @@ class Expressions_11_4_6_Test < ECMAScriptTestCase
     ['1234e-5', 0.01234],
   ]
   0.upto(9) { |x| @@sign_tests << [x, x] }
-  0.upto(15) { |x|
+
+  # 0x0 needs special treatment as sprintf("%#x", 0) results in "0"
+  @@sign_tests << ["0x0", 0]
+  @@sign_tests << ["0X0", 0]
+
+  1.upto(15) { |x|
     @@sign_tests << [sprintf("%#x", x), x]
     @@sign_tests << [sprintf("%#x", x).gsub(/x/, 'X'), x]
     if sprintf("%#x", x) =~ /[a-f]/
@@ -70,6 +75,7 @@ class Expressions_11_4_6_Test < ECMAScriptTestCase
       @@sign_tests << [sprintf("%#x", x).upcase, x]
     end
   }
+
   @@sign_tests.each { |actual, expected|
     define_method(:"test_num_#{actual.to_s.gsub(/[\.+]/, '_')}") do
       @runtime.execute("

data/test/test_ecma_visitor.rb

@@ -9,6 +9,9 @@ class ECMAVisitorTest < Test::Unit::TestCase
     assert_to_ecma('a = function() { };')
   end
 
+  def test_named_function_expr
+    assert_to_ecma('a = function b() { };')
+  end
 
   def test_this_node
     assert_to_ecma('this.foo;')

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rkelly-remix
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.0.5
 platform: ruby
 authors:
 - Aaron Patterson
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-30 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -31,25 +28,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.6'
-description: ! 'Fork of the RKelly library to make it suitable as the JavaScript parser
-
-  in JSDuck.
-
-
-  * http://rkelly.rubyforge.org/'
+        version: '3.7'
+description: |-
+  RKelly Remix is a fork of the
+  RKelly[https://github.com/tenderlove/rkelly] JavaScript parser.
 email:
 - aaron.patterson@gmail.com
 - rene.saarsoo@sencha.com
@@ -264,8 +256,10 @@ files:
 - test/test_while_node.rb
 - test/test_with_node.rb
 - .gemtest
-homepage: 
-licenses: []
+homepage: https://github.com/nene/rkelly-remix
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --main
@@ -273,24 +267,22 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: rkelly-remix
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: Fork of the RKelly library to make it suitable as the JavaScript parser in
-  JSDuck
+specification_version: 4
+summary: RKelly Remix is a fork of the RKelly[https://github.com/tenderlove/rkelly]
+  JavaScript parser.
 test_files:
 - test/test_parser.rb
 - test/test_ecma_visitor.rb