relaton-iso-bib 1.7.0 → 1.9.0

data/lib/relaton_iso_bib/ics.rb

@@ -27,6 +27,7 @@ module RelatonIsoBib
     def to_hash
       hash = {}
       hash["code"] = code if code
+      hash["text"] = description if description
       hash
     end
 

data/lib/relaton_iso_bib/iso_bibliographic_item.rb

@@ -24,9 +24,11 @@ module RelatonIsoBib
     TYPES = %w[
       international-standard technical-specification technical-report
       publicly-available-specification international-workshop-agreement guide
-      amendment technical-corrigendum
+      amendment technical-corrigendum directive
     ].freeze
 
+    SUBDOCTYPES = %w[specification method-of-test vocabulary code-of-practice].freeze
+
     # @return [RelatonIsoBib::StructuredIdentifier]
     attr_reader :structuredidentifier
 
@@ -36,6 +38,9 @@ module RelatonIsoBib
     # @return [String, NilClass]
     attr_reader :doctype, :stagename
 
+    # @return [Boolean, nil]
+    attr_reader :horizontal
+
     # @return [RelatonIsoBib::EditorialGroup]
     attr_reader :editorialgroup
 
@@ -62,6 +67,9 @@ module RelatonIsoBib
     # @param classification [RelatonBib::Classification, NilClass]
     # @param validity [RelatonBib:Validity, NilClass]
     # @param docid [Array<RelatonBib::DocumentIdentifier>]
+    # @param doctype [String, nil]
+    # @param subdoctype [String, nil]
+    # @param horizontal [Boolean, nil]
     # @param structuredidentifier [RelatonIsoBib::StructuredIdentifier]
     # @param stagename [String, NilClass]
     #
@@ -125,26 +133,31 @@ module RelatonIsoBib
     def initialize(**args)
       check_doctype args[:doctype]
 
-      super_args = args.select do |k|
-        %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 doctype keyword].include? k
-      end
-      super super_args
+      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
+      ]
+      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])
+                            EditorialGroup.new(**args[:editorialgroup])
                           else args[:editorialgroup]
                           end
       end
 
+      if args[:subdoctype] && !SUBDOCTYPES.include?(args[:subdoctype])
+        warn "Invald subdoctype '#{args[:subdoctype]}'. Allowed values are: #{SUBDOCTYPES.join(', ')}"
+      end
+      @subdoctype = args[:subdoctype]
       @structuredidentifier = args[:structuredidentifier]
-      # @doctype = args[:doctype] || "international-standard"
-      @ics = args.fetch(:ics, []).map { |i| i.is_a?(Hash) ? Ics.new(i) : i }
+      @horizontal = args[:horizontal]
+      @ics = args.fetch(:ics, []).map { |i| i.is_a?(Hash) ? Ics.new(**i) : i }
       @stagename = args[:stagename]
       @id_attribute = true
     end
@@ -155,23 +168,17 @@ module RelatonIsoBib
     # @option opts [String] :lang language
     # @return [String] XML
     def to_xml(**opts)
-      super **opts do |b|
-        if opts[:bibdata] && (doctype || respond_to?(:committee) && committee ||
-          editorialgroup || ics.any? || structuredidentifier || stagename ||
-          block_given?)
+      super(**opts) do |b|
+        if block_given? then yield b
+        elsif opts[:bibdata] && has_ext_attrs?
           b.ext do
             b.doctype doctype if doctype
-            b.docsubtype docsubtype if respond_to?(:docsubtype) && docsubtype
-            # GB renders gbcommittee elements istead of an editorialgroup
-            if respond_to? :committee
-              committee&.to_xml b
-            else
-              editorialgroup&.to_xml b
-            end
+            b.subdoctype subdoctype if subdoctype
+            b.horizontal horizontal unless horizontal.nil?
+            editorialgroup&.to_xml b
             ics.each { |i| i.to_xml b }
             structuredidentifier&.to_xml b
             b.stagename stagename if stagename
-            yield b if block_given?
           end
         end
       end
@@ -183,6 +190,7 @@ module RelatonIsoBib
     # @return [Hash]
     def to_hash
       hash = super
+      hash["horizontal"] = horizontal unless horizontal.nil?
       hash["stagename"] = stagename if stagename
       hash
     end
@@ -190,7 +198,7 @@ module RelatonIsoBib
     # @param prefix [String]
     # @return [String]
     def to_asciibib(prefix = "")
-      pref = prefix.empty? ? prefix : prefix + "."
+      pref = prefix.empty? ? prefix : "#{prefix}."
       out = super
       out += "#{pref}stagename:: #{stagename}\n" if stagename
       out
@@ -202,7 +210,8 @@ module RelatonIsoBib
     # @raise ArgumentError
     def check_doctype(doctype)
       if doctype && !self.class::TYPES.include?(doctype)
-        warn "[relaton-iso-bib] invalid doctype: #{doctype}"
+        warn "[relaton-iso-bib] WARNING: invalid doctype: #{doctype}"
+        warn "[relaton-iso-bib] Allowed doctypes are: #{self.class::TYPES.join(', ')}"
       end
     end
 
@@ -218,5 +227,13 @@ module RelatonIsoBib
       end
       idstr&.gsub(/:/, "-")&.gsub(/\s/, "")&.strip
     end
+
+    #
+    # @return [Boolean]
+    #
+    def has_ext_attrs? # rubocop:disable Metrics/CyclomaticComplexity
+      (doctype || !horizontal.nil? || editorialgroup || ics.any? ||
+        structuredidentifier || stagename || horizontal)
+    end
   end
 end

data/lib/relaton_iso_bib/structured_identifier.rb

@@ -31,8 +31,8 @@ module RelatonIsoBib
 
     # in docid manipulations, assume ISO as the default: id-part:year
     def remove_part
-      @part_number = nil
-      @subpart_number = nil
+      @part = nil
+      @subpart = nil
       @project_number = case @type
                         when "Chinese Standard"
                           @project_number.sub(/\.\d+/, "")

data/lib/relaton_iso_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonIsoBib
-  VERSION = "1.7.0".freeze
+  VERSION = "1.9.0".freeze
 end

data/lib/relaton_iso_bib/xml_parser.rb

@@ -13,9 +13,8 @@ module RelatonIsoBib
         ext = isoitem.at "./ext"
         return data unless ext
 
-        data[:doctype] = ext.at("./doctype")&.text
-        data[:editorialgroup] = fetch_editorialgroup ext
-        data[:structuredidentifier] = fetch_structuredidentifier ext
+        hrzt = ext.at("./horizontal")
+        data[:horizontal] = hrzt.text == "true" if hrzt
         data[:stagename] = ext.at("./stagename")&.text
         data
       end
@@ -24,7 +23,7 @@ module RelatonIsoBib
       # @param item_hash [Hash]
       # @return [RelatonIsoBib::IsoBibliographicItem]
       def bib_item(item_hash)
-        IsoBibliographicItem.new item_hash
+        IsoBibliographicItem.new(**item_hash)
       end
 
       # @param ext [Nokogiri::XML::Element]
@@ -61,8 +60,8 @@ module RelatonIsoBib
       def iso_subgroup(com)
         return nil if com.nil?
 
-        IsoSubgroup.new(name: com.text, type: com[:type],
-                        number: com[:number]&.to_i)
+        RelatonBib::WorkGroup.new(name: com.text, type: com[:type],
+                                  number: com[:number]&.to_i)
       end
     end
   end

data/lib/relaton_iso_bib.rb

@@ -10,7 +10,7 @@ module RelatonIsoBib
   def self.grammar_hash
     gem_path = File.expand_path "..", __dir__
     grammars_path = File.join gem_path, "grammars", "*"
-    grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
+    grammars = Dir[grammars_path].sort.map { |gp| File.read gp, encoding: "UTF-8" }.join
     Digest::MD5.hexdigest grammars
   end
 end

data/relaton_iso_bib.gemspec

@@ -24,17 +24,17 @@ Gem::Specification.new do |spec|
   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(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
-  spec.add_development_dependency "debase"
+  # spec.add_development_dependency "debase"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "ruby-debug-ide"
+  # spec.add_development_dependency "ruby-debug-ide"
   spec.add_development_dependency "ruby-jing"
   spec.add_development_dependency "simplecov"
 
   spec.add_dependency "isoics", "~> 0.1.6"
-  spec.add_dependency "relaton-bib", "~> 1.7.0"
+  spec.add_dependency "relaton-bib", "~> 1.9.0"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iso-bib
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-27 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: debase
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: ruby-debug-ide
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-jing
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.9.0
 description: 'RelatonIsoBib: Ruby ISOXMLDOC impementation.'
 email:
 - open.source@ribose.com
@@ -157,9 +129,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/macos.yml"
-- ".github/workflows/ubuntu.yml"
-- ".github/workflows/windows.yml"
+- ".github/workflows/rake.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -168,6 +138,7 @@ files:
 - README.adoc
 - Rakefile
 - bin/console
+- bin/rspec
 - bin/setup
 - grammars/basicdoc.rng
 - grammars/biblio.rng
@@ -196,14 +167,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: 'RelatonIsoBib: Ruby ISOXMLDOC impementation.'

data/.github/workflows/macos.yml

@@ -1,34 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-name: macos
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ '**' ]
-
-jobs:
-  test-macos:
-    name: Test on Ruby ${{ matrix.ruby }} macOS
-    runs-on: macos-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
-    steps:
-      - uses: actions/checkout@master
-      - name: Use Ruby
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
-      - name: Update gems
-        run: |
-          sudo gem install bundler --force
-          ruby -v | grep 2.5 && bundle config set build.debase --with-cflags="-Wno-error=implicit-function-declaration"
-          ruby -v | grep 2.5 && bundle config set build.ruby-debug-ide --with-cflags="-Wno-error=implicit-function-declaration"
-          bundle install --jobs 4 --retry 3
-      - name: Run specs
-        run: |
-          bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -1,33 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-name: ubuntu
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ '**' ]
-
-jobs:
-  test-linux:
-    name: Test on Ruby ${{ matrix.ruby }} Ubuntu
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
-    steps:
-      - uses: actions/checkout@master
-      - name: Use Ruby
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
-      - name: Update gems
-        run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
-      - name: Run specs
-        run: |
-          unset JAVA_TOOL_OPTIONS
-          bundle exec rake

data/.github/workflows/windows.yml

@@ -1,35 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-name: windows
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ '**' ]
-
-jobs:
-  test-windows:
-    name: Test on Ruby ${{ matrix.ruby }} Windows
-    runs-on: windows-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
-    steps:
-      - uses: actions/checkout@master
-      - name: Use Ruby
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
-      - name: Update gems
-        shell: pwsh
-        run: |
-          gem install bundler
-          bundle config --local path vendor/bundle
-          bundle update
-          bundle install --jobs 4 --retry 3
-      - name: Run specs
-        run: |
-          bundle exec rake