elibri_onix 0.1.5 → 0.1.6

data/Gemfile

@@ -3,12 +3,13 @@ source "http://rubygems.org"
 gem 'activesupport', '>= 2.3.5'
 gem 'roxml', '= 3.1.3'
 gem 'i18n'
+gem 'elibri_onix_dict', '0.0.3'
 
 group :development do
   gem "pry"
   gem "mocha"
   gem "minitest", ">= 0"
-  gem "bundler", "~> 1.0.0"
+  gem "bundler", ">= 1.0.0"
   gem "jeweler", "~> 1.6.2"
   gem "rcov", ">= 0"
 end

data/Gemfile.lock

@@ -3,6 +3,7 @@ GEM
   specs:
     activesupport (2.3.5)
     coderay (0.9.8)
+    elibri_onix_dict (0.0.3)
     git (1.2.5)
     i18n (0.6.0)
     jeweler (1.6.4)
@@ -36,7 +37,8 @@ PLATFORMS
 
 DEPENDENCIES
   activesupport (>= 2.3.5)
-  bundler (~> 1.0.0)
+  bundler (>= 1.0.0)
+  elibri_onix_dict (= 0.0.3)
   i18n
   jeweler (~> 1.6.2)
   minitest

data/elibri_onix.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{elibri_onix}
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marcin Urbanski"]
-  s.date = %q{2011-10-18}
+  s.date = %q{2011-11-14}
   s.description = %q{EDItEUR ONIX format subset implementation used in Elibri publication system}
   s.email = %q{marcin@urbanski.vdl.pl}
   s.extra_rdoc_files = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "elibri_onix.gemspec",
     "lib/elibri_onix.rb",
+    "lib/elibri_onix/inspector.rb",
     "lib/elibri_onix/onix_3_0/audience_range.rb",
     "lib/elibri_onix/onix_3_0/collection.rb",
     "lib/elibri_onix/onix_3_0/contributor.rb",
@@ -54,10 +55,49 @@ Gem::Specification.new do |s|
     "lib/elibri_onix/onix_3_0/title_element.rb",
     "lib/elibri_onix/releases.rb",
     "lib/elibri_onix/version.rb",
+    "test/elibri_audience_range_test.rb",
+    "test/elibri_contributors_test.rb",
+    "test/elibri_edition_test.rb",
+    "test/elibri_extensions_test.rb",
+    "test/elibri_extent_test.rb",
+    "test/elibri_languages_test.rb",
+    "test/elibri_measurement_test.rb",
     "test/elibri_onix_release_3_0_onix_message_test.rb",
     "test/elibri_onix_test.rb",
+    "test/elibri_product_form_test.rb",
+    "test/elibri_publisher_info_test.rb",
+    "test/elibri_publishing_status_test.rb",
+    "test/elibri_record_identifiers_test.rb",
+    "test/elibri_sale_restrictions_test.rb",
+    "test/elibri_series_memberships_test.rb",
+    "test/elibri_supporting_resources_test.rb",
+    "test/elibri_texts_test.rb",
+    "test/elibri_titles_test.rb",
     "test/fixtures/all_possible_tags.xml",
     "test/fixtures/old_dialect.xml",
+    "test/fixtures/onix_announced_product_example.xml",
+    "test/fixtures/onix_audience_range_example.xml",
+    "test/fixtures/onix_audiobook_extent_example.xml",
+    "test/fixtures/onix_collective_work_example.xml",
+    "test/fixtures/onix_contributors_example.xml",
+    "test/fixtures/onix_ebook_extent_example.xml",
+    "test/fixtures/onix_edition_example.xml",
+    "test/fixtures/onix_elibri_extensions_example.xml",
+    "test/fixtures/onix_languages_example.xml",
+    "test/fixtures/onix_measurement_example.xml",
+    "test/fixtures/onix_no_contributors_example.xml",
+    "test/fixtures/onix_out_of_print_product_example.xml",
+    "test/fixtures/onix_preorder_product_example.xml",
+    "test/fixtures/onix_product_form_example.xml",
+    "test/fixtures/onix_published_product_example.xml",
+    "test/fixtures/onix_publisher_info_example.xml",
+    "test/fixtures/onix_record_identifiers_example.xml",
+    "test/fixtures/onix_sale_restrictions_example.xml",
+    "test/fixtures/onix_series_memberships_example.xml",
+    "test/fixtures/onix_supporting_resources_example.xml",
+    "test/fixtures/onix_texts_example.xml",
+    "test/fixtures/onix_title_with_collection_example.xml",
+    "test/fixtures/onix_titles_example.xml",
     "test/helper.rb"
   ]
   s.homepage = %q{http://github.com/elibri/elibri_onix}
@@ -73,20 +113,22 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<activesupport>, [">= 2.3.5"])
       s.add_runtime_dependency(%q<roxml>, ["= 3.1.3"])
       s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_runtime_dependency(%q<elibri_onix_dict>, ["= 0.0.3"])
       s.add_development_dependency(%q<pry>, [">= 0"])
       s.add_development_dependency(%q<mocha>, [">= 0"])
       s.add_development_dependency(%q<minitest>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<activesupport>, [">= 2.3.5"])
       s.add_dependency(%q<roxml>, ["= 3.1.3"])
       s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<elibri_onix_dict>, ["= 0.0.3"])
       s.add_dependency(%q<pry>, [">= 0"])
       s.add_dependency(%q<mocha>, [">= 0"])
       s.add_dependency(%q<minitest>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
@@ -94,10 +136,11 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<activesupport>, [">= 2.3.5"])
     s.add_dependency(%q<roxml>, ["= 3.1.3"])
     s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<elibri_onix_dict>, ["= 0.0.3"])
     s.add_dependency(%q<pry>, [">= 0"])
     s.add_dependency(%q<mocha>, [">= 0"])
     s.add_dependency(%q<minitest>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
     s.add_dependency(%q<rcov>, [">= 0"])
   end

data/lib/elibri_onix.rb

@@ -6,7 +6,9 @@ require 'active_support'
 require 'active_support/core_ext'
 require 'roxml'
 require 'elibri_onix/version'
+require 'elibri_onix/inspector'
 require 'elibri_onix/releases'
+require 'elibri_onix_dict'
 
 $KCODE = "UTF-8"
 
@@ -17,3 +19,4 @@ module Elibri
     
   end
 end
+

data/lib/elibri_onix/inspector.rb

@@ -0,0 +1,25 @@
+module Inspector
+
+  def attribute_for_inspect(attr_name)
+    value = self.send(attr_name)
+
+    if value.is_a?(String) && value.length > 50
+      "#{value[0..50]}...".inspect
+    elsif value.is_a?(Date) || value.is_a?(Time)
+      %("#{value.to_s(:db)}")
+    #elsif value.is_a?(Array)
+    #  "\n    [" + value.map(&:inspect).join(",\n     ") + "]"
+    else
+      value.inspect
+    end
+  end
+
+  def inspect
+    include_fields = self.respond_to?(:inspect_include_fields) ? self.inspect_include_fields : []
+    attributes_as_nice_string = (include_fields + self.roxml_references.map { |rr| rr.opts.attr_name }).collect { |name|
+      "#{name}: #{attribute_for_inspect(name)}"
+    }.compact.join(", ")
+    "#<#{self.class} #{attributes_as_nice_string}>"
+  end
+end
+

data/lib/elibri_onix/onix_3_0/audience_range.rb

@@ -5,12 +5,13 @@ module Elibri
 
       class AudienceRange
         include ROXML
+        include Inspector
 
         xml_name 'AudienceRange'
 
-        xml_accessor :qualifier, :from => 'AudienceRangeQualifier', :as => Fixnum
-        xml_accessor :precision, :from => 'AudienceRangePrecision', :as => Fixnum
-        xml_accessor :value, :from => 'AudienceRangeValue'
+        xml_accessor :qualifier, :from => 'AudienceRangeQualifier'
+        xml_accessor :precision, :from => 'AudienceRangePrecision'
+        xml_accessor :value, :from => 'AudienceRangeValue', :as => Fixnum
 
 
       end

data/lib/elibri_onix/onix_3_0/collection.rb

@@ -5,10 +5,11 @@ module Elibri
 
       class Collection
         include ROXML
+        include Inspector
 
         xml_name 'Collection'
 
-        xml_accessor :type, :from => 'CollectionType', :as => Fixnum
+        xml_accessor :type, :from => 'CollectionType'
         xml_accessor :elements, :as => [TitleElement]
         xml_accessor :title_detail, :as => TitleDetail
 
@@ -16,6 +17,14 @@ module Elibri
           title_detail.try(:full_title)
         end
 
+        def type_name
+          Elibri::ONIX::Dict::Release_3_0::CollectionType.find_by_onix_code(type).const_name.downcase
+        end
+
+        def inspect_include_fields
+          [:type_name]
+        end
+
       end
 
     end

data/lib/elibri_onix/onix_3_0/contributor.rb

@@ -5,6 +5,7 @@ module Elibri
 
       class Contributor
         include ROXML
+        include Inspector
 
         xml_name 'Contributor'
 
@@ -20,6 +21,14 @@ module Elibri
         xml_accessor :biographical_note, :from => 'BiographicalNote'
 
         xml_accessor :unnamed_persons, :from => 'UnnamedPersons'
+
+        def role_name
+          Elibri::ONIX::Dict::Release_3_0::ContributorRole.find_by_onix_code(self.role).const_name.downcase
+        end
+
+        def inspect_include_fields
+          [:role_name]
+        end
       end
 
     end

data/lib/elibri_onix/onix_3_0/extent.rb

@@ -6,11 +6,25 @@ module Elibri
 
       class Extent
         include ROXML
+        include Inspector
 
         xml_name 'Extent'
-        xml_accessor :type, :from => 'ExtentType', :as => Fixnum
-        xml_accessor :value, :from => 'ExtentValue', :as => BigDecimal
-        xml_accessor :unit, :from => 'ExtentUnit', :as => Fixnum
+        xml_accessor :type, :from => 'ExtentType'
+        xml_accessor :value, :from => 'ExtentValue', :as => Fixnum
+        xml_accessor :unit, :from => 'ExtentUnit'
+
+        def type_name
+          Elibri::ONIX::Dict::Release_3_0::ExtentType.find_by_onix_code(type).const_name.downcase
+        end
+ 
+        def unit_name
+          Elibri::ONIX::Dict::Release_3_0::ExtentUnit.find_by_onix_code(unit).const_name.downcase
+        end
+
+        def inspect_include_fields
+          [:type_name, :unit_name]
+        end
+    
       end
 
     end

data/lib/elibri_onix/onix_3_0/header.rb

@@ -6,6 +6,7 @@ module Elibri
 
       class Header
         include ROXML
+        include Inspector
 
         xml_name 'Header'
         xml_accessor :sent_date_time, :as => Date, :from => 'SentDateTime'

data/lib/elibri_onix/onix_3_0/imprint.rb

@@ -6,6 +6,7 @@ module Elibri
 
       class Imprint
         include ROXML
+        include Inspector
 
         xml_name 'Imprint'
 

data/lib/elibri_onix/onix_3_0/language.rb

@@ -6,12 +6,24 @@ module Elibri
 
       class Language
         include ROXML
-
+        include Inspector
         xml_name 'Language'
 
-        xml_accessor :role, :from => 'LanguageRole', :as => Fixnum
+        xml_accessor :role, :from => 'LanguageRole'
         xml_accessor :code, :from => 'LanguageCode'
 
+        def role_name
+          Elibri::ONIX::Dict::Release_3_0::LanguageRole.find_by_onix_code(self.role).const_name.downcase
+        end
+   
+        def language
+          Elibri::ONIX::Dict::Release_3_0::LanguageCode.find_by_onix_code(self.code).name(:pl).downcase
+        end
+
+        def inspect_include_fields
+           [:role_name, :language]
+        end
+
       end
 
     end

data/lib/elibri_onix/onix_3_0/measure.rb

@@ -6,11 +6,21 @@ module Elibri
 
       class Measure
         include ROXML
+        include Inspector
 
         xml_name 'Measure'
-        xml_accessor :type, :from => 'MeasureType', :as => Fixnum
-        xml_accessor :measurement, :from => 'Measurement', :as => BigDecimal
+        xml_accessor :type, :from => 'MeasureType'
+        xml_accessor :measurement, :from => 'Measurement', :as => Fixnum
         xml_accessor :unit, :from => 'MeasureUnitCode'
+
+        def type_name
+           Elibri::ONIX::Dict::Release_3_0::MeasureType.find_by_onix_code(type).const_name.downcase
+        end
+
+        def inspect_include_fields
+          [:type_name]
+        end
+
       end
 
     end

data/lib/elibri_onix/onix_3_0/onix_message.rb

@@ -5,7 +5,8 @@ module Elibri
 
       class ONIXMessage
         include ROXML
-        
+        #include Inspector
+
         xml_name 'ONIXMessage'
         xml_accessor :release, :from => "@release"
         xml_accessor :elibri_dialect, :from => "elibri:Dialect"

data/lib/elibri_onix/onix_3_0/price.rb

@@ -8,6 +8,7 @@ module Elibri
 
       class Price
         include ROXML
+        include Inspector
 
         xml_name 'Price'
 

data/lib/elibri_onix/onix_3_0/product.rb

@@ -5,11 +5,16 @@ module Elibri
 
       class Product
         include ROXML
-        attr_accessor :elibri_dialect
+
+        attr_accessor :elibri_dialect, :height, :width, :thickness, :weight, :ean, :isbn13, :number_of_pages, :duration, 
+                      :file_size, :publisher_name, :imprint_name, :current_state, :reading_age_from, :reading_age_to, 
+                      :table_of_contents, :description, :reviews, :excerpts, :series, :title, :subtitle, :collection_title,
+                      :collection_part, :full_title, :original_title, :trade_title, :parsed_publishing_date
+
 
         xml_name 'Product'
         xml_accessor :record_reference, :from => 'RecordReference'
-        xml_accessor :notification_type, :from => 'NotificationType', :as => Fixnum
+        xml_accessor :notification_type, :from => 'NotificationType'
         xml_accessor :deletion_text, :from => 'DeletionText'
 
         # Load attributes specific for dialect 3.0.1
@@ -37,12 +42,13 @@ module Elibri
         xml_accessor :related_products, :as => [RelatedProduct], :in => 'RelatedMaterial'
         xml_accessor :supply_details, :as => [SupplyDetail], :in => 'ProductSupply'
 
-        xml_accessor :product_composition, :in => 'DescriptiveDetail', :from => 'ProductComposition', :as => Fixnum
+        xml_accessor :product_composition, :in => 'DescriptiveDetail', :from => 'ProductComposition'
         xml_accessor :product_form, :in => 'DescriptiveDetail', :from => 'ProductForm'
         xml_accessor :measures, :in => 'DescriptiveDetail', :as => [Measure]
         xml_accessor :title_details, :in => 'DescriptiveDetail', :as => [TitleDetail]
         xml_accessor :collections, :in => 'DescriptiveDetail', :as => [Collection]
         xml_accessor :contributors, :in => 'DescriptiveDetail', :as => [Contributor]
+        xml_accessor :no_contributor, :in => 'DescriptiveDetail', :from => 'NoContributor'
         xml_accessor :languages, :in => 'DescriptiveDetail', :as => [Language]
         xml_accessor :extents, :in => 'DescriptiveDetail', :as => [Extent]
         xml_accessor :subjects, :in => 'DescriptiveDetail', :as => [Subject]
@@ -55,99 +61,123 @@ module Elibri
 
         xml_accessor :imprint, :in => 'PublishingDetail', :as => Imprint
         xml_accessor :publisher, :in => 'PublishingDetail', :as => Publisher
-        xml_accessor :publishing_status, :in => 'PublishingDetail', :from => 'PublishingStatus', :as => Fixnum
+        xml_accessor :publishing_status, :in => 'PublishingDetail', :from => 'PublishingStatus'
         xml_accessor :publishing_date, :in => 'PublishingDetail', :as => PublishingDate
         xml_accessor :sales_restrictions, :in => 'PublishingDetail', :as => [SalesRestriction]
 
-
-        def isbn13
-          identifiers.find {|identifier| identifier.type == 15}.try(:value)
+        def sales_restrictions?
+          sales_restrictions.size > 0
         end
 
-
-        def ean13
-          identifiers.find {|identifier| identifier.type == 3}.try(:value)
+        def no_contributor?
+          no_contributor == ""
         end
 
-
-        %w{height width thickness weight}.each do |method_name|
-          define_method(method_name) do
-            send(method_name + '_measure').try(:measurement)
-          end
-
-          define_method(method_name + '_unit') do
-            send(method_name + '_measure').try(:unit)
-          end
-        end  
-
-
-        def proprietary_identifiers
-          Hash.new.tap do |hash|
-            identifiers.each do |identifier|
-              hash[identifier.type_name] = identifier.value if identifier.type == 1
-            end
-          end
+        def unnamed_persons?
+          contributors.size == 1 && contributors[0].unnamed_persons.present?
         end
 
-
-        def full_title
-          title_details.find {|title_detail| title_detail.type == 1}.try(:full_title)
+        def front_cover
+          supporting_resources.find { |resource| resource.content_type_name == "front_cover" }.try(:link)
         end
 
-
-        def original_title
-          title_details.find {|title_detail| title_detail.type == 3}.try(:full_title)
+        def series_names
+          series.map { |series| series[0] }
         end
-
-
-        def trade_title
-          title_details.find {|title_detail| title_detail.type == 10}.try(:full_title)
+ 
+        def proprietary_identifiers 
+          identifiers.find_all { |i| i.identifier_type == "proprietary" }.inject({}) { |res, ident| res[ident.type_name] = ident.value; res }
         end
 
-
-        def number_of_pages
-          extents.find {|extent| extent.type == 0}.try(:value)
-        end
-
-
-        def reading_age_from
-          age_from = audience_ranges.find {|audience_range| (audience_range.qualifier == 18) && (audience_range.precision == 3)}.try(:value)
-          age_from.present? ? age_from.to_i : nil
+        #I don't want to see roxml_references in output - it's faar to big output
+        def pretty_print_instance_variables
+          (instance_variables - ["@roxml_references", "@measures", "@identifiers", "@notification_type", "@publishing_status",
+                                 "@elibri_dialect", "@product_composition", "@extents", "@publisher", "@imprint",
+                                 "@audience_ranges", "@text_contents", "@collections", "@title_details", "@publishing_date"]).find_all { |varname|
+              instance_variable_get(varname).present?
+          }.sort
         end
 
 
-        def reading_age_to
-          age_to = audience_ranges.find {|audience_range| (audience_range.qualifier == 18) && (audience_range.precision == 4)}.try(:value)
-          age_to.present? ? age_to.to_i : nil
+        def pretty_print(pp)
+          pp.object_address_group(self) {
+            pp.seplist(self.pretty_print_instance_variables, lambda { pp.text ',' }) {|v|
+              pp.breakable
+              v = v.to_s if Symbol === v
+              pp.text v
+              pp.text '='
+              pp.group(1) {
+                pp.breakable ''
+                pp.pp(self.instance_eval(v))
+              }
+            }
+          }
         end
 
-
-        def imprint_name
-          imprint.try(:name)
-        end
-
-
         private
 
-          def height_measure
-            measures.find {|measure| measure.type == 1}
-          end
-
+        def find_title(code)
+          title_details.find {|title_detail| title_detail.type == code}
+        end
 
-          def width_measure
-            measures.find {|measure| measure.type == 2}
+        def parse_publishing_date!
+          if sales_restrictions?
+            date = sales_restrictions[0].end_date
+            @parsed_publishing_date = [date.year, date.month, date.day]
+          elsif publishing_date
+            @parsed_publishing_date = publishing_date.parsed
+          else
+            @parsed_publishing_date = []
           end
+        end
 
 
-          def thickness_measure
-            measures.find {|measure| measure.type == 3}
+        def after_parse
+          %w{height width thickness weight}.each do |mn|
+            instance_variable_set("@#{mn}", measures.find { |m| m.type_name == mn }.try(:measurement))
           end
 
+          @ean = identifiers.find { |identifier| identifier.identifier_type == "ean" }.try(:value)
+          @isbn13 = identifiers.find { |identifier| identifier.identifier_type == "isbn13" }.try(:value)
+          @number_of_pages = extents.find {|extent| extent.type_name == "page_count" }.try(:value)
+          @duration = extents.find {|extent| extent.type_name == "duration" }.try(:value)
+          @file_size = extents.find {|extent| extent.type_name == "file_size" }.try(:value)
+          @publisher_name = publisher.name if publisher
+          @imprint_name = imprint.name if imprint
+
+          @reading_age_from = audience_ranges.find {|ar| (ar.qualifier == "18") && (ar.precision == "03")}.try(:value)
+          @reading_age_to = audience_ranges.find {|ar| (ar.qualifier == "18") && (ar.precision == "04")}.try(:value)
+          @table_of_contents = text_contents.find { |t| t.type_name == "table_of_contents" }.try(:text)
+          @description = text_contents.find { |t| t.type_name == "main_description" }.try(:text)
+          @reviews = text_contents.find_all { |t| t.type_name == "review" }.map { |t| [t.text, t.author] }
+          @excerpts = text_contents.find_all { |t| t.type_name == "excerpt" }.map { |t| t.text }
+          @series = collections.map { |c| [c.title_detail.elements[0].title,  c.title_detail.elements[0].part_number] }
+          @title = find_title(Elibri::ONIX::Dict::Release_3_0::TitleType::DISTINCTIVE_TITLE).product_level.try(:title)
+          @subtitle = find_title(Elibri::ONIX::Dict::Release_3_0::TitleType::DISTINCTIVE_TITLE).product_level.try(:subtitle)
+          @collection_title = find_title(Elibri::ONIX::Dict::Release_3_0::TitleType::DISTINCTIVE_TITLE).collection_level.try(:title)
+          @collection_part = find_title(Elibri::ONIX::Dict::Release_3_0::TitleType::DISTINCTIVE_TITLE).collection_level.try(:part_number)
+          @full_title = find_title(Elibri::ONIX::Dict::Release_3_0::TitleType::DISTINCTIVE_TITLE).try(:full_title)
+          @original_title = find_title(Elibri::ONIX::Dict::Release_3_0::TitleType::ORIGINAL_TITLE).try(:full_title)
+          @trade_title = find_title(Elibri::ONIX::Dict::Release_3_0::TitleType::DISTRIBUTORS_TITLE).try(:full_title)
+          compute_state!
+          parse_publishing_date!
+        end
 
-          def weight_measure
-            measures.find {|measure| measure.type == 8}
+        def compute_state!
+          if notification_type == "01"
+            @current_state = :announced
+          elsif notification_type == "02"
+            @current_state = :preorder
+          else
+            if publishing_status == "04"
+              @current_state = :published
+            elsif publishing_status == "07"
+              @current_state = :out_of_print
+            else
+              raise "cannot determine the state of the product"
+            end
           end
-
+        end
       end
 
     end