onix 0.8.3 → 0.8.4

data/CHANGELOG

@@ -1,3 +1,7 @@
+v0.8.4 (18th October 2010)
+- some small fixes to xml names from Tim
+- make all code lists available via the ONIX::Lists class
+
 v0.8.3 (9th September 2010)
 - Fix for race condition in ONIX::Normaliser
   - thanks to pixelvixen for reporting

data/README.markdown

@@ -45,6 +45,7 @@ view the comments to the following classes:
 * ONIX::Reader - For reading ONIX files
 * ONIX::Writer - For writing ONIX files
 * ONIX::Normaliser - For normalising ONIX files before reading them. Fixes encoding issues, etc
+* ONIX::Lists  - For building hashes of code lists from the ONIX spec
 
 ## Licensing
 

data/lib/onix/code_list_extractor.rb

@@ -0,0 +1,69 @@
+# coding: utf-8
+
+module ONIX
+
+  # A utility class that processes the code list XSD from the ONIX spec and
+  # creates a set of TSV files. The generated files are used by this library
+  # to make hashes of the code lists available to users.
+  #
+  class CodeListExtractor
+
+    # Creates a new extractor. Expects the path to a copy of the code lists
+    # file from the spec (called ONIX_BookProduct_CodeLists.xsd on my system).
+    #
+    def initialize(filename)
+      raise ArgumentError, "#{filename} not found" unless File.file?(filename)
+
+      @filename = filename
+    end
+
+    # generate a set of TSV files in the given directory. Creates the directory
+    # if it doesn't exist and will overwrite existing files.
+    #
+    def run(dir)
+      FileUtils.mkdir_p(dir) unless File.directory?(dir)
+
+      each_list do |number, data|
+        #puts number
+        file = number.to_s.rjust(3, "0") + ".tsv"
+        path = File.join(dir, file)
+        File.open(path, "w") { |f| f.write data}
+      end
+    end
+
+    private
+
+    def data
+      @data ||= File.open(@filename) { |f| f.read }
+    end
+
+    def document
+      @document ||= Nokogiri::XML(data)
+      @document.remove_namespaces! if @document.namespaces.size > 0
+      @document
+    end
+
+    def each_list(&block)
+      document.xpath("//simpleType").each do |node|
+        list_name   = node.xpath("./@name").first.value
+        list_number = list_name[/List(\d+)/,1].to_i
+        if list_number > 0
+          yield list_number, list_data(list_number)
+        end
+      end
+    end
+
+    def list_data(num)
+      str   = ""
+      nodes = document.xpath("//simpleType[@name='List#{num}']/restriction/enumeration")
+      nodes.each do |node|
+        code  = node.xpath("./@value").first.value
+        desc  = node.xpath("./annotation/documentation").first.text
+        ldesc = node.xpath("./annotation/documentation").last.text
+        str += "#{code}\t#{desc}\t#{ldesc}\n"
+      end
+      str
+    end
+
+  end
+end

data/lib/onix/lists.rb

@@ -0,0 +1,134 @@
+# coding: utf-8
+
+module ONIX
+
+  # Builds hashes for all code lists in the ONIX spec.
+  #
+  # Use like so:
+  #
+  #   ONIX::Lists.list(7)
+  #   => { "BB" => "Hardback", ... }
+  #
+  # There are also some constants for commonly used lists:
+  #
+  #   ONIX::Lists::PRODUCT_FORM
+  #   => { "BB" => "Hardback", ... }
+  #
+  class Lists
+    include Singleton
+
+    # retrieve a hash with the specified code list
+    #
+    #  ONIX::Lists.list(7)
+    #  => { "BB" => "Hardback", ... }
+    #
+    def self.list(number)
+      self.instance.list(number)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.audience_code
+      self.instance.list(28)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.contributor_role
+      self.instance.list(17)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.country_code
+      self.instance.list(91)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.language_code
+      self.instance.list(74)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.language_role
+      self.instance.list(22)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.notification_type
+      self.instance.list(1)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.product_availability
+      self.instance.list(65)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.product_form
+      self.instance.list(7)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.product_form_detail
+      self.instance.list(78)
+    end
+
+    # return a hash with the data for a single code list.
+    #
+    # number should be a fixnum specifying the list to retrieve
+    #
+    #  ONIX::Lists.instance.list(7)
+    #  => { "BB" => "Hardback", ... }
+    #
+    def list(number)
+      cache[number] ||= build_hash(number)
+    end
+
+    private
+
+    def build_hash(number)
+      val = {}
+      data(number).each_line do |line|
+        code, desc, ldesc = *line.split("\t")
+        code = code.to_i if code.to_s.match(/\d+/)
+        val[code] = desc
+      end
+      val
+    end
+
+    def cache
+      @cache ||= {}
+    end
+
+    def path(number)
+      code_dir = File.dirname(__FILE__) + "/../../support/codes"
+      filename = number.to_s.rjust(3, "0") + ".tsv"
+      File.join(code_dir, filename)
+    end
+
+    def data(number)
+      File.open(path(number)) { |f| f.read }
+    end
+
+    public
+
+    # These are here for backwards compatability with the onix gem <= 0.8.3
+    AUDIENCE_CODE        = ONIX::Lists.audience_code
+    CONTRIBUTOR_ROLE     = ONIX::Lists.contributor_role
+    COUNTRY_CODE         = ONIX::Lists.country_code
+    LANGUAGE_CODE        = ONIX::Lists.language_code
+    LANGUAGE_ROLE        = ONIX::Lists.language_role
+    NOTIFICATION_TYPE    = ONIX::Lists.notification_type
+    PRODUCT_AVAILABILITY = ONIX::Lists.product_availability
+    PRODUCT_FORM         = ONIX::Lists.product_form
+    PRODUCT_FORM_DETAIL  = ONIX::Lists.product_form_detail
+
+  end
+end

data/lib/onix/price.rb

@@ -7,7 +7,7 @@ module ONIX
     xml_name "Price"
 
     xml_accessor :price_type_code, :from => "PriceTypeCode", :as => Fixnum, :to_xml => ONIX::Formatters.two_digit
-    xml_accessor :price_type_qualifier, :from => "PriceTypeQualifier", :as => Fixnum, :to_xml => ONIX::Formatters.two_digit
+    xml_accessor :price_type_qualifier, :from => "PriceQualifier", :as => Fixnum, :to_xml => ONIX::Formatters.two_digit
     xml_accessor :price_type_description, :from => "PriceTypeDescription"
     xml_accessor :price_per, :from => "PricePer", :as => Fixnum, :to_xml => ONIX::Formatters.two_digit
     xml_accessor :minimum_order_qty, :from => "MinimumOrderQuantity", :as => Fixnum

data/lib/onix/product.rb

@@ -18,6 +18,7 @@ module ONIX
     xml_accessor :edition_number, :from => "EditionNumber", :as => Fixnum
     xml_accessor :languages, :from => "Language", :as => [ONIX::Language]
     xml_accessor :number_of_pages, :from => "NumberOfPages", :as => Fixnum
+    xml_accessor :basic_main_subject, :from => "BASICMainSubject"
     xml_accessor :bic_main_subject, :from => "BICMainSubject"
     xml_accessor :subjects, :from => "Subject", :as => [ONIX::Subject]
     xml_accessor :audience_code, :from => "AudienceCode", :to_xml => ONIX::Formatters.two_digit

data/lib/onix.rb

@@ -2,6 +2,7 @@
 
 require 'bigdecimal'
 require 'cgi'
+require 'singleton'
 require 'roxml'
 require 'andand'
 
@@ -9,7 +10,7 @@ module ONIX
   module Version #:nodoc:
     Major = 0
     Minor = 8
-    Tiny  = 3
+    Tiny  = 4
 
     String = [Major, Minor, Tiny].join('.')
   end
@@ -82,18 +83,11 @@ require File.join(File.dirname(__FILE__), "onix", "product")
 require File.join(File.dirname(__FILE__), "onix", "reader")
 require File.join(File.dirname(__FILE__), "onix", "writer")
 
-# lists
-require File.join(File.dirname(__FILE__), "onix", "lists", "product_form")
-require File.join(File.dirname(__FILE__), "onix", "lists", "product_availability")
-require File.join(File.dirname(__FILE__), "onix", "lists", "country_code")
-require File.join(File.dirname(__FILE__), "onix", "lists", "language_code")
-require File.join(File.dirname(__FILE__), "onix", "lists", "language_role")
-require File.join(File.dirname(__FILE__), "onix", "lists", "notification_type")
-require File.join(File.dirname(__FILE__), "onix", "lists", "product_form_detail")
-
 # product wrappers
 require File.join(File.dirname(__FILE__), "onix", "simple_product")
 require File.join(File.dirname(__FILE__), "onix", "apa_product")
 
 # misc
+require File.join(File.dirname(__FILE__), "onix", "lists")
 require File.join(File.dirname(__FILE__), "onix", "normaliser")
+require File.join(File.dirname(__FILE__), "onix", "code_list_extractor")

data/spec/apa_product_spec.rb

@@ -12,7 +12,7 @@ context "ONIX::APAProduct" do
     @product_node = @doc.root
   end
 
-  specify "should provide read access to attibutes" do
+  specify "should provide read access to attributes" do
     @product = ONIX::Product.from_xml(@product_node.to_s)
     @apa     = ONIX::APAProduct.new(@product)
 
@@ -26,7 +26,7 @@ context "ONIX::APAProduct" do
     @apa.pack_quantity.should eql(12)
   end
 
-  specify "should provide write access to attibutes" do
+  specify "should provide write access to attributes" do
     apa = ONIX::APAProduct.new
 
     apa.notification_type = 3

data/spec/audience_range_spec.rb

@@ -16,7 +16,7 @@ context "ONIX::AudienceRange" do
     aud.to_xml.to_s[0,15].should eql("<AudienceRange>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     aud = ONIX::AudienceRange.from_xml(@root.to_s)
 
     aud.audience_range_qualifier.should eql(11)
@@ -28,7 +28,7 @@ context "ONIX::AudienceRange" do
     aud.audience_range_values[1].should eql(5)
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     aud = ONIX::AudienceRange.new
 
     aud.audience_range_qualifier = 12

data/spec/contributor_spec.rb

@@ -16,7 +16,7 @@ context "ONIX::Contributor" do
     header.to_xml.to_s[0,13].should eql("<Contributor>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     contrib = ONIX::Contributor.from_xml(@root.to_s)
 
     contrib.contributor_role.should eql("A01")
@@ -24,7 +24,7 @@ context "ONIX::Contributor" do
     contrib.sequence_number.should eql(1)
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     contrib = ONIX::Contributor.new
 
     contrib.contributor_role = "A02"

data/spec/header_spec.rb

@@ -16,7 +16,7 @@ context "ONIX::Header" do
     header.to_xml.to_s[0,8].should eql("<Header>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     header = ONIX::Header.from_xml(@header_node.to_s)
 
     header.from_ean_number.should eql("1111111111111")
@@ -42,7 +42,7 @@ context "ONIX::Header" do
     header.default_class_of_trade.should eql("f")
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     header = ONIX::Header.new
 
     header.from_ean_number = "1111111111111"

data/spec/imprint_spec.rb

@@ -16,13 +16,13 @@ context "ONIX::Imprint" do
     imp.to_xml.to_s[0,9].should eql("<Imprint>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     imp = ONIX::Imprint.from_xml(@root.to_s)
 
     imp.imprint_name.should eql("Oxford University Press UK")
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     imp = ONIX::Imprint.new
 
     imp.imprint_name = "Paulist Press"

data/spec/language_spec.rb

@@ -16,7 +16,7 @@ context "ONIX::Language" do
     lan.to_xml.to_s[0,10].should eql("<Language>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     lan = ONIX::Language.from_xml(@root.to_s)
 
     lan.language_role.should eql(1)
@@ -24,7 +24,7 @@ context "ONIX::Language" do
     lan.country_code.should eql("US")
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     lan = ONIX::Language.new
 
     lan.language_role = 2

data/spec/lists_spec.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+context ONIX::Lists, "list method" do
+
+  it "should return a hash containing the ProductForm code list" do
+    forms = ONIX::Lists.list(7)
+    forms.should be_a(Hash)
+    forms["BB"].should eql("Hardback")
+  end
+
+end
+
+context ONIX::Lists, "product_form shortcut method" do
+
+  it "should return a hash containing the ProductForm code list" do
+    forms = ONIX::Lists.product_form
+    forms.should be_a(Hash)
+    forms["BB"].should eql("Hardback")
+  end
+
+end
+
+context ONIX::Lists, "PRODUCT_FORM shortcut constant" do
+
+  it "should return a hash containing the ProductForm code list" do
+    forms = ONIX::Lists::PRODUCT_FORM
+    forms.should be_a(Hash)
+    forms["BB"].should eql("Hardback")
+  end
+
+end

data/spec/market_representation_spec.rb

@@ -16,14 +16,14 @@ context "ONIX::MarketRepresentation" do
     rep.to_xml.to_s[0,22].should eql("<MarketRepresentation>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     rep = ONIX::MarketRepresentation.from_xml(@root.to_s)
 
     rep.agent_name.should eql("Allen & Unwin")
     rep.agent_role.should eql(7)
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     rep = ONIX::MarketRepresentation.new
 
     rep.agent_name = "Rainbow Book Agencies"

data/spec/measure_spec.rb

@@ -16,7 +16,7 @@ context "ONIX::Measure" do
     m.to_xml.to_s[0,9].should eql("<Measure>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     m = ONIX::Measure.from_xml(@root.to_s)
 
     m.measure_type_code.should eql(1)
@@ -24,7 +24,7 @@ context "ONIX::Measure" do
     m.measure_unit_code.should eql("mm")
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     m = ONIX::Measure.new
 
     m.measure_type_code = 1

data/spec/media_file_spec.rb

@@ -16,14 +16,14 @@ context "ONIX::MediaFile" do
     mf.to_xml.to_s[0,11].should eql("<MediaFile>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     mf = ONIX::MediaFile.from_xml(@root.to_s)
     mf.media_file_type_code.should eql(4)
     mf.media_file_link_type_code.should eql(1)
     mf.media_file_link.should eql("http://www.allenandunwin.com/BookCovers/resized_9788888028729_224_297_FitSquare.jpg")
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     mf = ONIX::MediaFile.new
 
     mf.media_file_type_code = 2

data/spec/other_text_spec.rb

@@ -16,14 +16,14 @@ context "ONIX::OtherText" do
     ot.to_xml.to_s[0,11].should eql("<OtherText>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     ot = ONIX::OtherText.from_xml(@root.to_s)
 
     ot.text_type_code.should eql(2)
     ot.text[0,7].should eql("A woman")
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     ot = ONIX::OtherText.new
 
     ot.text_type_code = 2

data/spec/price_spec.rb

@@ -16,14 +16,14 @@ context "ONIX::Price" do
     p.to_xml.to_s[0,7].should eql("<Price>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     p = ONIX::Price.from_xml(@root.to_s)
 
     p.price_type_code.should eql(2)
     p.price_amount.should eql(BigDecimal.new("7.5"))
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     p = ONIX::Price.new
 
     p.price_type_code = 1

data/spec/product_identifier_spec.rb

@@ -16,14 +16,14 @@ context "ONIX::ProductIdentifier" do
     id.to_xml.to_s[0,19].should eql("<ProductIdentifier>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     id = ONIX::ProductIdentifier.from_xml(@root.to_s)
 
     id.product_id_type.should eql(2)
     id.id_value.should eql("0858198363")
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     id = ONIX::ProductIdentifier.new
 
     id.product_id_type = 2

data/spec/product_spec.rb

@@ -11,7 +11,7 @@ context "ONIX::Product" do
     @product_node = @doc.root
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     product = ONIX::Product.from_xml(@product_node.to_s)
 
     product.record_reference.should eql("365-9780194351898")
@@ -52,7 +52,7 @@ context "ONIX::Product" do
     product.measurements.size.should eql(1)
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     product = ONIX::Product.new
 
     product.notification_type = 3

data/spec/publisher_spec.rb

@@ -16,13 +16,13 @@ context "ONIX::Publisher" do
     pub.to_xml.to_s[0,11].should eql("<Publisher>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     pub = ONIX::Publisher.from_xml(@root.to_s)
     pub.publishing_role.should eql(1)
     pub.publisher_name.should eql("Desbooks Publishing")
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     pub = ONIX::Publisher.new
 
     pub.publisher_name = "Paulist Press"

data/spec/sales_restriction_spec.rb

@@ -16,13 +16,13 @@ context "ONIX::SalesRestriction" do
     sr.to_xml.to_s[0,18].should eql("<SalesRestriction>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     sr = ONIX::SalesRestriction.from_xml(@root.to_s)
 
     sr.sales_restriction_type.should eql(0)
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     sr = ONIX::SalesRestriction.new
 
     sr.sales_restriction_type = 1

data/spec/sender_identifier.rb

@@ -16,14 +16,14 @@ context "ONIX::SenderIdentifier" do
     id.to_xml.to_s[0,18].should eql("<SenderIdentifier>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     id = ONIX::SenderIdentifier.from_xml(@root.to_s)
 
     id.sender_id_type.should eql(1)
     id.id_value.should eql("123456")
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     id = ONIX::SenderIdentifier.new
 
     id.sender_id_type = 1

data/spec/series_identifier_spec.rb

@@ -16,14 +16,14 @@ context "ONIX::SeriesIdentifier" do
     series.to_xml.to_s[0,18].should eql("<SeriesIdentifier>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     series = ONIX::SeriesIdentifier.from_xml(@root.to_s)
 
     series.series_id_type.should eql(1)
     series.id_value.should eql("10001")
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     series = ONIX::SeriesIdentifier.new
 
     series.series_id_type = 9

data/spec/series_spec.rb

@@ -16,13 +16,13 @@ context "ONIX::Series" do
     series.to_xml.to_s[0,8].should eql("<Series>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     series = ONIX::Series.from_xml(@root.to_s)
 
     series.title_of_series.should eql("Citizens and Their Governments")
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     series = ONIX::Series.new
 
     series.title_of_series = "Cool Science Careers"

data/spec/stock_spec.rb

@@ -16,7 +16,7 @@ context "ONIX::Stock" do
     s.to_xml.to_s[0,7].should eql("<Stock>")
   end
 
-  specify "should provide read access to first level attibutes" do
+  specify "should provide read access to first level attributes" do
     s = ONIX::Stock.from_xml(@root.to_s)
 
     # note that these fields *should* be numeric according to the ONIX spec,
@@ -25,7 +25,7 @@ context "ONIX::Stock" do
     s.on_order.should eql("0")
   end
 
-  specify "should provide write access to first level attibutes" do
+  specify "should provide write access to first level attributes" do
     s = ONIX::Stock.new
 
     s.on_hand = "123"