relaton-cli 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfce91270bd957a41eb9ef66a7ece0eb1ba02b1f
-  data.tar.gz: e9d98aca4fae3ab0f7c190e3b34c3203ba6f2f9f
+  metadata.gz: '080ef2cfe08edfba51c903c9ce1d11bdf888257f'
+  data.tar.gz: 338339afba81aee2d161fa677708a0cff46abe68
 SHA512:
-  metadata.gz: 9750ec75dc8064f8e003973c577ebe4ed3515f4e1069acb9fd09779a019f2fa68e32282403a00318bf823a799af6e717b45737bf3ba8d8ccf04ec87c6a99b4bd
-  data.tar.gz: e662791c6045d76b62e818790fe98fdf98df4374eddd8861c94c6c4313288970a02aa722388121c2819c428a35f9c65e94d498acf4c2eff6bc927517ad48cbc7
+  metadata.gz: aa6ff088313b823a22ee62c19c0906f718af15f0202ae9785c2b9eaa63d2303c113e0158abe208daa0bb59c68bcd785318bcb253ec2ed9ec28866a08dc915723
+  data.tar.gz: 1b03e8509251c6893c778fb134effc0221bdd0f3c103a5bc06b6064fb9dfd9c8fa0749383657e4a0a088854b6cb89aff7bcc3de14aba542bad2092953efc13da

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    relaton-cli (0.3.5)
+    relaton-cli (0.3.6)
       liquid
       relaton (~> 0.5)
       thor
@@ -38,7 +38,7 @@ GEM
       method_source (~> 0.9.0)
     public_suffix (4.0.1)
     rake (12.3.3)
-    relaton (0.5.4)
+    relaton (0.5.5)
       relaton-gb (~> 0.6.0)
       relaton-iec (~> 0.4.0)
       relaton-ietf (~> 0.6.0)
@@ -46,31 +46,31 @@ GEM
       relaton-itu (~> 0.3.0)
       relaton-nist (~> 0.3.0)
       relaton-ogc (~> 0.1.0)
-    relaton-bib (0.3.6)
+    relaton-bib (0.3.8)
       addressable
       nokogiri
-    relaton-gb (0.6.3)
+    relaton-gb (0.6.4)
       cnccs (~> 0.1.1)
       gb-agencies (~> 0.0.1)
       relaton-iso-bib (~> 0.3.0)
-    relaton-iec (0.4.4)
+    relaton-iec (0.4.6)
       addressable
       relaton-iso-bib (~> 0.3.0)
-    relaton-ietf (0.6.4)
+    relaton-ietf (0.6.5)
       relaton-bib (~> 0.3.0)
-    relaton-iso (0.6.5)
+    relaton-iso (0.6.6)
       relaton-iec (~> 0.4.0)
       relaton-iso-bib (~> 0.3.0)
-    relaton-iso-bib (0.3.5)
+    relaton-iso-bib (0.3.7)
       isoics (~> 0.1.6)
       relaton-bib (~> 0.3.0)
       ruby_deep_clone (~> 0.8.0)
-    relaton-itu (0.3.3)
+    relaton-itu (0.3.4)
       relaton-iso-bib (~> 0.3.0)
-    relaton-nist (0.3.4)
+    relaton-nist (0.3.5)
       relaton-bib (~> 0.3.0)
       rubyzip
-    relaton-ogc (0.1.0)
+    relaton-ogc (0.1.1)
       faraday
       relaton-iso-bib (~> 0.3.0)
     rspec (3.8.0)
@@ -96,7 +96,7 @@ GEM
     ruby-debug-ide (0.7.0)
       rake (>= 0.8.1)
     ruby_deep_clone (0.8.0)
-    rubyzip (1.2.4)
+    rubyzip (2.0.0)
     simplecov (0.17.0)
       docile (~> 1.1)
       json (>= 1.8, < 3)

data/docs/README.adoc

@@ -201,7 +201,269 @@ Convert a Relaton XML file (`filename.xml` or `filename.rxl`) into a Relaton YAM
 
 [source,console]
 ----
-$ relaton yaml2xml Relaton-YAML [<stylesheet>] [<liquid-template-dir>]
+$ relaton yaml2xml <filename.yaml> [<stylesheet>] [<liquid-template-dir>]
 ----
 
-Render a Relaton YAML file as an HTML file. The stylesheet and liquid-template-dir directories are as for <<relaton-xml2html,relaton xml2html>>.
+Render a Relaton YAML file (`filename.yaml`) as an HTML file. The stylesheet and liquid-template-dir directories are as for <<relaton-xml2html,relaton xml2html>>.
+
+=== relaton yaml2xmlnew
+
+[source,console]
+----
+$ relaton yaml2xmlnew <filename.yaml> -o OUTPUT-DIRECTORY -x RELATON_EXTENSION -p PREFIX -r LIBRARY
+----
+
+Convert a Relaton YAML file (`filename.yaml`) in a new format into a Relaton XML file (`filename.xml`). If the Relaton YAML file specifies multiple bibliograph items, and `OUTPUT-DIRECTORY` is nominated, also convert the file into a list of Relaton XML files for each entry, stored in that directory. The document identifier is used as the name of each Relaton XML file; the Relaton XML filename is suffixed with `RELATON_EXTENSION` (default `.rxl`) and prefixed with `PREFIX` (default empty). Any libraries that need to be required for the conversion are specified in `LIBRARY` as a space-delimited list.
+
+A Relaton Colleciton YAML file contains some initial metadata, and a list of metadata about each bibliographic entry:
+
+[source,yaml]
+----
+root:
+  author: The Calendaring and Scheduling Consortium
+  title: CalConnect Standards Registry
+  items:
+    - technical_committee: PUBLISH
+      docid: 
+        type: CC
+        id: CC 36000
+      type: standard
+      title: 
+        type: main
+        content: Standardization documents -- Vocabulary
+      docstatus:
+        stage: proposal
+      date:
+        type: issued
+        value:  2018-10-25
+    - technical_committee: DATETIME
+      docid: 
+        type: CC
+        id: CC 34000
+      type: standard
+      title: 
+        type: main
+        content: Date and time -- Concepts and vocabulary
+      docstatus:
+        stage: proposal
+      date:
+        type: issued
+        value: 2018-10-25
+----
+
+A Relaton YAML file describing an individual bibliographic entry is limited to metadata specific to that entry. Flavor gems have aditional fields. The following illustrates the common fields supported by all flavor gems (see link:https://github.com/relaton/relaton-bib/blob/master/docs/hash.adoc#yaml[Relaton YAML]):
+
+[source,yaml]
+----
+---
+id: ISO/TC211
+title:
+- type: main
+  content: Geographic information
+  language: en
+  script: Latn
+  format: text/plain
+- content: Information géographique
+  language: fr
+  script: Latn
+  format: text/plain
+link:
+- type: src
+  content: https://www.iso.org/standard/53798.html
+- type: obp
+  content: https://www.iso.org/obp/ui/#!iso:std:53798:en
+- type: rss
+  content: https://www.iso.org/contents/data/standard/05/37/53798.detail.rss
+type: standard
+docid:
+  id: TC211
+  type: ISO
+docnumber: '123456'
+date:
+- type: issued
+  value: '2014-01-01'
+- type: published
+  value: '2014-04-01'
+- type: accessed
+  value: '2015-05-20'
+contributor:
+- organization:
+    name: International Organization for Standardization
+    abbreviation: ISO
+    subdivision: division
+    url: www.iso.org
+  role:
+    description: Publisher role
+    type: publisher
+- person:
+    name:
+      completename:
+        content: A. Bierman
+        language: en
+    affiliation:
+      organization:
+        name: IETF
+        abbreviation: IETF
+        identifier:
+          type: uri
+          id: www.ietf.org
+    contact:
+    - street:
+      - Street
+      city: City
+      state: State
+      country: Country
+      postcode: '123456'
+    - type: phone
+      value: '223322'
+  role: author
+- organization:
+    name: IETF
+    abbreviation: IETF
+    identifier:
+      type: uri
+      id: www.ietf.org
+  role: publisher
+- person:
+    name:
+      forename:
+        content: Forename
+        language: en
+      initial:
+        content: A.
+        language: en
+      surname:
+        content: Bierman
+        language: en
+      addition:
+        content: Addition
+        language: en
+      prefix:
+        content: Prefix
+        language: en
+    affiliation:
+      organization:
+        name: IETF
+        abbreviation: IETF
+      description:
+        content: Description
+        language: en
+    identifier:
+      type: uri
+      id: www.person.com
+    contact:
+    - street:
+      - Street
+      city: City
+      state: State
+      country: Country
+      postcode: '123456'
+    - type: phone
+      value: '223322'
+  role: author
+edition: '1'
+version:
+  revision_date: '2019-04-01'
+  draft: draft
+biblionote:
+  content: note
+  type: bibnote
+language:
+- en
+- fr
+script: Latn
+abstract:
+- content: ISO 19115-1:2014 defines the schema required for ...
+  language: en
+  script: Latn
+  format: text/plain
+- content: L'ISO 19115-1:2014 définit le schéma requis pour ...
+  language: fr
+  script: Latn
+  format: text/plain
+docstatus:
+  stage: stage
+  substage: substage
+  iteration: final
+copyright:
+  owner:
+    name: International Organization for Standardization
+    abbreviation: ISO
+    url: www.iso.org
+  from: '2014'
+  to: '2020'
+relation:
+- type: updates
+  bibitem:
+    formattedref:
+      content: ISO 19115:2003
+      format: text/plain
+  bib_locality:
+    type: updates
+    reference_from: Reference form
+- type: updates
+  bibitem:
+    type: standard
+    formattedref:
+      content: ISO 19115:2003/Cor 1:2006
+      format: text/plain
+series:
+- type: main
+  title:
+    type: original
+    content: ISO/IEC FDIS 10118-3
+    language: en
+    script: Latn
+    format: text/plain
+  place: Serie's place
+  organization: Serie's organization
+  abbreviation: ABVR
+  from: '2009-02-01'
+  to: '2010-12-20'
+  number: serie1234
+  partnumber: part5678
+- type: alt
+  formattedref:
+    content: serieref
+    language: en
+    script: Latn
+    format: text/plain
+medium:
+  form: medium form
+  size: medium size
+  scale: medium scale
+place: bib place
+extent:
+  type: section
+  reference_from: Reference from
+  reference_to: Reference to
+accesslocation:
+- accesslocation1
+- accesslocation2
+classification:
+  value: value
+  type: type
+validity:
+  begins: 2010-10-10 12:21
+  ends: 2011-02-03 18:30
+  revision: 2011-03-04 09:00
+fetched: '2019-08-16'
+----
+
+=== relaton xml2yamlnew
+
+[source,console]
+----
+$ relaton xml2yamlnew <filename.xml> -o OUTPUT-DIRECTORY -x RELATON_EXTENSION -p PREFIX -r LIBRARY
+----
+
+Convert a Relaton XML file (`filename.xml` or `filename.rxl`) into a Relaton YAML file (`filename.yaml`) in a new format. If the Relaton XML file is a collection, and `OUTPUT-DIRECTORY` is nominated, also convert the file into a list of Relaton YAML files for each entry, stored in that directory. The document identifier is used as the name of each Relaton XML file; the Relaton XML filename is suffixed with `RELATON_EXTENSION` (default `.yaml`) and prefixed with `PREFIX` (default empty). Any libraries that need to be required for the conversion are specified in `LIBRARY` as a space-delimited list.
+
+=== relaton yaml2htmlnew
+
+[source,console]
+----
+$ relaton yaml2xmlnew <filename.yaml> [<stylesheet>] [<liquid-template-dir>]
+----
+
+Render a Relaton YAML file in a new format (`filename.yaml`) as an HTML file. The `stylesheet` and `liquid-template-dir` directories are as for <<relaton xml2html,relaton xml2html>>.

data/lib/relaton/cli/command.rb

@@ -1,5 +1,6 @@
 require "relaton/cli/relaton_file"
 require "relaton/cli/xml_convertor"
+require "relaton/cli/xml_convertor_new"
 require "relaton/cli/yaml_convertor"
 require "relaton/cli/yaml_convertor_new"
 require "fcntl"
@@ -72,6 +73,17 @@ module Relaton
         Relaton::Cli::XMLConvertor.to_yaml(filename, options)
       end
 
+      desc "xml2yamlnew XML", "Convert Relaton XML into Relaton Bibdata / Bibcollection YAML (and separate files)"
+      option :extension, aliases: :x, desc: "File extension of Relaton YAML files, defaults to 'yaml'"
+      option :prefix, aliases: :p, desc: "Filename prefix of Relaton XML files, defaults to empty"
+      option :outdir, aliases: :o, desc: "Output to the specified directory with individual Relaton Bibdata YAML files"
+      option :require, aliases: :r, type: :array, desc: "Require LIBRARY prior to execution"
+      option :overwrite, aliases: :f, type: :boolean, default: false, desc: "Overwrite the existing file"
+
+      def xml2yamlnew(filename)
+        Relaton::Cli::XMLConvertorNew.to_yaml(filename, options)
+      end
+
       desc "xml2html RELATON-INDEX-XML", "Convert Relaton Collection XML into HTML"
       option :stylesheet, aliases: :s, desc: "Stylesheet file path for rendering HTML index"
       option :templatedir, aliases: :t, desc: "Liquid template directory for rendering Relaton items and collection"

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "0.3.5".freeze
+    VERSION = "0.3.6".freeze
   end
 end

data/lib/relaton/cli/xml_convertor_new.rb

@@ -0,0 +1,76 @@
+require "nokogiri"
+require "relaton/cli/base_convertor"
+
+module Relaton
+  module Cli
+    class XMLConvertorNew < Relaton::Cli::BaseConvertor
+      def to_yaml
+        convert_and_write(file_content, :to_yaml)
+      end
+
+      # Convert to YAML
+      #
+      # This interface allow us to convert any XML file to YAML.
+      # It only require us to provide a valid XML file and it can
+      # do converstion using default attributes, but it also allow
+      # us to provide custom options to customize this converstion
+      # process.
+      #
+      # @param file [File] The complete path to a XML file
+      # @param options [Hash] Options as hash key, value pairs.
+      #
+      def self.to_yaml(file, options = {})
+        new(file, options).to_yaml
+      end
+
+      private
+
+      def default_ext
+        "yaml"
+      end
+
+      # @param content [Nokogiri::XML::Document]
+      # @return [Hash]
+      def convert_content(content)
+        if content.root.name == "bibdata"
+          # Bibdata.from_xml(content.to_s)
+          convert_bibdata content
+        else
+          # Bibcollection.from_xml(content)
+          title = content.at("relaton-collection/title").text
+          author = content.at("relaton-collection/contributor/organization/name").text
+          collection = { "root" => { "title" => title, "author" => author } }
+
+          collection["root"]["items"] = content.xpath("//bibdata").map do |bib|
+            convert_bibdata bib
+          end
+
+          collection
+        end
+      end
+
+      # @param content [Nokogiri::XML::Document]
+      # @return [Hash]
+      def convert_bibdata(doc)
+        if (processor = Relaton::Registry.instance.by_type(doctype(doc)))
+          processor.from_xml(doc.to_s).to_hash
+        else
+          RelatonBib::XMLParser.from_xml(doc.to_s).to_hash
+        end
+      end
+
+      # @param content [Nokogiri::XML::Document]
+      # @return [String]
+      def doctype(doc)
+        docid = doc.at "//docidentifier"
+        return docid[:type] if docid && docid[:type]
+
+        docid.text.match(/^\w+/).to_s
+      end
+
+      def file_content
+        Nokogiri::XML(File.read(file, encoding: "utf-8")).remove_namespaces!
+      end
+    end
+  end
+end

data/lib/relaton/cli/yaml_convertor_new.rb

@@ -47,14 +47,22 @@ module Relaton
       end
 
       def convert_single_file(content)
-        docid = content["docid"].is_a?(Array) ? content["docid"][0] : content["docid"]
-        if (processor = Relaton::Registry.instance.by_type(docid["type"]))
+        if (processor = Relaton::Registry.instance.by_type(doctype(content["docid"])))
           processor.hash_to_bib content
         else
           RelatonBib::BibliographicItem.new(RelatonBib::HashConverter::hash_to_bib(content))
         end
       end
 
+      # @param content [Nokogiri::XML::Document]
+      # @return [String]
+      def doctype(docid)
+        did = docid.is_a?(Array) ? docid.fetch(0) : docid
+        return did["type"] if did && did["type"]
+
+        did&.fetch("id")&.match(/^\w+/)&.to_s
+      end
+
       def convert_collection(content)
         if content.has_key?("root")
           content["root"]["items"] = content["root"]["items"].map do |i|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-cli
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-12 00:00:00.000000000 Z
+date: 2019-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -230,6 +230,7 @@ files:
 - lib/relaton/cli/relaton_file.rb
 - lib/relaton/cli/version.rb
 - lib/relaton/cli/xml_convertor.rb
+- lib/relaton/cli/xml_convertor_new.rb
 - lib/relaton/cli/xml_to_html_renderer.rb
 - lib/relaton/cli/yaml_convertor.rb
 - lib/relaton/cli/yaml_convertor_new.rb