milkfarm-onix 0.7.7 → 0.8.3

data/CHANGELOG

@@ -1,3 +1,33 @@
+v0.8.2 (6th May 2010)
+- fix APAProduct#series and APAProduct#series=
+
+v0.8.1 (5th January 2010)
+- Use nokogiri's support for transparent entity conversion when reading an ONIX file
+- Removed entity replacement from ONIX::Normaliser
+  - the external dependency on sed made me uncomfortable, and it wasn't really
+    necessary now that nokogiri can do it for us
+- Removed utf-8 normalisation from ONIX::Normaliser
+  - nokogiri also handles this really cleanly and transparently. Regardless of
+    the source file encoding, Nokogiri::Reader returns utf-8 encoded data
+- Add the release attribute to files we generate
+  - it's optional in 2.1, but mandatory in 3.0. As we start to see 3.0 files in the
+    wild it will help to have a rapid way to distinguish between them
+- Add ONIX::Reader#release - to detect the release version of files we read in
+
+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.
@@ -29,7 +59,7 @@ v0.7.1 (24th June 2009)
 
 v0.7.0 (17th June 2009)
 - try using LibXML for reader again
-  - retrieving the ONIX version of the input file is currently disabled, as 
+  - retrieving the ONIX version of the input file is currently disabled, as
     that seems to be the source of our instability
 - Various Ruby 1.9 compatability tweaks
   - add source file coding declarations. All source files are UTF-8

data/README.markdown

@@ -10,6 +10,29 @@ 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.
 
+## Feature Support
+
+This library currently only handles ONIX 2.1 files (all revisions). At some
+point I'll need to work out what to do about supporting ONIX 3.0 files. I
+suspect a separate library will be the simplest solution.
+
+ONIX::Reader only handles the reference tag versions of ONIX 2.1. Use
+ONIX::Normaliser to convert any short tag files to reference tags.
+
+ONIX::Writer only generates reference tag ONIX files.
+
+## DTD Loading
+
+To correctly handle named entities when reading an ONIX file, this gem attempts
+to load the DTD describing the ONIX format into memory. By default, this means
+each file you read will require several hundred Kb of data to be downloaded
+over the net.
+
+This is obviously not desirable in most cases. To avoid it, you need to add copies
+of the ONIX DTDs into your system XML catalog. On Debian and Ubuntu systems,
+the quickest way to do that is to build and install the package available @
+http://github.com/yob/onix-dtd
+
 ## Installation
 
     gem install onix
@@ -36,5 +59,4 @@ 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)
+- The official specs [http://www.editeur.org/8/ONIX/](http://www.editeur.org/8/ONIX/)

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  = 7
+    Minor = 8
+    Tiny  = 3
 
     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
@@ -76,6 +62,7 @@ require File.join(File.dirname(__FILE__), "onix", "header")
 require File.join(File.dirname(__FILE__), "onix", "product_identifier")
 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", "website")
 require File.join(File.dirname(__FILE__), "onix", "contributor")

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

@@ -6,7 +6,6 @@ module ONIX
     delegate :record_reference, :record_reference=
     delegate :notification_type, :notification_type=
     delegate :product_form, :product_form=
-    delegate :series, :series=
     delegate :edition, :edition=
     delegate :number_of_pages, :number_of_pages=
     delegate :bic_main_subject, :bic_main_subject=
@@ -107,6 +106,20 @@ module ONIX
       composite.subtitle = str
     end
 
+    def series
+      composite = product.series.first
+      composite.andand.title_of_series
+    end
+
+    def series=(val)
+      composite = product.series.first
+      if composite.nil?
+        composite =  ONIX::Series.new
+        product.series << composite
+      end
+      composite.title_of_series = val.to_s
+    end
+
     # retrieve the current publisher website for this particular product
     def publisher_website
       website(2).andand.website_link
@@ -651,7 +664,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"
 
@@ -11,12 +10,12 @@ module ONIX
     xml_accessor :audience_range_precisions, :from => "AudienceRangePrecision", :as => [Fixnum], :to_xml => [ONIX::Formatters.two_digit] # TODO: two_digit isn't working on the array items
     xml_accessor :audience_range_values, :from => "AudienceRangeValue", :as => [Integer]
 
-    # TODO: element AudienceRange: validity error : 
-    #   Element AudienceRange content does not follow the DTD, expecting 
-    #   (AudienceRangeQualifier , AudienceRangePrecision , AudienceRangeValue , 
-    #   (AudienceRangePrecision , AudienceRangeValue)?), 
-    #   got 
-    #   (AudienceRangeQualifier AudienceRangePrecision AudienceRangePrecision 
+    # TODO: element AudienceRange: validity error :
+    #   Element AudienceRange content does not follow the DTD, expecting
+    #   (AudienceRangeQualifier , AudienceRangePrecision , AudienceRangeValue ,
+    #   (AudienceRangePrecision , AudienceRangeValue)?),
+    #   got
+    #   (AudienceRangeQualifier AudienceRangePrecision AudienceRangePrecision
     #   AudienceRangeValue AudienceRangeValue )
     def initialize
       self.audience_range_precisions = []

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/lists/contributor_role.rb

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+module ONIX
+  module Lists
+    # Code list 17
+    CONTRIBUTOR_ROLE = {
+      "A01" => "By (author)",
+      "A02" => "With",
+      "A03" => "Screenplay by",
+      "A04" => "Libretto by",
+      "A05" => "Lyrics by",
+      "A06" => "By (composer)",
+      "A07" => "By (artist)",
+      "A08" => "By (photographer)",
+      "A09" => "Created by",
+      "A10" => "From an idea by",
+      "A11" => "Designed by",
+      "A12" => "Illustrated by",
+      "A13" => "Photographs by",
+      "A14" => "Text by",
+      "A15" => "Preface by",
+      "A16" => "Prologue by",
+      "A17" => "Summary by",
+      "A18" => "Supplement by",
+      "A19" => "Afterword by",
+      "A20" => "Notes by",
+      "A21" => "Commentaries by",
+      "A22" => "Epilogue by",
+      "A23" => "Foreword by",
+      "A24" => "Introduction by",
+      "A25" => "Footnotes by",
+      "A26" => "Memoir by",
+      "A27" => "Experiments by",
+      "A29" => "Introduction and notes by",
+      "A30" => "Software written by",
+      "A31" => "Book and lyrics by",
+      "A32" => "Contributions by",
+      "A33" => "Appendix by",
+      "A34" => "Index by",
+      "A35" => "Drawings by",
+      "A36" => "Cover design or artwork by",
+      "A37" => "Preliminary work by",
+      "A38" => "Original author",
+      "A39" => "Maps by",
+      "A40" => "Inked or colored by",
+      "A41" => "Pop-ups by",
+      "A42" => "Continued by",
+      "A43" => "Interviewer",
+      "A44" => "Interviewee",
+      "A99" => "Other primary creator",
+      "B01" => "Edited by",
+      "B02" => "Revised by",
+      "B03" => "Retold by",
+      "B04" => "Abridged by",
+      "B05" => "Adapted by",
+      "B06" => "Translated by",
+      "B07" => "As told by",
+      "B08" => "Translated with commentary by",
+      "B09" => "Series edited by",
+      "B10" => "Edited and translated by",
+      "B11" => "Editor-in-chief",
+      "B12" => "Guest editor",
+      "B13" => "Volume editor",
+      "B14" => "Editorial board member",
+      "B15" => "Editorial coordination by",
+      "B16" => "Managing editor",
+      "B17" => "Founded by",
+      "B18" => "Prepared for publication by",
+      "B19" => "Associate editor",
+      "B20" => "Consultant editor",
+      "B21" => "General editor",
+      "B22" => "Dramatized by",
+      "B23" => "General rapporteur",
+      "B24" => "Literary editor",
+      "B25" => "Arranged by (music)",
+      "B99" => "Other adaptation by",
+      "C01" => "Compiled by",
+      "C02" => "Selected by",
+      "C99" => "Other compilation by",
+      "D01" => "Producer",
+      "D02" => "Director",
+      "D03" => "Conductor",
+      "D99" => "Other direction by",
+      "E01" => "Actor",
+      "E02" => "Dancer",
+      "E03" => "Narrator",
+      "E04" => "Commentator",
+      "E05" => "Vocal soloist",
+      "E06" => "Instrumental soloist",
+      "E07" => 'Read by',
+      "E08" => "Performed by (orchestra, band, ensemble)",
+      "E99" => "Performed by",
+      "F01" => "Filmed/photographed by",
+      "F99" => "Other recording by",
+      "Z01" => "Assisted by",
+      "Z99" => "Other",
+    }
+  end
+end

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/normaliser.rb

@@ -40,9 +40,6 @@ module ONIX
       raise ArgumentError, "#{oldfile} does not exist" unless File.file?(oldfile)
       raise ArgumentError, "#{newfile} already exists" if File.file?(newfile)
       raise "xsltproc app not found" unless app_available?("xsltproc")
-      raise "isutf8 app not found"   unless app_available?("isutf8")
-      raise "iconv app not found"    unless app_available?("iconv")
-      raise "sed app not found"      unless app_available?("sed")
       raise "tr app not found"       unless app_available?("tr")
 
       @oldfile = oldfile
@@ -60,21 +57,11 @@ module ONIX
         @curfile = dest
       end
 
-      # convert to utf8
-      dest = next_tempfile
-      to_utf8(@curfile, dest)
-      @curfile = dest
-
       # remove control chars
       dest = next_tempfile
       remove_control_chars(@curfile, dest)
       @curfile = dest
 
-      # remove entities
-      dest = next_tempfile
-      replace_named_entities(@curfile, dest)
-      @curfile = dest
-
       FileUtils.cp(@curfile, @newfile)
     end
 
@@ -110,41 +97,6 @@ module ONIX
       `xsltproc -o #{outpath} #{xsltpath} #{inpath}`
     end
 
-    # ensure the file is valid utf8, then make sure it's declared as such.
-    #
-    # The following behaviour is  expected:
-    #
-    #   file is valid utf8, is marked correctly
-    #     - copied untouched
-    #   file is valid utf8, is marked incorrectly or has no marked encoding
-    #     - copied and encoding mark fixed or added
-    #   file is no utf8, encoding is marked
-    #     - file is converted to utf8 and enecoding mark is updated
-    #   file is not utf8, encoding is not marked
-    #     - file is copied untouched
-    #
-    def to_utf8(src, dest)
-      inpath = File.expand_path(src)
-      outpath = File.expand_path(dest)
-
-      m, src_enc = *@head.match(/encoding=.([a-zA-Z0-9\-]+)./i)
-
-      # ensure the file is actually utf8
-      if `isutf8 #{inpath}`.strip == ""
-        if src_enc.to_s.downcase == "utf-8"
-          FileUtils.cp(inpath, outpath)
-        else
-          FileUtils.cp(inpath, outpath)
-          `sed -i 's/<?xml.*?>/<?xml version=\"1.0\" encoding=\"UTF-8\"?>/g' #{outpath}`
-        end
-      elsif src_enc
-        `iconv --from-code=#{src_enc} --to-code=UTF-8 #{inpath} > #{outpath}`
-        `sed -i 's/#{src_enc}/UTF-8/' #{outpath}`
-      else
-          FileUtils.cp(inpath, outpath)
-      end
-    end
-
     # XML files shouldn't contain low ASCII control chars. Strip them.
     #
     def remove_control_chars(src, dest)
@@ -153,35 +105,6 @@ module ONIX
       `cat #{inpath} | tr -d "\\000-\\010\\013\\014\\016-\\037" > #{outpath}`
     end
 
-    # replace all named entities in the specified file with
-    # numeric entities.
-    #
-    def replace_named_entities(src, dest)
-      inpath = File.expand_path(src)
-      outpath = File.expand_path(dest)
-
-      cmd = "sed " + entity_map.map do |named, numeric|
-        "-e 's/\\&#{named};/\\&#{numeric};/g'"
-      end.join(" ") + " #{inpath} > #{outpath}"
-      #raise cmd
-      `#{cmd}`
-    end
-
-    # return a named entity to numeric entity mapping, build by extracting
-    # data from the ONIX DTD
-    #
-    def entity_map
-      return @map if @map
-
-      path = File.dirname(__FILE__) + "/../../support/entities.txt"
-      @map = {}
-      File.read(path).split.each do |line|
-        elements = line.split(":")
-        @map[elements.first] = elements.last
-      end
-      @map
-    end
-
   end
 
 end