onix 0.4.0 → 0.4.2

data/CHANGELOG

@@ -1,3 +1,11 @@
+v0.4.2 (XXX)
+- Remove final remnants of REXML code
+- Minor reordering of elements to match DTD
+
+v0.4.1 (UNRELEASED)
+- Added accesses to various product measurements. Height, weight, etc.
+- Reduced time for an ONIX::Reader class to initialise
+
 v0.4.0 (28th October 2008)
 - Major rework: now based on ROXML instead of xml-mapping
   - Mostly API Compatible

data/README.markdown

@@ -0,0 +1,39 @@
+## ONIX
+
+The ONIX standard is a somewhat verbose XML format that is rapidly becoming the
+industry standard for electronic data sharing in the book and publishing
+industries.
+
+This library provides a slim layer over the format and simplifies both reading
+and writing ONIX files in your ruby applications.
+
+This replaces the obsolete rbook-onix gem that was spectacular in its crapness.
+Let us never speak of it again.
+
+## Installation
+
+    gem install onix
+
+## Usage
+
+See files in the examples directory to get started quickly. For further reading
+view the comments to the following classes:
+
+* ONIX::Reader - For reading ONIX files
+* ONIX::Writer - For writing ONIX files
+
+## Licensing
+
+This library is distributed under the terms of the MIT License. See the included file for
+more detail.
+
+## Contributing
+
+All suggestions and patches welcome, preferably via a git repository I can pull from.
+To be honest, I'm not really expecting any, this is a niche library.
+
+## Further Reading
+
+- The source: [http://github.com/yob/onix/tree/master](http://github.com/yob/onix/tree/master)
+- Rubyforge project: [http://rubyforge.org/projects/rbook/](http://rubyforge.org/projects/rbook/)
+- The official specs [http://www.editeur.org/onix.html](http://www.editeur.org/onix.html)

data/lib/onix.rb

@@ -9,6 +9,7 @@ require 'roxml'
 require 'andand'
 
 # custom xml-mapping node types
+require File.join(File.dirname(__FILE__), "onix", "decimal_type")
 require File.join(File.dirname(__FILE__), "onix", "etext_type")
 require File.join(File.dirname(__FILE__), "onix", "integer_type")
 require File.join(File.dirname(__FILE__), "onix", "two_digit_type")
@@ -33,6 +34,7 @@ require File.join(File.dirname(__FILE__), "onix", "sales_restriction")
 require File.join(File.dirname(__FILE__), "onix", "stock")
 require File.join(File.dirname(__FILE__), "onix", "price")
 require File.join(File.dirname(__FILE__), "onix", "supply_detail")
+require File.join(File.dirname(__FILE__), "onix", "measure")
 require File.join(File.dirname(__FILE__), "onix", "product")
 require File.join(File.dirname(__FILE__), "onix", "reader")
 require File.join(File.dirname(__FILE__), "onix", "writer")
@@ -49,7 +51,7 @@ module ONIX
   module Version #:nodoc:
     Major = 0
     Minor = 4
-    Tiny  = 0
+    Tiny  = 2
 
     String = [Major, Minor, Tiny].join('.')
   end

data/lib/onix/apa_product.rb

@@ -11,6 +11,18 @@ module ONIX
     delegate :publishing_status, :publishing_status=
     delegate :publication_date, :publication_date=
 
+    def measurement_system
+      @measurement_system ||= :metric
+    end
+
+    def measurement_system=(value)
+      if value == :metric || value == :imperial
+        @measurement_system = value
+      else
+        raise ArgumentError, "#{value} is not a recognised measurement system"
+      end
+    end
+
     # retrieve the current EAN
     def ean
       identifier(3).andand.id_value
@@ -390,6 +402,98 @@ module ONIX
       price_set(2, num)
     end
 
+    # retrieve the height of the product
+    #
+    # If APAProduct#measurement_system is metric, these will be in mm, otherwise they
+    # will be in inches.
+    #
+    def height
+      # TODO: auto unit conversion
+      measurement(1).andand.measurement
+    end
+
+    # set the height of the book
+    #
+    # If APAProduct#measurement_system is metric, this should be in mm, otherwise it
+    # will be in inches.
+    #
+    def height=(value)
+      if measurement_system == :metric
+        measurement_set(1,value, "mm")
+      elsif measurement_system == :imperial
+        measurement_set(1,value, "in")
+      end
+    end
+
+    # retrieve the width of the product
+    #
+    # If APAProduct#measurement_system is metric, these will be in mm, otherwise they
+    # will be in inches.
+    #
+    def width
+      # TODO: auto unit conversion
+      measurement(2).andand.measurement
+    end
+
+    # set the width of the product
+    #
+    # If APAProduct#measurement_system is metric, this should be in mm, otherwise it
+    # will be in inches.
+    #
+    def width=(value)
+      if measurement_system == :metric
+        measurement_set(2,value, "mm")
+      elsif measurement_system == :imperial
+        measurement_set(2,value, "in")
+      end
+    end
+
+    # retrieve the weight of the product
+    #
+    # If APAProduct#measurement_system is metric, these will be in grams, otherwise they
+    # will be in ounces.
+    #
+    def weight
+      # TODO: auto unit conversion
+      measurement(8).andand.measurement
+    end
+
+    # set the weight of the product
+    #
+    # If APAProduct#measurement_system is metric, this should be in grams, otherwise it
+    # will be in ounces.
+    #
+    def weight=(value)
+      if measurement_system == :metric
+        measurement_set(8,value, "gr")
+      elsif measurement_system == :imperial
+        measurement_set(8,value, "oz")
+      end
+    end
+
+    # retrieve the thickness of the product
+    #
+    # If APAProduct#measurement_system is metric, these will be in mm, otherwise they
+    # will be in inches.
+    #
+    def thickness
+      # TODO: auto unit conversion
+      measurement(3).andand.measurement
+    end
+
+    # set the thickness of the product
+    #
+    # If APAProduct#measurement_system is metric, this should be in mm, otherwise it
+    # will be in inches.
+    #
+    def thickness=(value)
+      if measurement_system == :metric
+        measurement_set(3,value, "mm")
+      elsif measurement_system == :imperial
+        measurement_set(3,value, "in")
+      end
+    end
+
     private
 
     # add a new subject to this product
@@ -431,6 +535,27 @@ module ONIX
       isbn_id.id_value = value
     end
 
+    # retrieve the value of a particular measurement
+    def measurement(type)
+      product.measurements.find { |m| m.measure_type_code == type }
+    end
+
+    # set the value of a particular measurement
+    def measurement_set(type, value, unit)
+      measure = measurement(type)
+
+      # create a new isbn record if we need to
+      if measure.nil?
+        measure = ONIX::Measure.new
+        measure.measure_type_code = type
+        product.measurements << measure
+      end
+
+      # store the new value
+      measure.measurement = value
+      measure.measure_unit_code = unit.to_s
+    end
+
     # retrieve the value of a particular media file
     def media_file(type)
       product.media_files.find { |m| m.media_file_type_code == type }

data/lib/onix/decimal_type.rb

@@ -0,0 +1,49 @@
+require 'bigdecimal'
+
+module ONIX
+
+  class DecimalType < ROXML::XMLRef # ::nodoc::
+    attr_reader :cdata, :content
+
+    def initialize(accessor, args, &block)
+      super(accessor, args, &block)
+      @content = args.content?
+      @cdata = args.cdata?
+    end
+
+    # Updates the text in the given _xml_ block to
+    # the _value_ provided.
+    def update_xml(xml, value)
+      parent = wrap(xml)
+      if value.kind_of?(BigDecimal)
+        value = value.to_s("F")
+      else
+        value = value.to_s
+      end
+      add(parent.child_add(LibXML::XML::Node.new_element(name)), value)
+      xml
+    end
+
+    def value(xml)
+      if content
+        value = BigDecimal.new(xml.content)
+      else
+        child = xml.search(name).first
+        value = BigDecimal.new(child.content) if child
+      end
+      block ? block.call(value) : value
+    end
+
+    private
+
+    def add(dest, value)
+      if cdata
+        dest.child_add(LibXML::XML::Node.new_cdata(value.to_utf))
+      else
+        dest.content = value.to_utf
+      end
+    end
+  end
+end
+
+ROXML::TypeRegistry.register(:decimal, ONIX::DecimalType)

data/lib/onix/header.rb

@@ -4,11 +4,11 @@ module ONIX
 
     xml_name "Header"
 
-    xml_accessor :from_person,     :etext, :from => "FromPerson"
     xml_accessor :from_ean_number, :etext, :from => "FromEANNumber"
     xml_accessor :from_san,        :etext, :from => "FromSAN"
     xml_accessor :sender_identifiers, [ONIX::SenderIdentifier], :from => "SenderIdentifier"
     xml_accessor :from_company,    :etext, :from => "FromCompany"
+    xml_accessor :from_person,     :etext, :from => "FromPerson"
     xml_accessor :from_email,      :etext, :from => "FromEmail"
     xml_accessor :to_ean_number,   :etext, :from => "ToEANNumber"
     xml_accessor :to_san,          :etext, :from => "ToSAN"

data/lib/onix/measure.rb

@@ -0,0 +1,9 @@
+module ONIX
+  class Measure
+    include ROXML
+
+    xml_accessor :measure_type_code, :twodigit, :from => "MeasureTypeCode"
+    xml_accessor :measurement,       :decimal,  :from => "Measurement"
+    xml_accessor :measure_unit_code, :etext,    :from => "MeasureUnitCode"
+  end
+end

data/lib/onix/product.rb

@@ -11,8 +11,8 @@ module ONIX
     xml_accessor :series, :from => "Series"
     xml_accessor :edition_number, :integer, :from => "EditionNumber"
     xml_accessor :titles, [ONIX::Title], :from => "Title"
-    xml_accessor :websites, [ONIX::Website], :from => "Website"
     xml_accessor :contributors, [ONIX::Contributor], :from => "Contributor"
+    xml_accessor :websites, [ONIX::Website], :from => "Website"
     xml_accessor :number_of_pages, :integer, :from => "NumberOfPages"
     xml_accessor :bic_main_subject, :from => "BICMainSubject"
     xml_accessor :subjects, [ONIX::Subject], :from => "Subject"
@@ -24,7 +24,17 @@ module ONIX
     xml_accessor :publication_date, :yyyymmdd, :from => "PublicationDate"
     xml_accessor :year_first_published, :integer, :from => "YearFirstPublished"
     xml_accessor :sales_restrictions, [ONIX::SalesRestriction], :from => "SalesRestriction"
+    xml_accessor :measurements, [ONIX::Measure], :from => "Measure"
     xml_accessor :supply_details, [ONIX::SupplyDetail], :from => "SupplyDetail"
 
+    # some deprecated attributes. Read only
+    # - See the measures array for the current way of specifying
+    #   various measurements of the product
+    xml_reader :height,    :decimal, :from => "Height"
+    xml_reader :width,     :decimal, :from => "Width"
+    xml_reader :thickness, :decimal, :from => "Thickness"
+    xml_reader :weight,    :decimal, :from => "Weight"
+    xml_reader :dimensions, :etext,  :from => "Dimensions"
+
   end
 end

data/lib/onix/reader.rb

@@ -68,18 +68,22 @@ module ONIX
       @product_klass = product_klass
 
       # create a sized queue to store each product read from the file
+      # We use a separate thread to read products from the source file.
+      # This queue is a thread-safe way to transfer products from that
+      # thread back into the main one.
       @queue = SizedQueue.new(100)
 
-      # launch a reader thread to process the file and store each
-      # product in the queue
+      # launch a reader thread
       Thread.abort_on_exception = true
       Thread.new { read_input }
 
-      # TODO: this is a seriously hacky way to ensure the reading thread
-      #       has enough time to read our metadata and header objects from
-      #       the input stream. I should be making the constructor block until
-      #       it has actively confirmed the data has been read
-      sleep 1
+      # don't return from the constructor until the reading thread
+      # has spun up and put at least one item into the queue. If
+      # it finds no Products in the file, it queues a nil, so we
+      # shouldn't get stuck here indefinitely
+      while @queue.size == 0
+        sleep 0.05
+      end
     end
 
     # Iterate over all the products in an ONIX file

data/lib/onix/writer.rb

@@ -73,11 +73,8 @@ module ONIX
     private
 
     def start_document
-      decl = REXML::XMLDecl.new
-      doctype = REXML::DocType.new('ONIXMessage', "SYSTEM \"#{DOCTYPE}\"")
-      decl.encoding = "utf-8"
-      @output.write(decl.to_s+"\n")
-      @output.write(doctype.to_s+"\n")
+      @output.write("<?xml version=\"1.0\" encoding=\"utf-8\"?>\n")
+      @output.write("<!DOCTYPE ONIXMessage SYSTEM \"#{DOCTYPE}\">\n")
       @output.write("<ONIXMessage>\n")
       @output.write(@header.to_xml.to_s)
       @output.write("\n")

data/spec/product_spec.rb

@@ -8,8 +8,8 @@ require 'date'
 context "ONIX::Product" do
 
   before(:each) do
-    data_path = File.join(File.dirname(__FILE__),"..","data")
-    file1    = File.join(data_path, "product.xml")
+    @data_path = File.join(File.dirname(__FILE__),"..","data")
+    file1    = File.join(@data_path, "product.xml")
     @doc = LibXML::XML::Document.file(file1)
     @product_node = @doc.root
   end
@@ -26,6 +26,13 @@ context "ONIX::Product" do
     product.publishing_status.should eql(4)
     product.publication_date.should eql(Date.civil(1998,9,1))
     product.year_first_published.should eql(1998)
+
+    # including ye olde, deprecated ones
+    product.height.should eql(100)
+    product.width.should eql(BigDecimal.new("200.5"))
+    product.weight.should eql(300)
+    product.thickness.should eql(300)
+    product.dimensions.should eql("100x200")
   end
 
   specify "should provide read access to product IDs" do
@@ -43,6 +50,11 @@ context "ONIX::Product" do
     product.subjects.size.should eql(1)
   end
 
+  specify "should provide read access to measurements" do
+    product = ONIX::Product.parse(@product_node.to_s)
+    product.measurements.size.should eql(1)
+  end
+
   specify "should provide write access to first level attibutes" do
     product = ONIX::Product.new
 
@@ -72,4 +84,14 @@ context "ONIX::Product" do
     product.year_first_published = 1998
     product.year_first_published.should eql(1998)
   end
+
+  specify "should correctly parse files that have non-standard entties"
+=begin
+  do
+    file = File.join(@data_path, "extra_entities.xml")
+    product = ONIX::Product.parse(File.read(file))
+
+    product.titles.first.title_text.should eql("Ipod® & Itunes® for Dummies®, 4th Edition")
+  end
+=end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: onix
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors: 
 - James Healy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-28 00:00:00 +11:00
+date: 2008-11-01 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -78,8 +78,10 @@ files:
 - lib/onix/two_digit_type.rb
 - lib/onix/writer.rb
 - lib/onix/etext_type.rb
+- lib/onix/measure.rb
+- lib/onix/decimal_type.rb
 - lib/onix.rb
-- README.rdoc
+- README.markdown
 - TODO
 - CHANGELOG
 has_rdoc: true

data/README.rdoc

@@ -1,30 +0,0 @@
-== ONIX
-
-The ONIX standard is a somewhat verbose XML format that is rapidly becoming the
-industry standard for electronic data sharing in the book and publishing
-industries.
-
-This library provides a slim layer over the format and simplifies both reading
-and writing ONIX files in your ruby applications.
-
-== Installation
-
-    gem install onix
-
-== Usage
-
-See files in the examples directory to get started quickly. For further reading
-view the comments to the following classes:
-
-* ONIX::Reader - For reading ONIX files
-* ONIX::Writer - For writing ONIX files
-
-== Contributing
-
-All suggestions and patches welcome, preferably via a git repository I can pull from.
-
-== Further Reading
-
-- The source: (http://github.com/yob/onix/tree/master)[http://github.com/yob/onix/tree/master]
-- Rubyforge project: (http://rubyforge.org/projects/rbook/)[http://rubyforge.org/projects/rbook/]
-- The official specs (http://www.editeur.org/onix.html)[http://www.editeur.org/onix.html]