relaton-bib 1.11.0 → 1.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a787155aa8128f6bbd98734d80eb23d60d890f564b0357b3d79070659a1322eb
-  data.tar.gz: 92f839bcc00d8346aece24347903e833268d6c89df5da8150e108f680ae171fa
+  metadata.gz: 2fff6fdcb77f7545cc6989fa6dcc65eadfde4609ee167eaacf2648205a43a9d4
+  data.tar.gz: d2529ceddabe29e386900bceedc3f101e9bf441a87c5d9ac128a7450813083d2
 SHA512:
-  metadata.gz: f9a7e7163e3d93cea465b269aea55a18e585fa65165512cfa383f05a081605c66680912d77b0a4878ff27690713cee8d8b28dc9bbb84bb2477cf854a799e1a23
-  data.tar.gz: 017ea5aab785898a8ed574bc685a14006b2b60c936996a97b5b96e18746f1ac23d1dc43ebfd5886cec7416469e0a8843886277f8d4e5e4ade1cd907739318a2e
+  metadata.gz: d4aab0bed22dcc71b722547965dedc1a3b315cb092e5b08817cd760c2f3db4363d82d079d58da165f634f440974e2f474255a64a626c2917199ac546b3d05dc9
+  data.tar.gz: 21e8feee74c3f8c28b465068700b43c63f9f2ed81cca87974807cae646ed287def53651dce58c5fb5ca2ab274cf482cc1f34b634bdb276a39250df91ed000a6d

data/README.adoc

@@ -213,7 +213,11 @@ item = RelatonBib::BibliographicItem.new(
   ),
   place: [
     "bib place",
-    RelatonBib::Place.new(name: "Geneva", uri: "geneva.place", region: "Switzelznd")
+    RelatonBib::Place.new(
+      city: "Geneva",
+      region: [RelatonBib::Place::RegionType.new(name: "Region")],
+      country: [RelatonBib::Place::RegionType.new(name: "Switzeland", iso: "SH", recommended: true)],
+    )
   ],
   extent: [
     RelatonBib::BibItemLocality.new("section", "Reference from", "Reference to"),
@@ -412,6 +416,19 @@ item.to_bibtex
   ...
 ----
 
+=== Export bibliographic item to Citeproc
+
+[source,ruby]
+----
+item.to_citeproc
+=> [{"title"=>"Geographic information",
+  "edition"=>"1",
+  "author"=>[{"family"=>"Bierman", "given"=>"A."}, {"family"=>"Bierman", "given"=>"Forename"}],
+  "publisher"=>"Institute of Electrical and Electronics Engineers",
+  "publisher-place"=>"bib place",
+  ...
+----
+
 === Exporting bibliographic item to AsciiBib
 
 [source,ruby]

data/grammars/biblio.rng

@@ -527,7 +527,7 @@
   </define>
   <define name="LocalityType">
     <data type="string">
-      <param name="pattern">section|clause|part|paragraph|chapter|page|whole|table|annex|figure|note|list|example|volume|issue|time|anchor|locality:[a-zA-Z0-9_]+</param>
+      <param name="pattern">section|clause|part|paragraph|chapter|page|title|line|whole|table|annex|figure|note|list|example|volume|issue|time|anchor|locality:[a-zA-Z0-9_]+</param>
     </data>
   </define>
   <define name="referenceFrom">
@@ -851,17 +851,46 @@
   </define>
   <define name="bplace">
     <element name="place">
-      <optional>
-        <attribute name="uri">
-          <data type="anyURI"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="region"/>
-      </optional>
+      <choice>
+        <text/>
+        <group>
+          <ref name="bibliocity"/>
+          <zeroOrMore>
+            <ref name="biblioregion"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="bibliocountry"/>
+          </zeroOrMore>
+        </group>
+      </choice>
+    </element>
+  </define>
+  <define name="bibliocity">
+    <element name="city">
       <text/>
     </element>
   </define>
+  <define name="biblioregion">
+    <element name="region">
+      <ref name="RegionType"/>
+    </element>
+  </define>
+  <define name="bibliocountry">
+    <element name="country">
+      <ref name="RegionType"/>
+    </element>
+  </define>
+  <define name="RegionType">
+    <optional>
+      <attribute name="iso"/>
+    </optional>
+    <optional>
+      <attribute name="recommended">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <text/>
+  </define>
   <define name="bprice">
     <element name="price">
       <attribute name="currency"/>

data/lib/relaton_bib/bibliographic_item.rb

@@ -401,30 +401,26 @@ module RelatonBib
       hash
     end
 
-    # @param bibtex [BibTeX::Bibliography, NilClass]
+    #
+    # Reander BibTeX
+    #
+    # @param bibtex [BibTeX::Bibliography, nil]
+    #
     # @return [String]
-    def to_bibtex(bibtex = nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
-      item = BibTeX::Entry.new
-      item.type = bibtex_type
-      item.key = id
-      bibtex_title item
-      item.edition = edition if edition
-      bibtex_author item
-      bibtex_contributor item
-      item.address = place.first.name if place.any?
-      bibtex_note item
-      bibtex_relation item
-      bibtex_extent item
-      bibtex_date item
-      bibtex_series item
-      bibtex_classification item
-      item.keywords = keyword.map(&:content).join(", ") if keyword.any?
-      bibtex_docidentifier item
-      item.timestamp = fetched.to_s if fetched
-      bibtex_link item
-      bibtex ||= BibTeX::Bibliography.new
-      bibtex << item
-      bibtex.to_s
+    #
+    def to_bibtex(bibtex = nil)
+      bibtext_item(bibtex).to_s
+    end
+
+    #
+    # Render citeproc
+    #
+    # @param bibtex [BibTeX::Bibliography, nil]
+    #
+    # @return [Hash] citeproc
+    #
+    def to_citeproc(bibtex = nil)
+      bibtext_item(bibtex).to_citeproc.map { |cp| cp.transform_keys(&:to_s) }
     end
 
     # @param lang [String, nil] language code Iso639
@@ -555,13 +551,35 @@ module RelatonBib
 
     private
 
-    # @return [String]
-    def bibtex_title(item)
-      title.each do |t|
-        case t.type
-        when "main" then item.tile = t.title.content
-        end
-      end
+    #
+    # Create BibTeX item for this document
+    #
+    # @param [BibTeX::Bibliography, nil] bibtex <description>
+    #
+    # @return [BibTeX::Bibliography] BibTeX bibliography
+    #
+    def bibtext_item(bibtex) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      item = BibTeX::Entry.new
+      item.type = bibtex_type
+      item.key = id
+      title.to_bibtex item
+      item.edition = edition if edition
+      bibtex_author item
+      bibtex_contributor item
+      item.address = place.first.name if place.any?
+      bibtex_note item
+      bibtex_relation item
+      bibtex_extent item
+      bibtex_date item
+      bibtex_series item
+      bibtex_classification item
+      item.keywords = keyword.map(&:content).join(", ") if keyword.any?
+      bibtex_docidentifier item
+      item.timestamp = fetched.to_s if fetched
+      bibtex_link item
+      bibtex ||= BibTeX::Bibliography.new
+      bibtex << item
+      bibtex
     end
 
     # @return [String]

data/lib/relaton_bib/place.rb

@@ -1,49 +1,141 @@
 module RelatonBib
   class Place
-    # @return [String]
-    attr_reader :name
-
-    # @return [String, NilClass]
-    attr_reader :uri, :region
-
-    # @param name [String]
-    # @param uri [String, NilClass]
-    # @param region [String, NilClass]
-    def initialize(name:, uri: nil, region: nil)
-      @name   = name
-      @uri    = uri
-      @region = region
+    # @return [String, nil]
+    attr_reader :name, :city
+
+    # @return [Array<RelatonBib::Place::RegionType>]
+    attr_reader :region, :country
+
+    #
+    # Initialize place.
+    #
+    # @param name [String, nil] name of place, name or city should be provided
+    # @param city [String, nil] name of city, city or name should be provided
+    # @param region [Array<RelatonBib::Place::RegionType>] region of place
+    # @param country [Array<RelatonBib::Place::RegionType>] country of place
+    #
+    def initialize(name: nil, city: nil, region: [], country: []) # rubocop:disable Metrics/CyclomaticComplexity
+      if name.nil? && city.nil?
+        raise ArgumentError, "`name` or `city` should be provided"
+      end
+
+      @name    = name
+      @city    = city
+      @region  = region.map { |r| r.is_a?(Hash) ? RegionType.new(**r) : r }
+      @country = country.map { |c| c.is_a?(Hash) ? RegionType.new(**c) : c }
     end
 
+    #
+    # Render place as XML.
+    #
     # @param builder [Nologiri::XML::Builder]
+    #
     def to_xml(builder)
-      xml = builder.place name
-      xml[:uri] = uri if uri
-      xml[:region] = region if region
+      if name
+        builder.place name
+      else
+        builder.place do |b|
+          b.city city
+          region.each { |r| b.region { r.to_xml b } }
+          country.each { |c| b.country { c.to_xml b } }
+        end
+      end
     end
 
+    #
+    # Render place as Hash.
+    #
     # @return [Hash]
+    #
     def to_hash
-      if uri || region
-        hash = { "name" => name }
-        hash["uri"] = uri if uri
-        hash["region"] = region if region
-        hash
+      if name then name
       else
-        name
+        hash = { "city" => city }
+        hash["region"] = region.map(&:to_hash) if region.any?
+        hash["country"] = country.map(&:to_hash) if country.any?
+        hash
       end
     end
 
+    #
+    # Render place as AsciiBib.
+    #
     # @param prefix [String]
     # @param count [Integer] number of places
+    #
     # @return [Stirng]
-    def to_asciibib(prefix = "", count = 1)
-      pref = prefix.empty? ? "place" : prefix + ".place"
+    #
+    def to_asciibib(prefix = "", count = 1) # rubocop:disable Metrics/AbcSize
+      pref = prefix.empty? ? "place" : "#{prefix}.place"
       out = count > 1 ? "#{pref}::\n" : ""
-      out += "#{pref}.name:: #{name}\n"
-      out += "#{pref}.uri:: #{uri}\n" if uri
-      out += "#{pref}.region:: #{region}\n" if region
-      out
+      return "#{out}#{pref}.name:: #{name}\n" if name
+
+      out += "#{pref}.city:: #{city}\n"
+      out += region.map { |r| r.to_asciibib("#{pref}.region", region.size) }.join
+      out + country.map { |c| c.to_asciibib("#{pref}.country", country.size) }.join
+    end
+
+    class RegionType
+      # @return [Strign] name of region
+      attr_reader :name
+
+      # @return [Strign, nil] ISO code of region
+      attr_reader :iso
+
+      # @return [Boolean, nil] <description>
+      attr_reader :recommended
+
+      #
+      # Initialize region type.
+      #
+      # @param [String] 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
+        @iso  = iso
+        @recommended = recommended
+      end
+
+      #
+      # Render region type as XML.
+      #
+      # @param [Nokogiri::XML::Builder] builder XML builder
+      #
+      def to_xml(builder)
+        builder.parent["iso"] = iso if iso
+        builder.parent["recommended"] = recommended.to_s unless recommended.nil?
+        builder.text name
+      end
+
+      #
+      # Render region type as Hash.
+      #
+      # @return [Hash] region type as Hash
+      #
+      def to_hash
+        hash = { "name" => name }
+        hash["iso"] = iso if iso
+        hash["recommended"] = recommended unless recommended.nil?
+        hash
+      end
+
+      #
+      # Render region type as AsciiBib.
+      #
+      # @param [String] pref prefix
+      # @param [Integer] count number of region types
+      #
+      # @return [String] region type as AsciiBib
+      #
+      def to_asciibib(pref, count = 1) # rubocop:disable Metrics/AbcSize
+        out = count > 1 ? "#{pref}::\n" : ""
+        out += "#{pref}.name:: #{name}\n"
+        out += "#{pref}.iso:: #{iso}\n" if iso
+        out += "#{pref}.recommended:: #{recommended}\n" if recommended
+        out
+      end
     end
   end
 end

data/lib/relaton_bib/typed_title_string.rb

@@ -62,6 +62,18 @@ module RelatonBib
       tl.each { |t| opts[:builder].title { t.to_xml opts[:builder] } }
     end
 
+    #
+    # Add main title ot bibtex entry
+    #
+    # @param [BibTeX::Entry] item bibtex entry
+    #
+    def to_bibtex(item)
+      tl = titles.detect { |t| t.type == "main" }
+      return unless tl
+
+      item.title = tl.title.content
+    end
+
     private
 
     # @param lang [String]

data/lib/relaton_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonBib
-  VERSION = "1.11.0".freeze
+  VERSION = "1.11.3".freeze
 end

data/lib/relaton_bib/xml_parser.rb

@@ -72,7 +72,26 @@ module RelatonBib
 
       def fetch_place(item)
         item.xpath("./place").map do |pl|
-          Place.new(name: pl.text, uri: pl[:uri], region: pl[:region])
+          if (city = pl.at("./city"))
+            Place.new(city: city.text, region: create_region_country(pl),
+                      country: create_region_country(pl, "country"))
+          else
+            Place.new(name: pl.text)
+          end
+        end
+      end
+
+      #
+      # Create region or country from place element
+      #
+      # @param [Nokogiri::XML::Element] place place element
+      # @param [String] node name of the node to parse
+      #
+      # @return [Array<RelatonBib::Place::RegionType>] <description>
+      #
+      def create_region_country(place, node = "region")
+        place.xpath("./#{node}").map do |r|
+          Place::RegionType.new(name: r.text, iso: r[:iso], recommended: r[:recommended])
         end
       end
 
@@ -401,21 +420,25 @@ module RelatonBib
       def localities(rel)
         rel.xpath("./locality|./localityStack").map do |lc|
           if lc.name == "locality"
-            Locality.new lc[:type], lc.at("referenceFrom").text, lc.at("referenceTo")&.text
+            locality lc
           else
             LocalityStack.new(lc.xpath("./locality").map { |l| locality l })
           end
         end
       end
 
+      #
+      # Create Locality object from Nokogiri::XML::Element
+      #
       # @param loc [Nokogiri::XML::Element]
+      # @param klass [RelatonBib::Locality.class, RelatonBib::LocalityStack.class]
+      #
       # @return [RelatonBib::Locality]
       def locality(loc, klass = Locality)
-        ref_to = (rt = loc.at("./referenceTo")) && LocalizedString.new(rt.text)
         klass.new(
           loc[:type],
-          LocalizedString.new(loc.at("./referenceFrom").text),
-          ref_to,
+          loc.at("./referenceFrom")&.text,
+          loc.at("./referenceTo")&.text,
         )
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.11.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-10 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug