relaton-plateau 1.19.0

data/lib/relaton/plateau/parser.rb

@@ -0,0 +1,69 @@
+module Relaton
+  module Plateau
+    class Parser
+      ATTRIS = %i[docid title abstract cover edition type doctype subdoctype
+                  date link filesize keyword structuredidentifier].freeze
+
+      def initialize(item)
+        @item = item
+      end
+
+      def parse
+        args = ATTRIS.each_with_object({}) do |attr, hash|
+          hash[attr] = send("parse_#{attr}")
+        end
+        BibItem.new(**args)
+      end
+
+      private
+
+      def parse_docid; [] end
+
+      def create_docid(id)
+        RelatonBib::DocumentIdentifier.new(type: "PLATEAU", id: id, primary: true)
+      end
+
+      def create_formatted_string(content, lang = "ja", script = "Jpan")
+        RelatonBib::FormattedString.new(content: content, language: lang, script: script)
+      end
+
+      def parse_title
+        [create_title(@item["title"], "ja", "Jpan")]
+      end
+
+      def create_title(title, lang, script)
+        RelatonBib::TypedTitleString.new(type: "main", content: title, language: lang, script: script)
+      end
+
+      def parse_abstract; [] end
+
+      def parse_cover
+        image_ext = @item["thumbnail"]["mediaItemUrl"].split(".").last
+        mimetype = "image/"
+        mimetype += image_ext == "jpg" ? "jpeg" : image_ext
+        src = "https://www.mlit.go.jp/#{@item["thumbnail"]["mediaItemUrl"]}"
+        image = RelatonBib::Image.new(src: src, mimetype: mimetype)
+        Cover.new(image)
+      end
+
+      def parse_edition; raise "Not implemented" end
+      def parse_type; "standard" end
+      def parse_doctype; nil end
+      def parse_subdoctype; nil end
+      def parse_date; [] end
+      def parse_link; [] end
+
+      def create_date(date, type = "published")
+        RelatonBib::BibliographicDate.new(type: type, on: date)
+      end
+
+      def create_link(url, type)
+        RelatonBib::TypedUri.new(type: type, content: url)
+      end
+
+      def parse_filesize; raise "Not implemented" end
+      def parse_keyword; [] end
+      def parse_structuredidentifier; raise "Not implemented" end
+    end
+  end
+end

data/lib/relaton/plateau/processor.rb

@@ -0,0 +1,69 @@
+require "relaton/processor"
+
+module Relaton
+  module Plateau
+    class Processor < Relaton::Processor
+      attr_reader :idtype
+
+      def initialize # rubocop:disable Lint/MissingSuper
+        @short = :"relaton/plateau"
+        @prefix = "PLATEAU"
+        @defaultprefix = /^PLATEAU\s/
+        @idtype = "PLATEAU"
+        @datasets = %w[plateau-handbooks plateau-technical-reports]
+      end
+
+      # @param code [String]
+      # @param date [String, nil] year
+      # @param opts [Hash]
+      # @return [Relaton::Plateau::BibliographicItem
+      def get(code, date, opts)
+        ::Relaton::Plateau::Bibliography.get(code, date, opts)
+      end
+
+      #
+      # Fetch all the documents from www.mlit.go.jp/plateau
+      #
+      # @param [String] source source name (plateau-handbooks, paleteau-technical-reports)
+      # @param [Hash] opts
+      # @option opts [String] :output directory to output documents
+      # @option opts [String] :format output format (xml, yaml, bibxml)
+      #
+      def fetch_data(source, opts)
+        Fetcher.fetch(source, **opts)
+      end
+
+      # @param xml [String]
+      # @return [Relaton::Plateau::BibItem]
+      def from_xml(xml)
+        ::Relaton::Plateau::XMLParser.from_xml xml
+      end
+
+      # @param hash [Hash]
+      # @return [Relaton:Plateau::BibItem]
+      def hash_to_bib(hash)
+        item_hash = HashConverter.hash_to_bib(hash)
+        ::Relaton::Plateau::BibItem.new(**item_hash)
+      end
+
+      # Returns hash of XML grammar
+      # @return [String]
+      def grammar_hash
+        @grammar_hash ||= ::Relaton::Plateau.grammar_hash
+      end
+
+      # Returns number of workers
+      # @return [Integer]
+      def threads
+        3
+      end
+
+      #
+      # Remove index file
+      #
+      def remove_index_file
+        Relaton::Index.find_or_create(:plateau, url: true, file: "#{Bibliography::INDEXFILE}.yaml").remove_file
+      end
+    end
+  end
+end

data/lib/relaton/plateau/stagename.rb

@@ -0,0 +1,42 @@
+module Relaton
+  module Plateau
+    class Stagename
+      # @return [String]
+      attr_reader :content
+
+      # @return [String, nil]
+      attr_reader :abbreviation
+
+      #
+      # Initialize the Stagename object
+      #
+      # @param [String] content name of the stage
+      # @param [String] abbreviation abbreviation of the stage
+      #
+      def initialize(content:, abbreviation: nil)
+        @content = content
+        @abbreviation = abbreviation
+      end
+
+      def to_xml(builder)
+        builder.stagename do |b|
+          b.parent[:abbreviation] = abbreviation if abbreviation
+          b.text content
+        end
+      end
+
+      def to_hash
+        hash = { content: content }
+        hash[:abbreviation] = abbreviation if abbreviation
+        hash
+      end
+
+      def to_asciibib(prefix = "")
+        pref = prefix.empty? ? "stagename" : "#{prefix}.stagename"
+        output = "#{pref}.content:: #{content}\n"
+        output += "#{pref}.abbreviation:: #{abbreviation}\n" if abbreviation
+        output
+      end
+    end
+  end
+end

data/lib/relaton/plateau/technical_report_parser.rb

@@ -0,0 +1,55 @@
+module Relaton
+  module Plateau
+    class TechnicalReportParser < Parser
+      def initialize(entry)
+        @entry = entry
+        super entry["technicalReport"]
+      end
+
+      private
+
+      def parse_docid
+        super << create_docid("PLATEAU Tech Report ##{@entry["slug"]}")
+      end
+
+      def parse_abstract
+        super << create_formatted_string(@item["subtitle"])
+      end
+
+      def parse_edition
+        RelatonBib::Edition.new content: "1.0", number: "1.0"
+      end
+
+      def parse_doctype
+        DocumentType.new type: "technical-report"
+      end
+
+      def parse_subdoctype
+        @entry["technicalReportCategories"]["nodes"].dig(0, "name")
+      end
+
+      def parse_date
+        super << create_date(@entry["date"])
+      end
+
+      def parse_link
+        super << create_link(@item["pdf"], "pdf")
+      end
+
+      def parse_filesize
+        @item["filesize"].to_i
+      end
+
+      def parse_keyword
+        @entry["globalTags"]["nodes"].map { |tag| tag["name"] }
+      end
+
+      def parse_structuredidentifier
+        strid = RelatonBib::StructuredIdentifier.new(
+          type: "Tech Report", class: parse_subdoctype, agency: ["PLATEAU"], docnumber: @entry["slug"]
+        )
+        RelatonBib::StructuredIdentifierCollection.new [strid]
+      end
+    end
+  end
+end

data/lib/relaton/plateau/util.rb

@@ -0,0 +1,8 @@
+module Relaton
+  module Plateau
+    module Util
+      extend RelatonBib::Util
+      PROGNAME = "relaton-plateau".freeze
+    end
+  end
+end

data/lib/relaton/plateau/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Plateau
+    VERSION = "1.19.0"
+  end
+end

data/lib/relaton/plateau/xml_parser.rb

@@ -0,0 +1,63 @@
+module Relaton
+  module Plateau
+    class XMLParser < RelatonBib::XMLParser
+      class << self
+        private
+
+        #
+        # Parse bibitem data
+        #
+        # @param bibitem [Nokogiri::XML::Element] bibitem element
+        #
+        # @return [Hash] bibitem data
+        #
+        def item_data(doc)
+          resp = super
+          ext = doc.at("./ext")
+          return resp unless ext
+
+          resp[:cover] = fetch_cover ext
+          resp[:filesize] = fetch_filesize ext
+          resp[:stagename] = fetch_stagename ext
+          resp
+        end
+
+        def fetch_cover(ext)
+          img = ext.at("./cover/image")
+          return unless img
+
+          Cover.new fetch_image(img)
+        end
+
+        def fetch_filesize(elm)
+          fs = elm.at("./filesize")
+          return unless fs
+
+          fs.text.to_i
+        end
+
+        def fetch_stagename(ext)
+          sn = ext.at("./stagename")
+          return unless sn
+
+          Stagename.new content: sn.text, abbreviation: sn[:abbreviation]
+        end
+
+        #
+        # override RelatonBib::XMLParser#bib_item method
+        #
+        # @param item_hash [Hash]
+        #
+        # @return [RelatonCcsds::BibliographicItem]
+        #
+        def bib_item(item_hash)
+          BibItem.new(**item_hash)
+        end
+
+        def create_doctype(type)
+          DocumentType.new type: type.text, abbreviation: type[:abbreviation]
+        end
+      end
+    end
+  end
+end

data/lib/relaton/plateau.rb

@@ -0,0 +1,22 @@
+require "net/http"
+require "uri"
+require "relaton/index"
+require "relaton_bib"
+require_relative "plateau/version"
+require_relative "plateau/util"
+require_relative "plateau/document_type"
+require_relative "plateau/bibitem"
+require_relative "plateau/bibliography"
+require_relative "plateau/xml_parser"
+require_relative "plateau/hash_converter"
+require_relative "plateau/fetcher"
+
+module Relaton
+  module Plateau
+    class Error < StandardError; end
+
+    def self.grammar_hash
+      Digest::MD5.hexdigest Relaton::Plateau::VERSION + RelatonBib::VERSION # grammars
+    end
+  end
+end

data/relaton-plateau.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/relaton/plateau/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "relaton-plateau"
+  spec.version = Relaton::Plateau::VERSION
+  spec.authors = ["Ribose Inc."]
+  spec.email = ["open.source@ribose.com"]
+
+  spec.summary = "RelatonPlateau: retrieve Project PLATEAU bibliographic " \
+                 "items"
+  spec.description = "Retrieve Project PLATEAU bibliographic items."
+
+  spec.homepage = "https://github.com/relaton/relaton-plateau"
+  spec.license = "BSD-2-Clause"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  # spec.add_dependency "pubid", "~> 0.1.1"
+  spec.add_dependency "relaton-index", "~> 0.2.12"
+  spec.add_dependency "relaton-logger", "~> 0.2.0"
+  spec.add_dependency "relaton-bib", "~> 1.19.3"
+end

data/sig/relaton/plateau.rbs

@@ -0,0 +1,6 @@
+module Relaton
+  module Plateau
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: relaton-plateau
+version: !ruby/object:Gem::Version
+  version: 1.19.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: relaton-index
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.12
+- !ruby/object:Gem::Dependency
+  name: relaton-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: relaton-bib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.3
+description: Retrieve Project PLATEAU bibliographic items.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rake.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.adoc
+- Rakefile
+- bin/console
+- bin/setup
+- grammar/basicdoc.rng
+- grammar/biblio-standoc.rng
+- grammar/biblio.rng
+- grammar/relaton-plateau-compile.rng
+- grammar/relaton-plateau.rng
+- lib/relaton/plateau.rb
+- lib/relaton/plateau/bibitem.rb
+- lib/relaton/plateau/bibliography.rb
+- lib/relaton/plateau/cover.rb
+- lib/relaton/plateau/document_type.rb
+- lib/relaton/plateau/fetcher.rb
+- lib/relaton/plateau/handbook_parser.rb
+- lib/relaton/plateau/hash_converter.rb
+- lib/relaton/plateau/parser.rb
+- lib/relaton/plateau/processor.rb
+- lib/relaton/plateau/stagename.rb
+- lib/relaton/plateau/technical_report_parser.rb
+- lib/relaton/plateau/util.rb
+- lib/relaton/plateau/version.rb
+- lib/relaton/plateau/xml_parser.rb
+- relaton-plateau.gemspec
+- sig/relaton/plateau.rbs
+homepage: https://github.com/relaton/relaton-plateau
+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: 3.0.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: 'RelatonPlateau: retrieve Project PLATEAU bibliographic items'
+test_files: []