rasantiago-tiny_xpath_helper 0.1.4 → 0.1.5

data/README.rdoc

@@ -34,12 +34,6 @@ and :find can be :first or :all
   >> xpath.find_xpath( 'node/@style', :format => :rexml, :find => :all )
   => [style='first']
 
-If you only need to set :format, you may pass just the symbol instead of an options hash
-This is especially convenient using the [] syntax since a bug in ruby1.8
-prevents using => inside of []
-  >> xpath[ 'node/@style', :rexml ]
-  => [style='first']
-
 If you want to filter the output, you can pass something that can be to_proc'd as :format
 (Note that this acts on the string value of the element, not the REXML node)
   >> xpath[ 'node/@style', :to_i ]
@@ -51,10 +45,31 @@ If you want to filter the output, you can pass something that can be to_proc'd a
   >> xpath[ 'node', lambda{|x| x.strip.split(//) } ]
   => [["o", "n", "e"], ["t", "w", "o"], ["t", "h", "r", "e", "e"]]
 
+If you only need to set :format, you may pass just the symbol instead of an options hash
+This is especially convenient using the [] syntax since a bug in ruby1.8
+prevents using => inside of []
+  >> xpath[ 'node/@style', :rexml ]
+  => [style='first']
+
+Actually, formats :rexml and :text are aliases for the :auto_text parameter, which takes a bool,
+and defaults to true.
+  >> xpath.all( 'node/@style', :auto_text => false )
+  => [style='first']
+
+Option defaults can be passed to TinyXPathHelper#new
+  >> xpath_with_options = TinyXPathHelper.new( File.open( 'test/xml/sample.xml' ), :format => :to_i, :find => :all )
+  >> xpath_with_options.find_xpath( 'node' )
+  => [0,0,0]
+
+You can access the default options for the TinyXMLHelper Class or any instance with #default_options
+  >> TinyXPathHelper.default_options
+  => {:format => nil,   :auto_text => true, :find => :first}
+  >> xpath_with_options.default_options
+  => {:format => :to_i, :auto_text => true, :find => :all}
 
 You can also pass a block, which will get called on the entire return value, but
 only if at least one element is found
-  >> xpath.all( 'node' ){ |nodes| nodes.count } # nodes is an array
+  >> xpath.all( 'node' ){ |nodes| nodes.count } # nodes is an array of strings
   => 3
 
   >> xpath.first( 'node' ){ |node| node.reverse } # node is a string
@@ -66,9 +81,10 @@ only if at least one element is found
   >> xpath.all( 'nothing' ){ |nodes| raise "this will not run" }
   => []
   
-There's no shortcut for the case where you want to run something over the array of matching REXML nodes.
-Just use Array#map for that.
-  >> xpath[ 'node', :rexml ].map(&:name)
+If you really want shortcut for the case where you want to run something
+over the array of matching REXML nodes, set :auto_text to false when calling TinyXpathHelper#new
+  >> rexml_xpath = TinyXPathHelper.new( File.open( 'test/xml/sample.xml' ), :auto_text => false )
+  >> rexml_xpath[ 'node', :name ]
   => ['node', 'node', 'node']
 
 The output from :format => :rexml is suitable for passing to another TinyXPathHelper

data/lib/tiny_xpath_helper.rb

@@ -10,11 +10,11 @@ class TinyXPathHelper
   end
 
   def default_options
-    @options.dup
+    self.class.default_options.dup.update(@options)
   end
 
   def with_options(*options)
-    r = default_options
+    r = default_options.dup
 
     options.each do |option|
       if not Hash === option
@@ -77,32 +77,33 @@ class TinyXPathHelper
     end
   end
 
+  def self.default_options
+    {:format => nil, :auto_text => true, :find => :first}.freeze
+  end
+
   def self.find_xpath_from(element, path, options = {}, &blk)
     if options[:with_indifferent_access]
       path = path.to_s
     end
 
-    format = options[:format] || :text
-    if format == :array
-      options.update( :format => :text, :find => :all )
-      format = :text
-    end
-
-    count = options[:find] || :first
-
-    filter1 = self.method(:xml_node_to_text)
-    filter2 = nil
+    options = self.default_options.dup.update(options)
+    format    = options[:format]
+    auto_text = options[:auto_text]
+    count     = options[:find]
 
-    if format == :xml or format == :rexml
-      filter1 = nil
+    if format == :array
+      count     = :all
+      format    = nil
     elsif format == :text
-      filter2 = nil
-    elsif format.respond_to? :to_proc
-      filter2 = format.to_proc
-    else
-      raise "I don't know the format #{format.inspect}"
+      auto_text = true
+      format    = nil
+    elsif format == :xml or format == :rexml
+      auto_text = false
+      format    = nil
     end
 
+    filter1 = auto_text ? self.method(:xml_node_to_text) : nil
+    filter2 = format
 
     if count   == :all
       elements = REXML::XPath.match(element, path)

data/tiny_xpath_helper.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tiny_xpath_helper}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.authors = ["Jesse Wolfe"]
   s.date = %q{2009-06-01}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rasantiago-tiny_xpath_helper
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Jesse Wolfe