relaton-bib 0.3.4 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee06437cee7f0efbacf8d04554136258ad4544f4
-  data.tar.gz: 3608ad874a15aa0a7c1d2d03270dc02a2a308dfd
+  metadata.gz: c135f7e0e77b7cfa7c31ae9743e0c6bf716a27e0
+  data.tar.gz: 4998ac95553d5ab1e6248b48e7c41e36179c49c3
 SHA512:
-  metadata.gz: 45f05d3a1362dcb45a09c7a04696eb87a48094eaba7314271a519c13c85e83ddbeb85e2c6ccbad8e3f7a064a70c471dc6270684efabce3f2e09374c151fd38ad
-  data.tar.gz: 78315011778a04275ff534780f3138bb3f6e2c2476a6f7e7f1ea3287856664dffa80fe678ed0294494a5bed0d1d331c8c1f700d939ba4a7dad813fd435de3a53
+  metadata.gz: 290f43263f27e6a5f66e091d89bb95e296470311994525359dfd7f8dc63c11e329b404a6a56f8f834666e78f7a6aea6d7b5c05e3b4563f225454cad119ec7f33
+  data.tar.gz: 40f1bb2b469029b5cfa334207bd1d230deb49b4eae361dec3ef221f2efe3714e91e22c1d0706c8f6e43f14343907b9b6d08be6e75959b2c10d483234d182cf11

data/.github/workflows/macos.yml

@@ -0,0 +1,27 @@
+# Auto-generated !!! Do not edit it manually
+# use ci-master https://github.com/metanorma/metanorma-build-scripts
+name: macos
+
+on: [push]
+
+jobs:
+  test-macos:
+    name: Test on Ruby ${{ matrix.ruby }} macOS
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        run: |
+          sudo gem install bundler -v "~> 2" --force
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -0,0 +1,27 @@
+# Auto-generated !!! Do not edit it manually
+# use ci-master https://github.com/metanorma/metanorma-build-scripts
+name: ubuntu
+
+on: [push]
+
+jobs:
+  test-linux:
+    name: Test on Ruby ${{ matrix.ruby }} Ubuntu
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        run: |
+          gem install bundler -v "~> 2"
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.github/workflows/windows.yml

@@ -0,0 +1,30 @@
+# Auto-generated !!! Do not edit it manually
+# use ci-master https://github.com/metanorma/metanorma-build-scripts
+name: windows
+
+on: [push]
+
+jobs:
+  test-windows:
+    name: Test on Ruby ${{ matrix.ruby }} Windows
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        shell: pwsh
+        run: |
+          gem install bundler -v "~> 2"
+          bundle config --local path vendor/bundle
+          bundle update
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    relaton-bib (0.3.4)
+    relaton-bib (0.3.9)
       addressable
-      nokogiri (~> 1.10)
+      nokogiri
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     byebug (11.0.1)
     debase (0.2.3)
       debase-ruby_core_source (>= 0.10.2)
@@ -22,7 +22,7 @@ GEM
     mini_portile2 (2.4.0)
     nokogiri (1.10.3)
       mini_portile2 (~> 2.4.0)
-    public_suffix (3.1.1)
+    public_suffix (4.0.1)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)

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

@@ -45,9 +45,9 @@ module RelatonBib
 
     # @return [Hash]
     def to_hash
-      hash = { type: type, reference_from: reference_from }
-      hash[:reference_to] = reference_to if reference_to
+      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

@@ -23,7 +23,10 @@ module RelatonBib
     # @return [Hash]
     def to_hash
       hash = super
-      hash[:type] = type if type
+      return hash unless type
+
+      hash = { "content" => hash } if hash.is_a? String
+      hash["type"] = type
       hash
     end
   end

data/lib/relaton_bib/biblio_version.rb

@@ -2,6 +2,8 @@ module RelatonBib
   # Version
   class BibliographicItem
     class Version
+      include RelatonBib
+
       # @return [String, NilClass]
       attr_reader :revision_date
 
@@ -18,7 +20,7 @@ module RelatonBib
       # @param builder [Nokogiri::XML::Builder]
       def to_xml(builder)
         builder.version do
-          builder.revision_date revision_date if revision_date
+          builder.send("revision-date", revision_date) if revision_date
           draft.each { |d| builder.draft d }
         end
       end
@@ -26,8 +28,8 @@ module RelatonBib
       # @return [Hash]
       def to_hash
         hash = {}
-        hash[:revision_date] = revision_date if revision_date
-        hash[:draft] = draft if draft&.any?
+        hash["revision_date"] = revision_date if revision_date
+        hash["draft"] = single_element_array(draft) if draft&.any?
         hash
       end
     end

data/lib/relaton_bib/bibliographic_date.rb

@@ -6,8 +6,7 @@ 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
@@ -22,18 +21,18 @@ module RelatonBib
     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
@@ -54,10 +53,10 @@ module RelatonBib
 
     # @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 = { "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
 
@@ -74,19 +73,5 @@ module RelatonBib
       else date.year
       end
     end
-
-    # @params date [String] 'yyyy', 'yyyy-mm', 'yyyy-mm-dd
-    # @return [Date]
-    def parse_date(date)
-      return unless date
-
-      if date =~ /^\d{4}$/
-        Date.strptime date, "%Y"
-      elsif date =~ /^\d{4}-\d{2}$/
-        Date.strptime date, "%Y-%m"
-      elsif date =~ /\d{4}-\d{2}-\d{2}$/
-        Date.strptime date, "%Y-%m-%d"
-      end
-    end
   end
 end

data/lib/relaton_bib/bibliographic_item.rb

@@ -26,11 +26,12 @@ 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, NilClass]
     attr_reader :id
@@ -168,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|
@@ -209,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]
@@ -273,32 +274,32 @@ module RelatonBib
     # @return [Hash]
     def to_hash
       hash = {}
-      hash[:id] = id if id
-      hash[:title] = title.map(&:to_hash) if title&.any?
-      hash[:link] = link.map(&:to_hash) if link&.any?
-      hash[:type] = type if type
-      hash[:docid] = docidentifier.map(&:to_hash) if docidentifier&.any?
-      hash[:docnumber] = docnumber if docnumber
-      hash[:date] = date.map(&:to_hash) if date&.any?
-      hash[:contributor] = contributor.map(&:to_hash) if contributor&.any?
-      hash[:edition] = edition if edition
-      hash[:version] = version.to_hash if version
-      hash[:biblionote] = biblionote.map(&:to_hash) if biblionote&.any?
-      hash[:language] = language if language&.any?
-      hash[:script] = script if script&.any?
-      hash[:formattedref] = formattedref.to_hash if formattedref
-      hash[:abstract] = abstract.map(&:to_hash) if abstract&.any?
-      hash[:docstatus] = status.to_hash if status
-      hash[:copyright] = copyright.to_hash if copyright
-      hash[:relation] = relation.map(&:to_hash) if relation&.any?
-      hash[:series] = series.map(&:to_hash) if series&.any?
-      hash[:medium] = medium.to_hash if medium
-      hash[:place] = place if place&.any?
-      hash[:extent] = extent.map(&:to_hash) if extent&.any?
-      hash[:accesslocation] = 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["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
 

data/lib/relaton_bib/classification.rb

@@ -21,8 +21,8 @@ module RelatonBib
 
     # @return [Hash]
     def to_hash
-      hash = { value: value }
-      hash[:type] = type if type
+      hash = { "value" => value }
+      hash["type"] = type if type
       hash
     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|
@@ -37,18 +38,22 @@ module RelatonBib
       end
     end
 
-    # @return [Array]
+    # @return [Hash, String]
     def to_hash
       if description&.any?
-        [type, description.map(&:content)] if type
-      else
-        type if type
+        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
 
@@ -71,7 +76,7 @@ module RelatonBib
     # @return [Hash]
     def to_hash
       hash = entity.to_hash
-      hash[:role] = role.map(&:to_hash) if role&.any?
+      hash["role"] = single_element_array(role) if role&.any?
       hash
     end
   end