relaton-bib 1.18.4 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8679abcdf3cc3df08c557a56be973ef54472d530eaa64369cad097d35a1a4066
-  data.tar.gz: b75301c9af89e12b094d15353553ca25c6c4c455e83ee49b07f60f53852d1711
+  metadata.gz: '078eeaee528f7e51a51015dc49723903af554087be753a244d69ebb2d1c0ac83'
+  data.tar.gz: 1ab74dea087ac8a1a4366ed24630ca4869774cc8b8f938e275a3684e0a61ec69
 SHA512:
-  metadata.gz: e9e3974f8afa4b5532fb792a9792e13679c9fa3bf45320f3339ad990c0a17325ca3f52696b24e27b0e06172af6bbe63cf53171d80572173c71f78899e39cde67
-  data.tar.gz: 0befd12bbb263ead171ca64f1a0b698175801eb19a7ef29cd308a454d52fc06a4601e4b5255c933d0c1823c218ac4cefdd474a9ccad83807658f119f64c67754
+  metadata.gz: 62b65c967d716d9680b6e1ec1a361a3f1f2a0d48f032e793585b3630f1146a49897b2d2563c40e165bc04ceb437aeb7da70f7581945fb3f08a23563c79438e58
+  data.tar.gz: 34f6adc6c2998fe912879615f71079963331d83eb12cbb7d7bcff9c8ce4276da73b252aa8240cc105314a2f0aff786f401c99579a50a7df0255ac87673544059

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/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/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/person.rb

@@ -53,7 +53,7 @@ module RelatonBib
     # @param count [Integer] number of ids
     # @return [String]
     def to_asciibib(prefix = "", count = 1)
-      pref = prefix.empty? ? prefix : prefix + "."
+      pref = prefix.empty? ? prefix : "#{prefix}."
       out = count > 1 ? "#{prefix}::\n" : ""
       out += "#{pref}type:: #{type}\n"
       out += "#{pref}value:: #{value}\n"

data/lib/relaton_bib/place.rb

@@ -1,5 +1,6 @@
 module RelatonBib
   class Place
+
     # @return [String, nil]
     attr_reader :name, :city
 
@@ -76,24 +77,85 @@ module RelatonBib
     end
 
     class RegionType
+      STATES = {
+        "AK" =>	"Alaska",
+        "AL" =>	"Alabama",
+        "AR" =>	"Arkansas",
+        "AZ" =>	"Arizona",
+        "CA" =>	"California",
+        "CO" =>	"Colorado",
+        "CT" =>	"Connecticut",
+        "DC" =>	"District Of Columbia",
+        "DE" =>	"Delaware",
+        "FL" =>	"Florida",
+        "GA" =>	"Georgia",
+        "GU" =>	"Guam",
+        "HI" =>	"Hawaii",
+        "IA" =>	"Iowa",
+        "ID" =>	"Idaho",
+        "IL" =>	"Illinois",
+        "IN" =>	"Indiana",
+        "KS" =>	"Kansas",
+        "KY" =>	"Kentucky",
+        "LA" =>	"Louisiana",
+        "MA" =>	"Massachusetts",
+        "MD" =>	"Maryland",
+        "ME" =>	"Maine",
+        "MI" =>	"Michigan",
+        "MN" =>	"Minnesota",
+        "MO" =>	"Missouri",
+        "MS" =>	"Mississippi",
+        "MT" =>	"Montana",
+        "NC" =>	"North Carolina",
+        "ND" =>	"North Dakota",
+        "NE" =>	"Nebraska",
+        "NH" =>	"New Hampshire",
+        "NJ" =>	"New Jersey",
+        "NM" =>	"New Mexico",
+        "NV" =>	"Nevada",
+        "NY" =>	"New York",
+        "OH" =>	"Ohio",
+        "OK" =>	"Oklahoma",
+        "OR" =>	"Oregon",
+        "PA" =>	"Pennsylvania",
+        "PR" =>	"Puerto Rico",
+        "RI" =>	"Rhode Island",
+        "SC" =>	"South Carolina",
+        "SD" =>	"South Dakota",
+        "TN" =>	"Tennessee",
+        "TX" =>	"Texas",
+        "UT" =>	"Utah",
+        "VA" =>	"Virginia",
+        "VI" =>	"Virgin Islands",
+        "VT" =>	"Vermont",
+        "WA" =>	"Washington",
+        "WI" =>	"Wisconsin",
+        "WV" =>	"West Virginia",
+        "WY" =>	"Wyoming",
+      }.freeze
+
       # @return [Strign] name of region
       attr_reader :name
 
       # @return [Strign, nil] ISO code of region
       attr_reader :iso
 
-      # @return [Boolean, nil] <description>
+      # @return [Boolean, nil]
       attr_reader :recommended
 
       #
-      # Initialize region type.
+      # Initialize region type. Name or valid US state ISO code should be provided.
       #
-      # @param [String] name name of region
+      # @param [String, nil] name name of region
       # @param [String, nil] iso ISO code of region
       # @param [Boolean, nil] recommended recommended region
       #
-      def initialize(name:, iso: nil, recommended: nil)
-        @name = name
+      def initialize(name: nil, iso: nil, recommended: nil)
+        unless name || STATES.key?(iso&.upcase)
+          raise ArgumentError, "`name` or valid US state ISO code should be provided"
+        end
+
+        @name = name || STATES[iso&.upcase]
         @iso  = iso
         @recommended = recommended
       end

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.4".freeze
+  VERSION = "1.19.0".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

@@ -27,5 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "bibtex-ruby"
   spec.add_dependency "htmlentities"
   spec.add_dependency "iso639"
-  spec.add_dependency "nokogiri", "~> 1.15.0"
+  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.4
+  version: 1.19.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-20 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -72,14 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: '1.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        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