cacofonix 0.10.0

data/lib/cacofonix/elements/prize.rb

@@ -0,0 +1,10 @@
+# coding: utf-8
+
+class Cacofonix::Prize < Cacofonix::Element
+  xml_name "Prize"
+  xml_accessor :prize_name, :from => "PrizeName"
+  xml_accessor :prize_year, :from => "PrizeYear"
+  onix_code_from_list :prize_country, "PrizeCountry", :list => 91
+  onix_code_from_list :prize_code, "PrizeCode", :list => 41
+  xml_accessor :prize_jury, :from => "PrizeJury"
+end

data/lib/cacofonix/elements/product.rb

@@ -0,0 +1,155 @@
+# coding: utf-8
+
+class Cacofonix::Product < Cacofonix::ProductBase
+  xml_name "Product"
+
+  # PR.1 Record reference number, type and source
+  xml_accessor :record_reference, :from => "RecordReference"
+  onix_code_from_list :notification_type, "NotificationType", :list => 1
+  onix_code_from_list :deletion_code, "DeletionCode", :list => 2
+  xml_accessor :deletion_text, :from => "DeletionText"
+  onix_code_from_list :record_source_type, "RecordSourceType", :list => 3
+  onix_code_from_list :record_source_identifier_type, "RecordSourceIdentifierType", :list => 44
+  xml_accessor :record_source_identifier, :from => "RecordSourceIdentifier"
+  xml_accessor :record_source_name, :from => "RecordSourceName"
+
+  # PR.2 Product numbers
+  onix_codes_from_list :barcodes, "Barcode", :list => 6
+
+  # PR.3 Product Form
+  # (See also ProductBase)
+  onix_composite :contained_items, Cacofonix::ContainedItem
+  onix_composite :product_classifications, Cacofonix::ProductClassification
+
+  # PR.4 Epublication
+  # (See also ProductBase)
+  onix_code_from_list :epub_source, "EpubSource", :list => 11
+  xml_accessor :epub_source_version, "EpubSourceVersion"
+  xml_accessor :epub_source_description, "EpubSourceDescription"
+
+  onix_composite :series, Cacofonix::Series
+  onix_boolean_flag(:no_series, "NoSeries")
+
+  # PR.6 Set
+  onix_composite :sets, Cacofonix::Set
+
+  # PR.7 Title
+  onix_composite :titles, Cacofonix::Title
+  onix_composite :work_identifiers, Cacofonix::WorkIdentifier
+  onix_code_from_list :thesis_type, "ThesisType", :list => 72
+  xml_accessor :thesis_presented_to, :from => "ThesisPresentedTo"
+  xml_accessor :year_of_thesis, :from => "YearOfThesis", :as => Integer
+
+  # PR.8 Authorship
+  onix_composite :contributors, Cacofonix::Contributor
+  xml_accessor :contributor_statement, :from => "ContributorStatement"
+  onix_boolean_flag(:no_contributor, "NoContributor")
+
+  # PR.9 Conference
+  onix_composite :conferences, Cacofonix::Conference
+
+  # PR.10 Edition
+  onix_code_from_list :edition_type_code, "EditionTypeCode", :list => 21
+  xml_accessor :edition_number, :from => "EditionNumber", :as => Integer
+  xml_accessor :edition_version_number, :from => "EditionVersionNumber"
+  xml_accessor :edition_statement, :from => "EditionStatement"
+  onix_boolean_flag(:no_edition, "NoEdition")
+  onix_composite :religious_text, Cacofonix::ReligiousText, :singular => true
+
+  # PR.11 Language
+  onix_composite :languages, Cacofonix::Language
+
+  # PR.12 Extents and other content
+  xml_accessor :number_of_pages, :from => "NumberOfPages", :as => Integer
+  xml_accessor :pages_roman, :from => "PagesRoman"
+  xml_accessor :pages_arabic, :from => "PagesArabic", :as => Integer
+  onix_composite :extents, Cacofonix::Extent
+  xml_accessor :number_of_illustrations, :from => "NumberOfIllustrations", :as => Integer
+  xml_accessor :illustrations_note, :from => "IllustrationsNote"
+  onix_composite :illustrations, Cacofonix::Illustrations
+  xml_accessor :map_scale, :from => "MapScale", :as => [Integer]
+
+  # PR.13 Subject
+  xml_accessor :basic_main_subject, :from => "BASICMainSubject"
+  xml_accessor :basic_version, :from => "BASICVersion"
+  xml_accessor :bic_main_subject, :from => "BICMainSubject"
+  xml_accessor :bic_version, :from => "BICVersion"
+  onix_composite :main_subjects, Cacofonix::MainSubject
+  onix_composite :subjects, Cacofonix::Subject
+  onix_composite :person_as_subjects, Cacofonix::Contributor, :from => "PersonAsSubject"
+  xml_accessor :corporate_body_as_subject, :from => "CorporateBodyAsSubject", :as => []
+  xml_accessor :place_as_subject, :from => "PlaceAsSubject", :as => []
+
+  # PR.14 Audience
+  onix_codes_from_list :audience_codes, "AudienceCode", :list => 28
+  onix_composite :audiences, Cacofonix::Audience
+  onix_composite :audience_ranges, Cacofonix::AudienceRange
+  xml_accessor :audience_description, :from => "AudienceDescription"
+  onix_composite :complexities, Cacofonix::Complexity
+
+  # PR.15 Descriptions and supporting texts
+  onix_composite :other_texts, Cacofonix::OtherText
+  # NB: alias included for backwards compatibility
+  alias_accessor :text, :other_texts
+
+  # PR.16 Links to image/audio/video files
+  onix_composite :media_files, Cacofonix::MediaFile
+  onix_composite :product_websites, Cacofonix::Website, :from => "ProductWebsite"
+
+  # PR.17 Prizes
+  onix_composite :prizes, Cacofonix::Prize
+
+  # PR.18 Content items
+  onix_composite :content_items, Cacofonix::ContentItem
+
+  # PR.19 Publisher
+  onix_composite :imprints, Cacofonix::Imprint
+  onix_composite :publishers, Cacofonix::Publisher
+  xml_accessor :cities_of_publication, :from => "CityOfPublication", :as => []
+  onix_code_from_list :country_of_publication, "CountryOfPublication", :list => 91
+
+  # PR.20 Publishing status and dates, and copyright
+  onix_code_from_list :publishing_status, "PublishingStatus", :list => 64
+  xml_accessor :publishing_status_note, :from => "PublishingStatusNote"
+  onix_date_accessor :announcement_date, "AnnouncementDate"
+  onix_date_accessor :trade_announcement_date, "TradeAnnouncementDate"
+  onix_date_accessor :publication_date, "PublicationDate"
+  onix_composite :copyright_statements, Cacofonix::CopyrightStatement
+  xml_accessor :copyright_year, :from => "CopyrightYear", :as => Integer
+  xml_accessor :year_first_published, :from => "YearFirstPublished", :as => Integer
+
+  # PR.21 Territorial rights and other sales restrictions
+  onix_composite :sales_rights, Cacofonix::SalesRights
+  onix_composite :not_for_sales, Cacofonix::NotForSale
+  onix_composite :sales_restrictions, Cacofonix::SalesRestriction
+
+  # PR.22 Dimensions
+  onix_composite :measures, Cacofonix::Measure
+  alias_accessor :measurements, :measures
+  # Some deprecated attributes. Read only
+  # - See the measurements array for the current way of specifying
+  #   various measurements of the product
+  xml_reader :height,     :from => "Height", :as => BigDecimal
+  xml_reader :width,      :from => "Width", :as => BigDecimal
+  xml_reader :thickness,  :from => "Thickness", :as => BigDecimal
+  xml_reader :weight,     :from => "Weight", :as => BigDecimal
+  xml_reader :dimensions, :from => "Dimensions"
+
+  # PR.23 Related products
+  onix_composite :related_products, Cacofonix::RelatedProduct
+  onix_date_accessor :out_of_print_date, "OutOfPrintDate"
+
+  # PR.24 Supplier, availability and prices
+  onix_composite :supply_details, Cacofonix::SupplyDetail
+
+  # PR.25 Market representation
+  onix_composite :market_representations, Cacofonix::MarketRepresentation
+
+  # PR.26 Sales promotion
+  xml_accessor :promotion_campaign, :from => "PromotionCampaign"
+  xml_accessor :promotion_contact_details, :from => "PromotionContactDetails"
+  xml_accessor :initial_print_run, :from => "InitialPrintRun"
+  xml_accessor :reprint_details, :from => "ReprintDetail", :as => []
+  xml_accessor :copies_sold, :from => "CopiesSold"
+  xml_accessor :book_club_adoption, :from => "BookClubAdoption"
+end

data/lib/cacofonix/elements/product_base.rb

@@ -0,0 +1,61 @@
+# coding: utf-8
+
+# This is the abstract base class of Product, RelatedProduct
+# and ContainedItem.
+#
+class Cacofonix::ProductBase < Cacofonix::Element
+  onix_composite :product_identifiers, Cacofonix::ProductIdentifier
+  onix_composite :websites, Cacofonix::Website
+  onix_code_from_list :product_form, "ProductForm", :list => 7
+  onix_codes_from_list :product_form_details, "ProductFormDetail", :list => 78
+  onix_composite :product_form_features, Cacofonix::ProductFormFeature
+  onix_code_from_list :product_packaging, "ProductPackaging", :list => 80
+  xml_accessor :product_form_description, :from => "ProductFormDescription"
+  xml_accessor :number_of_pieces, :from => "NumberOfPieces", :as => Integer
+  onix_code_from_list :trade_category, "TradeCategory", :list => 12
+  onix_code_from_list :product_content_type, "ProductContentType", :list => 81
+  onix_code_from_list :epub_type, "EpubType", :list => 10
+  xml_accessor :epub_type_version, "EpubTypeVersion"
+  xml_accessor :epub_type_description, "EpubTypeDescription"
+  onix_code_from_list :epub_format, "EpubFormat", :list => 11
+  xml_accessor :epub_format_version, "EpubFormatVersion"
+  xml_accessor :epub_format_description, "EpubFormatDescription"
+  xml_accessor :epub_type_note, "EpubTypeNote"
+
+  # Extend this product instance with a module. Typically these modules
+  # make it easier to read or write common values in the Product.
+  #
+  # The product tracks the modules that have extended it, so that it
+  # can easily pass these extensions on to other products
+  # (see #interpret_like_me).
+  #
+  # For convenience, this method returns the product itself.
+  #
+  def interpret(mods)
+    @_extensions ||= []
+    [mods].flatten.compact.uniq.each { |mod|
+      next  if @_extensions.include?(mod)
+      @_extensions << mod
+      extend(mod)
+    }
+    self
+  end
+
+  # Apply all the modules that have extended this product to another product.
+  #
+  # This is useful when, say, accessing RelatedProduct or ContainedItem
+  # composites. Your module might do something like:
+  #
+  #   def print_product
+  #     prod = related_products.detect { |p| p.relation_code == 13 }
+  #     prod ? interpret_like_me(prod) : nil
+  #   end
+  #
+  # As a result, this related product will have all the extensions applied
+  # to this product.
+  #
+  def interpret_like_me(product)
+    product.interpret(@_extensions)
+  end
+
+end

data/lib/cacofonix/elements/product_classification.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+class Cacofonix::ProductClassification < Cacofonix::Element
+  xml_name "ProductClassification"
+  xml_accessor :product_classification_type, "ProductClassificationType"
+  onix_code_from_list :product_classification_code, "ProductClassificationCode", :list => 9
+  xml_accessor :percent, :from => "Percent", :as => Float
+end

data/lib/cacofonix/elements/product_form_feature.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+class Cacofonix::ProductFormFeature < Cacofonix::Element
+  xml_name "ProductFormFeature"
+  onix_code_from_list :product_form_feature_type, "ProductFormFeatureType", :list => 79
+  xml_accessor :product_form_feature_value, :from => "ProductFormFeatureValue"
+  xml_accessor :product_form_feature_description, :from => "ProductFormFeatureDescription"
+end

data/lib/cacofonix/elements/product_identifier.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+
+class Cacofonix::ProductIdentifier < Cacofonix::Identifier
+  xml_name "ProductIdentifier"
+  onix_code_from_list :product_id_type, "ProductIDType", :list => 5
+end

data/lib/cacofonix/elements/professional_affiliation.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+
+class Cacofonix::ProfessionalAffiliation < Cacofonix::Element
+  xml_name "ProfessionalAffiliation"
+  xml_accessor :professional_position, :from => "ProfessionalPosition"
+  xml_accessor :affiliation, :from => "Affiliation"
+end

data/lib/cacofonix/elements/publisher.rb

@@ -0,0 +1,11 @@
+# coding: utf-8
+
+class Cacofonix::Publisher < Cacofonix::Element
+  xml_name "Publisher"
+  onix_code_from_list :publishing_role, "PublishingRole", :list => 45
+  onix_code_from_list :name_code_type, "NameCodeType", :list => 44
+  xml_accessor :name_code_type_name, :from => "NameCodeTypeName"
+  xml_accessor :name_code_type_value, :from => "NameCodeTypeValue"
+  xml_accessor :publisher_name, :from => "PublisherName"
+  onix_composite :websites, Cacofonix::Website
+end

data/lib/cacofonix/elements/reissue.rb

@@ -0,0 +1,9 @@
+# coding: utf-8
+
+class Cacofonix::Reissue < Cacofonix::Element
+  xml_name "Reissue"
+  onix_date_accessor :reissue_date, "ReissueDate"
+  xml_accessor :reissue_description, :from => "ReissueDescription"
+  onix_composite :prices, Cacofonix::Price
+  onix_composite :media_files, Cacofonix::MediaFile
+end

data/lib/cacofonix/elements/related_product.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+
+class Cacofonix::RelatedProduct < Cacofonix::ProductBase
+  xml_name "RelatedProduct"
+  onix_code_from_list :relation_code, "RelationCode", :list => 51
+end

data/lib/cacofonix/elements/religious_text.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+class Cacofonix::ReligiousText < Cacofonix::Element
+  xml_name "ReligiousText"
+  onix_composite :bible, Cacofonix::Bible, :singular => true
+  onix_code_from_list :religious_text_identifier, "ReligiousTextIdentifier", :list => 88
+  onix_composite :religious_text_feature, Cacofonix::ReligiousTextFeature
+end

data/lib/cacofonix/elements/religious_text_feature.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+class Cacofonix::ReligiousTextFeature < Cacofonix::Element
+  xml_name "ReligiousTextFeature"
+  onix_code_from_list :religious_text_feature_type, "ReligiousTextFeatureType", :list => 89
+  onix_code_from_list :religious_text_feature_code, "ReligiousTextFeatureCode", :list => 90
+  xml_accessor :religious_text_feature_description, :from => "ReligiousTextFeatureDescription"
+end

data/lib/cacofonix/elements/sales_outlet.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+
+class Cacofonix::SalesOutlet < Cacofonix::Element
+  xml_name "SalesOutlet"
+  onix_composite :sales_outlet_identifier, Cacofonix::SalesOutletIdentifier
+  xml_accessor :sales_outlet_name, :from => "SalesOutletName"
+end

data/lib/cacofonix/elements/sales_outlet_identifier.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+
+class Cacofonix::SalesOutletIdentifier < Cacofonix::Identifier
+  xml_name "SalesOutletIdentifier"
+  onix_code_from_list :sales_outlet_id_type, "SalesOutletIDType", :list => 102
+end

data/lib/cacofonix/elements/sales_restriction.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+
+class Cacofonix::SalesRestriction < Cacofonix::Element
+  xml_name "SalesRestriction"
+  onix_code_from_list :sales_restriction_type, "SalesRestrictionType", :list => 71
+  onix_composite :sales_outlets, Cacofonix::SalesOutlet
+end

data/lib/cacofonix/elements/sales_rights.rb

@@ -0,0 +1,13 @@
+# coding: utf-8
+
+# See also: NotForSale. It's possible to set not for sale here as well.
+#
+class Cacofonix::SalesRights < Cacofonix::Element
+  xml_name "SalesRights"
+  onix_code_from_list :sales_rights_type, "SalesRightsType", :list => 46
+  onix_spaced_codes_from_list :rights_countries, "RightsCountry", :list => 91
+  onix_spaced_codes_from_list :rights_territories, "RightsTerritory", :list => 49
+
+  # Deprecated accessors
+  onix_codes_from_list :rights_region, "RightsRegion", :list => 47
+end

data/lib/cacofonix/elements/sender_identifier.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+
+class Cacofonix::SenderIdentifier < Cacofonix::Identifier
+  xml_name "SenderIdentifier"
+  onix_code_from_list :sender_id_type, "SenderIDType", :list => 44
+end

data/lib/cacofonix/elements/series.rb

@@ -0,0 +1,11 @@
+# coding: utf-8
+
+class Cacofonix::Series < Cacofonix::Element
+  xml_name "Series"
+  onix_composite :series_identifiers, Cacofonix::SeriesIdentifier
+  xml_accessor :title_of_series, :from => "TitleOfSeries"
+  onix_composite :titles, Cacofonix::Title
+  onix_composite :contributors, Cacofonix::Contributor
+  xml_accessor :number_within_series, :from => "NumberWithinSeries"
+  xml_accessor :year_of_annual, :from => "YearOfAnnual"
+end

data/lib/cacofonix/elements/series_identifier.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+
+class Cacofonix::SeriesIdentifier < Cacofonix::Identifier
+  xml_name "SeriesIdentifier"
+  onix_code_from_list :series_id_type, "SeriesIDType", :list => 13
+end

data/lib/cacofonix/elements/set.rb

@@ -0,0 +1,13 @@
+# coding: utf-8
+
+class Cacofonix::Set < Cacofonix::Element
+  xml_name "Set"
+  onix_composite :product_identifiers, Cacofonix::ProductIdentifier
+  xml_accessor :title_of_set, :from => "TitleOfSet"
+  onix_composite :titles, Cacofonix::Title
+  xml_accessor :set_part_number, :from => "SetPartNumber"
+  xml_accessor :set_part_title, :from => "SetPartTitle"
+  xml_accessor :number_within_set, :from => "ItemNumberWithinSet"
+  xml_accessor :level_sequence_number, :from => "LevelSequenceNumber"
+  xml_accessor :set_item_title, :from => "SetItemTitle"
+end

data/lib/cacofonix/elements/stock.rb

@@ -0,0 +1,16 @@
+# coding: utf-8
+
+class Cacofonix::Stock < Cacofonix::Element
+  xml_name "Stock"
+  onix_composite :location_identifier, Cacofonix::LocationIdentifier, :singular => true
+  xml_accessor :location_name, :from => "LocationName"
+  onix_composite :stock_quantity_coded, Cacofonix::StockQuantityCoded, :singular => true
+
+  # NOTE: these *should* be numeric fields according to the spec,
+  #       but heaps of ONIX files in the wild use text
+  xml_accessor :on_hand, :from => "OnHand"
+  xml_accessor :on_order, :from => "OnOrder"
+
+  xml_accessor :cbo, :from => "CBO"
+  onix_composite :on_order_detail, Cacofonix::OnOrderDetail, :singular => true
+end

data/lib/cacofonix/elements/stock_quantity_coded.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+class Cacofonix::StockQuantityCoded < Cacofonix::Element
+  xml_name "StockQuantityCoded"
+  onix_code_from_list :stock_quantity_code_type, "StockQuantityCodeType", :list => 70
+  xml_accessor :stock_quantity_code_type_name, :from => "StockQuantityCodeTypeName"
+  xml_accessor :stock_quantity_code
+end

data/lib/cacofonix/elements/subject.rb

@@ -0,0 +1,13 @@
+# coding: utf-8
+
+class Cacofonix::Subject < Cacofonix::Element
+  xml_name "Subject"
+  onix_code_from_list :subject_scheme_identifier, "SubjectSchemeIdentifier", :list => 27
+  # Aliased for backwards compat
+  alias_accessor :subject_scheme_id, :subject_scheme_identifier
+
+  xml_accessor :subject_scheme_name, :from => "SubjectSchemeName"
+  xml_accessor :subject_scheme_version, :from => "SubjectSchemeVersion"
+  xml_accessor :subject_code, :from => "SubjectCode"
+  xml_accessor :subject_heading_text, :from => "SubjectHeadingText"
+end

data/lib/cacofonix/elements/supplier_identifier.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+
+class Cacofonix::SupplierIdentifier < Cacofonix::Identifier
+  xml_name "SupplierIdentifier"
+  onix_code_from_list :supplier_id_type, "SupplierIDType", :list => 92
+end