relaton-bib 1.3.1 → 1.5.0

data/lib/relaton_bib/biblio_note.rb

@@ -1,4 +1,31 @@
 module RelatonBib
+  class BiblioNoteCollection
+    extend Forwardable
+
+    def_delegators :@array, :[], :first, :last, :empty?, :any?, :size,
+                   :each, :map, :detect, :length
+
+    def initialize(notes)
+      @array = notes
+    end
+
+    # @param bibnote [RelatonBib::BiblioNote]
+    # @return [self]
+    def <<(bibnote)
+      @array << bibnote
+      self
+    end
+
+    # @param opts [Hash]
+    # @option opts [Nokogiri::XML::Builder] XML builder
+    # @option opts [String] :lang language
+    def to_xml(**opts)
+      bnc = @array.select { |bn| bn.language&.include? opts[:lang] }
+      bnc = @array unless bnc.any?
+      bnc.each { |bn| bn.to_xml opts[:builder] }
+    end
+  end
+
   class BiblioNote < FormattedString
     # @return [String, NilClass]
     attr_reader :type

data/lib/relaton_bib/bibliographic_date.rb

@@ -6,7 +6,8 @@ module RelatonBib
   # Bibliographic date.
   class BibliographicDate
     TYPES = %w[published accessed created implemented obsoleted confirmed
-               updated issued transmitted copied unchanged circulated adapted].freeze
+               updated issued transmitted copied unchanged circulated adapted
+               vote-started vote-ended].freeze
 
     # @return [String]
     attr_reader :type

data/lib/relaton_bib/bibliographic_item.rb

@@ -45,7 +45,7 @@ module RelatonBib
     attr_reader :id, :type, :docnumber, :edition, :doctype
 
     # @!attribute [r] title
-    # @return [Array<RelatonBib::TypedTitleString>]
+    # @return [RelatonBib::TypedTitleStringCollection]
 
     # @return [Array<RelatonBib::TypedUri>]
     attr_reader :link
@@ -59,10 +59,10 @@ module RelatonBib
     # @return [Array<RelatonBib::ContributionInfo>]
     attr_reader :contributor
 
-    # @return [RelatonBib::BibliongraphicItem::Version, NilClass]
+    # @return [RelatonBib::BibliographicItem::Version, NilClass]
     attr_reader :version
 
-    # @return [Array<RelatonBib::BiblioNote>]
+    # @return [RelatonBib::BiblioNoteCollection]
     attr_reader :biblionote
 
     # @return [Array<String>] language Iso639 code
@@ -126,7 +126,8 @@ module RelatonBib
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     # @param id [String, NilClass]
-    # @param title [Array<RelatonBib::TypedTitleString>]
+    # @param title [RelatonBib::TypedTitleStringCollection,
+    #   Array<Hash, RelatonBib::TypedTitleString>]
     # @param formattedref [RelatonBib::FormattedRef, NilClass]
     # @param type [String, NilClass]
     # @param docid [Array<RelatonBib::DocumentIdentifier>]
@@ -136,7 +137,7 @@ module RelatonBib
     # @param docstatus [RelatonBib::DocumentStatus, NilClass]
     # @param edition [String, NilClass]
     # @param version [RelatonBib::BibliographicItem::Version, NilClass]
-    # @param biblionote [Array<RelatonBib::BiblioNote>]
+    # @param biblionote [RelatonBib::BiblioNoteCollection]
     # @param series [Array<RelatonBib::Series>]
     # @param medium [RelatonBib::Medium, NilClas]
     # @param place [Array<String, RelatonBib::Place>]
@@ -193,9 +194,7 @@ module RelatonBib
         warn %{[relaton-bib] document type "#{args[:type]}" is invalid.}
       end
 
-      @title = (args[:title] || []).map do |t|
-        t.is_a?(Hash) ? TypedTitleString.new(t) : t
-      end
+      @title = TypedTitleStringCollection.new(args[:title])
 
       @date = (args[:date] || []).map do |d|
         d.is_a?(Hash) ? BibliographicDate.new(d) : d
@@ -224,7 +223,7 @@ module RelatonBib
       @docnumber      = args[:docnumber]
       @edition        = args[:edition]
       @version        = args[:version]
-      @biblionote     = args.fetch :biblionote, []
+      @biblionote     = args.fetch :biblionote, BiblioNoteCollection.new([])
       @language       = args.fetch :language, []
       @script         = args.fetch :script, []
       @status         = args[:docstatus]
@@ -262,12 +261,15 @@ module RelatonBib
     # @return [RelatonBib::FormattedString, Array<RelatonBib::FormattedString>]
     def abstract(lang: nil)
       if lang
-        @abstract.detect { |a| a.language.include? lang }
+        @abstract.detect { |a| a.language&.include? lang }
       else
         @abstract
       end
     end
 
+    # @param id [RelatonBib::DocumentIdentifier]
+    # @param attribute [boolean, nil]
+    # @return [String]
     def makeid(id, attribute)
       return nil if attribute && !@id_attribute
 
@@ -282,8 +284,12 @@ module RelatonBib
       idstr.strip
     end
 
+    # @param identifier [RelatonBib::DocumentIdentifier]
+    # @param options [Hash]
+    # @option options [boolean, nil] :no_year
+    # @option options [boolean, nil] :all_parts
     # @return [String]
-    def shortref(identifier, **opts) # rubocop:disable Metrics/CyclomaticComplexity
+    def shortref(identifier, **opts) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize,Metrics/PerceivedComplexity
       pubdate = date.select { |d| d.type == "published" }
       year = if opts[:no_year] || pubdate.empty? then ""
              else ":" + pubdate&.first&.on&.year.to_s
@@ -293,14 +299,18 @@ module RelatonBib
       "#{makeid(identifier, false)}#{year}"
     end
 
-    # @param builder [Nokogiri::XML::Builder, NillClass] (nil)
-    # @return [String]
-    def to_xml(builder = nil, **opts, &block)
-      if builder
-        render_xml builder, **opts, &block
+    # @param opts [Hash]
+    # @option opts [Nokogiri::XML::Builder] :builder XML builder
+    # @option opts [Boolean] :bibdata
+    # @option opts [Symbol, NilClass] :date_format (:short), :full
+    # @option opts [String, Symbol] :lang language
+    # @return [String] XML
+    def to_xml(**opts, &block)
+      if opts[:builder]
+        render_xml **opts, &block
       else
         Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
-          render_xml xml, **opts, &block
+          render_xml builder: xml, **opts, &block
         end.doc.root.to_xml
       end
     end
@@ -344,7 +354,9 @@ module RelatonBib
       hash["keyword"] = single_element_array(keyword) if keyword&.any?
       hash["license"] = single_element_array(license) if license&.any?
       hash["doctype"] = doctype if doctype
-      hash["editorialgroup"] = editorialgroup.to_hash if editorialgroup
+      if editorialgroup&.presence?
+        hash["editorialgroup"] = editorialgroup.to_hash
+      end
       hash["ics"] = single_element_array ics if ics.any?
       if structuredidentifier&.presence?
         hash["structuredidentifier"] = structuredidentifier.to_hash
@@ -378,12 +390,10 @@ module RelatonBib
       bibtex.to_s
     end
 
-    # @param lang [String] language code Iso639
-    # @return [Array<RelatonIsoBib::TypedTitleString>]
+    # @param lang [String, nil] language code Iso639
+    # @return [RelatonIsoBib::TypedTitleStringCollection]
     def title(lang: nil)
-      if lang then @title.select { |t| t.title.language&.include? lang }
-      else @title
-      end
+      @title.lang lang
     end
 
     # @param type [Symbol] type of url, can be :src/:obp/:rss
@@ -406,12 +416,12 @@ module RelatonBib
     end
 
     # remove title part components and abstract
-    def to_all_parts # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+    def to_all_parts # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength,Metrics/PerceivedComplexity
       me = deep_clone
       me.disable_id_attribute
       me.relation << DocumentRelation.new(type: "instance", bibitem: self)
       me.language.each do |l|
-        me.title.delete_if { |t| t.type == "title-part" }
+        me.title.delete_title_part!
         ttl = me.title.select do |t|
           t.type != "main" && t.title.language&.include?(l)
         end
@@ -449,7 +459,7 @@ module RelatonBib
 
     # If revision_date exists then returns it else returns published date or nil
     # @return [String, NilClass]
-    def revdate # rubocop:disable Metrics/CyclomaticComplexity
+    def revdate # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       @revdate ||= if version&.revision_date
                      version.revision_date
                    else
@@ -526,7 +536,7 @@ module RelatonBib
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
 
     # @param [BibTeX::Entry]
-    def bibtex_author(item) # rubocop:disable Metrics/CyclomaticComplexity
+    def bibtex_author(item) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       authors = contributor.select do |c|
         c.entity.is_a?(Person) && c.role.map(&:type).include?("author")
       end.map &:entity
@@ -560,7 +570,7 @@ module RelatonBib
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     # @param [BibTeX::Entry]
-    def bibtex_note(item) # rubocop:disable Metrics/CyclomaticComplexity
+    def bibtex_note(item) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize
       biblionote.each do |n|
         case n.type
         when "annote" then item.annote = n.content
@@ -656,32 +666,40 @@ module RelatonBib
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     # rubocop:disable Style/NestedParenthesizedCalls, Metrics/BlockLength
 
-    # @param builder [Nokogiri::XML::Builder]
-    # @return [String]
-    def render_xml(builder, **opts)
+    # @param opts [Hash]
+    # @option opts [Nokogiri::XML::Builder] :builder XML builder
+    # @option opts [Boolean] bibdata
+    # @option opts [Symbol, NilClass] :date_format (:short), :full
+    # @option opts [String] :lang language
+    def render_xml(**opts)
       root = opts[:bibdata] ? :bibdata : :bibitem
-      xml = builder.send(root) do
+      xml = opts[:builder].send(root) do |builder|
         builder.fetched fetched if fetched
-        title.each { |t| builder.title { t.to_xml builder } }
+        title.to_xml **opts
         formattedref&.to_xml builder
         link.each { |s| s.to_xml builder }
-        docidentifier.each { |di| di.to_xml builder }
+        docidentifier.each { |di| di.to_xml **opts }
         builder.docnumber docnumber if docnumber
         date.each { |d| d.to_xml builder, **opts }
         contributor.each do |c|
           builder.contributor do
-            c.role.each { |r| r.to_xml builder }
-            c.to_xml builder
+            c.role.each { |r| r.to_xml **opts }
+            c.to_xml **opts
           end
         end
         builder.edition edition if edition
         version&.to_xml builder
-        biblionote.each { |n| n.to_xml builder }
+        biblionote.to_xml **opts
+        opts[:note]&.each do |n|
+          builder.note(n[:text], format: "text/plain", type: n[:type])
+        end
         language.each { |l| builder.language l }
         script.each { |s| builder.script s }
-        abstract.each { |a| builder.abstract { a.to_xml(builder) } }
+        abstr = abstract.select { |ab| ab.language&.include? opts[:lang] }
+        abstr = abstract unless abstr.any?
+        abstr.each { |a| builder.abstract { a.to_xml(builder) } }
         status&.to_xml builder
-        copyright&.each { |c| c.to_xml builder }
+        copyright&.each { |c| c.to_xml **opts }
         relation.each { |r| r.to_xml builder, **opts }
         series.each { |s| s.to_xml builder }
         medium&.to_xml builder
@@ -690,7 +708,9 @@ module RelatonBib
         accesslocation.each { |al| builder.accesslocation al }
         license.each { |l| builder.license l }
         classification.each { |cls| cls.to_xml builder }
-        keyword.each { |kw| builder.keyword { kw.to_xml(builder) } }
+        kwrd = keyword.select { |kw| kw.language&.include? opts[:lang] }
+        kwrd = keyword unless kwrd.any?
+        kwrd.each { |kw| builder.keyword { kw.to_xml(builder) } }
         validity&.to_xml builder
         if block_given? then yield builder
         elsif opts[:bibdata] && (doctype || editorialgroup || ics&.any? ||

data/lib/relaton_bib/bibtex_parser.rb

@@ -6,7 +6,7 @@ module RelatonBib
     class << self
       # @param bibtex [String]
       # @return [Hash{String=>RelatonBib::BibliographicItem}]
-      def from_bibtex(bibtex)
+      def from_bibtex(bibtex) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
         BibTeX.parse(bibtex).reduce({}) do |h, bt|
           h[bt.key] = BibliographicItem.new(
             id: bt.key,
@@ -35,7 +35,7 @@ module RelatonBib
 
       # @param bibtex [BibTeX::Entry]
       # @return [Array<RelatonBib::DocumentIdentifier>]
-      def fetch_docid(bibtex)
+      def fetch_docid(bibtex) # rubocop:disable Metrics/AbcSize
         docid = []
         docid << DocumentIdentifier.new(id: bibtex.isbn.to_s, type: "isbn") if bibtex["isbn"]
         docid << DocumentIdentifier.new(id: bibtex.lccn.to_s, type: "lccn") if bibtex["lccn"]
@@ -67,17 +67,17 @@ module RelatonBib
       end
 
       # @param bibtex [BibTeX::Entry]
-      # @return [Array<Hash>]
+      # @return [RelatonBib::TypedTitleStringCollection]
       def fetch_title(bibtex)
         title = []
         title << { type: "main", content: bibtex.title.to_s } if bibtex["title"]
         title << { type: "main", content: bibtex.subtitle.to_s } if bibtex["subtitle"]
-        title
+        TypedTitleStringCollection.new title
       end
 
       # @param bibtex [BibTeX::Entry]
       # @return [Array<Hash>]
-      def fetch_contributor(bibtex)
+      def fetch_contributor(bibtex) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
         contributor = []
         fetch_person(bibtex["author"]).each do |entity|
           contributor << { entity: entity, role: [{ type: "author" }] }
@@ -94,7 +94,7 @@ module RelatonBib
         if bibtex["institution"]
           contributor << {
             entity: { name: bibtex.institution.to_s },
-            role: [{ type: "distributor", description: ["sponsor"] }]
+            role: [{ type: "distributor", description: ["sponsor"] }],
           }
         end
 
@@ -145,11 +145,11 @@ module RelatonBib
       end
 
       # @param bibtex [BibTeX::Entry]
-      # @return [Array<RelatonBib::BiblioNote>]
+      # @return [RelatonBib::BiblioNoteCollection]
       def fetch_note(bibtex)
         bibtex.select do |k, _v|
           %i[annote howpublished comment note content].include? k
-        end.reduce([]) do |mem, note|
+        end.reduce(BiblioNoteCollection.new([])) do |mem, note|
           type = case note[0]
                  when :note then nil
                  when :content then "tableOfContents"
@@ -164,13 +164,14 @@ module RelatonBib
       def fetch_relation(bibtex)
         return [] unless bibtex["booktitle"]
 
-        title = TypedTitleString.new(type: "main", content: bibtex.booktitle.to_s)
-        [{ type: "partOf", bibitem: BibliographicItem.new(title: [title]) }]
+        ttl = TypedTitleString.new(type: "main", content: bibtex.booktitle.to_s)
+        title = TypedTitleStringCollection.new [ttl]
+        [{ type: "partOf", bibitem: BibliographicItem.new(title: title) }]
       end
 
       # @param bibtex [BibTeX::Entry]
       # @return [Array<RelatonBib::BibItemLocality>]
-      def fetch_extent(bibtex)
+      def fetch_extent(bibtex) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
         bibtex.select do |k, _v|
           %i[chapter pages volume].include? k
         end.reduce([]) do |mem, loc|
@@ -188,13 +189,13 @@ module RelatonBib
 
       # @param bibtex [BibTeX::Entry]
       # @return [Array<RelatonBib::Series>]
-      def fetch_series(bibtex)
+      def fetch_series(bibtex) # rubocop:disable Metrics/MethodLength
         series = []
         if bibtex["journal"]
           series << Series.new(
             type: "journal",
             title: TypedTitleString.new(content: bibtex.journal.to_s),
-            number: bibtex["number"]&.to_s,
+            number: bibtex["number"]&.to_s
           )
         end
 
@@ -207,7 +208,7 @@ module RelatonBib
 
       # @param bibtex [BibTeX::Entry]
       # @return [Array<RelatonBib::TypedUri>]
-      def fetch_link(bibtex)
+      def fetch_link(bibtex) # rubocop:disable Metrics/AbcSize
         link = []
         link << TypedUri.new(type: "src", content: bibtex.url.to_s) if bibtex["url"]
         link << TypedUri.new(type: "doi", content: bibtex.doi.to_s) if bibtex["doi"]
@@ -242,4 +243,4 @@ module RelatonBib
       end
     end
   end
-end
+end

data/lib/relaton_bib/contribution_info.rb

@@ -31,11 +31,15 @@ module RelatonBib
       end
     end
 
-    # @param builder [Nokogiri::XML::Builder]
-    def to_xml(builder)
-      builder.role(type: type) do
-        description.each do |d|
-          builder.description { |desc| d.to_xml(desc) }
+    # @param opts [Hash]
+    # @option opts [Nokogiri::XML::Builder] :builder XML builder
+    # @option opts [String] :lang language
+    def to_xml(**opts) # rubocop:disable Metrics/AbcSize
+      opts[:builder].role(type: type) do |builder|
+        desc = description.select { |d| d.language&.include? opts[:lang] }
+        desc = description unless desc.any?
+        desc.each do |d|
+          builder.description { |b| d.to_xml(b) }
         end
       end
     end
@@ -83,9 +87,11 @@ module RelatonBib
       @role   = role.map { |r| ContributorRole.new(**r) }
     end
 
-    # @param builder [Nokogiri::XML::Builder]
-    def to_xml(builder)
-      entity.to_xml builder
+    # @param opts [Hash]
+    # @option opts [Nokogiri::XML::Builder] :builder XML builder
+    # @option opts [String, Symbol] :lang language
+    def to_xml(**opts)
+      entity.to_xml **opts
     end
 
     # @return [Hash]

data/lib/relaton_bib/contributor.rb

@@ -129,12 +129,16 @@ module RelatonBib
       @description  = description
     end
 
-    # @params builder [Nokogiri::XML::Builder]
-    def to_xml(builder)
-      builder.affiliation do
+    # @param opts [Hash]
+    # @option opts [Nokogiri::XML::Builder] :builder XML builder
+    # @option opts [String] :lang language
+    def to_xml(**opts) # rubocop:disable Metrics/AbcSize
+      opts[:builder].affiliation do |builder|
         builder.name { name.to_xml builder } if name
-        description.each { |d| builder.description { d.to_xml builder } }
-        organization.to_xml builder
+        desc = description.select { |d| d.language&.include? opts[:lang] }
+        desc = description unless desc.any?
+        desc.each { |d| builder.description { d.to_xml builder } }
+        organization.to_xml **opts
       end
     end
 
@@ -151,7 +155,7 @@ module RelatonBib
     # @param prefix [String]
     # @param count [Integer]
     # @return [String]
-    def to_asciibib(prefix = "", count = 1)
+    def to_asciibib(prefix = "", count = 1) # rubocop:disable Metrics/AbcSize
       pref = prefix.empty? ? prefix : prefix + "."
       out = count > 1 ? "#{pref}affiliation::\n" : ""
       out += name.to_asciibib "#{pref}affiliation.name" if name