pipa-xmlnuts 0.0.5 → 0.1

data/README.rdoc

@@ -0,0 +1,121 @@
+== Introduction
+XmlNuts is an library that allows for bidirectional mapping between Ruby objects and XML.
+
+== Features
+- Type awareness (extensible)
+- XML namespaces support
+- Pluggable backends to work with different XML APIs (only REXML implemented so far)
+
+== Installation
+ gem install pipa-xmlnuts --source http://gems.github.com
+
+== Usage
+TODO
+Please see example below.
+
+== Issue tracking
+Please file bugs and feature requests at http://pipa.lighthouseapp.com/projects/21756-xmlnuts
+
+== License
+Released under the MIT license (included).
+
+== Example
+    class Cheezburger
+      include XmlNuts::Nut
+
+      attribute :weight, :integer
+    end
+
+    class Cat
+      include XmlNuts::Nut
+
+      namespaces :lol => 'urn:x-lol', :kthnx => 'urn:x-lol:kthnx'
+
+      root 'kitteh', :xmlns => :lol
+
+      attribute :has_tail, :boolean, :xmlname => 'has-tail', :xmlns => 'urn:x-lol:kthnx'
+      attribute :ears, :integer
+
+      element :ration, [:string], :xmlname => :eats, :xmlns => :kthnx
+      element :name, :string, :whitespace => :collapse, :xmlns => 'urn:x-lol:kthnx'
+      elements :paws, :string, :xmlname => :paw
+
+      element :friends, :xmlname => :pals do # anonymous class definition follows within block
+        elements :names, :string, :xmlname => :friend, :xmlname => :pal
+      end
+
+      element :cheezburger, Cheezburger
+    end
+
+    class ParsingTest < Test::Unit::TestCase
+      def setup
+        @xml_fragment = <<-EOS
+            <kitteh xmlns='urn:x-lol' xmlns:kthnx='urn:x-lol:kthnx' ears=' 2 ' kthnx:has-tail=' yes  '>
+              <name xmlns='urn:x-lol:kthnx'>
+                  Silly
+                  Tom
+                  Писда
+              </name>
+              <kthnx:eats>
+                tigers
+                lions
+              </kthnx:eats>
+              <pals>
+                <pal>Chrissy</pal>
+                <pal>Missy</pal>
+                <pal>Sissy</pal>
+              </pals>
+              <paw>  one</paw>
+              <paw> two </paw>
+              <paw>three</paw>
+              <paw>four</paw>
+              <cheezburger weight='2' />
+            </kitteh>
+        EOS
+        @cat = Cat.parse(@xml_fragment)
+      end
+
+      context "A cat" do
+        should 'be named Silly Tom' do
+          assert_equal 'Silly Tom Писда', @cat.name
+        end
+
+        should 'eat tigers and lions' do
+          assert_equal %w(tigers lions), @cat.ration
+        end
+
+        should 'be a friend of Chrissy, Missy & Sissy' do
+          assert_equal ['Chrissy', 'Missy', 'Sissy'], @cat.friends.names
+        end
+
+        should 'have 2 ears' do
+          assert_equal 2, @cat.ears
+        end
+
+        should 'have tail' do
+          assert_equal true, @cat.has_tail
+        end
+
+        should 'have four paws' do
+          assert_not_nil @cat.paws
+          assert_equal 4, @cat.paws.length
+          assert_equal %w(one two three four), @cat.paws
+        end
+
+        should 'has cheezburger' do
+          assert_kind_of Cheezburger, @cat.cheezburger
+        end
+      end
+
+      context 'A cheezburger' do
+        setup do
+          @burger = @cat.cheezburger
+        end
+
+        should 'weigh 2 pounds' do
+          assert_equal 2, @burger.weight
+        end
+      end
+    end
+    ...
+    puts @cat.build

data/lib/xmlnuts/converters.rb

@@ -36,9 +36,9 @@ module XmlNuts
       def from_xml(string)
         return nil unless string
         string = case @whitespace
-        when :trim then string.strip
+        when :trim then string.gsub(/(\A\s*)|(\s*\Z)/, '')
         when :preserve then string
-        when :collapse then string.gsub(/\s+/, ' ').strip
+        when :collapse then string.gsub(/\s+/, ' ').gsub(/\A\s*|\s*\Z|\s*(?=\s)/, '')
         end
       end
     end

data/lib/xmlnuts/nuts.rb

@@ -54,7 +54,8 @@ module XmlNuts #:nodoc:
         @root ||= Root.new('root')
       end
 
-      #    element(name, [type[, options]]) -> Mappings::Element or Mappings::ElementValue
+      #    element(name, [type[, options]])   -> Mappings::Element or Mappings::ElementValue
+      #    element(name[, options]) { block } -> Mappings::Element
       #
       # Defines single-element mapping.
       #
@@ -62,6 +63,7 @@ module XmlNuts #:nodoc:
       # +name+::    Accessor name
       # +type+::    Element type. +:string+ assumed if omitted (see +Converter+).
       # +options+:: +:xmlname+, +:xmlns+, converter options (see +Converter+).
+      # +block+::   An anonymous class definition.
       #
       # === Example:
       #    class Cat
@@ -71,12 +73,14 @@ module XmlNuts #:nodoc:
       #      element :cheeseburger, Cheeseburger, :xmlname => :cheezburger
       #      ...
       #    end
-      def element(name, type = :string, options = {})
+      def element(name, type = :string, options = {}, &block)
+        type, options = prepare_args(type, options, &block)
         define_accessor name
         (mappings << (type.is_a?(Class) ? Element : ElementValue).new(name, type, prepare_options(options))).last
       end
 
-      #    elements(name, [type[, options]]) -> Mappings::Element or Mappings::ElementValue
+      #    elements(name, [type[, options]])   -> Mappings::Element or Mappings::ElementValue
+      #    elements(name[, options]) { block } -> Mappings::Element
       #
       # Defines multiple elements mapping.
       #
@@ -84,16 +88,18 @@ module XmlNuts #:nodoc:
       # +name+::    Accessor name
       # +type+::    Element type. +:string+ assumed if omitted (see +Converter+).
       # +options+:: +:xmlname+, +:xmlns+, converter options (see +Converter+).
+      # +block+::   An anonymous class definition.
       #
       # === Example:
       #    class RichCat
       #      include XmlNuts::Nut
       #      ...
       #      elements :ration, :string, :whitespace => :collapse
-      #      elements :cheeseburgers, Cheeseburger, :xmlname => :cheezburgers
+      #      elements :cheeseburgers, Cheeseburger, :xmlname => :cheezburger
       #      ...
       #    end
-      def elements(name, type = :string, options = {})
+      def elements(name, type = :string, options = {}, &block)
+        type, options = prepare_args(type, options, &block)
         define_accessor name
         (mappings << (type.is_a?(Class) ? Elements : ElementValues).new(name, type, prepare_options(options))).last
       end
@@ -122,7 +128,7 @@ module XmlNuts #:nodoc:
 
       #    mappings -> Array
       #
-      # Returns all previously defined XmlNuts mappings on a class.
+      # Returns all XmlNuts mappings defined on a class.
       def mappings
         @mappings ||= []
       end
@@ -143,6 +149,18 @@ module XmlNuts #:nodoc:
       end
 
       private
+      def prepare_args(type, options, &block)
+        if block_given?
+          options = type if type.is_a?(Hash)
+          type = Class.new
+          type.class_eval do
+            include XmlNuts::Nut
+            class_eval(&block)
+          end
+        end
+        return type, prepare_options(options)
+      end
+
       def prepare_options(options)
         ns = options[:xmlns]
         if ns.is_a?(Symbol)

data/lib/xmlnuts.rb

@@ -1,48 +1 @@
 require 'xmlnuts/nuts'
-
-#class Cheezburger
-#  include XmlNuts::Nut
-#
-#  attribute :weight, :integer
-#end
-#
-#class Pet
-#  include XmlNuts::Nut
-#
-#  namespaces :pipi => 'a', :piz => 'b'
-#
-#  root 'anus', :xmlns => :piz
-#
-#  element :eats, [:string], :xmlname => :ration, :xmlns => 'a'
-#  element :species, :string, :whitespace => :collapse
-#  elements :paws, :string, :xmlname => :paw
-#
-#  attribute :has_tail, :boolean, :xmlname => 'has-tail', :xmlns => 'b'
-#  attribute :height, :integer
-#
-#  element :cheezburger, Cheezburger
-#end
-#
-#xml_fragment = <<-EOS
-#        <mypet xmlns='lol' xmlns:pizda="b" height=' 12 ' pizda:has-tail=' yes  '>
-#          <species>
-#silly
-#              mouse
-#          </species>
-#          <pi:ration xmlns:pi="a">
-#            tigers
-#            lions
-#          </pi:ration>
-#          <paw>  one</paw>
-#          <paw> two </paw>
-#          <paw>three</paw>
-#          <paw>four</paw>
-#          <cheezburger weight='2'>
-#          </cheezburger>
-#          <cub age='4'>
-#          </cub>
-#        </mypet>
-#EOS
-#pet = Pet.parse(xml_fragment)
-#
-#puts pet.build

data/test/parsing_test.rb

@@ -13,16 +13,20 @@ end
 class Cat
   include XmlNuts::Nut
 
-  namespaces :lol => 'urn:lol', :p => 'b'
+  namespaces :lol => 'urn:x-lol', :kthnx => 'urn:x-lol:kthnx'
 
-  root 'kitteh', :xmlns => 'lol'
+  root 'kitteh', :xmlns => :lol
 
-  element :eats, [:string], :xmlname => :ration, :xmlns => :lol
-  element :friend, :string, :whitespace => :collapse, :xmlns => 'c'
+  attribute :has_tail, :boolean, :xmlname => 'has-tail', :xmlns => 'urn:x-lol:kthnx'
+  attribute :ears, :integer
+
+  element :ration, [:string], :xmlname => :eats, :xmlns => :kthnx
+  element :name, :string, :whitespace => :collapse, :xmlns => 'urn:x-lol:kthnx'
   elements :paws, :string, :xmlname => :paw
 
-  attribute :has_tail, :boolean, :xmlname => 'has-tail', :xmlns => 'b'
-  attribute :height, :integer
+  element :friends, :xmlname => :pals do
+    elements :names, :string, :xmlname => :pal
+  end
 
   element :cheezburger, Cheezburger
 end
@@ -30,39 +34,46 @@ end
 class ParsingTest < Test::Unit::TestCase
   def setup
     @xml_fragment = <<-EOS
-        <mypet xmlns='lol' xmlns:aa='urn:lol' xmlns:bb='b' height=' 12 ' bb:has-tail=' yes  '>
-          <friend xmlns='c'>
-silly
-              mouse
-          </friend>
-          <aa:ration>
+        <kitteh xmlns='urn:x-lol' xmlns:kthnx='urn:x-lol:kthnx' ears=' 2 ' kthnx:has-tail=' yes  '>
+          <name xmlns='urn:x-lol:kthnx'>
+              Silly
+              Tom
+              Писта
+          </name>
+          <kthnx:eats>
             tigers
             lions
-          </aa:ration>
+          </kthnx:eats>
+          <pals>
+            <pal>Chrissy</pal>
+            <pal>Missy</pal>
+            <pal>Sissy</pal>
+          </pals>
           <paw>  one</paw>
           <paw> two </paw>
           <paw>three</paw>
           <paw>four</paw>
-          <cheezburger weight='2'>
-          </cheezburger>
-          <cub age='4'>
-          </cub>
-        </mypet>
+          <cheezburger weight='2' />
+        </kitteh>
     EOS
     @cat = Cat.parse(@xml_fragment)
   end
 
   context "A cat" do
-    should 'be a friend of a silly mouse' do
-      assert_equal 'silly mouse', @cat.friend
+    should 'be named Silly Tom' do
+      assert_equal 'Silly Tom Писта', @cat.name
     end
 
     should 'eat tigers and lions' do
-      assert_equal ['tigers', 'lions'], @cat.eats
+      assert_equal %w(tigers lions), @cat.ration
+    end
+
+    should 'be a friend of Chrissy, Missy & Sissy' do
+      assert_equal ['Chrissy', 'Missy', 'Sissy'], @cat.friends.names
     end
 
-    should 'be 12 meters tall' do
-      assert_equal 12, @cat.height
+    should 'have 2 ears' do
+      assert_equal 2, @cat.ears
     end
 
     should 'have tail' do
@@ -85,7 +96,7 @@ silly
       @burger = @cat.cheezburger
     end
 
-    should 'weigh 2 kg' do
+    should 'weigh 2 pounds' do
       assert_equal 2, @burger.weight
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pipa-xmlnuts
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: "0.1"
 platform: ruby
 authors: 
 - Igor Gunko
@@ -13,17 +13,17 @@ date: 2008-12-16 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: XmlNuts is an XML to ruby object and back again mapping library.
+description: XmlNuts is an XML to Ruby and back again mapping library.
 email: tekmon@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 - MIT-LICENSE
 files: 
-- README
+- README.rdoc
 - MIT-LICENSE
 - lib/xmlnuts.rb
 - lib/xmlnuts/nuts.rb
@@ -38,7 +38,7 @@ rdoc_options:
 - --line-numbers
 - --inline-source
 - --main
-- README
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -59,6 +59,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Making xml<->ruby binding easy
+summary: Making XML <-> Ruby binding easy
 test_files: 
 - test/parsing_test.rb

data/README

@@ -1,5 +0,0 @@
-== xmlnuts
-
-
-
-Released under the MIT license (included)