relaton-bib 0.3.3 → 0.3.8

data/lib/relaton_bib.rb

@@ -1,8 +1,40 @@
 require "relaton_bib/version"
-require "relaton_bib/bibliographic_item.rb"
+require "relaton_bib/bibliographic_item"
+require "relaton_bib/hit_collection"
+require "relaton_bib/hit"
 
 module RelatonBib
   class Error < StandardError; end
 
   class RequestError < StandardError; end
+
+  class << self
+    # @param date [String]
+    # @return [Date, NilClass]
+    def parse_date(sdate)
+      if /(?<date>\w+\s\d{4})/ =~ sdate # February 2012
+        Date.strptime(date, "%B %Y")
+      elsif /(?<date>\w+\s\d{1,2},\s\d{4})/ =~ sdate # February 11, 2012
+        Date.strptime(date, "%B %d, %Y")
+      elsif /(?<date>\d{4}-\d{2}-\d{2})/ =~ sdate # 2012-02-11
+        Date.parse(date)
+      elsif /(?<date>\d{4}-\d{2})/ =~ sdate # 2012-02
+        Date.strptime date, "%Y-%m"
+      elsif /(?<date>\d{4})/ =~ sdate # 2012
+        Date.strptime date, "%Y"
+      end
+    end
+  end
+
+  private
+
+  # @param array [Array]
+  # @return [Array<String>, String]
+  def single_element_array(array)
+    if array.size > 1
+      array.map { |e| e.is_a?(String) ? e : e.to_hash }
+    else
+      array[0].is_a?(String) ? array[0] : array[0].to_hash
+    end
+  end
 end

data/lib/relaton_bib/bib_item_locality.rb

@@ -17,18 +17,18 @@ module RelatonBib
 
   # Bibliographic item locality.
   class BibItemLocality
-    # @return [RelatonBib::SpecificLocalityType]
+    # @return [String]
     attr_reader :type
 
-    # @return [RelatonBib::LocalizedString]
+    # @return [String]
     attr_reader :reference_from
 
-    # @return [RelatonBib::LocalizedString]
+    # @return [String, NilClass]
     attr_reader :reference_to
 
     # @param type [String]
     # @param referenceFrom [String]
-    # @param referenceTo [String]
+    # @param referenceTo [String, NilClass]
     def initialize(type, reference_from, reference_to = nil)
       @type           = type
       @reference_from = reference_from
@@ -42,5 +42,12 @@ module RelatonBib
         builder.referenceTo reference_to if reference_to
       end
     end
+
+    # @return [Hash]
+    def to_hash
+      hash = { "type" => type, "reference_from" => reference_from }
+      hash["reference_to"] = reference_to if reference_to
+      hash
+    end
   end
-end
+end

data/lib/relaton_bib/biblio_note.rb

@@ -1,13 +1,13 @@
 module RelatonBib
   class BiblioNote < FormattedString
-    # @return [String]
+    # @return [String, NilClass]
     attr_reader :type
 
     # @param content [String]
-    # @param type [String]
-    # @param language [String] language code Iso639
-    # @param script [String] script code Iso15924
-    # @param format [String] the content type
+    # @param type [String, NilClass]
+    # @param language [String, NilClass] language code Iso639
+    # @param script [String, NilClass] script code Iso15924
+    # @param format [String, NilClass] the content format
     def initialize(content:, type: nil, language: nil, script: nil, format: nil)
       @type = type
       super content: content, language: language, script: script, format: format
@@ -19,5 +19,15 @@ module RelatonBib
       xml[:type] = type if type
       xml
     end
+
+    # @return [Hash]
+    def to_hash
+      hash = super
+      return hash unless type
+
+      hash = { "content" => hash } if hash.is_a? String
+      hash["type"] = type
+      hash
+    end
   end
 end

data/lib/relaton_bib/biblio_version.rb

@@ -2,13 +2,15 @@ module RelatonBib
   # Version
   class BibliographicItem
     class Version
-      # @return [String]
+      include RelatonBib
+
+      # @return [String, NilClass]
       attr_reader :revision_date
 
       # @return [Array<String>]
       attr_reader :draft
 
-      # @param revision_date [String]
+      # @param revision_date [String, NilClass]
       # @param draft [Array<String>]
       def initialize(revision_date = nil, draft = [])
         @revision_date = revision_date
@@ -22,6 +24,14 @@ module RelatonBib
           draft.each { |d| builder.draft d }
         end
       end
+
+      # @return [Hash]
+      def to_hash
+        hash = {}
+        hash["revision_date"] = revision_date if revision_date
+        hash["draft"] = single_element_array(draft) if draft&.any?
+        hash
+      end
     end
   end
 end

data/lib/relaton_bib/bibliographic_date.rb

@@ -6,34 +6,33 @@ module RelatonBib
   # Bibliographic date.
   class BibliographicDate
     TYPES = %w[published accessed created implemented obsoleted confirmed
-               updated issued transmitted copied unchanged circulated
-    ].freeze
+               updated issued transmitted copied unchanged circulated adapted].freeze
 
     # @return [String]
     attr_reader :type
 
-    # @return [Time]
+    # @return [Date]
     attr_reader :from
 
-    # @return [Time]
+    # @return [Date]
     attr_reader :to
 
-    # @return [Time]
+    # @return [Date]
     attr_reader :on
 
     # @param type [String] "published", "accessed", "created", "activated"
+    # @param on [String]
     # @param from [String]
     # @param to [String]
     def initialize(type:, on: nil, from: nil, to: nil)
       raise ArgumentError, "expected :on or :from argument" unless on || from
 
-      TYPES.include?(type) or
-        raise ArgumentError, %{Type "#{type}" is invalid.} unless
+      # raise ArgumentError, "invalid type: #{type}" unless TYPES.include? type
 
       @type = type
-      @on   = parse_date on
-      @from = parse_date from
-      @to   = parse_date to
+      @on   = RelatonBib.parse_date on
+      @from = RelatonBib.parse_date from
+      @to   = RelatonBib.parse_date to
     end
 
     # rubocop:disable Metrics/AbcSize
@@ -52,6 +51,15 @@ module RelatonBib
     end
     # rubocop:enable Metrics/AbcSize
 
+    # @return [Hash]
+    def to_hash
+      hash = { "type" => type }
+      hash["value"] = on.to_s if on
+      hash["from"] = from.to_s if from
+      hash["to"] = to.to_s if to
+      hash
+    end
+
     private
 
     # Formats date
@@ -65,19 +73,5 @@ module RelatonBib
       else date.year
       end
     end
-
-    # @params date [String] 'yyyy', 'yyyy-mm', 'yyyy-mm-dd
-    # @return [Time]
-    def parse_date(date)
-      return unless date
-
-      if date =~ /^\d{4}$/
-        Time.strptime date, "%Y"
-      elsif date =~ /^\d{4}-\d{2}$/
-        Time.strptime date, "%Y-%m"
-      elsif date =~ /\d{4}-\d{2}-\d{2}$/
-        Time.strptime date, "%Y-%m-%d"
-      end
-    end
   end
 end

data/lib/relaton_bib/bibliographic_item.rb

@@ -26,13 +26,14 @@ require "relaton_bib/hash_converter"
 module RelatonBib
   # Bibliographic item
   class BibliographicItem
+    include RelatonBib
+
     TYPES = %W[article book booklet conference manual proceedings presentation
                thesis techreport standard unpublished map electronic\sresource
                audiovisual film video broadcast graphic_work music patent
-               inbook incollection inproceedings journal
-    ].freeze
+               inbook incollection inproceedings journal].freeze
 
-    # @return [String]
+    # @return [String, NilClass]
     attr_reader :id
 
     # @return [Array<RelatonBib::TypedTitleString>]
@@ -41,13 +42,13 @@ module RelatonBib
     # @return [Array<RelatonBib::TypedUri>]
     attr_reader :link
 
-    # @return [String]
+    # @return [String, NilClass]
     attr_reader :type
 
     # @return [Array<RelatonBib::DocumentIdentifier>]
     attr_reader :docidentifier
 
-    # @return [String] docnumber
+    # @return [String, NilClass] docnumber
     attr_reader :docnumber
 
     # @return [Array<RelatonBib::BibliographicDate>]
@@ -59,10 +60,10 @@ module RelatonBib
     # @return [String, NillClass]
     attr_reader :edition
 
-    # @return [RelatonBib::BibliongraphicItem::Version]
+    # @return [RelatonBib::BibliongraphicItem::Version, NilClass]
     attr_reader :version
 
-    # @return [Array<RelatonBib::BiblioNote>, NilClass]
+    # @return [Array<RelatonBib::BiblioNote>]
     attr_reader :biblionote
 
     # @return [Array<String>] language Iso639 code
@@ -71,7 +72,7 @@ module RelatonBib
     # @return [Array<String>] script Iso15924 code
     attr_reader :script
 
-    # @return [RelatonBib::FormattedRef]
+    # @return [RelatonBib::FormattedRef, NilClass]
     attr_reader :formattedref
 
     # @!attribute [r] abstract
@@ -80,7 +81,7 @@ module RelatonBib
     # @return [RelatonBib::DocumentStatus, NilClass]
     attr_reader :status
 
-    # @return [RelatonBib::CopyrightAssociation]
+    # @return [RelatonBib::CopyrightAssociation, NilClass]
     attr_reader :copyright
 
     # @return [RelatonBib::DocRelationCollection]
@@ -134,6 +135,11 @@ module RelatonBib
     # @param validity [RelatonBib:Validity, NilClass]
     # @param fetched [Date, NilClass] default nil
     #
+    # @param copyright [Hash, RelatonBib::CopyrightAssociation, NilClass]
+    # @option copyright [Hash, RelatonBib::ContributionInfo] :owner
+    # @option copyright [String] :form
+    # @option copyright [String, NilClass] :to
+    #
     # @param date [Array<Hash>]
     # @option date [String] :type
     # @option date [String] :from
@@ -163,7 +169,7 @@ module RelatonBib
     # @option link [String] :content
     def initialize(**args)
       if args[:type] && !TYPES.include?(args[:type])
-        raise ArgumentError, %{Type "#{args[:type]}" is invalid.}
+        warn %{Document type "#{args[:type]}" is invalid.}
       end
 
       @title = (args[:title] || []).map do |t|
@@ -204,7 +210,7 @@ module RelatonBib
       @language       = args.fetch :language, []
       @script         = args.fetch :script, []
       @status         = args[:docstatus]
-      @relation      = DocRelationCollection.new(args[:relation] || [])
+      @relation       = DocRelationCollection.new(args[:relation] || [])
       @link           = args.fetch(:link, []).map { |s| s.is_a?(Hash) ? TypedUri.new(s) : s }
       @series         = args.fetch :series, []
       @medium         = args[:medium]
@@ -265,6 +271,38 @@ module RelatonBib
       end
     end
 
+    # @return [Hash]
+    def to_hash
+      hash = {}
+      hash["id"] = id if id
+      hash["title"] = single_element_array(title) if title&.any?
+      hash["link"] = single_element_array(link) if link&.any?
+      hash["type"] = type if type
+      hash["docid"] = single_element_array(docidentifier) if docidentifier&.any?
+      hash["docnumber"] = docnumber if docnumber
+      hash["date"] = single_element_array(date) if date&.any?
+      hash["contributor"] = single_element_array(contributor) if contributor&.any?
+      hash["edition"] = edition if edition
+      hash["version"] = version.to_hash if version
+      hash["biblionote"] = single_element_array(biblionote) if biblionote&.any?
+      hash["language"] = single_element_array(language) if language&.any?
+      hash["script"] = single_element_array(script) if script&.any?
+      hash["formattedref"] = formattedref.to_hash if formattedref
+      hash["abstract"] = single_element_array(abstract) if abstract&.any?
+      hash["docstatus"] = status.to_hash if status
+      hash["copyright"] = copyright.to_hash if copyright
+      hash["relation"] = single_element_array(relation) if relation&.any?
+      hash["series"] = single_element_array(series) if series&.any?
+      hash["medium"] = medium.to_hash if medium
+      hash["place"] = single_element_array(place) if place&.any?
+      hash["extent"] = single_element_array(extent) if extent&.any?
+      hash["accesslocation"] = single_element_array(accesslocation) if accesslocation&.any?
+      hash["classification"] = classification.to_hash if classification
+      hash["validity"] = validity.to_hash if validity
+      hash["fetched"] = fetched.to_s if fetched
+      hash
+    end
+
     private
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength

data/lib/relaton_bib/classification.rb

@@ -18,5 +18,12 @@ module RelatonBib
       xml = builder.classification value
       xml[:type] = type if type
     end
+
+    # @return [Hash]
+    def to_hash
+      hash = { "value" => value }
+      hash["type"] = type if type
+      hash
+    end
   end
 end

data/lib/relaton_bib/contribution_info.rb

@@ -4,17 +4,17 @@ require "relaton_bib/person"
 
 # RelatonBib module
 module RelatonBib
-
   # Contributor's role.
   class ContributorRole
+    include RelatonBib
+
     TYPES = %w[author performer publisher editor adapter translator
-               distributor
-    ].freeze
+               distributor].freeze
 
     # @return [Array<RelatonBib::FormattedString>]
     attr_reader :description
 
-    # @return [ContributorRoleType]
+    # @return [Strig]
     attr_reader :type
 
     # @param type [String] allowed types "author", "editor",
@@ -29,6 +29,7 @@ module RelatonBib
       @description = args.fetch(:description, []).map { |d| FormattedString.new content: d, format: nil }
     end
 
+    # @param builder [Nokogiri::XML::Builder]
     def to_xml(builder)
       builder.role(type: type) do
         description.each do |d|
@@ -36,10 +37,23 @@ module RelatonBib
         end
       end
     end
+
+    # @return [Hash, String]
+    def to_hash
+      if description&.any?
+        hash = { "description" => single_element_array(description) }
+        hash["type"] = type if type
+        hash
+      elsif type
+        type
+      end
+    end
   end
 
   # Contribution info.
   class ContributionInfo
+    include RelatonBib
+
     # @return [Array<RelatonBib::ContributorRole>]
     attr_reader :role
 
@@ -54,8 +68,16 @@ module RelatonBib
       @role   = role.map { |r| ContributorRole.new(**r) }
     end
 
+    # @param builder [Nokogiri::XML::Builder]
     def to_xml(builder)
       entity.to_xml builder
     end
+
+    # @return [Hash]
+    def to_hash
+      hash = entity.to_hash
+      hash["role"] = single_element_array(role) if role&.any?
+      hash
+    end
   end
 end

data/lib/relaton_bib/contributor.rb

@@ -43,6 +43,17 @@ module RelatonBib
         doc.postcode postcode if postcode
       end
     end
+
+    # @return [Hash]
+    def to_hash
+      hash = {}
+      hash["street"] = street if street&.any?
+      hash["city"] = city
+      hash["state"] = state if state
+      hash["country"] = country
+      hash["postcode"] = postcode if postcode
+      hash
+    end
   end
 
   # Contact class.
@@ -63,11 +74,18 @@ module RelatonBib
     def to_xml(doc)
       doc.send type, value
     end
+
+    # @return [Hash]
+    def to_hash
+      { "type" => type, "value" => value }
+    end
   end
 
   # Affilation.
   class Affilation
-    # @return [RelatonBib::LocalizedString]
+    include RelatonBib
+
+    # @return [RelatonBib::LocalizedString, NilClass]
     attr_reader :name
 
     # @return [Array<RelatonBib::FormattedString>]
@@ -77,8 +95,10 @@ module RelatonBib
     attr_reader :organization
 
     # @param organization [RelatonBib::Organization]
+    # @param name [RelatonBib::LocalizedString, NilClass]
     # @param description [Array<RelatonBib::FormattedString>]
-    def initialize(organization, description = [])
+    def initialize(organization:, name: nil, description: [])
+      @name = name
       @organization = organization
       @description  = description
     end
@@ -91,18 +111,28 @@ module RelatonBib
         organization.to_xml builder
       end
     end
+
+    # @return [Hash]
+    def to_hash
+      hash = organization.to_hash
+      hash["name"] = name.to_hash if name
+      hash["description"] = single_element_array(description) if description&.any?
+      hash
+    end
   end
 
   # Contributor.
   class Contributor
+    include RelatonBib
+
     # @return [URI]
     attr_reader :uri
 
-    # @return [Array<RelatonBib::Address, RelatonBib::Phone>]
+    # @return [Array<RelatonBib::Address, RelatonBib::Contact>]
     attr_reader :contact
 
     # @param url [String]
-    # @param contact [Array<RelatonBib::Address, RelatonBib::Phone>]
+    # @param contact [Array<RelatonBib::Address, RelatonBib::Contact>]
     def initialize(url: nil, contact: [])
       @uri = URI url if url
       @contact = contact
@@ -118,5 +148,13 @@ module RelatonBib
     def to_xml(builder)
       contact.each { |contact| contact.to_xml builder }
     end
+
+    # @return [Hash]
+    def to_hash
+      hash = {}
+      hash["url"] = uri.to_s if uri
+      hash["contact"] = single_element_array(contact) if contact&.any?
+      hash
+    end
   end
 end