smg 0.0.2 → 0.1.0

data/README.rdoc

@@ -8,6 +8,7 @@ Backed by Nokogiri's SAX Parser.
 * Typecasting
 * Nested resources (aka has_one)
 * Collections (aka has_many)
+* Contextual parsing
 
 == EXAMPLES:
 
@@ -38,7 +39,7 @@ Backed by Nokogiri's SAX Parser.
 
   end
 
-=== discogs.com
+=== discogs.com (with context)
 
   class Label
 
@@ -49,10 +50,9 @@ Backed by Nokogiri's SAX Parser.
       extract :release  , :at => :id, :as => :discogs_id, :class => :integer
       extract :release  , :at => :status
 
-      root 'release'
-      extract :title
-      extract :catno
-      extract :artist
+      extract 'release/title'
+      extract 'release/catno'
+      extract 'release/artist'
 
     end
 
@@ -61,10 +61,18 @@ Backed by Nokogiri's SAX Parser.
     root 'resp/label'
     extract :name
     extract :profile
-    collect 'releases/release'  , :as => :releases, :class => Release
+    collect 'releases/release'  , :as => :releases, :class => Release, :context => [:with_releases]
 
   end
 
+  label = Label.parse(xml)
+  label.name #=> "name of the label"
+  label.releases #=> []
+
+  label = Label.parse(xml, :with_releases)
+  label.name #=> "name of the label"
+  label.releases #=> [#<Label::Release...>, ... #<Label::Release...>]
+
 == REQUIREMENTS:
 
 nokogiri (>=1.3)

data/examples/discogs.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+
+class Label
+
+  class Release
+
+    include SMG::Resource
+
+    extract 'release'  , :at => :id, :as => :discogs_id, :class => :integer
+    extract 'release'  , :at => :status
+
+    extract 'release/title'
+    extract 'release/catno'
+    extract 'release/artist'
+
+  end
+
+  include SMG::Resource
+
+  root 'resp/label'
+  extract 'name'
+  extract 'profile'
+  collect 'releases/release'  , :as => :releases, :class => Release, :context => [:with_releases]
+
+end
+
+data = File.read(ROOT.join('spec/fixtures/discogs/Genosha+Recordings.xml'))
+
+label = Label.parse(data)
+puts label.name
+puts label.profile
+puts label.releases.map { |release| "#{release.catno}: #{release.title}" }.join("\n")
+
+label = Label.parse(data,:with_releases)
+puts label.name
+puts label.profile
+puts label.releases.map { |release| "#{release.catno}: #{release.title}" }.join("\n")
+
+# EOF

data/examples/helper.rb

@@ -0,0 +1,10 @@
+require 'pathname'
+
+ROOT = Pathname(__FILE__).dirname.expand_path.parent
+
+dir = ROOT.join('lib').to_s
+$:.unshift(dir) unless $:.include?(dir)
+
+require 'smg'
+
+# EOF

data/examples/plant.rb

@@ -0,0 +1,89 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+
+class Conservation
+
+  include SMG::Resource
+
+  extract :conservation  , :at => :code
+  extract :conservation  , :at => :year   , :context => [:conservation]
+  extract :conservation  , :as => :status , :context => [:conservation]
+
+end
+
+class Plant
+
+  include SMG::Resource
+
+  root 'spec'
+
+  extract 'family'            , :context => [:classification]
+  extract 'genus'             , :context => [:classification]
+  extract 'binomial'
+  extract 'conservation'      , :context => [:conservation, :info], :class => Conservation
+  collect 'synonims/binomial' , :context => [:synonims], :as => :synonims, 
+
+end
+
+data = <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<spec>
+  <family>Rosaceae</family>
+  <genus>Malus</genus>
+  <conservation code="NE" year="2007">Not Evaluated</conservation>
+  <binomial>Malus pumila Mill.</binomial>
+  <synonims>
+    <binomial>Malus communis  Poir.</binomial>
+    <binomial>Malus domestica auct. non Borkh.</binomial>
+    <binomial>Malus praecox (Pall.) Borkh.</binomial>
+    <binomial>Malus pumila Mill. var. niedzwetzkyana (Dieck) C.K. Schneid.</binomial>
+    <binomial>Malus sylvestris Amer. auth., non (L.) Mill.</binomial>
+    <binomial>Malus sylvestris (L.) Mill. var. praecox (Pall.) Ponomar.</binomial>
+    <binomial>Pyrus pumila (Mill.) K. Koch</binomial>
+  </synonims>
+</spec>
+XML
+
+plant = Plant.parse(data,:classification)
+
+puts plant.family               #=> "Rosaceae"
+puts plant.genus                #=> "Malus"
+puts plant.binomial             #=> "Malus pumila Mill."
+puts plant.conservation         #=> nil
+puts plant.synonims             #=> []
+
+plant = Plant.parse(data,:synonims)
+
+puts plant.family               #=> nil
+puts plant.genus                #=> nil
+puts plant.binomial             #=> "Malus pumila Mill."
+puts plant.conservation         #=> nil
+puts plant.synonims             #=> [ "Malus communis  Poir.", 
+                                #     "Malus domestica auct. non Borkh.",
+                                #     "Malus praecox (Pall.) Borkh.",
+                                #     "Malus pumila Mill. var. niedzwetzkyana (Dieck) C.K. Schneid.",
+                                #     "Malus sylvestris Amer. auth., non (L.) Mill.",
+                                #     "Malus sylvestris (L.) Mill. var. praecox (Pall.) Ponomar.",
+                                #     "Pyrus pumila (Mill.) K. Koch" ]
+
+plant = Plant.parse(data,:conservation)
+
+puts plant.family               #=> nil
+puts plant.genus                #=> nil
+puts plant.binomial             #=> "Malus pumila Mill."
+puts plant.conservation.status  #=> "Not Evaluated"
+puts plant.conservation.code    #=> "NE"
+puts plant.conservation.year    #=> "2007"
+puts plant.synonims             #=> []
+
+plant = Plant.parse(data,:info)
+
+puts plant.family               #=> nil
+puts plant.genus                #=> nil
+puts plant.binomial             #=> "Malus pumila Mill."
+puts plant.conservation.status  #=> nil
+puts plant.conservation.code    #=> "NE"
+puts plant.conservation.status  #=> nil
+puts plant.synonims             #=> []
+
+
+# EOF

data/examples/twitter.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+
+class Status
+  include SMG::Resource
+
+  root 'status'
+
+  extract :id         , :class => :integer, :as => :status_id
+  extract :created_at , :class => :datetime
+  extract :text
+
+end
+
+class User
+  include SMG::Resource
+
+  root 'user'
+
+  extract :id                 , :class => :integer, :as => :twitter_id
+  extract :location           , :class => :string
+  extract :status             , :class => Status
+  extract :created_at         , :class => :datetime
+  extract :name
+  extract :screen_name
+
+end
+
+data = File.read(ROOT.join('spec/fixtures/twitter/pipopolam.xml'))
+user = User.parse(data)
+
+puts "#{user.screen_name} (#{user.name}), since #{user.created_at.strftime('%Y.%m.%d')}"
+puts user.location
+puts user.status.text
+
+# EOF

data/lib/smg/document.rb

@@ -3,12 +3,13 @@ module SMG #:nodoc:
 
     attr_reader :object, :thing
 
-    def initialize(object, thing = nil)
+    def initialize(object, context = nil, thing = nil)
       @object   = object
       @mapping  = object.class.mapping
       @stack    = []
       @docs     = []
       @thing    = thing
+      @context  = context
       @chars    = ""
     end
 
@@ -18,26 +19,33 @@ module SMG #:nodoc:
 
       if doc = @docs.last
         doc.start_element(name, attrs)
-      elsif thing = @mapping.nested[@stack]
-        @docs << doc = Document.new(thing.data_class.new,thing)
+      elsif (thing = @mapping.nested[@stack]) && thing.in_context_of?(@context)
+        @docs << doc = Document.new(thing.data_class.new,@context,thing)
         doc.start_element(name, attrs)
       end
 
       if !attrs.empty? && maps = @mapping.attributes[@stack]
-        maps.values_at(*Hash[*attrs].keys).compact.each do |m|
-          ix = attrs.index(m.at)
-          @object.__send__(m.accessor, m.cast(attrs.at(ix+=1))) if ix
+        attrh = Hash[*attrs]
+        maps.values_at(*attrh.keys).compact.each do |m|
+          @object.__send__(m.accessor, m.cast(attrh[m.at])) if m.in_context_of?(@context)
         end
       end
 
-      @element = @mapping.elements[@stack]
-      @chars = ""
+      if (e = @mapping.elements[@stack]) && e.in_context_of?(@context)
+        @element = e
+        @chars = ""
+      end
 
     end
 
     def end_element(name)
-      @object.send(@element.accessor, @element.cast(@chars)) if @element && @chars
-      @chars, @element = nil, nil
+
+      if @element
+        @object.__send__(@element.accessor, @element.cast(@chars))
+        @chars = ""
+        @element = nil
+      end
+
       if doc = @docs.last
         doc.end_element(name)
         if doc.thing.path == @stack
@@ -45,13 +53,14 @@ module SMG #:nodoc:
           @docs.pop
         end
       end
+
       @stack.pop
+
     end
 
     def characters(string)
       if doc = @docs.last
         doc.characters(string)
-        @chars ||= ""
         @chars << string
       elsif @element
         @chars << string

data/lib/smg/mapping.rb

@@ -12,22 +12,25 @@ module SMG #:nodoc:
 
     def attach_element(tag,options)
       chain = handle_path(tag)
+      thing = Element.new(chain, options)
       if options.key?(:at)
-        thing = Element.new(chain, options)
         @attributes[chain] ||= {}
         @attributes[chain][thing.at] = thing
       else
-        @elements[chain] = Element.new(chain, options)
+        @elements[chain] = thing
       end
+      thing
     end
 
     def attach_nested(tag,options)
       chain = handle_path(tag)
-      @nested[chain] = Element.new(chain, options.merge(:nested => true))
+      thing = Element.new(chain, options.merge(:nested => true))
+      @nested[chain] = thing
+      thing
     end
 
     def use_root(path)
-      @root = normalize_path(path) # just a root tag for further definitions
+      @root = normalize_path(path)
     end
 
     private

data/lib/smg/mapping/element.rb

@@ -2,26 +2,36 @@ module SMG #:nodoc:
   class Mapping #:nodoc:
 
     class Element
-      attr_reader :path, :name, :accessor, :data_class, :cast_to, :at
+      attr_reader :path, :name, :accessor, :data_class, :cast_to, :at, :context
 
       def initialize(path, options = {})
 
         @name       = (options[:as] || options[:at] || path.last).to_sym
         @path       = path
         @collection = !!options[:collection]
-        @accessor   = @collection ? :"attach_#{@name}" : :"#{@name}="
+        @accessor   = @collection ? :"append_to_#{@name}" : :"#{@name}="
         @data_class = nil
         @cast_to    = nil
+        @context    = nil
 
-        if c = options[:class]
-          if Class === c
-            raise ArgumentError, "#{c} is not an SMG::Model" unless c.include?(::SMG::Resource)
-            @data_class = c
-          elsif Symbol === c
-            raise ArgumentError, "#{c} is not a valid typecast" unless TypeCasts.key?(c)
-            @cast_to = c
+        if options.key?(:context)
+          if Array === options[:context]
+            @context = options[:context].compact
+            @context.uniq!
+            @context = nil if @context.empty?
           else
-            raise ArgumentError, ":class should be an SMG::Model or a Symbol"
+            raise ArgumentError, ":context should be an Array"
+          end
+        end
+
+        if options.key?(:class)
+          klass = options[:class]
+          if SMG::Model === klass
+            @data_class = klass
+          elsif TypeCasts.key?(klass)
+            @cast_to = klass
+          else
+            raise ArgumentError, ":class should be an SMG::Model or a valid typecast"
           end
         end
 
@@ -40,6 +50,10 @@ module SMG #:nodoc:
         @collection
       end
 
+      def in_context_of?(context)
+        @context.nil? || @context.include?(context)
+      end
+
     end
 
   end

data/lib/smg/model.rb

@@ -43,8 +43,12 @@ module SMG #:nodoc:
       mapping.use_root(tag)
     end
 
-    def parse(xml)
-      self.new.parse(xml)
+    def parse(data, context = nil)
+      resource = new
+      doc = SMG::Document.new(resource,context)
+      ::Nokogiri::XML::SAX::Parser.new(doc).parse(data)
+      resource.instance_variable_set(:@_parsed, true)
+      resource
     end
 
     def mapping

data/lib/smg/resource.rb

@@ -5,10 +5,8 @@ module SMG #:nodoc:
       base.extend Model
     end
 
-    def parse(data)
-      doc = SMG::Document.new(self)
-      ::Nokogiri::XML::SAX::Parser.new(doc).parse(data)
-      self
+    def parsed?
+      @_parsed
     end
 
   end

data/lib/smg/version.rb

@@ -1,5 +1,5 @@
 module SMG
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end
 
 # EOF

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - SSDany
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-17 00:00:00 +04:00
+date: 2010-04-29 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,7 +31,8 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 description: |
-  Object to xml mapping library with simple declarative syntax.
+  XML to Object mapping library with simple declarative syntax.
+  Supports 'contextual' parsing.
   Backed by Nokogiri's SAX Parser.
 
 email: inadsence@gmail.com
@@ -43,6 +44,10 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - README.rdoc
+- examples/helper.rb
+- examples/discogs.rb
+- examples/twitter.rb
+- examples/plant.rb
 - lib/smg/document.rb
 - lib/smg/mapping/element.rb
 - lib/smg/mapping/typecasts.rb