peanuts 2.0.7 → 2.1

data/README.rdoc

@@ -36,6 +36,8 @@ http://rdoc.info/projects/omg/peanuts
 Please report via Github issue tracking.
 
 === Example
+See also http://gist.github.com/230202 for real world example.
+
     class Cheezburger
       include Peanuts
 

data/lib/peanuts/mappable.rb

@@ -12,7 +12,7 @@ module Peanuts #:nodoc:
     def from_xml(source, options = {})
       source = XML::Reader.new(source, options) unless source.is_a?(XML::Reader)
       e = source.find_element
-      e && self.class.mapper.read(self, source)
+      e && Mapper.of(self.class).read(self, source)
     end
 
     #    save_to(:string|:document[, options])      -> new_string|new_document
@@ -32,7 +32,7 @@ module Peanuts #:nodoc:
     #    puts doc.to_s
     def to_xml(dest = :string, options = {})
       dest = XML::Writer.new(dest, options) unless dest.is_a?(XML::Writer)
-      self.class.mapper.write(self, dest)
+      Mapper.of(self.class).write(self, dest)
       dest.result
     end
   end
@@ -50,6 +50,16 @@ module Peanuts #:nodoc:
       cls
     end
 
+    def self.object_type?(type)
+      type.is_a?(Class) && !(type < Converter)
+    end
+
+    def from_xml(source, options = {})
+      new.from_xml(source, options)
+    end
+
+    private
+
     #    mapper -> Mapper
     #
     # Returns the mapper for the class.
@@ -144,17 +154,20 @@ module Peanuts #:nodoc:
     #    class Cat
     #      include Peanuts
     #      ...
-    #      shallow :friends do
+    #      wrapper :friends do
     #        element :friends, :name => :friend
     #      end
-    #      shallow :cheeseburger, Cheeseburger, :name => :cheezburger
+    #      wrapper :cheeseburger, Cheeseburger, :name => :cheezburger
     #      ...
     #    end
-    def shallow_element(name, *args, &block)
-      add_mapping(:shallow_element, name, *args, &block)
+    def wrapper_element(name, *args, &block)
+      add_mapping(:wrapper_element, name, *args, &block)
     end
 
-    alias shallow shallow_element
+    alias wrapper wrapper_element
+
+    alias shallow_element wrapper_element
+    alias shallow wrapper_element
 
     #    elements(name[, type][, options])   -> mapping_object
     #    elements(name[, options]) { block }  -> mapping_object
@@ -198,40 +211,35 @@ module Peanuts #:nodoc:
       add_mapping(:attribute, name, *args)
     end
 
+    def content(name, *args, &block)
+      add_mapping(:content, name, *args, &block)
+    end
+
     def schema(schema = nil)
       mapper.schema = schema if schema
       mapper.schema
     end
 
-    def from_xml(source, options = {})
-      new.from_xml(source, options)
-    end
-
-    private
-    def object_type?(type)
-      type.is_a?(Class) && !(type < Converter)
-    end
-
     def add_mapping(node, name, *args, &block)
       type, options = *args
       type, options = (block ? Class.new : :string), type if type.nil? || type.is_a?(Hash)
 
-      object_type = object_type?(type)
+      object_type = MappableType.object_type?(type)
       options = prepare_options(node, options || {})
 
       mapper << m = case node
       when :element
-        options.delete(:shallow) ? ShallowElement : (object_type ? Element : ElementValue)
+        options.delete(:wrapper) ? WrapperElement : (object_type ? Element : ElementValue)
       when :elements
         object_type ? Elements : ElementValues
       when :attribute
         Attribute
-      when :shallow_element
-        ShallowElement
+      when :wrapper_element
+        WrapperElement
+      when :content
+        Content
       end.new(name, type, options)
 
-      raise ArgumentError, 'bad type for shallow element' if !object_type && m.is_a?(ShallowElement)
-
       default_ns = m.prefix ? mapper.default_ns : m.namespace_uri
       if object_type && !type.is_a?(MappableType)
         raise ArgumentError, 'block is required' unless block

data/lib/peanuts/mapper.rb

@@ -2,6 +2,10 @@ require 'enumerator'
 
 module Peanuts
   class Mapper
+    def self.of(cls)
+      cls.send(:mapper)
+    end
+
     include Enumerable
 
     attr_reader :root, :namespaces, :ns_context

data/lib/peanuts/mappings.rb

@@ -1,5 +1,6 @@
 require 'forwardable'
 require 'peanuts/converters'
+require 'set'
 
 module Peanuts
   class Mapping
@@ -140,11 +141,37 @@ module Peanuts
     module ObjectMapping
       private
       def read_value(reader)
-        type.mapper.read(type.new, reader)
+        Mapper.of(type).read(type.new, reader)
       end
 
       def write_value(writer, value)
-        type.mapper.write_children(value, writer)
+        Mapper.of(type).write_children(value, writer)
+      end
+    end
+
+    class Content < MemberMapping
+      NODETYPES = Set[:text, :significant_whitespace, :cdata].freeze
+
+      include ValueMapping
+
+      node_type :text
+
+      def initialize(name, type, options)
+        options[:name] = '#text'
+        super
+      end
+
+      def matches?(reader)
+        NODETYPES.include? reader.node_type
+      end
+
+      private
+      def read_it(reader, acc)
+        (acc || '') << read_value(reader)
+      end
+
+      def write_it(writer, value)
+        write_value(writer, value) if value
       end
     end
 
@@ -188,13 +215,13 @@ module Peanuts
       node_type :element
     end
 
-    class ShallowElement < Element
+    class WrapperElement < Element
       def read(nut, reader)
-        type.mapper.read(nut, reader)
+        Mapper.of(type).read(nut, reader)
       end
 
       def write(nut, writer)
-        write_node(writer) {|w| type.mapper.write_children(nut, w) }
+        write_node(writer) {|w| Mapper.of(type).write_children(nut, w) }
       end
 
       def clear(nut)
@@ -202,8 +229,10 @@ module Peanuts
       end
 
       def define_accessors(type)
-        self.type.mapper.define_accessors(type)
+        Mapper.of(self.type).define_accessors(type)
       end
     end
+
+    ShallowElement = WrapperElement
   end
 end

data/spec/cat_spec.rb

@@ -3,7 +3,6 @@ $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'bigdecimal'
 require 'test/unit'
 require 'rubygems'
-require 'shoulda'
 require 'peanuts'
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: peanuts
 version: !ruby/object:Gem::Version 
-  version: 2.0.7
+  version: "2.1"
 platform: ruby
 authors: 
 - Igor Gunko
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-30 00:00:00 +03:00
+date: 2010-01-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.8
+        version: "1.3"
     version: 
 description: "    Peanuts is an XML to Ruby and back again mapping library.\n"
 email: tekmon@gmail.com
@@ -46,7 +46,6 @@ files:
 - MIT-LICENSE
 - Rakefile
 - lib/peanuts.rb
-- lib/omg-peanuts.rb
 - lib/peanuts/mappable.rb
 - lib/peanuts/mappings.rb
 - lib/peanuts/converters.rb

data/lib/omg-peanuts.rb

@@ -1 +0,0 @@
-require 'peanuts'