relaton-core 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e57b8db4577d599195b3948fdc1a5bf213d3e97e17c1b5d38dfa942e00130c18
+  data.tar.gz: d34080a4e6dd2e717ce35c80dc869c2630ffcf7d93a1358e05e4fcab4f878659
+SHA512:
+  metadata.gz: 0cb84f4a86ab0a3ff56c7c8639b5ff677a76bc189043a61c5bbd104a0950ec4f195a3e4fe952a47b72e0430066ffd3940042823250e47acc611c7a33799d1520
+  data.tar.gz: 1f8118680baa7149459c6e6d4a800cee274e594e1b28cbbac35677be12c2b655d4666065b150719f10348bf72b31ff7c629057078f71798a55198d2e97b2c96d

data/LICENSE.txt

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, Ribose
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,46 @@
+= Library for importing and caching bibliographic references to technical standards library
+
+== Usage
+
+=== Exclude attributes when compare
+
+[source,ruby]
+----
+require "relaton-core"
+
+pubid_first = Identifier.parse("ISO 1:1999")
+pubid_second = Identifier.parse("ISO 1")
+
+pubid_first == pubid_second
+=> false
+
+pubid_first.exclude(:year) == pubid_second
+=> true
+----
+
+=== Using #to_h to convert identifier to hash
+
+[source,ruby]
+----
+require "pubid-core"
+
+pubid = Identifier.parse("ISO 1:1999")
+pubid.to_h
+=> { publisher: "ISO", number: 1, year: 1999 }
+----
+
+=== Using #new_edition_of? to compare identifiers
+
+[source,ruby]
+----
+require "pubid-core"
+
+pubid_first = Identifier.parse("ISO 1:1999")
+pubid_second = Identifier.parse("ISO 1:2000")
+
+pubid_first.new_edition_of?(pubid_second)
+=> false
+pubid_second.new_edition_of?(pubid_first)
+=> true
+
+----

data/lib/relaton/core/data_fetcher.rb

@@ -0,0 +1,104 @@
+module Relaton::Core
+  class DataFetcher
+    attr_accessor :docs
+    #
+    # Initialize fetcher
+    #
+    # @param [String] output path to output directory
+    # @param [String] format output format (yaml, xml, bibxml)
+    #
+    def initialize(output, format)
+      @output = output
+      @format = format
+      @ext = format.sub "bibxml", "xml"
+      @files = []
+      @docs = []
+    end
+
+    def index
+      @index ||= Relaton::Index.find_or_create self.class::INDEX_TYPE,
+                                               file: self.class::INDEX_FILE,
+                                               pubid_class: self.class.get_identifier_class
+    end
+
+    # API method for external service
+    def self.fetch(output: "data", format: "yaml")
+      t1 = Time.now
+      puts "Started at: #{t1}"
+      FileUtils.mkdir_p output
+      new(output, format).fetch
+      t2 = Time.now
+      puts "Stopped at: #{t2}"
+      puts "Done in: #{(t2 - t1).round} sec."
+    end
+
+    def self.get_identifier_class
+      raise NotImplementedError, "#{self.class}#get_identifier_class method must be implemented"
+    end
+
+    def fetch
+      fetch_docs ACTIVE_PUBS_URL
+      fetch_docs OBSOLETE_PUBS_URL, retired: true
+      index.save
+    end
+
+    # Parse hash and return RelatonBib
+    # @param [Hash] doc document data
+    # @return [RelatonBib]
+    def parse(doc)
+      raise NotImplementedError, "#{self.class}#parse method must be implemented"
+    end
+
+    # @param [RelatonBib::BibliographicItem] bib
+    # @return [String] filename based on PubID identifier
+    def get_output_file(bib)
+      File.join @output, "#{bib.docidentifier.first.id.gsub(/[.\s-]+/, '-')}.#{@ext}"
+    end
+
+    #
+    # Parse document and save to file
+    #
+    # @param [Hash] doc document data
+    # @param [Boolean] retired if true then document is retired
+    #
+    # @return [void]
+    #
+    def parse_and_save(doc)
+      bibitem = parse(doc)
+      save_bib(bibitem)
+      index_add_or_update(bibitem)
+    end
+
+    #
+    # Save bibitem to file
+    #
+    # @param [RelatonBib::BibliographicItem] bib bibitem
+    #
+    # @return [void]
+    #
+    def save_bib(bib)
+      file = get_output_file(bib)
+      File.write file, serialize(bib), encoding: "UTF-8"
+    end
+
+    def index_add_or_update(bib)
+      index.add_or_update self.class.get_identifier_class.parse(bib.docidentifier.first.id),
+                          get_output_file(bib)
+    end
+
+    #
+    # Serialize bibliographic item
+    #
+    # @param [RelatonCcsds::BibliographicItem] bib <description>
+    #
+    # @return [String] serialized bibliographic item
+    #
+    def serialize(bib)
+      case @format
+      when "yaml" then bib.to_hash.to_yaml
+      when "xml" then bib.to_xml(bibdata: true)
+      else bib.send "to_#{@format}"
+      end
+    end
+  end
+end

data/lib/relaton/core/version.rb

@@ -0,0 +1,5 @@
+module Relaton
+  module Core
+    VERSION = "0.0.2".freeze
+  end
+end

data/lib/relaton/core.rb

@@ -0,0 +1,3 @@
+require "relaton_bib"
+require "relaton/index"
+require_relative "core/data_fetcher"

data/lib/relaton-core.rb

@@ -0,0 +1 @@
+require_relative "relaton/core"

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: relaton-core
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: relaton-bib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+- !ruby/object:Gem::Dependency
+  name: relaton-index
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.16
+- !ruby/object:Gem::Dependency
+  name: pubid-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.10
+description: Library for importing and caching bibliographic references to technical
+  standards
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.adoc
+- lib/relaton-core.rb
+- lib/relaton/core.rb
+- lib/relaton/core/data_fetcher.rb
+- lib/relaton/core/version.rb
+homepage: https://github.com/relaton/relaton-core
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: Library for importing and caching bibliographic references to technical standards
+test_files: []