nom-xml 0.0.6 → 0.0.7

data/lib/nom/xml/term.rb

@@ -6,6 +6,13 @@ module Nom::XML
     attr_writer :parent
     attr_reader :options
 
+    ##
+    # Create a new Nom::XML::Term
+    #
+    # @attr [Nom::XML::Term] parent
+    # @attr [String] name
+    # @attr [Hash] options
+    # @yield 
     def initialize parent, name, options = {}, *args, &block
       @name = name
       @terms = {}
@@ -17,40 +24,59 @@ module Nom::XML
       end
     end
 
-    def in_edit_context &block
-      @edit_context = true
-      yield
-      @edit_context = false
-    end
-
-    def in_edit_context?
-      @edit_context
-    end
-
-    def parent_xpath
-      @parent_xpath ||= self.parent.xpath
-    end
-
-    def clear_parent_cache!
-      @parent_xpath = nil
+    ##
+    # Traverse the tree to figure out what terminology this term belongs to
+    # @return [Nom::XML::Terminology]
+    def terminology
+      @terminology ||= parent.terminology
     end
 
+    ##
+    # Get the absolute xpath to this node
+    # @return [String]
     def xpath
       [parent_xpath, local_xpath].flatten.compact.join("/")
     end
 
+    ##
+    # Get the relative xpath to this node from its immediate parent's term
+    # @return [String]
     def local_xpath
       ("#{xmlns}:" unless xmlns.blank? ).to_s + (options[:path] || name).to_s
     end
 
-    def xmlns
-      (options[:xmlns] if options) || (self.parent.xmlns if self.parent)
-    end
-
+    ##
+    # Get the document nodes associated with this term
+    # @return [Nokogiri::XML::NodeSet]
     def nodes
       terminology.document.root.xpath(xpath, terminology.namespaces)
     end
 
+    ##
+    # Does this term have a sub-term called term_name
+    # @attr [String] term_key
+    # @return [Boolean]
+    def key? term_key
+      terms.key? term_key
+    end
+
+    ##
+    # Flatten this term and all sub-terms (recursively)
+    # @return [Array]
+    def flatten
+      [self, terms.map { |k,v| v.flatten }].flatten
+    end
+
+    def respond_to? method, *args, &block
+      if in_edit_context?
+        true
+      elsif key? method
+        true
+      else
+        super
+      end
+    end
+
     def method_missing method, *args, &block 
       if in_edit_context?
         add_term(method, *args, &block)
@@ -61,19 +87,17 @@ module Nom::XML
       end
     end
 
-    def key? term
-      terms.key? term
-    end
-
-    def flatten
-      [self, terms.map { |k,v| v.flatten }].flatten
+    protected
+    def in_edit_context &block
+      @edit_context = true
+      yield
+      @edit_context = false
     end
 
-    def terminology
-      @terminology ||= parent.terminology
+    def in_edit_context?
+      @edit_context
     end
 
-    protected
     def add_term method, options = {}, *args, &block
       terms[method] = Term.new(self, method, options, *args, &block)
     end
@@ -82,6 +106,16 @@ module Nom::XML
       terms[method]
     end
 
+    ##
+    # Get the XPath to the parent nodes for this term
+    def parent_xpath
+      @parent_xpath ||= self.parent.xpath
+    end
+
+    def xmlns
+      (options[:xmlns] if options) || (self.parent.xmlns if self.parent)
+    end
+
   end
 
 end

data/lib/nom/xml/version.rb

@@ -1,5 +1,5 @@
 module Nom
   module XML
-    VERSION = '0.0.6'
+    VERSION = '0.0.7'
   end
 end

data/spec/lib/terminology_decorator_spec.rb

@@ -93,6 +93,24 @@ describe "Nutrition" do
 
       subject.asdf
     end
+
+    it "should raise an error on unknown accessors" do
+      mock_term = mock(:local_xpath => '//asdf', :options => {:accessor => 123 })
+      @term_accessors = { :asdf => mock_term }
+
+      subject.should_receive(:xpath).with('//asdf', anything)
+
+      expect { subject.asdf }.to raise_error
+    end
+
+    it "should convert single-valued objects to single values" do
+      mock_term = mock(:local_xpath => '//asdf', :options => {:single => true })
+      @term_accessors = { :asdf => mock_term }
+
+      subject.should_receive(:xpath).with('//asdf', anything).and_return([1])
+
+      subject.asdf.should == 1
+    end
   end
 
   describe "#terms" do

data/spec/lib/terminology_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Nom::XML::Terminology do
+  describe "#namespaces" do
+    it "should pull the namespaces out of the terminology options" do
+      Nom::XML::Terminology.new(nil, :namespaces => { 'asd' => '123'}).namespaces.should == { 'asd' => '123'}
+    end
+
+    it "should return an empty hash if no namespace is provided" do
+      Nom::XML::Terminology.new.namespaces.should == {}
+    end
+  end
+
+  describe "#terminology" do
+    it "should be an identity function" do
+      a = Nom::XML::Terminology.new
+
+      a.terminology.should == a
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nom-xml
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-05 00:00:00.000000000 Z
+date: 2012-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -174,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3784330826546141673
+      hash: 2351930484694908071
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3784330826546141673
+      hash: 2351930484694908071
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23