relaton-iso-bib 1.0.0 → 1.3.0

data/grammars/isostandard.rng

@@ -91,6 +91,12 @@
     </define>
     <define name="sections">
       <element name="sections">
+        <zeroOrMore>
+          <choice>
+            <ref name="note"/>
+            <ref name="admonition"/>
+          </choice>
+        </zeroOrMore>
         <ref name="clause"/>
         <optional>
           <choice>
@@ -263,6 +269,8 @@
         <value>publicly-available-specification</value>
         <value>international-workshop-agreement</value>
         <value>guide</value>
+        <value>amendment</value>
+        <value>technical-corrigendum</value>
       </choice>
     </define>
     <define name="structuredidentifier">
@@ -354,6 +362,9 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="number"/>
+        </optional>
         <optional>
           <attribute name="subsequence"/>
         </optional>
@@ -510,7 +521,7 @@
         </attribute>
       </optional>
       <oneOrMore>
-        <ref name="paragraph-with-footnote"/>
+        <ref name="BasicBlock"/>
       </oneOrMore>
     </element>
   </define>

data/lib/relaton_iso_bib/editorial_group.rb

@@ -33,7 +33,7 @@ module RelatonIsoBib
     # @option workgroup [Integer] :number
     #
     # @param secretariat [String, NilClass]
-    def initialize(technical_committee:, **args)
+    def initialize(technical_committee:, **args) # rubocop:disable Metrics/CyclomaticComplexity
       @technical_committee = technical_committee.map do |tc|
         tc.is_a?(Hash) ? IsoSubgroup.new(tc) : tc
       end
@@ -49,8 +49,9 @@ module RelatonIsoBib
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
 
     # @param builder [Nokogiri::XML::Builder]
-    def to_xml(builder)
-      return unless technical_committee || subcommittee || workgroup || secretariat
+    def to_xml(builder) # rubocop:disable Metrics/CyclomaticComplexity
+      return unless technical_committee || subcommittee || workgroup ||
+        secretariat
 
       builder.editorialgroup do
         technical_committee.each do |tc|
@@ -69,12 +70,36 @@ module RelatonIsoBib
 
     # @return [Hash]
     def to_hash
-      hash = { "technical_committee" => single_element_array(technical_committee) }
-      hash["subcommittee"] = single_element_array(subcommittee) if subcommittee&.any?
+      hash = {
+        "technical_committee" => single_element_array(technical_committee),
+      }
+      if subcommittee&.any?
+        hash["subcommittee"] = single_element_array(subcommittee)
+      end
       hash["workgroup"] = single_element_array(workgroup) if workgroup&.any?
       hash["secretariat"] = secretariat if secretariat
       hash
     end
+
+    # @param prefix [String]
+    # @return [String]
+    def to_asciibib(prefix = "") # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      pref = prefix.empty? ? prefix : prefix + "."
+      pref += "editorialgroup"
+      out = ""
+      technical_committee.each do |tc|
+        out += tc.to_asciibib "#{pref}.technical_committee",
+                              technical_committee.size
+      end
+      subcommittee.each do |sc|
+        out += sc.to_asciibib "#{pref}.subcommittee", subcommittee.size
+      end
+      workgroup.each do |wg|
+        out += wg.to_asciibib "#{pref}.workgroup", workgroup.size
+      end
+      out += "#{pref}.secretariat:: #{secretariat}\n" if secretariat
+      out
+    end
   end
 
   # ISO subgroup.
@@ -111,5 +136,15 @@ module RelatonIsoBib
       hash["number"] = number if number
       hash
     end
+
+    # @param prefix [String]
+    # @param count [Integer] number of the elements
+    def to_asciibib(prefix, count = 1)
+      out = count > 1 ? "#{prefix}::\n" : ""
+      out += "#{prefix}.type:: #{type}\n" if type
+      out += "#{prefix}.number:: #{number}\n" if number
+      out += "#{prefix}.name:: #{name}\n"
+      out
+    end
   end
 end

data/lib/relaton_iso_bib/hash_converter.rb

@@ -1,75 +1,8 @@
 module RelatonIsoBib
   class HashConverter < RelatonBib::HashConverter
     class << self
-      # @override RelatonBib::HashConverter.hash_to_bib
-      # @param args [Hash]
-      # @param nested [TrueClass, FalseClass]
-      # @return [Hash]
-      def hash_to_bib(args, nested = false)
-        ret = super
-        return if ret.nil?
-
-        editorialgroup_hash_to_bib(ret)
-        ics_hash_to_bib(ret)
-        structuredidentifier_hash_to_bib(ret)
-        ret
-      end
-
-      def split_title(content, lang = "en", script = "Latn")
-        titles = content&.split(/ (?:--|—|–) /)
-        case titles&.size
-        when nil, 0
-          intro, main, part = nil, "", nil
-        when 1
-          intro, main, part = nil, titles[0], nil
-        when 2
-          if /^(Part|Partie) \d+:/ =~ titles[1]
-            intro, main, part = nil, titles[0], titles[1]
-          else
-            intro, main, part = titles[0], titles[1], nil
-          end
-        when 3
-          intro, main, part = titles[0], titles[1], titles[2]
-        else
-          intro, main, part = titles[0], titles[1], titles[2..-1]&.join(" -- ")
-        end
-        {
-          title_intro: intro,
-          title_main: main,
-          title_part: part,
-          language: lang,
-          script: script,
-        }
-      end
-
       private
 
-      #
-      # Ovverides superclass's method
-      #
-      # @param ret [Hash]
-      def title_hash_to_bib(ret)
-        return unless ret[:title]
-
-        ret[:title] = array(ret[:title])
-        ret[:title] = ret[:title].reduce([]) do |a, t|
-          if t.is_a?(String)
-            a << split_title(t)
-          elsif t.is_a?(Hash) && t[:type]
-            idx = a.index { |i| i[:language] == t[:language] }
-            title_key = t[:type].sub("-", "_").to_sym
-            if idx
-              a[idx][title_key] = t[:content]
-              a
-            else
-              a << { title_key => t[:content], language: t[:language], script: t[:script] }
-            end
-          elsif t.is_a?(Hash) && t[:content]
-            a << split_title(t[:content], t[:language], t[:script])
-          end
-        end
-      end
-
       #
       # Ovverides superclass's method
       #
@@ -83,9 +16,9 @@ module RelatonIsoBib
       # Ovverides superclass's method
       #
       # @param title [Hash]
-      # @return [RelatonIsoBib::TypedTitleString]
+      # @return [RelatonBib::TypedTitleString]
       def typed_title_strig(title)
-        TypedTitleString.new title
+        RelatonBib::TypedTitleString.new title
       end
 
       # @param ret [Hash]

data/lib/relaton_iso_bib/ics.rb

@@ -7,7 +7,8 @@ module RelatonIsoBib
     # @param subgroup [Integer, NilClass]
     def initialize(code = nil, field: nil, group: nil, subgroup: nil)
       unless code || field
-        raise ArgumentError, "wrong arguments (should be string or { fieldcode: [String] }"
+        raise ArgumentError,
+              "wrong arguments (should be string or { fieldcode: [String] }"
       end
 
       field, group, subgroup = code.split "." if code
@@ -28,5 +29,17 @@ module RelatonIsoBib
       hash["code"] = code if code
       hash
     end
+
+    # @param prefix [String]
+    # @param count [Integer] number of ICS
+    # @return [String]
+    def to_asciibib(prefix = "", count = 1)
+      pref = prefix.empty? ? prefix : prefix + "."
+      pref += "ics"
+      out = count > 1 ? "#{pref}::\n" : ""
+      out += "#{pref}.code:: #{code}\n"
+      out += "#{pref}.description:: #{description}\n"
+      out
+    end
   end
 end

data/lib/relaton_iso_bib/iso_bibliographic_item.rb

@@ -3,7 +3,6 @@
 require "nokogiri"
 require "isoics"
 require "relaton_bib"
-require "relaton_iso_bib/typed_title_string"
 require "relaton_iso_bib/editorial_group"
 require "relaton_iso_bib/xml_parser"
 require "relaton_iso_bib/structured_identifier"
@@ -23,19 +22,19 @@ module RelatonIsoBib
   # Bibliographic item.
   class IsoBibliographicItem < RelatonBib::BibliographicItem
     TYPES = %w[
-      standard
       international-standard technical-specification technical-report
       publicly-available-specification international-workshop-agreement guide
+      amendment technical-corrigendum
     ].freeze
 
     # @return [RelatonIsoBib::StructuredIdentifier]
     attr_reader :structuredidentifier
 
     # @!attribute [r] title
-    #   @return [Array<RelatonIsoBib::TypedTitleString>]
+    #   @return [Array<RelatonBib::TypedTitleString>]
 
     # @return [String, NilClass]
-    attr_reader :doctype
+    attr_reader :doctype, :stagename
 
     # @return [RelatonIsoBib::EditorialGroup]
     attr_reader :editorialgroup
@@ -43,9 +42,6 @@ module RelatonIsoBib
     # @return [Array<RelatonIsoBib::Ics>]
     attr_reader :ics
 
-    # @return [TrueClass, FalseClass, NilClass]
-    attr_accessor :all_parts
-
     # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity
 
@@ -67,6 +63,7 @@ module RelatonIsoBib
     # @param validity [RelatonBib:Validity, NilClass]
     # @param docid [Array<RelatonBib::DocumentIdentifier>]
     # @param structuredidentifier [RelatonIsoBib::StructuredIdentifier]
+    # @param stagename [String, NilClass]
     #
     # @param title [Array<Hash>]
     # @option title [String] :title_intro
@@ -75,7 +72,7 @@ module RelatonIsoBib
     # @option title [String] :language
     # @option title [String] :script
     #
-    # @param editorialgroup [Hash, RelatonIsoBib::EditorialGroup, RelatonItu::EditorialGroup]
+    # @param editorialgroup [Hash, RelatonIsoBib::EditorialGroup]
     # @option workgrpup [String] :name
     # @option workgrpup [String] :abbreviation
     # @option workgrpup [String] :url
@@ -127,24 +124,23 @@ module RelatonIsoBib
     # @raise [ArgumentError]
     def initialize(**args)
       check_doctype args[:doctype]
-      # check_language args.fetch(:language, [])
-      # check_script args.fetch(:script, [])
 
       super_args = args.select do |k|
         %i[id docnumber language script docstatus date abstract contributor
            edition version relation biblionote series medium place copyright
            link fetched docid formattedref extent accesslocation classification
-           validity keyword].include? k
+           validity doctype keyword].include? k
       end
       super super_args
 
       @type = args[:type] || "standard"
 
-      @title = args.fetch(:title, []).reduce([]) do |a, t|
+      @title = args.fetch(:title, []).map do |t|
         if t.is_a? Hash
-          a + typed_titles(t)
+          # a + typed_titles(t)
+          RelatonBib::TypedTitleString.new t
         else
-          a << t
+          t
         end
       end
 
@@ -156,98 +152,29 @@ module RelatonIsoBib
       end
 
       @structuredidentifier = args[:structuredidentifier]
-      @doctype ||= args[:doctype]
+      # @doctype = args[:doctype] || "international-standard"
       @ics = args.fetch(:ics, []).map { |i| i.is_a?(Hash) ? Ics.new(i) : i }
+      @stagename = args[:stagename]
       @id_attribute = true
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/MethodLength, Metrics/PerceivedComplexity
-
-    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
-
-    def abstract=(value)
-      @abstract = value
-    end
-
-    def deep_clone
-      dump = Marshal.dump self
-      Marshal.load dump
-    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
-      self.disable_id_attribute
-      me.relation << RelatonBib::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
 
-    # @param lang [String] language code Iso639
-    # @return [Array<RelatonIsoBib::TypedTitleString>]
-    def title(lang: nil)
-      if lang
-        @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
-
-    # @return [String]
-    def to_xml(builder = nil, **opts, &block)
+    def to_xml(builder = nil, **opts)
       if opts[:note]&.any?
         opts.fetch(:note, []).each do |n|
           @biblionote << RelatonBib::BiblioNote.new(
-            content: n[:text], type: n[:type], format: "text/plain",
+            content: n[:text], type: n[:type], format: "text/plain"
           )
         end
       end
       super builder, **opts do |b|
         if opts[:bibdata] && (doctype || respond_to?(:committee) && committee ||
-          editorialgroup || ics.any? || structuredidentifier || block_given?)
+          editorialgroup || ics.any? || structuredidentifier || stagename ||
+          block_given?)
           b.ext do
             b.doctype doctype if doctype
             b.docsubtype docsubtype if respond_to?(:docsubtype) && docsubtype
-            # GB renders gbcommittee elements istead of an editorialgroup element.
+            # GB renders gbcommittee elements istead of an editorialgroup
             if respond_to? :committee
               committee&.to_xml b
             else
@@ -255,41 +182,33 @@ module RelatonIsoBib
             end
             ics.each { |i| i.to_xml b }
             structuredidentifier&.to_xml b
+            b.stagename stagename if stagename
             yield b if block_given?
           end
         end
       end
     end
 
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
     # @return [Hash]
     def to_hash
       hash = super
-      hash["editorialgroup"] = editorialgroup.to_hash if editorialgroup
-      hash["ics"] = single_element_array(ics) if ics&.any?
-      hash["structuredidentifier"] = structuredidentifier.to_hash if structuredidentifier
-      hash["doctype"] = doctype if doctype
+      hash["stagename"] = stagename if stagename
       hash
     end
 
-    private
-
-    # @param language [Array<String>]
-    # @raise ArgumentError
-    # def check_language(language)
-    #   language.each do |lang|
-    #     unless %w[en fr].include? lang
-    #       raise ArgumentError, "invalid language: #{lang}"
-    #     end
-    #   end
-    # end
+    # @param prefix [String]
+    # @return [String]
+    def to_asciibib(prefix = "")
+      pref = prefix.empty? ? prefix : prefix + "."
+      out = super
+      out += "#{pref}stagename:: #{stagename}\n" if stagename
+      out
+    end
 
-    # @param script [Array<String>]
-    # @raise ArgumentError
-    # def check_script(script)
-    #   script.each do |scr|
-    #     raise ArgumentError, "invalid script: #{scr}" unless scr == "Latn"
-    #   end
-    # end
+    private
 
     # @param doctype [String]
     # @raise ArgumentError
@@ -299,64 +218,17 @@ module RelatonIsoBib
       end
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-
-    # @param title [Hash]
-    # @option title [String] :title_intro
-    # @option title [String] :title_main
-    # @option title [String] :title_part
-    # @option title [String] :language
-    # @option title [String] :script
-    # @return [Array<RelatonIsoBib::TypedTitleStrig>]
-    def typed_titles(title)
-      titles = []
-      if title[:title_intro]
-        titles << TypedTitleString.new(
-          type: "title-intro", content: title[:title_intro],
-          language: title[:language], script: title[:script], format: "text/plain",
-        )
-      end
-
-      if title[:title_main]
-        titles << TypedTitleString.new(
-          type: "title-main", content: title[:title_main],
-          language: title[:language], script: title[:script], format: "text/plain",
-        )
-      end
-
-      if title[:title_part]
-        titles << TypedTitleString.new(
-          type: "title-part", content: title[:title_part],
-          language: title[:language], script: title[:script], format: "text/plain",
-        )
-      end
-
-      unless titles.empty?
-        titles << TypedTitleString.new(
-          type: "main", content: titles.map { |t| t.title.content }.join(" – "),
-          language: title[:language], script: title[:script], format: "text/plain",
-        )
-      end
-
-      titles
-    end
-
-    def makeid(id, attribute, _delim = "")
+    def makeid(id, attribute, _delim = "") # rubocop:disable Metrics/CyclomaticComplexity
       return nil if attribute && !@id_attribute
 
       id ||= @docidentifier.reject { |i| i&.type == "DOI" }[0]
-      # contribs = publishers.map { |p| p&.entity&.abbreviation }.join '/'
-      # idstr = "#{contribs}#{delim}#{id.project_number}"
-      # idstr = id.project_number.to_s
       if id
         idstr = id.id
         idstr = "IEV" if structuredidentifier&.project_number == "IEV"
       else
         idstr = formattedref&.content
       end
-      # if id.part_number&.size&.positive? then idstr += "-#{id.part_number}"
       idstr&.gsub(/:/, "-")&.gsub(/\s/, "")&.strip
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
   end
 end