peachy 0.3.5 → 0.4.0

data/History.txt

@@ -1,4 +1,14 @@
+== 0.3.5
+
+* Improved compatibility for Ruby 1.9
+  * Method names are treated as symbols rather than strings
+
+== 0.3.4
+
+* Minor refactorings.
+
 == 0.3.3
+
 * Minor improvements
   * Added some more documentation to methods.
   * Removed whiny-ness from specs.
@@ -6,12 +16,14 @@
   * Added some guard clauses on specs that are impacted when Nokogiri is not installed.
 
 == 0.3.2
+
 * Minor improvements
   * Better support for Ruby 1.8.6
   * Better implementation of MorphIntoArray, which introduced the Mimic module.
   * Standardised to_s implementations to return the encapsulated XML from Proxies.
 
 == 0.3.1
+
 * Minor improvements
   * Should now work on 1.8.6, so removed minimum rqeuirement of Ruby version 1.8.7
   * Tweaked some implementation details.

data/README.rdoc

@@ -58,6 +58,11 @@ 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.
 
+A quick note about Nokogiri and XML namespaces: when Nokogiri creates a new XML node,
+it currently strips all namespaces from the document.  This simplification of the
+underlying XML is necessary so that the interface that Peachy presents to the user is
+still straightforward even when namespaces are set within the XML.
+
 === 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
@@ -75,9 +80,27 @@ E.g.
 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.
 
+=== Collections
+Peachy allows collections to be traversed as arrays in the following way:
+    proxy = Peachy::Proxy.new('<peachy><node>One</node><node>Two</node><node>Three</node></peachy>')
+    puts "First node: " + proxy.peachy.node[0].value
+    => First node: One
+    puts "Second node: " + proxy.peachy.node[1].value
+    => Second node: Two
+
+Note that a child of a Peachy Proxy can be either an array, or another proxy, and never 
+both.  The intent is that a consumer of some XML would expect something to be a single child
+all of the time, or a collection all of the time.  It doesn't make sense to treat a particular
+node as a singleton in some circumstances and a collection containing one element in others.
+
 === No method name match
 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.
+until runtime.
+
+Toggle between silent and noisy messages in Peachy using:
+
+    Peachy.be_quiet
+    Peachy.be_loud

data/lib/peachy.rb

@@ -51,11 +51,12 @@ module Peachy
     @whine = true
   end
 
-  # Indactes whether Peachy will #whine when it runs or not.
+  # Indicates whether Peachy will #whine when it runs or not.
   def self.whiny?
     return @whine
   end
 
+  # Creates a new proxy from the XML string passed to it.
   def self.proxy xml
     create_factory unless defined? @factory
     return Proxy.new(@factory.make_from(xml))
@@ -67,4 +68,4 @@ module Peachy
     @factory.load_parser
     return @factory
   end
-end
+end

data/lib/peachy/method_name.rb

@@ -12,10 +12,10 @@ 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]) {|array, method| array << send(method)}.uniq
+      variation_methods.inject([]) {|array, method| array << send(method)}.uniq
     end
 
-    def as_xpath
+    def as_xpath 
       variations.map {|variation| "./#{variation}" } * '|'
     end
 
@@ -32,10 +32,10 @@ module Peachy
     end
 
     # Checks whether the method name matches the Ruby convention of lowercase with
-    # underscores.  This method does not allow question marks, excalmation marks
-    # or numbers, however.
+    # underscores.  The only exception is using NS to indicate the end of an XML namespace.
+    # Note that this method does not allow question marks, exclamation marks or numbers.
     def matches_convention?
-      @method_name =~ /^[a-z]+(?:_[a-z]+){0,}$/
+      @method_name =~ /^[a-z]+(?:_[a-z]+){0,}(?:NS[a-z]+(?:_[a-z]+){0,})?$/
     end
   end
 end

data/lib/peachy/parsers/nokogiri_wrapper.rb

@@ -11,7 +11,7 @@ module Peachy
       # returning nil if no element or attribute matching the method name is found
       # in the children of the current location in the DOM.
       def find_matches method_name
-        matches = xpath(method_name.as_xpath)
+        matches = xpath method_name.as_xpath 
         matches.any? ? matches : nil
       end
 
@@ -47,4 +47,4 @@ module Peachy
       end
     end
   end
-end
+end

data/lib/peachy/parsers/parser_factory.rb

@@ -23,7 +23,8 @@ module Peachy
       end
 
       Parsers =
-        [{:gem => 'nokogiri', :implementation => lambda {|xml| NokogiriWrapper.new(Nokogiri::XML(xml)) }}]
+        [{:gem => 'nokogiri', 
+          :implementation => lambda {|xml| NokogiriWrapper.new(Nokogiri::XML(xml).remove_namespaces!)}}]
       
       DefaultParser =
         {
@@ -32,4 +33,4 @@ module Peachy
         }
     end
   end
-end
+end

data/lib/peachy/string_styler.rb

@@ -24,5 +24,9 @@ module Peachy
     def as_hyphen_separated
       @method_name.gsub(/_/, '-')
     end
+
+    def as_underscore
+      @method_name
+    end
   end
 end

data/lib/peachy/version.rb

@@ -1,3 +1,3 @@
 module Peachy
-  VERSION = '0.3.5'
+  VERSION = '0.4.0'
 end

data/spec/method_name_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "how to use Peachy::MethodName" do
+describe "Peachy::MethodName" do
   before(:each) do
     @method_name = Peachy::MethodName.new 'method_name'
   end
@@ -57,4 +57,9 @@ describe "how to use Peachy::MethodName" do
     method_name = Peachy::MethodName.new('method_Name')
     lambda { method_name.check_for_convention }.should raise_error(MethodNotInRubyConvention)
   end
-end
+end
+
+class MultipleNamespacesNotAllowed < Exception
+  def initialize method_name
+  end
+end

data/spec/nokigiri_wrapper_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'all_parser_wrappers_group'
 
 # this is to ignore this spec if the nokogiri gem is not available
 if Gem.available? 'nokogiri'

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 5
-  version: 0.3.5
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - NJ Pearman
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-13 00:00:00 +00:00
+date: 2011-01-16 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -57,19 +57,18 @@ files:
 - lib/already_an_only_child.rb
 - spec/nodes_with_children_spec.rb
 - spec/nokigiri_wrapper_spec.rb
+- spec/all_parser_wrappers_group.rb
 - spec/method_name_spec.rb
-- spec/mimc_spec.rb
 - spec/pascal_case_names_spec.rb
 - spec/rexml_wrapper_spec.rb
+- spec/mimic_spec.rb
 - spec/simple_element_referenced_as_collections_spec.rb
 - spec/make_peachy_quiet_spec.rb
 - spec/inferring_a_method_from_an_attribute_spec.rb
 - spec/camel_case_names_spec.rb
 - spec/collections_with_children_as_arrays_spec.rb
 - spec/nokogiri_is_the_available_xml_parser_spec.rb
-- spec/simple_content_wrapper_for_Peachy_spec.rb
 - spec/simple_xml_collections_as_arrays_spec.rb
-- spec/all_parser_wrappers_spec.rb
 - spec/nested_elements_spec.rb
 - spec/inferring_a_method_from_element_name_spec.rb
 - spec/rexml_attribute_wrapper_spec.rb
@@ -82,6 +81,7 @@ files:
 - spec/spec_helper.rb
 - spec/childless_elements_referenced_as_collections_spec.rb
 - spec/hyphen_separated_names_spec.rb
+- spec/simple_content_wrapper_for_peachy_spec.rb
 - README.rdoc
 - History.txt
 has_rdoc: true