relaton-bib 1.18.5 → 1.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78cb618453b32794d9e5583b0985965b7dbd449655a86350e3e768bae2ce62fc
-  data.tar.gz: c9588e46e7bac0c6af6253d871642a607be7760a25c723f963bb9abb445fbbc8
+  metadata.gz: 20fdd20c795644afb49d384f59a61147d4161e0f10de362996a6537976bf1e2e
+  data.tar.gz: 1d5f51e63402f944d4fad44e1884f8661af541a3cab52b37e46d2713acbf5d57
 SHA512:
-  metadata.gz: 0434d911a3c19805872da208af341c8750d12bbede958d18e24bece3b74b3852ac9623675aa50b01a9d525639578b314e73f00560dc735ed5c375f951e612582
-  data.tar.gz: ec8c14e1e5da20d4c4fed885acb055e5bb28a38c2019bef254fc3381644deb8e1fff85c873e7dbd67a496aff52cc99d575b9bfc7a15437721af8fb0523704947
+  metadata.gz: e069c6c9ee0b670b354f0409993de0ded12e11515bc771b5da1b178345669b48d3328ffd13d14e30ebf5dbe56380500e7f7c1912d75482b438c0348f6b402021
+  data.tar.gz: ba884104669e91900dfaca9ddbfa4ac6449b0bff33c6296f6bcb71947c3455c31e725eee3baeda12974a82e9861c3546ab45556a6c98aedc9f5f2812046ff8eb

data/.github/workflows/rake.yml

@@ -11,3 +11,5 @@ on:
 jobs:
   rake:
     uses: relaton/support/.github/workflows/rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.RELATON_CI_PAT_TOKEN }}

data/README.adoc

@@ -27,24 +27,13 @@ Or install it yourself as:
 
 == Usage
 
-=== 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 `RelatonBib.configure` block.
+=== Create bibliographic item
 
 [source,ruby]
 ----
 require 'relaton_bib'
 => true
 
-RelatonBib.configure do |config|
-  config.logger.level = Logger::DEBUG
-end
-----
-
-=== Create bibliographic item
-
-[source,ruby]
-----
 hash = YAML.load_file "spec/examples/bib_item.yml"
 => {"id"=>"ISOTC211",
 "fetched"=>"2022-05-02",
@@ -304,6 +293,10 @@ item.to_bibxml
     </reference>"
 ----
 
+=== Logging
+
+RelatonBib uses the relaton-logger gem for logging. By default, it logs to STDOUT. To change the log levels and add other loggers, read the https://github.com/relaton/relaton-logger#usage[relaton-logger] documentation.
+
 == Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/grammars/basicdoc.rng

@@ -244,6 +244,9 @@
         <data type="ID"/>
       </attribute>
       <attribute name="reviewer"/>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="date">
           <data type="dateTime"/>

data/grammars/versions.json

@@ -1,9 +1,9 @@
 {
-"relaton-models": "v1.2.8",
-"basicdoc-models": "v1.1.2",
+"relaton-models": "v1.2.9",
+"basicdoc-models": "v1.1.3",
 "metanorma-requirements-models": "v1.0.1",
 "relaton-model-ieee": "v1.0.1",
-"relaton-model-iso": "v1.0.0",
+"relaton-model-iso": "v1.0.3",
 "relaton-model-iec": "v1.0.0",
 "relaton-model-bsi": "v1.0.2",
 "relaton-model-gb": "v1.0.0",
@@ -29,6 +29,6 @@
 "relaton-model-oasis": "v1.0.1",
 "relaton-model-jis": "v0.0.1",
 "relaton-model-etsi": "v0.0.3",
-"metanorma-model": "v1.2.11",
-"date": "2024-01-04T03:55:06Z"
+"metanorma-model": "v1.3.0",
+"date": "2024-02-21T18:15:14Z"
 }

data/lib/relaton_bib/bib_item_locality.rb

@@ -18,7 +18,7 @@ module RelatonBib
         whole|table|annex|figure|note|list|example|volume|issue|time|anchor|
         locality:[a-zA-Z0-9_]+}x
       unless type&.match? type_ptrn
-        Util.warn "WARNING: invalid locality type: `#{type}`"
+        Util.warn "Invalid locality type: `#{type}`"
       end
 
       @type           = type

data/lib/relaton_bib/bibliographic_item.rb

@@ -207,7 +207,7 @@ module RelatonBib
     # @option link [String] :content
     def initialize(**args)
       if args[:type] && !TYPES.include?(args[:type])
-        Util.warn %{WARNING: type `#{args[:type]}` is invalid.}
+        Util.warn %{Type `#{args[:type]}` is invalid.}
       end
 
       @title = if args[:title].is_a?(TypedTitleStringCollection)

data/lib/relaton_bib/config.rb

@@ -10,18 +10,6 @@ module RelatonBib
   end
 
   class Configuration
-    PROGNAME = "relaton-bib".freeze
-
-    attr_accessor :logger
-
-    def initialize
-      @logger = ::Logger.new $stderr
-      @logger.level = ::Logger::WARN
-      @logger.progname = self.class::PROGNAME
-      @logger.formatter = proc do |_severity, _datetime, progname, msg|
-        "[#{progname}] #{msg}\n"
-      end
-    end
   end
 
   extend Config

data/lib/relaton_bib/contribution_info.rb

@@ -22,7 +22,7 @@ module RelatonBib
     # @param description [Array<String>]
     def initialize(**args)
       if args[:type] && !TYPES.include?(args[:type])
-        Util.warn %{WARNING: Contributor's type `#{args[:type]}` is invalid.}
+        Util.warn %{Contributor's type `#{args[:type]}` is invalid.}
       end
 
       @type = args[:type]

data/lib/relaton_bib/contributor.rb

@@ -30,6 +30,12 @@ module RelatonBib
       @formatted_address = args[:formatted_address] unless args[:city] && args[:country]
     end
 
+    def ==(other)
+      street == other.street && city == other.city && state == other.state &&
+        country == other.country && postcode == other.postcode &&
+        formatted_address == other.formatted_address
+    end
+
     # @param doc [Nokogiri::XML::Document]
     def to_xml(doc) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       doc.address do
@@ -100,6 +106,10 @@ module RelatonBib
       @value    = value
     end
 
+    def ==(other)
+      type == other.type && subtype == other.subtype && value == other.value
+    end
+
     # @param builder [Nokogiri::XML::Document]
     def to_xml(builder)
       node = builder.send type, value
@@ -144,6 +154,10 @@ module RelatonBib
       @description  = description
     end
 
+    def ==(other)
+      name == other.name && organization == other.organization && description == other.description
+    end
+
     # @param opts [Hash]
     # @option opts [Nokogiri::XML::Builder] :builder XML builder
     # @option opts [String] :lang language
@@ -224,6 +238,10 @@ module RelatonBib
       @contact = contact
     end
 
+    def ==(other)
+      uri == other.uri && contact == other.contact
+    end
+
     # Returns url.
     # @return [String]
     def url

data/lib/relaton_bib/document_relation.rb

@@ -46,7 +46,7 @@ module RelatonBib
                    source_locality: [])
       type = "obsoletes" if type == "Now withdrawn"
       unless self.class::TYPES.include? type
-        Util.warn "WARNING: invalid relation type: `#{type}`"
+        Util.warn "Invalid relation type: `#{type}`"
       end
       @type = type
       @description = description

data/lib/relaton_bib/forename.rb

@@ -16,6 +16,10 @@ module RelatonBib
       super content, language, script
     end
 
+    def ==(other)
+      super && initial == other.initial
+    end
+
     def to_s
       content.nil? ? initial : super
     end

data/lib/relaton_bib/formatted_string.rb

@@ -25,6 +25,10 @@ module RelatonBib
       super(content, language, script)
     end
 
+    def ==(other)
+      super && format == other.format
+    end
+
     # @param builder [Nokogiri::XML::Builder]
     def to_xml(builder)
       builder.parent["format"] = format if format

data/lib/relaton_bib/full_name.rb

@@ -37,6 +37,11 @@ module RelatonBib
       @completename = args[:completename]
     end
 
+    def ==(other)
+      surname == other.surname && abbreviation == other.abbreviation && completename == other.completename &&
+        forename == other.forename && initials == other.initials && addition == other.addition && prefix == other.prefix
+    end
+
     # @param opts [Hash]
     # @option opts [Nokogiri::XML::Builder] :builder XML builder
     # @option opts [String] :lang language

data/lib/relaton_bib/hash_converter.rb

@@ -358,7 +358,7 @@ module RelatonBib
       if rel[:bibitem]
         rel[:bibitem] = bib_item hash_to_bib(rel[:bibitem])
       else
-        Util.warn "WARNING: bibitem missing: `#{rel}`"
+        Util.warn "Bibitem missing: `#{rel}`"
         rel[:bibitem] = nil
       end
     end

data/lib/relaton_bib/image.rb

@@ -29,6 +29,12 @@ module RelatonBib
       @longdesc = args[:longdesc]
     end
 
+    def ==(other)
+      other.is_a?(Image) && id == other.id && src == other.src && mimetype == other.mimetype &&
+        filename == other.filename && width == other.width && height == other.height &&
+        alt == other.alt && title == other.title && longdesc == other.longdesc
+    end
+
     #
     # Converts the image object to XML format.
     #

data/lib/relaton_bib/localized_string.rb

@@ -37,6 +37,12 @@ module RelatonBib
                  end
     end
 
+    def ==(other)
+      return false unless other.is_a? LocalizedString
+
+      content == other.content && language == other.language && script == other.script
+    end
+
     #
     # String representation.
     #

data/lib/relaton_bib/organization.rb

@@ -25,6 +25,10 @@ module RelatonBib
       @value = value
     end
 
+    def ==(other)
+      type == other.type && value == other.value
+    end
+
     # @param builder [Nokogiri::XML::Builder]
     def to_xml(builder)
       builder.identifier(value, type: type)
@@ -90,6 +94,12 @@ module RelatonBib
       @logo = args[:logo]
     end
 
+    def ==(other)
+      name == other.name && abbreviation == other.abbreviation &&
+        subdivision == other.subdivision && identifier == other.identifier &&
+        logo == other.logo && super
+    end
+
     # @param opts [Hash]
     # @option opts [Nokogiri::XML::Builder] :builder XML builder
     # @option opts [String] :lang language

data/lib/relaton_bib/util.rb

@@ -2,16 +2,15 @@ module RelatonBib
   module Util
     extend self
 
-    def method_missing(...)
-      logger.send(...)
-    end
+    PROGNAME = "relaton-bib".freeze
 
-    def respond_to_missing?(method_name, include_private = false)
-      logger.respond_to?(method_name) || super
+    def method_missing(method_name, msg = nil, prog = nil, **opts, &block)
+      prog ||= self::PROGNAME
+      Relaton.logger_pool.send method_name, msg, prog, **opts, &block
     end
 
-    def logger
-      RelatonBib.configuration.logger
+    def respond_to_missing?(method_name, include_private = false)
+      Relaton.logger_pool.respond_to?(method_name) || super
     end
   end
 end

data/lib/relaton_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonBib
-  VERSION = "1.18.5".freeze
+  VERSION = "1.19.1".freeze
 end

data/lib/relaton_bib/xml_parser.rb

@@ -17,7 +17,7 @@ module RelatonBib
         if bibitem
           bib_item item_data(bibitem)
         else
-          Util.warn "WARNING: can't find bibitem or bibdata element in the XML"
+          Util.warn "Can't find bibitem or bibdata element in the XML"
           nil
         end
       end

data/lib/relaton_bib.rb

@@ -1,9 +1,9 @@
+require "relaton/logger"
 require "forwardable"
 require "yaml"
 require "htmlentities"
 require "relaton_bib/version"
 require "relaton_bib/deep_dup"
-require "relaton_bib/config"
 require "relaton_bib/util"
 require "relaton_bib/localized_string"
 require "relaton_bib/forename"

data/relaton-bib.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "htmlentities"
   spec.add_dependency "iso639"
   spec.add_dependency "nokogiri", "~> 1.16"
+  spec.add_dependency "relaton-logger", "~> 0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 1.18.5
+  version: 1.19.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-22 00:00:00.000000000 Z
+date: 2024-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !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
 description: 'RelatonBib: Ruby XMLDOC impementation.'
 email:
 - open.source@ribose.com