smg 0.1.0 → 0.2.0

data/spec/context_spec.rb

@@ -0,0 +1,189 @@
+require File.expand_path File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe SMG::Model do
+
+  before :each do
+    @klass = Class.new { include SMG::Resource }
+    @data = data = File.read(FIXTURES_DIR + 'fake/malus.xml')
+  end
+
+  describe ".extract with context" do
+
+    before :each do
+      @data = File.read(FIXTURES_DIR + 'fake/malus.xml')
+    end
+
+    it "does not extract data with the custom :context, when no context passed" do
+
+      @klass.root 'spec'
+
+      @klass.extract :genus
+      @klass.extract :binomial
+      @klass.extract :conservation  , :context => [:conservation]
+
+      malus = @klass.parse(@data)
+      malus.genus.should        == "Malus"
+      malus.binomial.should     == "Malus sieversii (Ledeb.) M.Roem."
+      malus.conservation.should be_nil
+
+      malus = @klass.parse(@data, :conservation)
+      malus.genus.should        == "Malus"
+      malus.binomial.should     == "Malus sieversii (Ledeb.) M.Roem."
+      malus.conservation.should == "Vulnerable (IUCN 2.3)"
+
+    end
+
+    it "respects the :context of elements and attributes" do
+
+      @klass.root 'spec'
+
+      @klass.extract :genus         , :context => [:classification]
+      @klass.extract :binomial      , :context => [:conservation, :classification]
+      @klass.extract :conservation  , :context => [:conservation], :as => :status
+      @klass.extract :conservation  , :context => [:conservation], :at => :code
+
+      malus = @klass.parse(@data,:conservation)
+      malus.genus.should    be_nil
+      malus.binomial.should == "Malus sieversii (Ledeb.) M.Roem."
+      malus.status.should   == "Vulnerable (IUCN 2.3)"
+      malus.code.should     == "VU"
+
+      malus = @klass.parse(@data,:classification)
+      malus.genus.should    == "Malus"
+      malus.binomial.should == "Malus sieversii (Ledeb.) M.Roem."
+      malus.status.should   be_nil
+      malus.code.should     be_nil
+
+    end
+
+    it "respects the :context of nested resources" do
+
+      cclass = Class.new { include SMG::Resource }
+      cclass.extract :conservation  , :at => :code
+      cclass.extract :conservation  , :as => :status
+
+      @klass.root 'spec'
+
+      @klass.extract :genus         , :context => [:classification]
+      @klass.extract :binomial      , :context => [:conservation, :classification]
+      @klass.extract :conservation  , :context => [:conservation], :class => cclass
+
+      malus = @klass.parse(@data,:classification)
+      malus.genus.should    == "Malus"
+      malus.binomial.should == "Malus sieversii (Ledeb.) M.Roem."
+      malus.conservation.should be_nil
+
+      malus = @klass.parse(@data,:conservation)
+      malus.genus.should be_nil
+      malus.binomial.should == "Malus sieversii (Ledeb.) M.Roem."
+
+      malus.conservation.should be_an_instance_of cclass
+      malus.conservation.status.should == "Vulnerable (IUCN 2.3)"
+      malus.conservation.code.should == "VU"
+
+    end
+
+    it "respects the :context IN nested resources" do
+
+      cclass = Class.new { include SMG::Resource }
+      cclass.extract :conservation  , :at => :code    , :context => [:conservation]
+      cclass.extract :conservation  , :as => :status  , :context => [:conservation, :info]
+
+      @klass.root 'spec'
+      @klass.extract :conservation  , :class => cclass
+
+      malus = @klass.parse(@data,:conservation)
+      malus.conservation.should be_an_instance_of cclass
+      malus.conservation.status.should == "Vulnerable (IUCN 2.3)"
+      malus.conservation.code.should == "VU"
+
+      malus = @klass.parse(@data,:info)
+      malus.conservation.should be_an_instance_of cclass
+      malus.conservation.status.should == "Vulnerable (IUCN 2.3)"
+      malus.conservation.code.should be_nil
+
+    end
+
+  end
+
+  describe ".collect with context" do
+
+    before :each do
+      @data = File.read(FIXTURES_DIR + 'discogs/Ophidian.xml')
+    end
+
+    it "does not collect data with the custom :context, when no context passed" do
+
+      @klass.root 'resp/artist'
+      @klass.collect 'namevariations/name'  , :as => :namevariations
+      @klass.collect 'aliases/name'         , :as => :aliases,  :context => [:aliases]
+
+      ophidian = @klass.parse(@data)
+      ophidian.namevariations.should == ["Ohidian", "Ophidian as Raziel", "Ophidian [C. Hoyer]", "Ophidiom"]
+      ophidian.aliases.should be_an ::Array
+      ophidian.aliases.should be_empty
+
+      ophidian = @klass.parse(@data, :aliases)
+      ophidian.namevariations.should == ["Ohidian", "Ophidian as Raziel", "Ophidian [C. Hoyer]", "Ophidiom"]
+      ophidian.aliases.should == ["Conrad Hoyer", "Cubist Boy", "Meander", "Trypticon"]
+
+    end
+
+    it "respects the :context of collections" do
+
+      @klass.root 'resp/artist'
+      @klass.collect 'namevariations/name'  , :context => [:namevariations] , :as => :namevariations
+      @klass.collect 'aliases/name'         , :context => [:aliases]        , :as => :aliases
+
+      ophidian = @klass.parse(@data,:namevariations)
+      ophidian.namevariations.should == ["Ohidian", "Ophidian as Raziel", "Ophidian [C. Hoyer]", "Ophidiom"]
+      ophidian.aliases.should be_an ::Array
+      ophidian.aliases.should be_empty
+
+      ophidian = @klass.parse(@data,:aliases)
+      ophidian.namevariations.should be_an ::Array
+      ophidian.namevariations.should be_empty
+      ophidian.aliases.should == ["Conrad Hoyer", "Cubist Boy", "Meander", "Trypticon"]
+
+    end
+
+    it "respects the :context IN collections" do
+
+      imgclass = Class.new { include SMG::Resource }
+      imgclass.extract :image , :at => :uri150  , :as => :preview
+      imgclass.extract :image , :at => :uri     , :as => :fullsize  , :context => [:everything]
+      imgclass.extract :image , :at => :height  ,                     :context => [:everything]
+      imgclass.extract :image , :at => :width   ,                     :context => [:everything]
+
+      @klass.root 'resp/artist'
+      @klass.collect 'images/image', :as => :images, :class => imgclass
+
+      ophidian = @klass.parse(@data)
+      ophidian.images.should be_an ::Array
+      ophidian.images.size.should == 5
+
+      image = ophidian.images[2]
+      image.should be_an_instance_of imgclass
+      image.height.should   be_nil
+      image.width.should    be_nil
+      image.fullsize.should be_nil
+      image.preview.should  == "http://www.discogs.com/image/A-150-15203-1172410732.jpeg"
+
+      ophidian = @klass.parse(@data, :everything)
+      ophidian.images.should be_an ::Array
+      ophidian.images.size.should == 5
+
+      image = ophidian.images[2]
+      image.should be_an_instance_of imgclass
+      image.height.should   == "399"
+      image.width.should    == "598"
+      image.fullsize.should == "http://www.discogs.com/image/A-15203-1172410732.jpeg"
+      image.preview.should  == "http://www.discogs.com/image/A-150-15203-1172410732.jpeg"
+
+    end
+
+  end
+
+end
+
+# EOF

data/spec/extract_spec.rb

@@ -0,0 +1,200 @@
+require File.expand_path File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe SMG::Model, ".extract" do
+
+  before :each do
+    @klass = Class.new { include SMG::Resource }
+    @data = File.read(FIXTURES_DIR + 'fake/malus.xml')
+  end
+
+  include Spec::Matchers::HaveInstanceMethodMixin
+
+  it "defines appropriate reader and writer" do
+    @klass.extract :whatever
+    @klass.should have_instance_method :whatever
+    @klass.should have_instance_method :whatever=
+  end
+
+  it "never overrides readers" do
+    @klass.class_eval "def kingdom; return @kingdom.to_s.upcase; end"
+    @klass.root 'spec'
+    @klass.extract :kingdom
+    malus = @klass.parse(@data)
+    malus.kingdom.should == "PLANTAE"
+    malus.instance_variable_get(:@kingdom).should == "Plantae"
+  end
+
+  it "never overrides writers" do
+    @klass.class_eval "def kingdom=(value); @kingdom = value.to_s.upcase; end"
+    @klass.root 'spec'
+    @klass.extract :kingdom
+    malus = @klass.parse(@data)
+    malus.kingdom.should == "PLANTAE"
+    malus.instance_variable_get(:@kingdom).should == "PLANTAE"
+  end
+
+  it "extracts an empty String if there's an empty element" do
+    @klass.root 'spec'
+    @klass.extract :additional
+    malus = @klass.parse(@data)
+    malus.additional.should == ""
+  end
+
+  it "extracts nothing if there's no appropriate element" do
+    @klass.root 'spec'
+    @klass.extract :bogus
+    malus = @klass.parse(@data)
+    malus.bogus.should == nil
+  end
+
+  it "extracts the text of an element otherwise" do
+    @klass.root 'spec'
+    @klass.extract :genus
+    malus = @klass.parse(@data)
+    malus.should respond_to :genus
+    malus.should respond_to :genus=
+    malus.genus.should == 'Malus'
+  end
+
+  describe "using :at option" do
+
+    it "extracts the appropriate attribute" do
+      @klass.extract 'spec/conservation', :as => :conservation_code, :at => :code
+      malus = @klass.parse(@data)
+      malus.conservation_code.should == 'VU'
+    end
+
+    it "extracts nothing if there'no appropriate attribute" do
+      @klass.extract 'spec/conservation', :as => :conservation_code, :at => :bogus
+      malus = @klass.parse(@data)
+      malus.conservation_code.should == nil
+    end
+
+    it "extracts nothing if there'no appropriate element" do
+      @klass.extract 'spec/whatever', :as => :whatever, :at => :bogus
+      malus = @klass.parse(@data)
+      malus.whatever.should == nil
+    end
+
+  end
+
+  describe "using :as option" do
+
+    it "defines appropriate reader and writer" do
+      @klass.extract 'spec/conservation', :as => :conservation_status
+      malus = @klass.parse(@data)
+      malus.should respond_to :conservation_status
+      malus.should respond_to :conservation_status=
+    end
+
+    it "extracts data from an element using the 'as' accessor" do
+      @klass.extract 'spec/conservation', :as => :conservation_status
+      malus = @klass.parse(@data)
+      malus.conservation_status.should == 'Vulnerable (IUCN 2.3)'
+    end
+
+    it "extracts nothing if there's no appropriate element" do
+      @klass.extract 'spec/bogus', :as => :conservation_code, :at => :bogus
+      malus = @klass.parse(@data)
+      malus.conservation_code.should == nil
+    end
+
+  end
+
+  describe "using :class option" do
+
+    describe "when :class represents an SMG::Resource" do
+
+      it "extracts data into the class (AKA has_one)" do
+        @foo = Class.new
+        @foo.send(:include, SMG::Resource)
+        @foo.root 'description'
+        @foo.extract :common
+        @foo.extract :described_by
+        @foo.extract :described_as
+        @foo.extract :described_at
+        @klass.extract 'spec/description' , :as => :description, :class => @foo
+        malus = @klass.parse(@data)
+        malus.description.should be_an_instance_of @foo
+        malus.description.common.should == "Asian Wild Apple"
+        malus.description.described_at.should == "1983"
+        malus.description.described_by.should == "Carl Friedrich von Ledebour"
+        malus.description.described_as.should == "Pyrus sieversii"
+      end
+
+    end
+
+    describe "when :class represents a built-in typecast" do
+
+      it "makes an attempt to perform a typecast" do
+        Class.new { include SMG::Resource }
+        @klass.root 'spec'
+        @klass.extract :conservation, :at => :year, :class => :integer, :as => :year_of_conservation_check
+        malus = @klass.parse(@data)
+        malus.year_of_conservation_check.should == 2007
+      end
+
+      it "raises an ArgumentError if typecasting fails" do
+        Class.new { include SMG::Resource }
+        @klass.root 'spec'
+        @klass.extract :conservation, :at => :year, :class => :datetime, :as => :year_of_conservation_check
+        lambda { @klass.parse(@data) }.
+        should raise_error ArgumentError, %r{"2007" is not a valid source for :datetime} 
+      end
+
+    end
+
+  end
+
+end
+
+describe SMG::Model, ".extract" do
+
+  describe "when XML contains two or more suitable elements" do
+
+    before :each do
+      @klass = Class.new { include SMG::Resource }
+      @data = File.read(FIXTURES_DIR + 'fake/valve.xml')
+    end
+
+    it "ignores everything except the first one suitable thing" do
+      @klass.extract "games/game", :as => :title
+      parsed = @klass.parse(@data)
+      parsed.title.should == "Half-Life 2"
+    end
+
+    describe "using :at option" do
+
+      it "ignores everything except the first one suitable thing" do
+        @klass.extract "games/game", :at => :AppID, :as => :steam_application_id, :class => :integer
+        parsed = @klass.parse(@data)
+        parsed.steam_application_id.should == 220
+      end
+
+    end
+
+    describe "using :class option, when :class option represents an SMG::Resource" do
+
+      it "ignores everything except the first one suitable thing" do
+        @game = Class.new { include SMG::Resource }
+        @game.extract :game, :at => "AppID", :as => :steam_application_id, :class => :integer
+        @game.extract :game, :at => "date"
+        @game.extract :game, :at => "type", :as => :content
+        @game.extract :game, :as => :title
+
+        @klass.extract 'games/game', :class => @game
+        parsed = @klass.parse(@data)
+        parsed.game.should_not be_nil
+        parsed.game.title.should == "Half-Life 2"
+        parsed.game.content.should == "fullprice"
+        parsed.game.steam_application_id.should == 220
+        parsed.game.date.should == "2004-11-16"
+      end
+
+    end
+
+  end
+
+end
+
+# EOF

data/spec/filtering_spec.rb

@@ -0,0 +1,164 @@
+require File.expand_path File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe SMG::Model, ".extract" do
+
+  before :each do
+    @klass = Class.new { include SMG::Resource }
+    @data = File.read(FIXTURES_DIR + 'fake/valve.xml')
+  end
+
+  describe "using :with option" do
+
+    it "extracts the text of an element if conditions are OK" do
+      @klass.extract 'games/game', :as => :title, :with => {:type => "episodic", :AppID => 420}
+      game = @klass.parse(@data)
+      game.title.should == "Half-Life 2: Episode Two"
+
+      @klass.extract 'games/game', :as => :title, :with => {:type => "episodic", :date => "To be announced"}
+      game = @klass.parse(@data)
+      game.title.should == "Half-Life 2: Episode Three"
+
+      @klass.extract 'games/game', :as => :title, :with => {:type => "episodic", :AppID => nil} # i.e. without @AppID attribute
+      game = @klass.parse(@data)
+      game.title.should == "Half-Life 2: Episode Three"
+    end
+
+    it "extracts nothing otherwise" do
+      @klass.extract 'games/game', :as => :title, :with => {:type => "episodic", :AppID => "malformed"}
+      game = @klass.parse(@data)
+      game.title.should == nil
+    end
+
+  end
+
+  describe "using :with and :at options together" do
+
+    it "extracts the text of an element if conditions are OK" do
+      conditions = {:type => "modification", :date => "2007-10-06"}
+      @klass.extract 'games/game', :as => :steam_application_id, :with => conditions, :at => "AppID", :class => :integer
+      @klass.extract 'games/game', :as => :title, :with => conditions
+      game = @klass.parse(@data)
+      game.steam_application_id.should == 380
+      game.title.should == "Minerva: Metastasis"
+    end
+
+    it "extracts nothing otherwise" do
+      conditions = {:type => "modification", :date => "fake"}
+      @klass.extract 'games/game', :as => :steam_application_id, :with => conditions, :at => "AppID", :class => :integer
+      @klass.extract 'games/game', :as => :title, :with => conditions
+      game = @klass.parse(@data)
+      game.steam_application_id.should == nil
+      game.title.should == nil
+    end
+
+  end
+
+  describe "using :with and :class options together" do
+
+    before :each do
+      @game = Class.new { include SMG::Resource }
+      @game.extract :game, :at => "AppID", :as => :steam_application_id, :class => :integer
+      @game.extract :game, :at => "date"
+      @game.extract :game, :at => "type", :as => :content
+      @game.extract :game, :as => :title
+    end
+
+    it "extracts the text of an element if conditions are OK" do
+      conditions = {:type => "modification", :date => "2007-10-06"}
+      @klass.extract 'games/game', :class => @game, :with => conditions
+      parsed = @klass.parse(@data)
+      parsed.game.should_not be_nil
+      parsed.game.title.should == "Minerva: Metastasis"
+      parsed.game.content.should == "modification"
+      parsed.game.steam_application_id.should == 380
+      parsed.game.date.should == "2007-10-06"
+    end
+
+    it "extracts nothing otherwise" do
+      conditions = {:type => "modification", :date => "malformed"}
+      @klass.extract 'games/game', :class => @game, :with => conditions
+      parsed = @klass.parse(@data)
+      parsed.game.should be_nil
+    end
+
+  end
+
+end
+
+describe SMG::Model, ".collect" do
+
+  before :each do
+    @klass = Class.new { include SMG::Resource }
+    @data = File.read(FIXTURES_DIR + 'fake/valve.xml')
+  end
+
+  describe "using :with option" do
+
+    it "collects texts, if conditions are OK" do
+      @klass.collect 'games/game', :with => {"type" => "episodic"}, :as => :titles
+      parsed = @klass.parse(@data)
+      parsed.titles.should == ["Half-Life 2: Episode One", "Half-Life 2: Episode Two", "Half-Life 2: Episode Three"]
+    end
+
+    it "collects texts, if conditions are OK" do
+      @klass.collect 'games/game', :with => {"type" => "unknowb"}, :as => :titles
+      parsed = @klass.parse(@data)
+      parsed.titles.should be_empty
+    end
+
+  end
+
+  describe "using :with and :at options together" do
+
+    it "collects attributes, if conditions are OK" do
+      @klass.collect 'games/game', :with => {"type" => "episodic"}, :at => :date, :as => :dates
+      parsed = @klass.parse(@data)
+      parsed.dates.should == ["2006-06-01", "2007-10-10", "To be announced"]
+    end
+
+    it "collects nothing otherwise" do
+      @klass.collect 'games/game', :with => {"type" => "unknown"}, :at => :date, :as => :dates
+      parsed = @klass.parse(@data)
+      parsed.dates.should be_empty
+    end
+
+  end
+
+  describe "using :with and :class options together" do
+
+    before :each do
+      @game = Class.new { include SMG::Resource }
+      @game.extract :game, :at => "AppID", :as => :steam_application_id, :class => :integer
+      @game.extract :game, :at => "date"
+      @game.extract :game, :as => :title
+    end
+
+    it "collects resources if conditions are OK" do
+      conditions = {:type => "modification"}
+      @klass.collect 'games/game', :class => @game, :with => conditions, :as => :games
+      collection = @klass.parse(@data)
+
+      collection.games.should_not be_empty
+      collection.games.size.should == 2
+
+      collection.games[0].title.should == "Minerva: Metastasis"
+      collection.games[0].steam_application_id.should == 380
+      collection.games[0].date.should == "2007-10-06"
+
+      collection.games[1].title.should == "Black Mesa"
+      collection.games[1].steam_application_id.should == nil
+      collection.games[1].date.should == "To be announced"
+    end
+
+    it "collects nothing otherwise" do
+      conditions = {:type => "unknown"}
+      @klass.collect 'games/game', :class => @game, :with => conditions, :as => :games
+      collection = @klass.parse(@data)
+      collection.games.should be_empty
+    end
+
+  end
+
+end
+
+# EOF