milkfarm-onix 0.8.6 → 0.8.7

data/CHANGELOG

@@ -1,3 +1,24 @@
+v0.8.7 (13 March 2011)
+- Merge yob's commits (code lists, short tags, i18n)
+- Add WorkIdentifier composite (PR.7.15, PR.7.16, PR.7.17)
+- Add EpubType element (PR.23.27)
+
+v0.8.6 (17 October 2010)
+- Provide method to set multiple prices 
+  - eg, General trade and School/Library market
+- Fix reference name of price type qualifier (PR.24.50)
+  - 'PriceTypeQualifier' should be 'PriceQualifier'
+
+v0.8.5 (Unreleased)
+- Pull yob's dependency yob-roxml
+
+v0.8.4 (Unreleased)
+- Handle BISAC main subject category (PR.13.1)
+
+----------------------------------------------------------------------
+- Accidentally diverged from yob's official onix gem version numbers
+----------------------------------------------------------------------
+
 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.rb

@@ -2,18 +2,11 @@
 
 require 'bigdecimal'
 require 'cgi'
+require 'singleton'
 require 'roxml'
 require 'andand'
 
 module ONIX
-  module Version #:nodoc:
-    Major = 0
-    Minor = 8
-    Tiny  = 6
-
-    String = [Major, Minor, Tiny].join('.')
-  end
-
   class Formatters
     def self.decimal
       lambda do |val|
@@ -64,6 +57,7 @@ require File.join(File.dirname(__FILE__), "onix", "series_identifier")
 require File.join(File.dirname(__FILE__), "onix", "series")
 require File.join(File.dirname(__FILE__), "onix", "set")
 require File.join(File.dirname(__FILE__), "onix", "title")
+require File.join(File.dirname(__FILE__), "onix", "work_identifier")
 require File.join(File.dirname(__FILE__), "onix", "website")
 require File.join(File.dirname(__FILE__), "onix", "contributor")
 require File.join(File.dirname(__FILE__), "onix", "language")
@@ -83,19 +77,12 @@ 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")
 require File.join(File.dirname(__FILE__), "onix", "sl_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/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/product.rb

@@ -11,9 +11,11 @@ module ONIX
     xml_accessor :product_identifiers, :from => "ProductIdentifier", :as => [ONIX::ProductIdentifier]
     xml_accessor :product_form, :from => "ProductForm"
     xml_accessor :product_form_detail, :from => "ProductFormDetail"
+    xml_reader   :epub_type, :from => "EpubType"
     xml_accessor :series, :from => "Series", :as => [ONIX::Series]
     xml_accessor :sets, :from => "Set", :as => [ONIX::Set]
     xml_accessor :titles, :from => "Title", :as => [ONIX::Title]
+    xml_accessor :work_identifiers, :from => "WorkIdentifier", :as => [ONIX::WorkIdentifier]
     xml_accessor :websites, :from => "Website", :as => [ONIX::Website]
     xml_accessor :contributors, :from => "Contributor", :as => [ONIX::Contributor]
     xml_accessor :edition_number, :from => "EditionNumber", :as => Fixnum
@@ -57,6 +59,7 @@ module ONIX
       self.series = []
       self.sets = []
       self.titles = []
+      self.work_identifiers = []
       self.contributors = []
       self.websites = []
       self.subjects = []
@@ -71,5 +74,16 @@ module ONIX
       self.supply_details = []
       self.market_representations = []
     end
+    
+    # TODO: Refactor writer methods using method_missing
+    def epub_type=(new_epub_type)
+      if new_epub_type.nil? || ONIX::Lists.list(10).keys.include?(new_epub_type)
+        # ProductForm code must equal DG if EpubType element is present
+        @product_form = "DG"
+        @epub_type = new_epub_type
+      else
+        raise "Invalid EpubType #{new_epub_type}"
+      end
+    end
   end
 end

data/lib/onix/sl_product.rb

@@ -7,6 +7,7 @@ module ONIX
     delegate :copyright_year, :copyright_year=
     delegate :product_form_detail, :product_form_detail=
     delegate :basic_main_subject, :basic_main_subject=
+    delegate :epub_type, :epub_type=
     
     # retrieve the value of a particular ID
     def series(str)
@@ -52,12 +53,34 @@ module ONIX
       end
     end
     
+    # retrieve the work_identifier that matches the given value
+    def work_identifier(str)
+      product.work_identifiers.find { |obj| obj.id_value == str }
+    end
+    
+    # set the value of a particular ID
+    def add_work_identifier(value, type = 1)
+      # process based on value type
+      if value.is_a?(WorkIdentifier)
+        str = value.id_value
+        work_identifier_obj = value
+      else
+        str = value
+        work_identifier_obj = ONIX::WorkIdentifier.new(:work_id_type => type, :id_value => value)
+      end
+      # check if exists already
+      unless work_identifier(str)
+        product.work_identifiers << work_identifier_obj
+      end
+    end
+    
     def add_price(amount, *args)
       options = args.extract_options!.symbolize_keys
       # restrict keys to setter methods of format "text="
       keys = ONIX::Price.instance_methods.delete_if{|x| ! /\w+=$/.match(x)}.map{|x| x.gsub(/=$/, '').to_sym}
       options.assert_valid_keys(keys)
-      options.reverse_merge!(:price_type_code => 1)
+      # if price_type_code is not set, default to 1
+      options.replace({:price_type_code => 1}.merge(options))
       price = ONIX::Price.new
       price.price_amount = amount
       options.each { |k, v| price.send("#{k}=", v) }

data/lib/onix/version.rb

@@ -0,0 +1,3 @@
+module ONIX
+  VERSION = "0.8.7"
+end

data/lib/onix/work_identifier.rb

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+module ONIX
+  class WorkIdentifier
+    include ROXML
+    
+    xml_name "WorkIdentifier"
+    
+    xml_reader :work_id_type, :from => "WorkIDType", :as => Fixnum, :to_xml => ONIX::Formatters.two_digit
+    xml_accessor :id_type_name, :from => "IDTypeName"
+    xml_accessor :id_value, :from => "IDValue"
+    
+    def initialize(options = {})
+      options.symbolize_keys!
+      self.work_id_type = options[:work_id_type]
+      @id_type_name = options[:id_type_name]
+      @id_value = options[:id_value]
+    end
+    
+    def work_id_type=(new_work_id_type)
+      if new_work_id_type.nil? || ::ONIX::Lists.list(16).keys.include?(new_work_id_type)
+        @work_id_type = new_work_id_type
+      else
+        raise "Invalid WorkIDType #{new_work_id_type}"
+      end
+    end
+  end
+end

data/spec/apa_product_spec.rb

@@ -3,7 +3,7 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 require 'date'
 
-context "ONIX::APAProduct" do
+describe "ONIX::APAProduct" do
 
   before(:each) do
     @data_path = File.join(File.dirname(__FILE__),"..","data")
@@ -12,7 +12,7 @@ context "ONIX::APAProduct" do
     @product_node = @doc.root
   end
 
-  specify "should provide read access to attributes" do
+  it "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 attributes" do
+  it "should provide write access to attributes" do
     apa = ONIX::APAProduct.new
 
     apa.notification_type = 3
@@ -56,8 +56,8 @@ context "ONIX::APAProduct" do
 
 end
 
-context ONIX::APAProduct, "series method" do
-  specify "should set the nested series value on the underlying product class" do
+describe ONIX::APAProduct, "series method" do
+  it "should set the nested series value on the underlying product class" do
     apa = ONIX::APAProduct.new
 
     apa.series = "Harry Potter"
@@ -66,7 +66,7 @@ context ONIX::APAProduct, "series method" do
   end
 end
 
-context ONIX::APAProduct, "price method" do
+describe ONIX::APAProduct, "price method" do
   before(:each) do
     @data_path = File.join(File.dirname(__FILE__),"..","data")
     file1    = File.join(@data_path, "usd.xml")
@@ -74,7 +74,7 @@ context ONIX::APAProduct, "price method" do
     @product_node = @doc.root
   end
 
-  specify "should return the first price in the file, regardless of type" do
+  it "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)
 
@@ -82,7 +82,7 @@ context ONIX::APAProduct, "price method" do
   end
 end
 
-context ONIX::APAProduct, "rrp_exc_sales_tax method" do
+describe 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")
@@ -90,7 +90,7 @@ context ONIX::APAProduct, "rrp_exc_sales_tax method" do
     @product_node = @doc.root
   end
 
-  specify "should return the first price in the file of type 1" do
+  it "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)