peachy 0.3.3 → 0.3.4

data/README.rdoc

@@ -1,12 +1,12 @@
 = Peachy
 
-Peachy dynamically slurps XML from an underlying XML DOM, creating ruby methods 
+Peachy dynamically slurps XML from an underlying XML DOM, creating Ruby methods
 on the fly to match the elements and attributes of the XML.
 
 Source available at http://github.com/njpearman/Peachy
 
 == Install
-The Peachy Ruby gem is available as you would expect.  Run:
+The Peachy gem is available as you would expect.  Run:
 
     gem install peachy
 
@@ -32,7 +32,7 @@ Call #value on a childless node to get the contents of the node, such as the
 example above.
 
 Peachy expects method names to be called in the Ruby convention of lowercase with
-underscores.  It will do it's best to match method names to elements and attributes
+underscores.  It will do its best to match method names to elements and attributes
 following different conventions (currently, this is camelCaseNames, PascalCaseNames
 or hyphen-separated-names)
 
@@ -42,8 +42,8 @@ More detailed usage examples can be found in the .rb files in the /test director
 It's possible to call #to_s on any node in the tree to get the underlying XML at
 that point in the tree, such as:
 
-    puts 'XML: ' + proxy.xml.node
-    => <node>Peachy</node>
+    puts 'XML: ' + proxy.xml.node.to_s
+    => XML: <node>Peachy</node>
 
 The exact representation of the XML will depend on the underlying XML parser that 
 is being used, but the XML will be valid and correct.
@@ -51,14 +51,18 @@ is being used, but the XML will be valid and correct.
 === XML parsing
 Peachy tries to determine which XML parser to load when it is first used.  Nokogiri
 is currently the first choice, defaulting to REXML if Nokogiri is not available.
-It's possible to extend this out so let me know if there are any other XML parsers
-that you'd like Peachy to support.
+Peachy requires the appropriate XML parser gem at runtime and, as such, I haven't
+included Nokogiri as a dependency in the gemspec.  It will use Nokogiri when it's
+available; otherwise REXML will be loaded and used at runtime.
+
+It is possible to extend out the parser support, for example Hpricot or LibXML,
+so let me know if there are any other XML parsers that you'd like Peachy to support.
 
 === Elements and Attributes
 Currently, elements and attributes are accessed in almost exactly the same way;
 call a method on your current node matching the attribute or element name that
-is required next.  Elements need to have .value or .to_s called on them to get
-the contents of the element, however.
+is required next.  Elements need to have #value called on them to get the contents
+of the element, however.
 
 E.g.
 
@@ -72,6 +76,8 @@ Peachy is just for slurping XML, so this convention should make it easy to know
 how to access the property that you're after, be they elements or attributes.
 
 === No method name match
-Peachy is currently short-tempered, in that if no element or attribute match is
-found when drilling down through proxies, a NoMatchingXmlPart error will be
-raised.
+By default, Peachy will raise a NoMatchingXmlPart error if a method call does not
+match a child node of the current location.  It's possible to globally switch of
+this behaviour and return nil when no child node is found.  This might be
+desirable if you cannot be certain of the XML that you are trying to interpret
+until runtime.

data/lib/peachy.rb

@@ -23,10 +23,34 @@ require File.join(File.dirname(__FILE__), 'peachy/proxy')
 require File.join(File.dirname(__FILE__), 'peachy/childless_proxy_with_attributes')
 
 module Peachy
+  # Tells Peachy to quietly return nil when an xml node is not found, rather than
+  # throwing a NoMatchingXmlPart error.  Use this setting when you want to have a
+  # conditional piece of logic with an XML node that may or may not exist.
+  def self.be_quiet
+    @quiet = true
+  end
+
+  # Tells Peachy to be loud about XML nodes that don't exist, by raising a
+  # NoMatchingXmlPart error.  Use this setting when you want to know about any
+  # XML nodes that unexpectedly don't exist.  This is the default setting, rather
+  # than #be_quiet.
+  def self.be_loud
+    @quiet = false
+  end
+
+  # Indicates whether Peachy is being quiet, i.e. whether Peachy will return nil
+  # when an XML node is not found by a Peachy::Proxy
+  def self.being_quiet?
+    return @quiet
+  end
+
+  # Tells Peachy that it should be whiny, and print all of the steps that it knows
+  # to report to screen.
   def self.whine
     @whine = true
   end
 
+  # Indactes whether Peachy will #whine when it runs or not.
   def self.whiny?
     return @whine
   end

data/lib/peachy/method_mask.rb

@@ -2,9 +2,13 @@ module Peachy
   module MethodMask
     private
     def hide_public_methods exceptions
-      methods_to_hide = public_instance_methods.clone
-      exceptions.each {|stay_public| methods_to_hide.delete(stay_public) }
+      formatted_exception = exceptions.map {|method_name| version_safe_method(method_name)}
+      methods_to_hide = public_instance_methods.map {|method| method unless formatted_exception.include? method }.compact
       private *methods_to_hide
     end
+
+    def version_safe_method(method_name)
+      /^1\.8/ === RUBY_VERSION ? method_name.to_s : method_name.to_s.to_sym
+    end
   end
 end

data/lib/peachy/method_name.rb

@@ -12,9 +12,7 @@ module Peachy
     # The valid varations are the underlying method name, plus all variations
     # provided by methods defined in the StringStyler module.
     def variations
-      (variation_methods.inject([@method_name]) do |array, method|
-        array << send(method)
-      end).uniq
+      variation_methods.inject([@method_name]) {|array, method| array << send(method)}.uniq
     end
 
     def as_xpath

data/lib/peachy/morph_into_array.rb

@@ -1,12 +1,12 @@
 module Peachy
   module MorphIntoArray
     private
-    def you_use_me_like_an_array method_name, block_given, *args
-      return ((block_given or args.size > 0) and array_can?(method_name))
+    def used_as_array method_name, block_given, *args
+      return (block_given or args.size > 0) && array_can?(method_name)
     end
 
     def array_can? method_name
-      Array.instance_methods.include?(method_name.to_s)
+      Array.instance_methods.include?(method_name.to_s) && method_name != :type
     end
 
     def morph_into_array to_add_to_array, method_to_invoke, *args, &block

data/lib/peachy/proxy.rb

@@ -6,7 +6,7 @@ module Peachy
     # This hides all public methods on the class except for 'methods', 'nil?'
     # 'respond_to?', 'inspect' and 'instance_eval', which I've found are too
     # useful / fundamental / dangerous to hide.
-    hide_public_methods ['methods', 'nil?', 'respond_to?', 'inspect', 'instance_eval']
+    hide_public_methods ['methods', 'nil?', 'respond_to?', 'inspect', 'instance_eval', 'kind_of?', 'send']
 
     # Takes either a string containing XML or a Nokogiri::XML::Element as the
     # single argument.
@@ -68,9 +68,7 @@ module Peachy
     #
     def method_missing method_name, *args, &block
       # check whether an Array method is called with arguments or a block
-      if you_use_me_like_an_array(method_name, block_given?, *args)
-        return morph_into_array(clone, method_name, *args, &block)
-      end
+      return morph_into_array(clone, method_name, *args, &block) if used_as_array(method_name, block_given?, *args)
 
       # standard method_missing for any other call with arguments or a block
       super if args.any? or block_given?
@@ -79,11 +77,11 @@ module Peachy
       child_proxy = generate_method_for_xml(MethodName.new(method_name))
 
       if !child_proxy.nil?
-        # found a match, so flag as only child
+        # found a match, so mark as only child
         acts_as_only_child
         child_proxy
       elsif array_can?(method_name)
-        # morph into an array, as method is a zero-length array call
+        # morph into an array, as method is a length one array call
         new_proxy = node.create_from_element
         morph_into_array(new_proxy, method_name)
       else
@@ -106,7 +104,8 @@ module Peachy
     end
 
     def no_matching_xml method_name
-      raise NoMatchingXmlPart.new(method_name, name)
+      raise NoMatchingXmlPart.new(method_name, name) unless Peachy.being_quiet?
+      return nil
     end
   end
 end

data/lib/peachy/simple_content.rb

@@ -14,11 +14,13 @@ module Peachy
     end
 
     def method_missing method_name, *args, &block
-      if you_use_me_like_an_array(method_name, block_given?, *args)
-        new_content = SimpleContent.new(@xml)
-        return morph_into_array(new_content, method_name, *args, &block)
-      end
+      return morph_with_content(method_name, *args, &block) if used_as_array(method_name, block_given?, *args)
       super
     end
+
+    private
+    def morph_with_content method_name, *args, &block
+      return morph_into_array(SimpleContent.new(@xml), method_name, *args, &block)
+    end
   end
 end

data/lib/peachy/version.rb

@@ -1,3 +1,3 @@
 module Peachy
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

data/spec/elements_referenced_as_collections_spec.rb

@@ -5,7 +5,7 @@ describe "an element referenced as the first part of a collection" do
     xml = <<XML
 <xml>
   <list>
-    <item id="1">
+    <item id="1" type="thingy">
       <child>one</child>
     </item>
   </list>
@@ -52,5 +52,13 @@ MSG
     @proxy.xml.list.item.child
     lambda { @proxy.xml.list.item[0] }.should raise_error(AlreadyAnOnlyChild, expected_message)
   end
-end
 
+  it "should not treat Array#type as an array reference" do
+    expected_message = <<MSG
+The 'item' node has already been accessed as a single child, but you are now trying to use it as a collection.
+Do not try to access Peachy::Proxies in a mixed manner in your implementation.
+MSG
+    @proxy.xml.list.item.type
+    lambda { @proxy.xml.list.item[0] }.should raise_error(AlreadyAnOnlyChild, expected_message)
+  end
+end

data/spec/make_peachy_quiet_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'Peacy can be quitened down when necessary' do
+  before(:each) do
+    @peachy_proxy = Peachy::Proxy.new '<xml />'
+  end
+
+  after(:each) do
+    Peachy.be_loud
+  end
+
+  it "should know when it should be quiet" do
+    Peachy.be_quiet
+    Peachy.being_quiet?.should be_true
+  end
+
+  it "should know when to be loud" do
+    Peachy.be_loud
+    Peachy.being_quiet?.should be_false
+  end
+
+  it "should not blow up when it's told to be quiet" do
+    Peachy.be_quiet
+    @peachy_proxy.not_a_method.should be_nil
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - NJ Pearman
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-05 00:00:00 +01:00
+date: 2010-09-08 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -62,6 +62,7 @@ files:
 - spec/collections_with_children_as_arrays_spec.rb
 - spec/method_name_spec.rb
 - spec/childless_elements_referenced_as_collections_spec.rb
+- spec/make_peachy_quiet_spec.rb
 - spec/simple_xml_collections_as_arrays_spec.rb
 - spec/simple_element_referenced_as_collections_spec.rb
 - spec/using_peachy_proxy_incorrectly_spec.rb