aniero-tire_swing 0.0.3 → 0.0.4

data/History.txt

@@ -1,3 +1,12 @@
+== 1.0.4 / 2008-11-17
+
+* 4 minor enhancements
+  * Updated array traversal code to be recursive by default
+  * Updated visitor code to use class instances instead of class-level methods for greater flexibility
+  * Updated error handling to include parsing context in error message
+  * Added clone method for deep copy of AST
+  * Updated node building to set node parents for easier traversal of the AST
+
 == 1.0.0 / 2008-06-29
 
 * 1 major enhancement

data/lib/tire_swing/node.rb

@@ -31,6 +31,8 @@ module TireSwing
       @attribute_mapping ||= {}
     end
 
+    attr_accessor :parent
+
     # Instantiate a node.
     #
     # Values can either be a hash of values to set the values of this node's attributes, or a Treetop syntax node
@@ -46,21 +48,18 @@ module TireSwing
       end
     end
 
+    # Deep-copy of this node and any children. Use this if you need to manipulate an AST without modifying the original
+    def clone
+      Marshal.load(Marshal.dump(self))
+    end
+
     protected
 
     # Auto-builds this node using the provided parsed node and the defined attributes and mapped attributes.
     def build_from_parsed_node(parsed_node)
       attributes.each do |attrib|
         if handler = mapping(attrib)
-          if handler.kind_of?(Proc)
-            value = handler.call(parsed_node)
-          else
-            if parsed_node.respond_to?(handler)
-              value = parsed_node.send(handler)
-            else
-              value = parsed_node.text_value.send(handler)
-            end
-          end
+          value = apply_mapping(handler, parsed_node)
         else
           value = parsed_node.send(attrib)
         end
@@ -75,9 +74,25 @@ module TireSwing
       end
     end
 
+    def apply_mapping(handler, parsed_node)
+      # TODO add in handler for arrays of methods to call in order
+      if handler.kind_of?(Proc)
+        value = handler.call(parsed_node)
+      else
+        # TODO need to add more error checking
+        if parsed_node.respond_to?(handler)
+          value = parsed_node.send(handler)
+        else
+          value = parsed_node.text_value.send(handler)
+        end
+      end
+    end
+
     def extract_value(value)
       if value.respond_to?(:build)
-        value.build
+        node = value.build
+        node.parent = self if node.kind_of?(Node)
+        node
       elsif value.kind_of?(Treetop::Runtime::SyntaxNode)
         value.text_value
       else

data/lib/tire_swing/node_definition.rb

@@ -2,15 +2,16 @@ module TireSwing::NodeDefinition
 
   module ModuleMethods
 
-    # Returns a NodeCreator to act as a stand-in for a normal node class definition.
+    # Returns a NodeCreator to act as a stand-in for a node class in the treetop parser.
     # According to the treetop metagrammar, node class definitions can have more than just a class in them.
-    # For example:
+    #
+    # Given the initial grammar,
     #
     #   rule variable
     #     [a-z]+ <Variable>
     #   end
     #
-    # Instead, use this method to use AST node auto-build functionality. Given
+    # you might instead use use the AST node auto-build functionality. Given
     #
     #   node :variable, :value => :text_value
     #
@@ -20,6 +21,8 @@ module TireSwing::NodeDefinition
     #     [a-z]+ <node(:variable)>
     #   end
     #
+    # and voila, you'll magically have a Variable node with a #value attribute containing the text value.
+    #
     # Also note that you can specify alternate namespaces:
     #
     #   module AST
@@ -28,15 +31,15 @@ module TireSwing::NodeDefinition
     #
     #   <AST.create_node(:variable)>
     #
-    # When you're using the parser extension:
+    # and when you're using the parser extension, tell the parser about the namespace
     #
     #   TireSwing.parses_grammar(Grammar, AST)
     #
-    # you can use
+    # and then you can use the shortest possible syntax,
     #
     #   <node(...)>
     #
-    # Which is an instance method wrapper for the create_node class method.
+    # which is an instance method wrapper for the create_node class method.
     #
     def create_node(name)
       TireSwing::NodeCreator.new(name, const_get(name.to_s.camelize))
@@ -133,7 +136,7 @@ module TireSwing::NodeDefinition
     #
     # If you provide a block, the filtered result will be yielded to the block and returned as the final result.
     #
-    def array_of(kind, recursive = false, &blk)
+    def array_of(kind, recursive = true, &blk)
       lambda do |node|
         result = NodeFilters.filter(node, kind, recursive)
         blk ? result.map(&blk) : result

data/lib/tire_swing/parser_extension.rb

@@ -8,7 +8,14 @@ module TireSwing
       if result
         result.build
       else
-        raise TireSwing::ParseError.new(parser.failure_reason, parser)
+        raise ParseError.new(
+          [
+            parser.failure_reason,
+            parser.input.split("\n")[parser.failure_line-1],
+            " " * parser.failure_index + "^"
+          ].join("\n"),
+          parser
+        )
       end
     end
 

data/lib/tire_swing/visitor.rb

@@ -16,18 +16,15 @@ module TireSwing
         end
       end
 
-      # Visit the given node using the visitor mapping defined with .visits.
-      # This finds the block to call for the given node and calls it with the node and additional arguments, if any.
-      #
-      # Raises an exception if no visitor is found for the given node.
-      #
+      # delegates to a new instance of the visitor class
       def visit(node, *args)
-        block = visitor_for(node)
-        if args.empty?
-          block.call(node)
-        else
-          block.call(node, *args)
-        end
+        visitor = new
+        visitor.visit(node, *args)
+      end
+
+      # Look up a visitor block for this node
+      def visitor_for(node)
+        nodes[node.class] or raise "could not find visitor definition for #{node.class}: #{node.inspect}"
       end
 
       protected
@@ -37,11 +34,20 @@ module TireSwing
         @nodes ||= {}
       end
 
-      # Look up a visitor block for this node
-      def visitor_for(node)
-        nodes[node.class] or raise "could not find visitor definition for #{node.class}: #{node.inspect}"
-      end
+    end
 
+    # Visit the given node using the visitor mapping defined with .visits.
+    # This finds the block to call for the given node and calls it with the node and additional arguments, if any.
+    #
+    # Raises an exception if no visitor is found for the given node.
+    #
+    def visit(node, *args)
+      block = self.class.visitor_for(node)
+      if args.empty?
+        block.call(node)
+      else
+        block.call(node, *args)
+      end
     end
 
   end

data/lib/tire_swing/visitor_definition.rb

@@ -35,6 +35,14 @@ module TireSwing::VisitorDefinition
     #
     #   HashVisitor.visit( assignment_node )
     #
+    # Note that this is using class_eval, so you can define methods inside, including overrides to #visit.
+    #
+    # Note also that this is just a wrapper for:
+    #
+    #   class MyVisitor < TireSwing::Visitor
+    #     visits ...
+    #   end
+    #
     def visitor(name, &blk)
       klass = Class.new(TireSwing::Visitor)
       const_set name.to_s.camelize, klass

data/lib/tire_swing.rb

@@ -1,7 +1,7 @@
 module TireSwing
 
   # :stopdoc:
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/spec/node_definition_spec.rb

@@ -76,19 +76,19 @@ describe TireSwing::NodeDefinition do
       TestNodes.array_of(:foo).call(node).should == [node]
     end
 
-    it "does not filter recursively by default" do
+    it "filters recursively by default" do
       b = mock_syntax_node("b", :elements => ["stuff", "whatever"], :node_to_build => :foo)
       a = mock_syntax_node("a", :elements => ["jkl", b], :node_to_build => :foo)
       top = mock_syntax_node("top", :elements => ["asdf", a], :node_to_build => :foo)
-      TestNodes.array_of(:foo).call(top).should == [top, a]
+      TestNodes.array_of(:foo, true).call(top).should == [top, a, b]
     end
 
-    describe "with the recursive flag" do
-      it "returns a lambda that filters recursively for the right kind of child" do
+    describe "with the recursive flag set to false" do
+      it "returns a lambda that does not filter recursively" do
         b = mock_syntax_node("b", :elements => ["stuff", "whatever"], :node_to_build => :foo)
         a = mock_syntax_node("a", :elements => ["jkl", b], :node_to_build => :foo)
         top = mock_syntax_node("top", :elements => ["asdf", a], :node_to_build => :foo)
-        TestNodes.array_of(:foo, true).call(top).should == [top, a, b]
+        TestNodes.array_of(:foo, false).call(top).should == [top, a]
       end
     end
 

data/spec/node_spec.rb

@@ -2,6 +2,13 @@ require File.join(File.dirname(__FILE__), %w[spec_helper])
 
 describe TireSwing::Node do
 
+  it "has a parent accessor" do
+    node = TireSwing::Node.new
+    node.parent.should be_nil
+    node.parent = :parent
+    node.parent.should == :parent
+  end
+
   describe ".create" do
     it "returns a class that inherits from TireSwing::Node" do
       klass = TireSwing::Node.create
@@ -120,6 +127,16 @@ describe TireSwing::Node do
           TireSwing::Node.create(:foo => :children).new(@top).foo.should == ["foo", 1, "child"]
         end
 
+        it "assigns the parent node if the child node is also a TireSwing node" do
+          @top.should_receive(:child).and_return(@child)
+          node = TireSwing::Node.create(:foo => :child)
+          child_node = TireSwing::Node.new
+          @child.should_receive(:build).and_return(child_node)
+          new_top = node.new(@top)
+          new_top.foo.should == child_node
+          child_node.parent.should == new_top
+        end
+
       end
 
       it "yields the syntax node instance if a named attribute is a lambda" do
@@ -139,4 +156,13 @@ describe TireSwing::Node do
     end
   end
 
+  describe "#clone" do
+    it "does a deep copy of a node" do
+      # can't leave this as an anonymous class, marshal dump/load doesn't like it
+      MyNode = TireSwing::Node.create
+      node = MyNode.new
+      node.clone.should_not eql node
+    end
+  end
+
 end

data/spec/parser_extension_spec.rb

@@ -70,8 +70,8 @@ end
 
     describe "with invalid input" do
 
-      it "raises an exception" do
-        lambda { parse }.should raise_error(TireSwing::ParseError)
+      it "raises an exception with" do
+        lambda { parse }.should raise_error(TireSwing::ParseError, /as3f.*\^/m)
       end
 
       def parse

data/spec/visitor_definition_spec.rb

@@ -32,11 +32,11 @@ describe TireSwing::VisitorDefinition, "when included" do
       @nodes.const_get("Printer").methods.should include("visits")
     end
 
-    it "takes a block with which to define visitors and evaluates it in the context of the new visitor class" do
+    it "evaluates at a class level to allow for attribute definitions and more" do
       @nodes.class_eval do
-        def what; end
+        visitor(:printer) { attr_accessor :thingy }
       end
-      @nodes.instance_methods.should include("what")
+      @nodes.const_get("Printer").new.should respond_to(:thingy=)
     end
 
   end

data/spec/visitor_spec.rb

@@ -25,24 +25,38 @@ describe TireSwing::Visitor do
 
   end
 
-  describe "#visit" do
+  describe "visitors", :shared => true do
     before(:each) do
       @visitor.visits(Foo) { |node| "#{node.class}-foo!" }
     end
 
     it "takes a node and calls the appropriate block, passing in the node" do
-      @visitor.visit(Foo.new).should == "#{Foo}-foo!"
+      @visitor_instance.visit(Foo.new).should == "#{Foo}-foo!"
     end
 
     it "raises an exception if it doesn't know how to handle a node" do
-      lambda { @visitor.visit(Bar.new) }.should raise_error(Exception, /Bar/)
+      lambda { @visitor_instance.visit(Bar.new) }.should raise_error(Exception, /Bar/)
     end
 
     it "calls the visit block with arguments, if arguments are given" do
       @visitor.visits(Bar) { |node, a, b| "#{a}-#{b}" }
-      @visitor.visit(Bar.new, "foo", "bar").should == "foo-bar"
+      @visitor_instance.visit(Bar.new, "foo", "bar").should == "foo-bar"
+    end
+
+  end
+
+  describe ".visit" do
+    before(:each) do
+      @visitor_instance = @visitor
     end
+    it_should_behave_like "visitors"
+  end
 
+  describe "#visit" do
+    before(:each) do
+      @visitor_instance = @visitor.new
+    end
+    it_should_behave_like "visitors"
   end
 
 end

data/tire_swing.gemspec

@@ -1,10 +1,12 @@
+# -*- encoding: utf-8 -*-
+
 Gem::Specification.new do |s|
   s.name = %q{tire_swing}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Witmer"]
-  s.date = %q{2008-08-11}
+  s.date = %q{2008-11-17}
   s.description = %q{Simple node and visitor definitions for Treetop grammars.}
   s.email = %q{nwitmer at gmail dot com}
   s.extra_rdoc_files = ["History.txt", "README.txt", "spec/fixtures/assignments.txt"]
@@ -14,14 +16,14 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{}
-  s.rubygems_version = %q{1.2.0}
+  s.rubygems_version = %q{1.3.1}
   s.summary = %q{Simple node and visitor definitions for Treetop grammars}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 2
 
-    if current_version >= 3 then
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<treetop>, [">= 1.2.4"])
       s.add_runtime_dependency(%q<attributes>, [">= 5.0.1"])
       s.add_runtime_dependency(%q<activesupport>, [">= 2.0.2"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aniero-tire_swing
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Nathan Witmer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-11 00:00:00 -07:00
+date: 2008-11-17 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency