relaton-iso-bib 1.12.1 → 1.14.0

data/lib/relaton_iso_bib/editorial_group.rb

@@ -32,7 +32,7 @@ module RelatonIsoBib
     # @option workgroup [String] :type
     # @option workgroup [Integer] :number
     #
-    # @param secretariat [String, NilClass]
+    # @param secretariat [String, nil]
     def initialize(technical_committee:, **args) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize
       @technical_committee = technical_committee.map do |tc|
         tc.is_a?(Hash) ? RelatonBib::WorkGroup.new(**tc) : tc
@@ -58,7 +58,7 @@ module RelatonIsoBib
 
       builder.editorialgroup do
         technical_committee.each do |tc|
-          builder.send("technical-committee") { tc.to_xml builder }
+          builder.send(:"technical-committee") { tc.to_xml builder }
         end
         subcommittee.each do |sc|
           builder.subcommittee { sc.to_xml builder }

data/lib/relaton_iso_bib/iso_bibliographic_item.rb

@@ -21,7 +21,7 @@ end
 module RelatonIsoBib
   # Bibliographic item.
   class IsoBibliographicItem < RelatonBib::BibliographicItem
-    TYPES = %w[
+    DOCTYPES = %w[
       international-standard technical-specification technical-report
       publicly-available-specification international-workshop-agreement guide
       amendment technical-corrigendum directive
@@ -133,17 +133,16 @@ module RelatonIsoBib
     def initialize(**args)
       check_doctype args[:doctype]
 
+      args[:type] ||= "standard"
       arg_names = %i[
         id title docnumber language script docstatus date abstract contributor
         edition version relation biblionote series medium place copyright link
         fetched docid formattedref extent accesslocation classification validity
-        editorialgroup doctype keyword
+        editorialgroup doctype keyword type
       ]
       super_args = args.select { |k| arg_names.include? k }
       super(**super_args)
 
-      @type = args[:type] || "standard"
-
       if args[:editorialgroup]
         @editorialgroup = if args[:editorialgroup].is_a?(Hash)
                             EditorialGroup.new(**args[:editorialgroup])
@@ -162,16 +161,31 @@ module RelatonIsoBib
       @id_attribute = true
     end
 
-    # @param opts [Hash]
+    #
+    # Fetch the flavour schema version
+    #
+    # @return [String] flavour schema version
+    #
+    def ext_schema
+      @ext_schema ||= schema_versions["relaton-model-iso"]
+    end
+
+    #
+    # Render the document as an XML string.
+    #
+    # @param opts [Hash] options
     # @option opts [Nokogiri::XML::Builder] :builder XML builder
-    # @option opts [Boolean] :bibdata
+    # @option opts [Boolean] :bibdata if true, bibdata element is created
+    # @option opts [Boolean] :embedded if true the document is embedded in another document
     # @option opts [String] :lang language
+    #
     # @return [String] XML
+    #
     def to_xml(**opts)
       super(**opts) do |b|
         if block_given? then yield b
         elsif opts[:bibdata] && has_ext_attrs?
-          b.ext do
+          ext = b.ext do
             b.doctype doctype if doctype
             b.subdoctype subdoctype if subdoctype
             b.horizontal horizontal unless horizontal.nil?
@@ -180,6 +194,7 @@ module RelatonIsoBib
             structuredidentifier&.to_xml b
             b.stagename stagename if stagename
           end
+          ext["schema-version"] = ext_schema unless opts[:embedded]
         end
       end
     end
@@ -187,8 +202,14 @@ module RelatonIsoBib
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
-    # @return [Hash]
-    def to_hash
+    #
+    # Render the document as HASH
+    #
+    # @param embedded [Boolean] true if the bibitem is embedded in another bibitem
+    #
+    # @return [Hash] the document as HAS
+    #
+    def to_hash(embedded: false)
       hash = super
       hash["horizontal"] = horizontal unless horizontal.nil?
       hash["stagename"] = stagename if stagename
@@ -209,9 +230,9 @@ module RelatonIsoBib
     # @param doctype [String]
     # @raise ArgumentError
     def check_doctype(doctype)
-      if doctype && !self.class::TYPES.include?(doctype)
+      if doctype && !self.class::DOCTYPES.include?(doctype)
         warn "[relaton-iso-bib] WARNING: invalid doctype: #{doctype}"
-        warn "[relaton-iso-bib] Allowed doctypes are: #{self.class::TYPES.join(', ')}"
+        warn "[relaton-iso-bib] Allowed doctypes are: #{self.class::DOCTYPES.join(', ')}"
       end
     end
 

data/lib/relaton_iso_bib/structured_identifier.rb

@@ -1,26 +1,26 @@
 module RelatonIsoBib
   # Document structured identifier.
   class StructuredIdentifier
-    # @return [Integer, NilClass]
+    # @return [Integer, nil]
     attr_reader :tc_document_number
 
     # @return [String]
     attr_reader :project_number
 
-    # @return [Integer, NilClass]
+    # @return [Integer, nil]
     attr_reader :part
 
-    # @return [Integer, NilClass]
+    # @return [Integer, nil]
     attr_reader :subpart
 
-    # @return [String, NilClass]
+    # @return [String, nil]
     attr_reader :type
 
-    # @param tc_document_number [Integer, NilClass]
+    # @param tc_document_number [Integer, nil]
     # @param project_number [String]
-    # @param part [String, NilClass]
-    # @param subpart [String, NilClass]
-    # @param type [String, NilClass]
+    # @param part [String, nil]
+    # @param subpart [String, nil]
+    # @param type [String, nil]
     def initialize(**args)
       @tc_document_number = args[:tc_document_number]
       @project_number = args[:project_number]
@@ -50,7 +50,7 @@ module RelatonIsoBib
     end
 
     def all_parts
-      @project_number = @project_number + " (all parts)"
+      @project_number = "#{@project_number} (all parts)"
     end
 
     def id
@@ -58,20 +58,20 @@ module RelatonIsoBib
     end
 
     # @param builder [Nokogiri::XML::Builder]
-    def to_xml(builder)
+    def to_xml(builder) # rubocop:disable Metrics/AbcSize
       xml = builder.structuredidentifier do
-        pn = builder.send "project-number", project_number
+        pn = builder.send :"project-number", project_number
         pn[:part] = part if part
         pn[:subpart] = subpart if subpart
         if tc_document_number
-          builder.send "tc-document-number", tc_document_number
+          builder.send :"tc-document-number", tc_document_number
         end
       end
       xml[:type] = type if type
     end
 
     # @return [Hash]
-    def to_hash
+    def to_hash # rubocop:disable Metrics/AbcSize
       hash = {}
       hash["tc_document_number"] = tc_document_number if tc_document_number
       hash["project_number"] = project_number if project_number
@@ -84,7 +84,7 @@ module RelatonIsoBib
     # @param prefix [String]
     # @return [String]
     def to_asciibib(prefix = "") # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
-      pref = prefix.empty? ? prefix : prefix + "."
+      pref = prefix.empty? ? prefix : "#{prefix}."
       pref += "structured_identifier"
       out = ""
       if tc_document_number

data/lib/relaton_iso_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonIsoBib
-  VERSION = "1.12.1".freeze
+  VERSION = "1.14.0".freeze
 end

data/relaton_iso_bib.gemspec

@@ -36,5 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov"
 
   spec.add_dependency "isoics", "~> 0.1.6"
-  spec.add_dependency "relaton-bib", "~> 1.12.0"
+  spec.add_dependency "relaton-bib", "~> 1.14.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iso-bib
 version: !ruby/object:Gem::Version
-  version: 1.12.1
+  version: 1.14.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-29 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.14.0
 description: 'RelatonIsoBib: Ruby ISOXMLDOC impementation.'
 email:
 - open.source@ribose.com
@@ -130,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/rake.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -141,10 +142,10 @@ files:
 - bin/rspec
 - bin/setup
 - grammars/basicdoc.rng
+- grammars/biblio-standoc.rng
 - grammars/biblio.rng
-- grammars/isodoc.rng
-- grammars/isostandard.rng
-- grammars/reqt.rng
+- grammars/relaton-iso-compile.rng
+- grammars/relaton-iso.rng
 - lib/relaton_iso_bib.rb
 - lib/relaton_iso_bib/editorial_group.rb
 - lib/relaton_iso_bib/hash_converter.rb