representable 0.9.2 → 0.9.3

data/CHANGES.textile

@@ -1,3 +1,7 @@
+h2. 0.9.3
+
+* Removed the @:as => [..]@ syntax in favor of @:array => true@.
+
 h2. 0.9.2
 
 * Arguments and block now successfully forwarded in @#from_*@.

data/lib/representable.rb

@@ -51,172 +51,28 @@ private
         representable_attrs.map {|attr| binding_for_definition(attr) }
       end
       
-      # Declares a reference to a certain xml element, whether an attribute, a node,
-      # or a typed collection of nodes.  This method does not add a corresponding accessor
-      # to the object.  For that behavior see the similar methods: .xml_reader and .xml_accessor.
+      # Declares a represented document node, which is usually a XML tag or a JSON key.
       #
-      # == Sym Option
-      # [sym]   Symbol representing the name of the accessor.
+      # Examples:
       #
-      # === Default naming
-      # This name will be the default node or attribute name searched for,
-      # if no other is declared.  For example,
-      #
-      #  xml_reader   :bob
-      #  xml_accessor :pony, :from => :attr
-      #
-      # are equivalent to:
-      #
-      #  xml_reader   :bob, :from => 'bob'
-      #  xml_accessor :pony, :from => '@pony'
-      #
-      # == Options
-      # === :as
-      # ==== Basic Types
-      # Allows you to specify one of several basic types to return the value as.  For example
-      #
-      #  xml_reader :count, :as => Integer
-      #
-      # is equivalent to:
-      #
-      #  xml_reader(:count) {|val| Integer(val) unless val.empty? }
-      #
-      # Such block shorthands for Integer, Float, Fixnum, BigDecimal, Date, Time, and DateTime
-      # are currently available, but only for non-Hash declarations.
-      #
-      # To reference many elements, put the desired type in a literal array. e.g.:
-      #
-      #   xml_reader :counts, :as => [Integer]
-      #
-      # Even an array of text nodes can be specified with :as => []
-      #
-      #   xml_reader :quotes, :as => []
-      #
-      # === Other ROXML Class
-      # Declares an accessor that represents another ROXML class as child XML element
-      # (one-to-one or composition) or array of child elements (one-to-many or
-      # aggregation) of this type. Default is one-to-one. For one-to-many, simply pass the class
-      # as the only element in an array.
-      #
-      # Composition example:
-      #  <book>
-      #   <publisher>
-      #     <name>Pragmatic Bookshelf</name>
-      #   </publisher>
-      #  </book>
-      #
-      # Can be mapped using the following code:
-      #   class Book
-      #     xml_reader :publisher, :as => Publisher
-      #   end
-      #
-      # Aggregation example:
-      #  <library>
-      #   <books>
-      #    <book/>
-      #    <book/>
-      #   </books>
-      #  </library>
-      #
-      # Can be mapped using the following code:
-      #  class Library
-      #    xml_reader :books, :as => [Book], :in => "books"
-      #  end
-      #
-      # If you don't have the <books> tag to wrap around the list of <book> tags:
-      #  <library>
-      #   <name>Ruby books</name>
-      #   <book/>
-      #   <book/>
-      #  </library>
-      #
-      # You can skip the wrapper argument:
-      #    xml_reader :books, :as => [Book]
-      #
-      # === :from
-      # The name by which the xml value will be found, either an attribute or tag name in XML.
-      # Default is sym, or the singular form of sym, in the case of arrays and hashes.
-      #
-      # This value may also include XPath notation.
-      #
-      # ==== :from => :content
-      # When :from is set to :content, this refers to the content of the current node,
-      # rather than a sub-node. It is equivalent to :from => '.'
-      #
-      # Example:
-      #  class Contributor
-      #    xml_reader :name, :from => :content
-      #    xml_reader :role, :from => :attr
-      #  end
-      #
-      # To map:
-      #  <contributor role="editor">James Wick</contributor>
-      #
-      # ==== :from => :attr
-      # When :from is set to :attr, this refers to the content of an attribute,
-      # rather than a sub-node. It is equivalent to :from => '@attribute_name'
-      #
-      # Example:
-      #  class Book
-      #    xml_reader :isbn, :from => "@ISBN"
-      #    xml_accessor :title, :from => :attr # :from defaults to '@title'
-      #  end
-      #
-      # To map:
-      #  <book ISBN="0974514055" title="Programming Ruby: the pragmatic programmers' guide" />
-      #
-      # ==== :from => :text
-      # The default source, if none is specified, this means the accessor
-      # represents a text node from XML.  This is documented for completeness
-      # only.  You should just leave this option off when you want the default behavior,
-      # as in the examples below.
-      #
-      # :text is equivalent to :from => accessor_name, and you should specify the
-      # actual node name (and, optionally, a namespace) if it differs, as in the case of :author below.
-      #
-      # Example:
-      #  class Book
-      #    xml_reader :author, :from => 'Author'
-      #    xml_accessor :description, :cdata => true
-      #    xml_reader :title
-      #  end
-      #
-      # To map:
-      #  <book>
-      #   <title>Programming Ruby: the pragmatic programmers' guide</title>
-      #   <description><![CDATA[Probably the best Ruby book out there]]></description>
-      #   <Author>David Thomas</Author>
-      #  </book>
-      #
-      # Likewise, a number of :text node values can be collected in an array like so:
-      #
-      # Example:
-      #  class Library
-      #    xml_reader :books, :as => []
-      #  end
-      #
-      # To map:
-      #  <library>
-      #      <book>To kill a mockingbird</book>
-      #      <book>House of Leaves</book>
-      #    <book>Gödel, Escher, Bach</book>
-      #  </library>
-      #
-      # === Other Options
-      # [:in] An optional name of a wrapping tag for this XML accessor.
-      #       This can include other xpath values, which will be joined with :from with a '/'
-      # [:required] If true, throws RequiredElementMissing when the element isn't present
-      # [:cdata] true for values which should be input from or output as cdata elements
-      # [:to_xml] this proc is applied to the attributes value outputting the instance via #to_xml
-      #
-      def representable_property(*args) # TODO: make it accept 1-n props.
+      #   representable_property :name
+      #   representable_property :name, :from => :title
+      #   representable_property :name, :as => Name
+      def representable_property(*args)
         attr = add_representable_property(*args)
         attr_reader(attr.getter)
         attr_writer(attr.getter)
       end
       
+      # Declares a represented document node collection.
+      #
+      # Examples:
+      #
+      #   representable_collection :products
+      #   representable_collection :products, :from => :item
+      #   representable_collection :products, :as => Product
       def representable_collection(name, options={})
-        options[:as] = [options[:as]].compact
+        options[:collection] = true
         representable_property(name, options)
       end
       

data/lib/representable/bindings/json_bindings.rb

@@ -44,7 +44,7 @@ module Representable
     class ObjectBinding < Binding
       def write(hash, value)
         if definition.array?
-          hash.merge! ({definition.from => value.collect {|v| v.to_hash(:wrap => false)}}) # hier name=> wech.
+          hash.merge!({definition.from => value.collect {|v| v.to_hash(:wrap => false)}})
         else
           hash.merge! value.to_hash
         end

data/lib/representable/definition.rb

@@ -3,24 +3,16 @@ module Representable
     attr_reader :name, :sought_type, :wrapper, :from
     alias_method :getter, :name
     
-    def initialize(sym, opts={})
-      @name = sym.to_s
-      
-      @array        = true if opts[:as].is_a?(Array) # DISCUSS: move to ArrayDefinition.
-      @from         = (opts[:from] || name).to_s
-      @sought_type  = extract_type(opts[:as])
+    def initialize(sym, options={})
+      @name         = sym.to_s
+      @array        = options[:collection]
+      @from         = (options[:from] || name).to_s
+      @sought_type  = options[:as] || :text
       
       # FIXME: move me to xml.
-      if opts[:from] == :content
-        opts[:from] = '.'
-      elsif opts[:from] == :name
-        opts[:from] = '*'
-      elsif opts[:from] == :attr
-        @sought_type = :attr
-        opts[:from] = nil
-      elsif opts[:from].to_s =~ /^@/
+      if options[:from].to_s =~ /^@/
         @sought_type = :attr
-        opts[:from].sub!('@', '')
+        options[:from].sub!('@', '')
       end
     end
 
@@ -67,12 +59,5 @@ module Representable
       
       value
     end
-
-  private
-    def extract_type(as)
-      as = as.first if as.is_a?(Array)  # TODO: move to ArrayDefinition.
-      
-      as || :text
-    end
   end
 end

data/lib/representable/json.rb

@@ -2,6 +2,10 @@ require 'json'
 require 'representable/bindings/json_bindings'
 
 module Representable
+  # Brings #to_xml, #to_hash, #from_xml and #from_hash to your object.
+  #
+  # Note: The authorative methods are #to_hash and #from_hash, if you override #to_json instead,
+  # things might work as expected.
   module JSON
     BINDING_FOR_TYPE = {  # TODO: refactor #representable_accessor for better extendability.
       :text     => TextBinding,

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

data/lib/representable/xml.rb

@@ -1,4 +1,5 @@
 require 'representable'
+require 'representable/nokogiri_extensions'
 require 'representable/bindings/xml_bindings'
 
 module Representable

data/test/definition_test.rb

@@ -9,7 +9,6 @@ class DefinitionTest < MiniTest::Spec
     it "responds to #typed?" do
       assert ! @def.typed?
       assert Representable::Definition.new(:songs, :as => Hash).typed?
-      assert Representable::Definition.new(:songs, :as => [Hash]).typed?
     end
     
     it "responds to #getter and returns string" do
@@ -41,19 +40,19 @@ class DefinitionTest < MiniTest::Spec
     end
     
     it "works with collection" do
-      @d = Representable::Definition.new(:song, :as => [])
+      @d = Representable::Definition.new(:song, :collection => true)
       assert_equal [2,3,4], @d.apply([1,2,3]) { |v| v+1 }
     end
     
     it "skips with collection and nil" do
-      @d = Representable::Definition.new(:song, :as => [])
+      @d = Representable::Definition.new(:song, :collection => true)
       assert_equal nil, @d.apply(nil) { |v| v+1 }
     end
   end
     
-  describe ":as => []" do
+  describe ":collection => true" do
     before do
-      @def = Representable::Definition.new(:songs, :as => [], :tag => :song)
+      @def = Representable::Definition.new(:songs, :collection => true, :tag => :song)
     end
     
     it "responds to #array?" do
@@ -64,18 +63,6 @@ class DefinitionTest < MiniTest::Spec
       assert_equal :text, @def.sought_type
     end
   end
-    
-    
-  describe ":as => [Item]" do
-    before do
-      @def = Representable::Definition.new(:songs, :as => [Hash])
-    end
-    
-    it "responds to #sought_type" do
-      assert_equal Hash, @def.sought_type
-    end
-  end
-  
   
   describe ":as => Item" do
     before do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 9
-  - 2
-  version: 0.9.2
+  - 3
+  version: 0.9.3
 platform: ruby
 authors: 
 - Nick Sutterer
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-25 00:00:00 +01:00
+date: 2011-11-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency