relaton-iso-bib 1.16.1 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f7d51e059f163a137cbd3bf2a21c7ebff8e56c3521126d2641374900b90b203
-  data.tar.gz: 8fb275454cc41ca26aa90198b916298bcd7683b10a5e386cda5add9035a3c9aa
+  metadata.gz: c20b36a2a29b65da5e78b52c28b6f67ad8b219a73f932121d845cf7a1299e1e6
+  data.tar.gz: b3d573c7dea77922baf318b9c291f2572b74118fb677c33fa71e469db5ad46a4
 SHA512:
-  metadata.gz: ac0d7d21d23201f5f2569d20ec0ff645642546c75a7f7faf5dec7aa4beb84af8f207997ca89d1124c62e3fe02db85692aafde76a16cab9546b7e0280532c3438
-  data.tar.gz: fe94a38bb8535645ffe2fc67ebbf5470003cad1374552b3150683e872806d603b76420c51977d5a7aa22a7e764dd93cc2c38d7dd183c6653674dd1423e72d642
+  metadata.gz: d61d22e7b2cb5077541d9b67cc6f1c07c92512788f6ee400fec0789b2af832dd2f069e72d6c1a20d7e3da72f665571e1e776dad3423b82edcaf8db6523e6a6f7
+  data.tar.gz: 8901e4722edb16249d04cf4dc49a1d1a6ec8bef9276854a89bacedd47c1fe0db523260b66d9577bd3ce50354760c2fe09308a28e3e5e151d4b1c06914bfd631b

data/README.adoc

@@ -1,9 +1,7 @@
 = RelatonIsoBib
 
 image:https://img.shields.io/gem/v/relaton-iso-bib.svg["Gem Version", link="https://rubygems.org/gems/relaton-iso-bib"]
-image:https://github.com/relaton/relaton-iso-bib/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/relaton/relaton-iso-bib/actions?workflow=macos"]
-image:https://github.com/relaton/relaton-iso-bib/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/relaton/relaton-iso-bib/actions?workflow=windows"]
-image:https://github.com/relaton/relaton-iso-bib/workflows/ubuntu/badge.svg["Build Status (Ubuntu)", link="https://github.com/relaton/relaton-iso-bib/actions?workflow=ubuntu"]
+image:https://github.com/relaton/relaton-iso-bib/workflows/rake/badge.svg["Build Status (macOS)", link="https://github.com/relaton/relaton-iso-bib/actions?workflow=rake"]
 image:https://codeclimate.com/github/relaton/relaton-iso-bib/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/relaton/relaton-iso-bib"]
 image:https://img.shields.io/github/issues-pr-raw/relaton/relaton-iso-bib.svg["Pull Requests", link="https://github.com/relaton/relaton-iso-bib/pulls"]
 image:https://img.shields.io/github/commits-since/relaton/relaton-iso-bib/latest.svg["Commits since latest",link="https://github.com/relaton/relaton-iso-bib/releases"]
@@ -29,13 +27,24 @@ Or install it yourself as:
 
 == Usage
 
-=== Create ISO bibliographic item
+=== Configuration
+
+Configuration is optional. The available option is `logger` which is a `Logger` instance. By default, the logger is `Logger.new($stderr)` with `Logger::WARN` level. To change the logger level, use `RelatonIsoBib.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_iso_bib'
 => true
 
+RelatonIsoBib.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Create ISO bibliographic item
+
+[source,ruby]
+----
 hash = YAML.load_file "spec/examples/iso_bib_item.yml"
 => {
     "schema-version"=>"v1.0.0",

data/grammars/basicdoc.rng

@@ -346,6 +346,8 @@
           <ref name="keyword"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </oneOrMore>
     </element>
@@ -623,6 +625,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -636,6 +640,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -648,6 +654,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -655,7 +663,11 @@
   <define name="keyword">
     <element name="keyword">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
@@ -676,7 +688,11 @@
   <define name="strike">
     <element name="strike">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>

data/grammars/biblio.rng

@@ -942,6 +942,7 @@
       <value>obsoleted</value>
       <value>confirmed</value>
       <value>updated</value>
+      <value>corrected</value>
       <value>issued</value>
       <value>transmitted</value>
       <value>copied</value>

data/lib/relaton_iso_bib/document_type.rb

@@ -0,0 +1,32 @@
+module RelatonIsoBib
+  class DocumentType < RelatonBib::DocumentType
+    DOCTYPES = %w[
+      international-standard technical-specification technical-report
+      publicly-available-specification international-workshop-agreement guide
+      amendment technical-corrigendum directive
+    ].freeze
+
+    #
+    # Create a new DocumentType object.
+    #
+    # @param [String] type document type
+    # @param [String, nil] abbreviation type abbreviation
+    #
+    def initialize(type:, abbreviation: nil)
+      check_doctype type
+      super
+    end
+
+    #
+    # Check if type is valid.
+    #
+    # @param [String] type document type
+    #
+    def check_doctype(type)
+      unless DOCTYPES.include? type
+        Util.warn "WARNING: invalid doctype: `#{type}`"
+        Util.warn "Allowed doctypes are: `#{DOCTYPES.join('`, `')}`"
+      end
+    end
+  end
+end

data/lib/relaton_iso_bib/hash_converter.rb

@@ -1,52 +1,57 @@
 module RelatonIsoBib
-  class HashConverter < RelatonBib::HashConverter
-    class << self
-      private
-
-      #
-      # Ovverides superclass's method
-      #
-      # @param item [Hash]
-      # @retirn [RelatonIsoBib::IsoBibliographicItem]
-      def bib_item(item)
-        IsoBibliographicItem.new(**item)
-      end
+  module HashConverter
+    include RelatonBib::HashConverter
+    extend self
 
-      #
-      # Ovverides superclass's method
-      #
-      # @param title [Hash]
-      # @return [RelatonBib::TypedTitleString]
-      def typed_title_strig(title)
-        RelatonBib::TypedTitleString.new(**title)
-      end
+    private
 
-      # @param ret [Hash]
-      def editorialgroup_hash_to_bib(ret)
-        eg = ret[:editorialgroup]
-        return unless eg
-
-        ret[:editorialgroup] = EditorialGroup.new(
-          technical_committee: RelatonBib.array(eg[:technical_committee]),
-          subcommittee: RelatonBib.array(eg[:subcommittee]),
-          workgroup: RelatonBib.array(eg[:workgroup]),
-          secretariat: eg[:secretariat],
-        )
-      end
+    #
+    # Ovverides superclass's method
+    #
+    # @param item [Hash]
+    # @retirn [RelatonIsoBib::IsoBibliographicItem]
+    def bib_item(item)
+      IsoBibliographicItem.new(**item)
+    end
 
-      # @param ret [Hash]
-      def ics_hash_to_bib(ret)
-        ret[:ics] = RelatonBib.array(ret[:ics]).map do |ics|
-          Ics.new(ics[:code] || ics)
-        end
-      end
+    #
+    # Ovverides superclass's method
+    #
+    # @param title [Hash]
+    # @return [RelatonBib::TypedTitleString]
+    def typed_title_strig(title)
+      RelatonBib::TypedTitleString.new(**title)
+    end
 
-      # @param ret [Hash]
-      def structuredidentifier_hash_to_bib(ret)
-        return unless ret[:structuredidentifier]
+    # @param ret [Hash]
+    def editorialgroup_hash_to_bib(ret)
+      eg = ret[:editorialgroup]
+      return unless eg
 
-        ret[:structuredidentifier] = RelatonIsoBib::StructuredIdentifier.new(**ret[:structuredidentifier])
+      ret[:editorialgroup] = EditorialGroup.new(
+        technical_committee: RelatonBib.array(eg[:technical_committee]),
+        subcommittee: RelatonBib.array(eg[:subcommittee]),
+        workgroup: RelatonBib.array(eg[:workgroup]),
+        secretariat: eg[:secretariat],
+      )
+    end
+
+    # @param ret [Hash]
+    def ics_hash_to_bib(ret)
+      ret[:ics] = RelatonBib.array(ret[:ics]).map do |ics|
+        Ics.new(ics[:code] || ics)
       end
     end
+
+    # @param ret [Hash]
+    def structuredidentifier_hash_to_bib(ret)
+      return unless ret[:structuredidentifier]
+
+      ret[:structuredidentifier] = RelatonIsoBib::StructuredIdentifier.new(**ret[:structuredidentifier])
+    end
+
+    def create_doctype(**args)
+      DocumentType.new(**args)
+    end
   end
 end

data/lib/relaton_iso_bib/iso_bibliographic_item.rb

@@ -18,22 +18,16 @@ end
 module RelatonIsoBib
   # Bibliographic item.
   class IsoBibliographicItem < RelatonBib::BibliographicItem
-    DOCTYPES = %w[
-      international-standard technical-specification technical-report
-      publicly-available-specification international-workshop-agreement guide
-      amendment technical-corrigendum directive
-    ].freeze
-
     SUBDOCTYPES = %w[specification method-of-test vocabulary code-of-practice].freeze
 
     # @return [RelatonIsoBib::StructuredIdentifier]
     attr_reader :structuredidentifier
 
-    # @!attribute [r] title
-    #   @return [Array<RelatonBib::TypedTitleString>]
+    # @return [String, nil]
+    attr_reader :stagename
 
-    # @return [String, NilClass]
-    attr_reader :doctype, :stagename
+    # @!attribute [r] subdoctype
+    #  @return [RelatonIsoBib::DocumentType]
 
     # @return [Boolean, nil]
     attr_reader :horizontal
@@ -64,18 +58,13 @@ module RelatonIsoBib
     # @param classification [RelatonBib::Classification, NilClass]
     # @param validity [RelatonBib:Validity, NilClass]
     # @param docid [Array<RelatonBib::DocumentIdentifier>]
-    # @param doctype [String, nil]
+    # @param doctype [RelatonIsoBib::DocumentType]
     # @param subdoctype [String, nil]
     # @param horizontal [Boolean, nil]
     # @param structuredidentifier [RelatonIsoBib::StructuredIdentifier]
     # @param stagename [String, NilClass]
     #
-    # @param title [Array<Hash>]
-    # @option title [String] :title_intro
-    # @option title [String] :title_main
-    # @option title [String] :title_part
-    # @option title [String] :language
-    # @option title [String] :script
+    # @param title [Array<Hash, RelatonBib::TypedTitleString>, RelatonBib::TypedTitleStringCollection]
     #
     # @param editorialgroup [Hash, RelatonIsoBib::EditorialGroup]
     # @option workgrpup [String] :name
@@ -128,8 +117,6 @@ module RelatonIsoBib
     #
     # @raise [ArgumentError]
     def initialize(**args)
-      check_doctype args[:doctype]
-
       args[:type] ||= "standard"
       arg_names = %i[
         id title docnumber language script docstatus date abstract contributor
@@ -183,7 +170,7 @@ module RelatonIsoBib
         if block_given? then yield b
         elsif opts[:bibdata] && has_ext_attrs?
           ext = b.ext do
-            b.doctype doctype if doctype
+            doctype.to_xml b if doctype
             b.subdoctype subdoctype if subdoctype
             b.horizontal horizontal unless horizontal.nil?
             editorialgroup&.to_xml b
@@ -224,15 +211,6 @@ module RelatonIsoBib
 
     private
 
-    # @param doctype [String]
-    # @raise ArgumentError
-    def check_doctype(doctype)
-      if doctype && !self.class::DOCTYPES.include?(doctype)
-        Util.warn "WARNING: invalid doctype: #{doctype}"
-        Util.warn "Allowed doctypes are: #{self.class::DOCTYPES.join(', ')}"
-      end
-    end
-
     def makeid(id, attribute, _delim = "") # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/AbcSize
       return nil if attribute && !@id_attribute
 

data/lib/relaton_iso_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonIsoBib
-  VERSION = "1.16.1".freeze
+  VERSION = "1.17.0".freeze
 end

data/lib/relaton_iso_bib.rb

@@ -4,6 +4,7 @@ require "relaton_bib"
 require "relaton_iso_bib/version"
 require "relaton_iso_bib/config"
 require "relaton_iso_bib/util"
+require "relaton_iso_bib/document_type"
 require "relaton_iso_bib/iso_bibliographic_item"
 require "digest/md5"
 

data/relaton_iso_bib.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_dependency "isoics", "~> 0.1.6"
-  spec.add_dependency "relaton-bib", "~> 1.16.0"
+  spec.add_dependency "relaton-bib", "~> 1.17.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iso-bib
 version: !ruby/object:Gem::Version
-  version: 1.16.1
+  version: 1.17.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-20 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: isoics
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.0
 description: 'RelatonIsoBib: Ruby ISOXMLDOC impementation.'
 email:
 - open.source@ribose.com
@@ -64,6 +64,7 @@ files:
 - grammars/relaton-iso.rng
 - lib/relaton_iso_bib.rb
 - lib/relaton_iso_bib/config.rb
+- lib/relaton_iso_bib/document_type.rb
 - lib/relaton_iso_bib/editorial_group.rb
 - lib/relaton_iso_bib/hash_converter.rb
 - lib/relaton_iso_bib/ics.rb