onix 0.7.8 → 0.8.0

data/CHANGELOG

@@ -1,3 +1,17 @@
+v0.8.0 (31st October 2009)
+- Replace LibXML dependency with Nokogiri. Nokogiri is under active development, has
+  a responsive maintainer and is significantly more stable
+- Switch to ROXML 3.x
+  - roxml also switched from libxml to nokogiri
+  - roxml removed deprecated parts of it's API
+  - should now avoid various conflicts with mongrel
+- Ensure APAProduct#price returns the first product price and ignores
+  the price type
+
+v0.7.8 (19th October 2009)
+- add support for additional elements (mostly series and audience related)
+  - thanks tim
+
 v0.7.7 (1st October 2009)
 - optimise sed usage in ONIX::Normaliser. *huge* speed improvement on
   large files.

data/lib/onix.rb

@@ -1,22 +1,15 @@
 # coding: utf-8
 
-require 'rubygems'
 require 'bigdecimal'
 require 'cgi'
-
-# ensure we load the correct gem versions
-gem 'roxml', '2.5.3'
-gem 'andand'
-
-# and now load the actual gems
 require 'roxml'
 require 'andand'
 
 module ONIX
   module Version #:nodoc:
     Major = 0
-    Minor = 7
-    Tiny  = 8
+    Minor = 8
+    Tiny  = 0
 
     String = [Major, Minor, Tiny].join('.')
   end
@@ -60,13 +53,6 @@ module ONIX
   end
 end
 
-# silence some warnings from ROXML
-unless ROXML.const_defined?("SILENCE_XML_NAME_WARNING")
-  ROXML::SILENCE_XML_NAME_WARNING = true
-end
-
-require File.join(File.dirname(__FILE__), "onix", "common")
-
 # core files
 # - ordering is important, classes need to be defined before any
 #   other class can use them

data/lib/onix/addressee_identifier.rb

@@ -3,7 +3,6 @@
 module ONIX
   class AddresseeIdentifier
     include ROXML
-    include ONIX::Common
 
     xml_accessor :addressee_id_type, :from => "AddresseeIDType", :as => Fixnum # should be a 2 digit num
     xml_accessor :id_type_name,      :from => "IDTypeName"

data/lib/onix/apa_product.rb

@@ -651,7 +651,11 @@ module ONIX
     # retrieve the value of a particular price
     def price_get(type)
       supply = find_or_create_supply_detail
-      supply.prices.find { |p| p.price_type_code == type }
+      if type.nil?
+        supply.prices.first
+      else
+        supply.prices.find { |p| p.price_type_code == type }
+      end
     end
 
     # set the value of a particular price

data/lib/onix/audience_range.rb

@@ -3,7 +3,6 @@
 module ONIX
   class AudienceRange
     include ROXML
-    include ONIX::Common
 
     xml_name "AudienceRange"
 

data/lib/onix/contributor.rb

@@ -3,7 +3,6 @@
 module ONIX
   class Contributor
     include ROXML
-    include ONIX::Common
 
     xml_name "Contributor"
 

data/lib/onix/header.rb

@@ -3,7 +3,6 @@
 module ONIX
   class Header
     include ROXML
-    include ONIX::Common
 
     xml_name "Header"
 

data/lib/onix/imprint.rb

@@ -3,7 +3,6 @@
 module ONIX
   class Imprint
     include ROXML
-    include ONIX::Common
 
     xml_name "Imprint"
 

data/lib/onix/language.rb

@@ -3,7 +3,6 @@
 module ONIX
   class Language
     include ROXML
-    include ONIX::Common
 
     xml_name "Language"
 

data/lib/onix/market_representation.rb

@@ -3,7 +3,6 @@
 module ONIX
   class MarketRepresentation
     include ROXML
-    include ONIX::Common
 
     xml_name "MarketRepresentation"
 

data/lib/onix/measure.rb

@@ -3,7 +3,6 @@
 module ONIX
   class Measure
     include ROXML
-    include ONIX::Common
 
     xml_name "Measure"
 

data/lib/onix/media_file.rb

@@ -3,7 +3,6 @@
 module ONIX
   class MediaFile
     include ROXML
-    include ONIX::Common
 
     xml_name "MediaFile"
 

data/lib/onix/other_text.rb

@@ -3,7 +3,6 @@
 module ONIX
   class OtherText
     include ROXML
-    include ONIX::Common
 
     xml_name "OtherText"
 

data/lib/onix/price.rb

@@ -3,7 +3,6 @@
 module ONIX
   class Price
     include ROXML
-    include ONIX::Common
 
     xml_name "Price"
 

data/lib/onix/product.rb

@@ -3,7 +3,6 @@
 module ONIX
   class Product
     include ROXML
-    include ONIX::Common
 
     xml_name "Product"
 

data/lib/onix/product_identifier.rb

@@ -3,7 +3,6 @@
 module ONIX
   class ProductIdentifier
     include ROXML
-    include ONIX::Common
 
     xml_name "ProductIdentifier"
 

data/lib/onix/publisher.rb

@@ -3,7 +3,6 @@
 module ONIX
   class Publisher
     include ROXML
-    include ONIX::Common
 
     xml_name "Publisher"
 

data/lib/onix/reader.rb

@@ -53,31 +53,38 @@ module ONIX
   class Reader
     include Enumerable
 
-    attr_reader :header , :version, :xml_lang, :xml_version, :encoding
+    attr_reader :header , :version, :xml_lang, :xml_version
 
     def initialize(input, product_klass = ::ONIX::Product)
       if input.kind_of?(String)
-        @reader = LibXML::XML::Reader.file(input)
+        @file   = File.open(input, "r")
+        @reader = Nokogiri::XML::Reader.from_io(@file)
       elsif input.kind_of?(IO)
-        @reader = LibXML::XML::Reader.io(input)
+        @reader = Nokogiri::XML::Reader.from_io(input)
       else
         raise ArgumentError, "Unable to read from file or IO stream"
       end
 
       @product_klass = product_klass
 
-      @header = read_next
+      @header = find_header
 
-      @xml_lang    ||= @reader.xml_lang
+      @xml_lang    ||= @reader.lang
       @xml_version ||= @reader.xml_version.to_f
-      @encoding    ||= encoding_const_to_name(@reader.encoding)
     end
 
     # Iterate over all the products in an ONIX file
     #
     def each(&block)
-      while obj = read_next
-        yield obj
+      @reader.each do |node|
+        if @reader.node_type == 1 && @reader.name == "Product"
+          str = @reader.outer_xml
+          if str.nil?
+            yield @product_klass.new
+          else
+            yield @product_klass.from_xml(str)
+          end
+        end
       end
     end
 
@@ -87,101 +94,19 @@ module ONIX
 
     private
 
-    # Walk the ONIX file, and grab the next header or product fragment.
-    #
-    def read_next
-      while @reader.read
-
-        if @reader.node_type == LibXML::XML::Reader::TYPE_DOCUMENT_TYPE
-          # TODO restore ONIX version extraction. The following expand()
-          #      call is triggering unpredictable behaviour in libxml-ruby
-          #      1.1.3 with libxml2 2.7.3. Sometimes segfaults, othertimes
-          #      cryptic errors about the input file being truncated or
-          #      incomplete
-          #uri = @reader.expand.to_s.dup
-          #m, major, minor, rev = *uri.match(/.+(\d)\.(\d)\/(\d*).*/)
-          #@version = [major.to_i, minor.to_i, rev.to_i]
-        elsif @reader.node_type == LibXML::XML::Reader::TYPE_ELEMENT
-          if @reader.name == "Header"
-            str = normalise_string_encoding(@reader.read_outer_xml.to_s.dup)
-            if str.size == 0
-              return ONIX::Header.new
-            else
-              return ONIX::Header.from_xml(str)
-            end
-          elsif @reader.name == "Product"
-            str = normalise_string_encoding(@reader.read_outer_xml.to_s.dup)
-            if str.size == 0
-              return @product_klass.new
-            else
-              return @product_klass.from_xml(str)
-            end
+    def find_header
+      100.times do
+        @reader.read
+        if @reader.node_type == 1 &&  @reader.name == "Header"
+          str = @reader.outer_xml
+          if str.nil?
+            return ONIX::Header.new
+          else
+            return ONIX::Header.from_xml(str)
           end
         end
       end
-
-      return nil
-    rescue LibXML::XML::Error => e
       return nil
     end
-
-    # XML::Reader seems to transparently convert all input data to utf-8, howver
-    # on Ruby 1.9 it fails to correctly set the encoding on the strings.
-    #
-    def normalise_string_encoding(str)
-      if RUBY_VERSION >= "1.9"
-        return str.dup.force_encoding("utf-8")
-      else
-        str
-      end
-    end
-
-    # simple mapping of encoding constants to a string
-    #
-    def encoding_const_to_name(const)
-      return nil if const.nil?
-      case const
-      when LibXML::XML::Encoding::UTF_8
-        "utf-8"
-      when LibXML::XML::Encoding::UTF_16LE
-        "utf-16le"
-      when LibXML::XML::Encoding::UTF_16BE
-        "utf-16be"
-      when LibXML::XML::Encoding::UCS_4LE
-        "ucs-4le"
-      when LibXML::XML::Encoding::UCS_4BE
-        "ucs-4be"
-      when LibXML::XML::Encoding::UCS_2
-        "ucs-2"
-      when LibXML::XML::Encoding::ISO_8859_1
-        "iso-8859-1"
-      when LibXML::XML::Encoding::ISO_8859_2
-        "iso-8859-2"
-      when LibXML::XML::Encoding::ISO_8859_3
-        "iso-8859-3"
-      when LibXML::XML::Encoding::ISO_8859_4
-        "iso-8859-4"
-      when LibXML::XML::Encoding::ISO_8859_5
-        "iso-8859-5"
-      when LibXML::XML::Encoding::ISO_8859_6
-        "iso-8859-6"
-      when LibXML::XML::Encoding::ISO_8859_7
-        "iso-8859-7"
-      when LibXML::XML::Encoding::ISO_8859_8
-        "iso-8859-8"
-      when LibXML::XML::Encoding::ISO_8859_9
-        "iso-8859-9"
-      when LibXML::XML::Encoding::ISO_2022_JP
-        "iso-2022-jp"
-      when LibXML::XML::Encoding::SHIFT_JIS
-        "shift-jis"
-      when LibXML::XML::Encoding::EUC_JP
-        "euc-jp"
-      when LibXML::XML::Encoding::ASCII
-        "ascii"
-      else
-        nil
-      end
-    end
   end
 end

data/lib/onix/sales_restriction.rb

@@ -3,7 +3,6 @@
 module ONIX
   class SalesRestriction
     include ROXML
-    include ONIX::Common
 
     xml_name "SalesRestriction"
 

data/lib/onix/sender_identifier.rb

@@ -3,7 +3,6 @@
 module ONIX
   class SenderIdentifier
     include ROXML
-    include ONIX::Common
 
     xml_name "SenderIdentifier"
 

data/lib/onix/series.rb

@@ -3,7 +3,6 @@
 module ONIX
   class Series
     include ROXML
-    include ONIX::Common
 
     xml_name "Series"
 

data/lib/onix/series_identifier.rb

@@ -3,7 +3,6 @@
 module ONIX
   class SeriesIdentifier
     include ROXML
-    include ONIX::Common
 
     xml_name "SeriesIdentifier"
 

data/lib/onix/stock.rb

@@ -3,7 +3,6 @@
 module ONIX
   class Stock
     include ROXML
-    include ONIX::Common
 
     xml_name "Stock"
 

data/lib/onix/subject.rb

@@ -3,7 +3,6 @@
 module ONIX
   class Subject
     include ROXML
-    include ONIX::Common
 
     xml_name "Subject"
 

data/lib/onix/supply_detail.rb

@@ -3,7 +3,6 @@
 module ONIX
   class SupplyDetail
     include ROXML
-    include ONIX::Common
 
     xml_name "SupplyDetail"
 

data/lib/onix/title.rb

@@ -3,7 +3,6 @@
 module ONIX
   class Title
     include ROXML 
-    include ONIX::Common
 
     xml_name "Title"
 

data/lib/onix/website.rb

@@ -3,7 +3,6 @@
 module ONIX
   class Website
     include ROXML
-    include ONIX::Common
 
     xml_name "Website"
 

data/spec/apa_product_spec.rb

@@ -1,8 +1,6 @@
 # coding: utf-8
 
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
-
-require 'onix'
+require File.dirname(__FILE__) + '/spec_helper.rb'
 require 'date'
 
 context "ONIX::APAProduct" do
@@ -10,7 +8,7 @@ context "ONIX::APAProduct" do
   before(:each) do
     @data_path = File.join(File.dirname(__FILE__),"..","data")
     file1    = File.join(@data_path, "product.xml")
-    @doc = LibXML::XML::Document.file(file1)
+    @doc     = Nokogiri::XML::Document.parse(File.read(file1))
     @product_node = @doc.root
   end
 
@@ -57,3 +55,35 @@ context "ONIX::APAProduct" do
   end
 
 end
+
+context ONIX::APAProduct, "price method" do
+  before(:each) do
+    @data_path = File.join(File.dirname(__FILE__),"..","data")
+    file1    = File.join(@data_path, "usd.xml")
+    @doc     = Nokogiri::XML::Document.parse(File.read(file1))
+    @product_node = @doc.root
+  end
+
+  specify "should return the first price in the file, regardless of type" do
+    @product = ONIX::Product.from_xml(@product_node.to_s)
+    @apa     = ONIX::APAProduct.new(@product)
+
+    @apa.price.should eql(BigDecimal.new("99.95"))
+  end
+end
+
+context ONIX::APAProduct, "rrp_exc_sales_tax method" do
+  before(:each) do
+    @data_path = File.join(File.dirname(__FILE__),"..","data")
+    file1    = File.join(@data_path, "usd.xml")
+    @doc     = Nokogiri::XML::Document.parse(File.read(file1))
+    @product_node = @doc.root
+  end
+
+  specify "should return the first price in the file of type 1" do
+    @product = ONIX::Product.from_xml(@product_node.to_s)
+    @apa     = ONIX::APAProduct.new(@product)
+
+    @apa.rrp_exc_sales_tax.should eql(BigDecimal.new("99.95"))
+  end
+end