relaton-bib 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ce6cabec8231c8496286a8b792efc2842abbfceee27f8ee27ed9c7759574416
-  data.tar.gz: efdd0740c622358066675c5e37d278c1b66e43b4cf0420bcd1afafb708140c15
+  metadata.gz: 2d8b311616840c90e25325574979fe74ec6253ef5d23c0873545255ff3dce033
+  data.tar.gz: b144ea5a04e375c1a97ccc06891e0660b790048394a65e272f54ffda8d8c2edb
 SHA512:
-  metadata.gz: bc52f3fb46b5491c7e83a1fd71602e8c9af0123823ea88faacf5d6a5f6f77dfd17bdbbcc5ec19f9ea878697961cbd55d4ab488595da7d659688e8958b50949fd
-  data.tar.gz: 7d3154b81eb5c7cc465b9257cc17c596ac2c71453b371b5f9767194bcbbe1c6c495247cb2a1c389fd40830e6fa7cc57f6fd27425a21b07b447ff99cf3121be88
+  metadata.gz: 81c5c5906f25a7f2289f9393efce6233ba11c7d8a0ffa0dfa1b7b863d69413756a6df679e5e0222fc744b3450bb6610499cbabe89da8b75dbaa00c1d9502080b
+  data.tar.gz: 31a66938522b61ca282a674106023d65c6250d0636f477b1dbed979427092a2f5aa3f6f8863331190b101a0eb56aa8e96dafed023c17a37f3c0459b148b2e413

data/.github/workflows/macos.yml

@@ -1,20 +1,29 @@
-# Auto-generated !!! Do not edit it manually
-# use ci-master https://github.com/metanorma/metanorma-build-scripts
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 name: macos
 
-on: [push]
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ '**' ]
 
 jobs:
   test-macos:
     name: Test on Ruby ${{ matrix.ruby }} macOS
     runs-on: macos-latest
     strategy:
+      fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
     steps:
-      - uses: actions/checkout@v1
-        with:
-          submodules: recursive
+      - uses: actions/checkout@master
+      - name: Checkout submodules
+        shell: bash
+        run: |
+          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
+          git submodule sync --recursive
+          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
       - name: Use Ruby
         uses: actions/setup-ruby@v1
         with:
@@ -22,7 +31,7 @@ jobs:
           architecture: 'x64'
       - name: Update gems
         run: |
-          sudo gem install bundler -v "~> 2" --force
+          sudo gem install bundler --force
           bundle install --jobs 4 --retry 3
       - name: Run specs
         run: |

data/.github/workflows/ubuntu.yml

@@ -1,20 +1,29 @@
-# Auto-generated !!! Do not edit it manually
-# use ci-master https://github.com/metanorma/metanorma-build-scripts
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 name: ubuntu
 
-on: [push]
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ '**' ]
 
 jobs:
   test-linux:
     name: Test on Ruby ${{ matrix.ruby }} Ubuntu
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
     steps:
-      - uses: actions/checkout@v1
-        with:
-          submodules: recursive
+      - uses: actions/checkout@master
+      - name: Checkout submodules
+        shell: bash
+        run: |
+          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
+          git submodule sync --recursive
+          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
       - name: Use Ruby
         uses: actions/setup-ruby@v1
         with:
@@ -22,7 +31,7 @@ jobs:
           architecture: 'x64'
       - name: Update gems
         run: |
-          gem install bundler -v "~> 2"
+          gem install bundler
           bundle install --jobs 4 --retry 3
       - name: Run specs
         run: |

data/.github/workflows/windows.yml

@@ -1,20 +1,29 @@
-# Auto-generated !!! Do not edit it manually
-# use ci-master https://github.com/metanorma/metanorma-build-scripts
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 name: windows
 
-on: [push]
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ '**' ]
 
 jobs:
   test-windows:
     name: Test on Ruby ${{ matrix.ruby }} Windows
     runs-on: windows-latest
     strategy:
+      fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
     steps:
-      - uses: actions/checkout@v1
-        with:
-          submodules: recursive
+      - uses: actions/checkout@master
+      - name: Checkout submodules
+        shell: bash
+        run: |
+          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
+          git submodule sync --recursive
+          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
       - name: Use Ruby
         uses: actions/setup-ruby@v1
         with:
@@ -23,7 +32,7 @@ jobs:
       - name: Update gems
         shell: pwsh
         run: |
-          gem install bundler -v "~> 2"
+          gem install bundler
           bundle config --local path vendor/bundle
           bundle update
           bundle install --jobs 4 --retry 3

data/lib/relaton_bib.rb

@@ -1,4 +1,5 @@
 require "relaton_bib/version"
+require "relaton_bib/deep_dup"
 require "relaton_bib/bibliographic_item"
 require "relaton_bib/hit_collection"
 require "relaton_bib/hit"

data/lib/relaton_bib/bibliographic_item.rb

@@ -102,7 +102,7 @@ module RelatonBib
     attr_reader :extent
 
     # @return [Array<Strig>]
-    attr_reader :accesslocation
+    attr_reader :accesslocation, :license
 
     # @return [Array<Relaton::Classification>]
     attr_reader :classification
@@ -113,6 +113,9 @@ module RelatonBib
     # @return [Date]
     attr_reader :fetched
 
+    # @return [Array<RelatonBib::LocalizedString>]
+    attr_reader :keyword
+
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
@@ -136,6 +139,7 @@ module RelatonBib
     # @param classification [Array<RelatonBib::Classification>]
     # @param validity [RelatonBib:Validity, NilClass]
     # @param fetched [Date, NilClass] default nil
+    # @param keyword [Array<String>]
     #
     # @param copyright [Hash, RelatonBib::CopyrightAssociation, NilClass]
     # @option copyright [Hash, RelatonBib::ContributionInfo] :owner
@@ -171,7 +175,7 @@ module RelatonBib
     # @option link [String] :content
     def initialize(**args)
       if args[:type] && !TYPES.include?(args[:type])
-        warn %{Document type "#{args[:type]}" is invalid.}
+        warn %{[relaton-bib] document type "#{args[:type]}" is invalid.}
       end
 
       @title = (args[:title] || []).map do |t|
@@ -222,6 +226,8 @@ module RelatonBib
       @classification = args.fetch :classification, []
       @validity       = args[:validity]
       @fetched        = args.fetch :fetched, nil # , Date.today # we should pass the fetched arg from scrappers
+      @keyword        = (args[:keyword] || []).map { |kw| LocalizedString.new(kw) }
+      @license        = args.fetch :license, []
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
@@ -303,6 +309,8 @@ module RelatonBib
       hash["classification"] = single_element_array(classification) if classification&.any?
       hash["validity"] = validity.to_hash if validity
       hash["fetched"] = fetched.to_s if fetched
+      hash["keyword"] = single_element_array(keyword) if keyword&.any?
+      hash["license"] = single_element_array(license) if license&.any?
       hash
     end
 
@@ -323,6 +331,7 @@ module RelatonBib
       bibtex_date item
       bibtex_series item
       bibtex_classification item
+      item.keywords = keyword.map(&:content).join(", ") if keyword.any?
       bibtex_docidentifier item
       item.timestamp = fetched.to_s if fetched
       bibtex_link item
@@ -455,7 +464,7 @@ module RelatonBib
       classification.each do |c|
         case c.type
         when "type" then item["type"] = c.value
-        when "keyword" then item.keywords = c.value
+        # when "keyword" then item.keywords = c.value
         when "mendeley" then item["mendeley-tags"] = c.value
         end
       end
@@ -519,7 +528,9 @@ module RelatonBib
         place.each { |pl| pl.to_xml builder }
         extent.each { |e| builder.extent { e.to_xml builder } }
         accesslocation.each { |al| builder.accesslocation al }
+        license.each { |l| builder.license l }
         classification.each { |cls| cls.to_xml builder }
+        keyword.each { |kw| builder.keyword { kw.to_xml(builder) } }
         validity&.to_xml builder
         if block_given?
           yield builder

data/lib/relaton_bib/bibtex_parser.rb

@@ -24,7 +24,8 @@ module RelatonBib
             series: fetch_series(bt),
             link: fetch_link(bt),
             language: fetch_language(bt),
-            classification: fetch_classification(bt)
+            classification: fetch_classification(bt),
+            keyword: fetch_keyword(bt)
           )
           h
         end
@@ -225,12 +226,18 @@ module RelatonBib
       def fetch_classification(bibtex)
         cls = []
         cls << Classification.new(type: "type", value: bibtex["type"].to_s) if bibtex["type"]
-        cls << Classification.new(type: "keyword", value: bibtex.keywords.to_s) if bibtex["keywords"]
+        # cls << Classification.new(type: "keyword", value: bibtex.keywords.to_s) if bibtex["keywords"]
         if bibtex["mendeley-tags"]
-        cls << Classification.new(type: "mendeley", value: bibtex["mendeley-tags"].to_s)
+          cls << Classification.new(type: "mendeley", value: bibtex["mendeley-tags"].to_s)
         end
         cls
       end
+
+      # @param bibtex [BibTeX::Entry]
+      # @return [Array<String>]
+      def fetch_keyword(bibtex)
+        bibtex["keywords"]&.split(", ") || []
+      end
     end
   end
 end

data/lib/relaton_bib/deep_dup.rb

@@ -0,0 +1,30 @@
+class Object
+  def duplicable?
+    true
+  end
+
+  def deep_dup
+    duplicable? ? dup : self
+  end
+end
+
+class Array
+  def deep_dup
+    map(&:deep_dup)
+  end
+end
+
+# class Hash
+#   def deep_dup
+#     hash = dup
+#     each_pair do |key, value|
+#       if key.frozen? && ::String === key
+#         hash[key] = value.deep_dup
+#       else
+#         hash.delete(key)
+#         hash[key.deep_dup] = value.deep_dup
+#       end
+#     end
+#     hash
+#   end
+# end

data/lib/relaton_bib/document_identifier.rb

@@ -41,7 +41,8 @@ module RelatonBib
     # @param [Nokogiri::XML::Builder] builder
     #
     def to_xml(builder)
-      builder.docidentifier(id, type: type)
+      element = builder.docidentifier id
+      element[:type] = type if type
     end
 
     # @return [Hash]

data/lib/relaton_bib/hash_converter.rb

@@ -26,6 +26,8 @@ module RelatonBib
         accesslocation_hash_to_bib(ret)
         classification_hash_to_bib(ret)
         validity_hash_to_bib(ret)
+        ret[:keyword] = array(ret[:keyword])
+        ret[:license] = array(ret[:license])
         ret
       end
 

data/lib/relaton_bib/hit.rb

@@ -1,5 +1,8 @@
 module RelatonBib
   class Hit
+    # @return [RelatonBib::HitCollection]
+    attr_reader :hit_collection
+
     # @return [Array<Hash>]
     attr_reader :hit
 
@@ -24,9 +27,20 @@ module RelatonBib
       "@title=\"#{@hit[:code]}\">"
     end
 
-    # @return [String]
-    def to_xml(**opts)
-      fetch.to_xml **opts
+    def fetch
+      raise "Not implemented"
+    end
+
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder = nil, **opts)
+      if builder
+        fetch.to_xml builder, **opts
+      else
+        builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+          fetch.to_xml xml, **opts
+        end
+        builder.doc.root.to_xml
+      end
     end
   end
 end

data/lib/relaton_bib/hit_collection.rb

@@ -1,5 +1,11 @@
+require "forwardable"
+
 module RelatonBib
-  class HitCollection < Array
+  class HitCollection
+    extend Forwardable
+
+    def_delegators :@array, :<<, :[], :first, :empty?, :any?, :size, :each, :each_slice
+
     # @return [TrueClass, FalseClass]
     attr_reader :fetched
 
@@ -9,6 +15,14 @@ module RelatonBib
     # @return [String]
     attr_reader :year
 
+    # @param text [String] reference to search
+    def initialize(text, year = nil)
+      @array = []
+      @text = text
+      @year = year
+      @fetched = false
+    end
+
     # @return [RelatonIso::HitCollection]
     def fetch
       workers = WorkersPool.new 4
@@ -22,13 +36,38 @@ module RelatonBib
       self
     end
 
+    def to_xml(**opts)
+      builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+        xml.documents do
+          @array.each do |hit|
+            hit.fetch
+            hit.to_xml xml, **opts
+          end
+        end
+      end
+      builder.to_xml
+    end
+
+    def select(&block)
+      me = self.deep_dup
+      array_dup = self.instance_variable_get(:@array).deep_dup
+      me.instance_variable_set(:@array, array_dup)
+      array_dup.select!(&block)
+      me
+    end
+
+    def reduce!(sum, &block)
+      @array = @array.reduce sum, &block
+      self
+    end
+
     def to_s
       inspect
     end
 
     # @return [String]
     def inspect
-      "<#{self.class}:#{format('%#.14x', object_id << 1)} @fetched=#{@fetched}>"
+      "<#{self.class}:#{format('%#.14x', object_id << 1)} @ref=#{@text} @fetched=#{@fetched}>"
     end
   end
 end

data/lib/relaton_bib/localized_string.rb

@@ -39,7 +39,7 @@ module RelatonBib
 
       builder.parent["language"] = language.join(",") if language&.any?
       builder.parent["script"]   = script.join(",") if script&.any?
-      builder.text content
+      builder.text content.encode(xml: :text)
     end
 
     # @return [Hash]

data/lib/relaton_bib/typed_uri.rb

@@ -6,7 +6,7 @@ module RelatonBib
     # @return [Symbol] :src/:obp/:rss
     attr_reader :type
     # @retutn [URI]
-    attr_accessor :content
+    attr_reader :content
 
     # @param type [String] src/obp/rss
     # @param content [String]
@@ -15,6 +15,11 @@ module RelatonBib
       @content = Addressable::URI.parse content if content
     end
 
+    # @parma url [String]
+    def content=(url)
+      @content = Addressable::URI.parse url
+    end
+
     # @param builder [Nokogiri::XML::Builder]
     def to_xml(builder)
       builder.uri(content.to_s, type: type)

data/lib/relaton_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonBib
-  VERSION = "0.5.0".freeze
+  VERSION = "0.8.0".freeze
 end

data/lib/relaton_bib/xml_parser.rb

@@ -42,6 +42,8 @@ module RelatonBib
           extent: fetch_extent(bibitem),
           accesslocation: bibitem.xpath("./accesslocation").map(&:text),
           classification: fetch_classification(bibitem),
+          keyword: bibitem.xpath("keyword").map(&:text),
+          license: bibitem.xpath("license").map(&:text),
           validity: fetch_validity(bibitem),
         }
       end
@@ -168,12 +170,13 @@ module RelatonBib
       end
 
       def fetch_dates(item)
-        item.xpath("./date").map do |d|
+        item.xpath("./date").reduce([]) do |a, d|
           type = d[:type].to_s.empty? ? "published" : d[:type]
-          RelatonBib::BibliographicDate.new(
-            type: type, on: d.at("on")&.text, from: d.at("from")&.text,
-            to: d.at("to")&.text
-          )
+          if (on = d.at("on"))
+            a << RelatonBib::BibliographicDate.new(type: type, on: on.text, to: d.at("to")&.text)
+          elsif (from = d.at("from"))
+            a << RelatonBib::BibliographicDate.new(type: type, from: from.text, to: d.at("to")&.text)
+          end
         end
       end
 

data/relaton-bib.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "RelatonBib: Ruby XMLDOC impementation."
   spec.description   = "RelatonBib: Ruby XMLDOC impementation."
-  spec.homepage      = "https://github.com/relaton/relaton-item"
+  spec.homepage      = "https://github.com/relaton/relaton-bib"
   spec.license       = "BSD-2-Clause"
 
   # Specify which files should be added to the gem when it is released.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-11 00:00:00.000000000 Z
+date: 2020-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debase
@@ -193,7 +193,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.adoc
 - Rakefile
@@ -212,6 +211,7 @@ files:
 - lib/relaton_bib/contribution_info.rb
 - lib/relaton_bib/contributor.rb
 - lib/relaton_bib/copyright_association.rb
+- lib/relaton_bib/deep_dup.rb
 - lib/relaton_bib/document_identifier.rb
 - lib/relaton_bib/document_relation.rb
 - lib/relaton_bib/document_relation_collection.rb
@@ -219,7 +219,6 @@ files:
 - lib/relaton_bib/formatted_ref.rb
 - lib/relaton_bib/formatted_string.rb
 - lib/relaton_bib/hash_converter.rb
-- lib/relaton_bib/hash_to_bib.rb
 - lib/relaton_bib/hit.rb
 - lib/relaton_bib/hit_collection.rb
 - lib/relaton_bib/localized_string.rb
@@ -235,7 +234,7 @@ files:
 - lib/relaton_bib/workers_pool.rb
 - lib/relaton_bib/xml_parser.rb
 - relaton-bib.gemspec
-homepage: https://github.com/relaton/relaton-item
+homepage: https://github.com/relaton/relaton-bib
 licenses:
 - BSD-2-Clause
 metadata: {}

data/lib/relaton_bib/hash_to_bib.rb

@@ -1,70 +0,0 @@
-module RelatonBib
-  class << self
-    def hash_to_bib(args, nested = false)
-      return nil unless args.is_a?(Hash)
-      ret = Marshal.load(Marshal.dump(symbolize(args))) # deep copy
-      timestamp_hash(ret) unless nested
-      title_hash_to_bib(ret)
-      link_hash_to_bib(ret)
-      language_hash_to_bib(ret)
-      script_hash_to_bib(ret)
-      dates_hash_to_bib(ret)
-      docid_hash_to_bib(ret)
-      version_hash_to_bib(ret)
-      biblionote_hash_to_bib(ret)
-      abstract_hash_to_bib(ret)
-      formattedref_hash_to_bib(ret)
-      docstatus_hash_to_bib(ret)
-      contributors_hash_to_bib(ret)
-      relations_hash_to_bib(ret)
-      series_hash_to_bib(ret)
-      medium_hash_to_bib(ret)
-      place_hash_to_bib(ret)
-      extent_hash_to_bib(ret)
-      accesslocation_hash_to_bib(ret)
-      classification_hash_to_bib(ret)
-      validity_hash_to_bib(ret)
-      ret
-    end
-
-    def timestamp_hash(ret)
-      ret[:fetched] ||= Date.today.to_s
-    end
-
-    def symbolize(obj)
-      obj.is_a? Hash and
-        return obj.inject({}){|memo,(k,v)| memo[k.to_sym] =  symbolize(v); memo}
-      obj.is_a? Array and
-        return obj.inject([]){|memo,v    | memo           << symbolize(v); memo}
-      return obj
-    end
-
-    def array(a)
-      return [] unless a
-      return [].push(a) unless a.is_a?(Array)
-      a
-    end
-
-    def localname(f, c)
-      return nil if f.nil?
-      f.is_a?(Hash) and lang = f[:language] 
-      lang ||= c[:name][:language] 
-      f.is_a?(Hash) and script = f[:script] 
-      script ||= c[:name][:script]
-      f.is_a?(Hash) ?
-        RelatonBib::LocalizedString.new(f[:content], lang, script) :
-        RelatonBib::LocalizedString.new(f, lang, script)
-    end
-
-    def localizedstring(f)
-      f.is_a?(Hash) ?
-        RelatonBib::LocalizedString.new(f[:content], f[:language], f[:script]) :
-        RelatonBib::LocalizedString.new(f)
-    end
-
-    def formattedref(f)
-      f.is_a?(Hash) ? RelatonBib::FormattedRef.new(f) :
-        RelatonBib::FormattedRef.new(content: f)
-    end
-  end
-end