relaton-bib 1.1.0 → 1.1.1

data/grammars/reqt.rng

@@ -0,0 +1,171 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    Presupposes isodoc.rnc, is included in it
+    include "isodoc.rnc" { }
+  -->
+  <define name="requirement">
+    <element name="requirement">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="recommendation">
+    <element name="recommendation">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="permission">
+    <element name="permission">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="RequirementType">
+    <optional>
+      <attribute name="obligation">
+        <ref name="ObligationType"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="unnumbered">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="subsequence"/>
+    </optional>
+    <attribute name="id">
+      <data type="ID"/>
+    </attribute>
+    <optional>
+      <attribute name="filename"/>
+    </optional>
+    <optional>
+      <attribute name="model"/>
+    </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <ref name="reqtitle"/>
+    </optional>
+    <optional>
+      <ref name="label"/>
+    </optional>
+    <optional>
+      <ref name="subject"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="reqinherit"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <choice>
+        <ref name="measurementtarget"/>
+        <ref name="specification"/>
+        <ref name="verification"/>
+        <ref name="import"/>
+        <ref name="description"/>
+      </choice>
+    </zeroOrMore>
+    <optional>
+      <ref name="reqt_references"/>
+    </optional>
+    <zeroOrMore>
+      <choice>
+        <ref name="requirement"/>
+        <ref name="recommendation"/>
+        <ref name="permission"/>
+      </choice>
+    </zeroOrMore>
+  </define>
+  <define name="reqtitle">
+    <element name="title">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="label">
+    <element name="label">
+      <text/>
+    </element>
+  </define>
+  <define name="subject">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="reqinherit">
+    <element name="inherit">
+      <text/>
+    </element>
+  </define>
+  <define name="measurementtarget">
+    <element name="measurement-target">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="specification">
+    <element name="specification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="verification">
+    <element name="verification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="import">
+    <element name="import">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="description">
+    <element name="description">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="reqt_references">
+    <element name="references">
+      <oneOrMore>
+        <ref name="bibitem"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="RequirementSubpart">
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <attribute name="exclude">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <oneOrMore>
+      <ref name="BasicBlock"/>
+    </oneOrMore>
+  </define>
+  <define name="ObligationType">
+    <choice>
+      <value>requirement</value>
+      <value>recommendation</value>
+      <value>permission</value>
+    </choice>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
+</grammar>

data/lib/relaton_bib.rb

@@ -10,6 +10,8 @@ module RelatonBib
   class RequestError < StandardError; end
 
   class << self
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+
     # @param date [String]
     # @return [Date, NilClass]
     def parse_date(sdate)
@@ -25,6 +27,7 @@ module RelatonBib
       elsif /(?<date>\d{4})/ =~ sdate then Date.strptime date, "%Y" # 2012
       end
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
   end
 
   private
@@ -35,7 +38,7 @@ module RelatonBib
     if array.size > 1
       array.map { |e| e.is_a?(String) ? e : e.to_hash }
     else
-      array[0].is_a?(String) ? array[0] : array[0].to_hash
+      array.first&.is_a?(String) ? array[0] : array.first&.to_hash
     end
   end
 end

data/lib/relaton_bib/bibliographic_item.rb

@@ -24,6 +24,9 @@ require "relaton_bib/biblio_version"
 require "relaton_bib/workers_pool"
 require "relaton_bib/hash_converter"
 require "relaton_bib/place"
+require "relaton_bib/structured_identifier"
+require "relaton_bib/editorial_group"
+require "relaton_bib/ics"
 
 module RelatonBib
   # Bibliographic item
@@ -35,33 +38,27 @@ module RelatonBib
                audiovisual film video broadcast graphic_work music patent
                inbook incollection inproceedings journal].freeze
 
+    # @return [TrueClass, FalseClass, NilClass]
+    attr_accessor :all_parts
+
     # @return [String, NilClass]
-    attr_reader :id
+    attr_reader :id, :type, :docnumber, :edition, :doctype
 
+    # @!attribute [r] title
     # @return [Array<RelatonBib::TypedTitleString>]
-    attr_reader :title
 
     # @return [Array<RelatonBib::TypedUri>]
     attr_reader :link
 
-    # @return [String, NilClass]
-    attr_reader :type
-
     # @return [Array<RelatonBib::DocumentIdentifier>]
     attr_reader :docidentifier
 
-    # @return [String, NilClass] docnumber
-    attr_reader :docnumber
-
     # @return [Array<RelatonBib::BibliographicDate>]
     attr_accessor :date
 
     # @return [Array<RelatonBib::ContributionInfo>]
     attr_reader :contributor
 
-    # @return [String, NillClass]
-    attr_reader :edition
-
     # @return [RelatonBib::BibliongraphicItem::Version, NilClass]
     attr_reader :version
 
@@ -116,6 +113,15 @@ module RelatonBib
     # @return [Array<RelatonBib::LocalizedString>]
     attr_reader :keyword
 
+    # @return [RelatonBib::EditorialGroup, nil]
+    attr_reader :editorialgroup
+
+    # @return [Array<RelatonBib:ICS>]
+    attr_reader :ics
+
+    # @return [RelatonBib::StructuredIdentifierCollection]
+    attr_reader :structuredidentifier
+
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
@@ -140,6 +146,10 @@ module RelatonBib
     # @param validity [RelatonBib:Validity, NilClass]
     # @param fetched [Date, NilClass] default nil
     # @param keyword [Array<String>]
+    # @param doctype [String]
+    # @param editorialgroup [RelatonBib::EditorialGroup, nil]
+    # @param ics [Array<RelatonBib::ICS>]
+    # @param structuredidentifier [RelatonBib::StructuredIdentifierCollection]
     #
     # @param copyright [Array<Hash, RelatonBib::CopyrightAssociation>]
     # @option copyright [Array<Hash, RelatonBib::ContributionInfo>] :owner
@@ -235,6 +245,10 @@ module RelatonBib
       @fetched        = args.fetch :fetched, nil # , Date.today # we should pass the fetched arg from scrappers
       @keyword        = (args[:keyword] || []).map { |kw| LocalizedString.new(kw) }
       @license        = args.fetch :license, []
+      @doctype        = args[:doctype]
+      @editorialgroup = args[:editorialgroup]
+      @ics            = args.fetch :ics, []
+      @structuredidentifier = args[:structuredidentifier]
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
@@ -286,6 +300,8 @@ module RelatonBib
       end
     end
 
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+
     # @return [Hash]
     def to_hash
       hash = {}
@@ -318,8 +334,15 @@ module RelatonBib
       hash["fetched"] = fetched.to_s if fetched
       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
+      hash["ics"] = single_element_array ics if ics.any?
+      if structuredidentifier&.presence?
+        hash["structuredidentifier"] = structuredidentifier.to_hash
+      end
       hash
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     # @param bibtex [BibTeX::Bibliography, NilClass]
     # @return [String]
@@ -346,6 +369,74 @@ module RelatonBib
       bibtex << item
       bibtex.to_s
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    # @param lang [String] language code Iso639
+    # @return [Array<RelatonIsoBib::TypedTitleString>]
+    def title(lang: nil)
+      if lang then @title.select { |t| t.title.language&.include? lang }
+      else @title
+      end
+    end
+
+    # @param type [Symbol] type of url, can be :src/:obp/:rss
+    # @return [String]
+    def url(type = :src)
+      @link.detect { |s| s.type == type.to_s }.content.to_s
+    end
+
+    def abstract=(value)
+      @abstract = value
+    end
+
+    def deep_clone
+      dump = Marshal.dump self
+      Marshal.load dump
+    end
+
+    def disable_id_attribute
+      @id_attribute = false
+    end
+
+    # remove title part components and abstract
+    def to_all_parts
+      me = deep_clone
+      me.disable_id_attribute
+      me.relation << RelatonBib::DocumentRelation.new(
+        type: "instance", bibitem: self,
+      )
+      me.language.each do |l|
+        me.title.delete_if { |t| t.type == "title-part" }
+        ttl = me.title.select { |t| t.type != "main" && t.title.language&.include?(l) }
+        tm_en = ttl.map { |t| t.title.content }.join " – "
+        me.title.detect { |t| t.type == "main" && t.title.language&.include?(l) }&.title&.content = tm_en
+      end
+      me.abstract = []
+      me.docidentifier.each(&:remove_part)
+      me.docidentifier.each(&:all_parts)
+      me.structuredidentifier.remove_part
+      me.structuredidentifier.all_parts
+      me.docidentifier.each &:remove_date
+      me.structuredidentifier&.remove_date
+      me.all_parts = true
+      me
+    end
+
+    # convert ISO:yyyy reference to reference to most recent
+    # instance of reference, removing date-specific infomration:
+    # date of publication, abstracts. Make dated reference Instance relation
+    # of the redacated document
+    def to_most_recent_reference
+      me = deep_clone
+      disable_id_attribute
+      me.relation << DocumentRelation.new(type: "instance", bibitem: self)
+      me.abstract = []
+      me.date = []
+      me.docidentifier.each &:remove_date
+      me.structuredidentifier&.remove_date
+      me.id&.sub! /-[12]\d\d\d/, ""
+      me
+    end
 
     # If revision_date exists then returns it else returns published date or nil
     # @return [String, NilClass]
@@ -376,6 +467,8 @@ module RelatonBib
       end
     end
 
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+
     # @param [BibTeX::Entry]
     def bibtex_author(item)
       authors = contributor.select do |c|
@@ -386,7 +479,7 @@ module RelatonBib
 
       item.author = authors.map do |a|
         if a.name.surname
-          "#{a.name.surname}, #{a.name.forename.map(&:to_s).join(" ")}"
+          "#{a.name.surname}, #{a.name.forename.map(&:to_s).join(' ')}"
         else
           a.name.completename.to_s
         end
@@ -408,6 +501,7 @@ module RelatonBib
         end
       end
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     # @param [BibTeX::Entry]
     def bibtex_note(item)
@@ -425,7 +519,10 @@ module RelatonBib
     # @param [BibTeX::Entry]
     def bibtex_relation(item)
       rel = relation.detect { |r| r.type == "partOf" }
-      item.booktitle = rel.bibitem.title.detect { |t| t.type == "main" }.title.content if rel
+      if rel
+        title_main = rel.bibitem.title.detect { |t| t.type == "main" }
+        item.booktitle = title_main.title.content
+      end
     end
 
     # @param [BibTeX::Entry]
@@ -539,8 +636,15 @@ module RelatonBib
         classification.each { |cls| cls.to_xml builder }
         keyword.each { |kw| builder.keyword { kw.to_xml(builder) } }
         validity&.to_xml builder
-        if block_given?
-          yield builder
+        if block_given? then yield builder
+        elsif opts[:bibdata] && (doctype || editorialgroup || ics&.any? ||
+                                 structuredidentifier&.presence?)
+          builder.ext do |b|
+            b.doctype doctype if doctype
+            editorialgroup&.to_xml b
+            ics.each { |i| i.to_xml b }
+            structuredidentifier&.to_xml b
+          end
         end
       end
       xml[:id] = id if id && !opts[:bibdata] && !opts[:embedded]

data/lib/relaton_bib/document_relation_collection.rb

@@ -8,7 +8,7 @@ module RelatonBib
     extend Forwardable
 
     def_delegators :@array, :<<, :[], :first, :last, :empty?, :any?, :size,
-      :each, :detect, :map, :length
+                   :each, :detect, :map, :length
 
     # @param relation [Array<RelatonBib::DocumentRelation, Hash>]
     # @option relation [String] :type
@@ -20,7 +20,7 @@ module RelatonBib
     #                   RelatonBib::SourceLocalityStack>] :source_locality
     # @option relation [RelatonBib::BibliographicItem, NillClass] :bibitem (nil)
     def initialize(relation)
-      @array =  relation.map { |r| r.is_a?(Hash) ? DocumentRelation.new(r) : r }
+      @array = relation.map { |r| r.is_a?(Hash) ? DocumentRelation.new(r) : r }
     end
 
     # @todo We don't have replace type anymore. Suppose we should update this