relaton-iso-bib 0.1.0

data/README.md

@@ -0,0 +1,39 @@
+# RelatonIsoBib
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/relaton_iso_bib`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'relaton_iso_bib'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install relaton_iso_bib
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/relaton_iso_bib.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "relaton_iso_bib"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/relaton_iso_bib/editorial_group.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module RelatonIsoBib
+  # ISO project group.
+  class EditorialGroup
+    # @return [Array<RelatonIsoBib::IsoSubgroup>]
+    attr_reader :technical_committee
+
+    # @return [RelatonIsoBib::IsoSubgroup]
+    attr_reader :subcommittee
+
+    # @return [RelatonIsoBib::IsoSubgroup]
+    attr_reader :workgroup
+
+    # @return [String]
+    attr_reader :secretariat
+
+    # @param technical_committee [Array<Hash, RelatonIsoBib::IsoSubgroup>]
+    # @option technical_committee [String] :name
+    # @option technical_committee [String] :type
+    # @option technical_committee [Integer] :number
+    #
+    # @param subcommittee [Array<Hash, RelatonIsoBib::IsoSubgroup>]
+    # @option subcommittee [String] :name
+    # @option subcommittee [String] :type
+    # @option subcommittee [Integer] :number
+    #
+    # @param workgroup [Array<Hash, RelatonIsoBib::IsoSubgroup>]
+    # @option workgroup [String] :name
+    # @option workgroup [String] :type
+    # @option workgroup [Integer] :number
+    #
+    # @param secretariat [String, NilClass]
+    def initialize(technical_committee:, **args)
+      @technical_committee = technical_committee.map do |tc|
+        tc.is_a?(Hash) ? IsoSubgroup.new(tc) : tc
+      end
+      @subcommittee = args.fetch(:subcommittee, []).map do |sc|
+        sc.is_a?(Hash) ? IsoSubgroup.new(sc) : sc
+      end
+      @workgroup = args.fetch(:workgroup, []).map do |wg|
+        wg.is_a?(Hash) ? IsoSubgroup.new(wg) : wg
+      end
+      @secretariat = args[:secretariat]
+    end
+
+    # rubocop:disable Metrics/AbcSize
+
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      return unless technical_committee || subcommittee || workgroup || secretariat
+      builder.editorialgroup do
+        technical_committee.each do |tc|
+          builder.technical_committee { tc.to_xml builder }
+        end
+        subcommittee.each do |sc|
+          builder.subcommittee { sc.to_xml builder }
+        end
+        workgroup.each do |wg|
+          builder.workgroup { wg.to_xml builder }
+        end
+        builder.secretariat secretariat if secretariat
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+
+  # ISO subgroup.
+  class IsoSubgroup
+    # @return [String, NilClass]
+    attr_reader :type
+
+    # @return [Integer, NilClass]
+    attr_reader :number
+
+    # @return [String]
+    attr_reader :name
+
+    # @param name [String]
+    # @param type [String, NilClass]
+    # @param number [Integer, NilClass]
+    def initialize(name:, type: nil, number: nil)
+      @name   = name
+      @type   = type
+      @number = number
+    end
+
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      builder.parent[:number] = number if number
+      builder.parent[:type] = type if type
+      builder.text name
+    end
+  end
+end

data/lib/relaton_iso_bib/ics.rb

@@ -0,0 +1,25 @@
+module RelatonIsoBib
+  # Iso ICS classificator.
+  class Ics < Isoics::ICS
+    # @param code [String, NilClass]
+    # @param field [Integer, NilClass]
+    # @param group [Integer, NilClass]
+    # @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] }"
+      end
+
+      field, group, subgroup = code.split '.' if code
+      super fieldcode: field, groupcode: group, subgroupcode: subgroup
+    end
+
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      builder.ics do
+        builder.code code
+        builder.text_ description
+      end
+    end
+  end
+end

data/lib/relaton_iso_bib/iso_bibliographic_item.rb

@@ -0,0 +1,357 @@
+# frozen_string_literal: false
+
+require "nokogiri"
+require "isoics"
+require "deep_clone"
+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"
+require "relaton_iso_bib/ics"
+
+# Add filter method to Array.
+class Array
+  # @param type [String]
+  # @return [Array]
+  def filter(type:)
+    select { |e| e.type == type }
+  end
+end
+
+module RelatonIsoBib
+  # Bibliographic item.
+  class IsoBibliographicItem < RelatonBib::BibliographicItem
+    TYPES = %w[
+      international-standard technical-specification technical-report
+      publicly-available-specification international-workshop-agreement guide
+    ].freeze
+
+    # @return [RelatonIsoBib::StructuredIdentifier]
+    attr_reader :structuredidentifier
+
+    # @!attribute [r] title
+    #   @return [Array<RelatonIsoBib::TypedTitleString>]
+
+    # @return [String, NilClass]
+    attr_reader :doctype
+
+    # @return [RelatonIsoBib::EditorialGroup]
+    attr_reader :editorialgroup
+
+    # @return [Array<RelatonIsoBib::Ics>]
+    attr_reader :ics
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity
+
+    # @param edition [String]
+    # @param docnumber [String, NilClass]
+    # @param language [Array<String>]
+    # @param script [Arrra<String>]
+    # @param docstatus [RelatonBib::DocumentStatus, NilClass]
+    # @param type [String, NilClass]
+    # @param formattedref [RelatonBib::FormattedRef, NilClass]
+    # @param version [RelatonBib::BibliographicItem::Version, NilClass]
+    # @param biblionote [Array<RelatonBib::BiblioNote>]
+    # @param series [Array<RelatonBib::Series>]
+    # @param medium [RelatonBib::Medium, NilClas]
+    # @param place [Array<String>]
+    # @param extent [Array<Relaton::BibItemLocality>]
+    # @param accesslocation [Array<String>]
+    # @param classification [RelatonBib::Classification, NilClass]
+    # @param validity [RelatonBib:Validity, NilClass]
+    # @param docid [Array<RelatonBib::DocumentIdentifier>]
+    # @param structuredidentifier [RelatonIsoBib::StructuredIdentifier]
+    #
+    # @param titles [Array<Hash>]
+    # @option titles [String] :title_intro
+    # @option titles [String] :title_main
+    # @option titles [String] :title_part
+    # @option titles [String] :language
+    # @option titles [String] :script
+    #
+    # @param editorialgroup [Hash, RelatonIsoBib::EditorialGroup]
+    # @option workgrpup [String] :name
+    # @option workgrpup [String] :abbreviation
+    # @option workgrpup [String] :url
+    # @option workgrpup [Hash] :technical_committee
+    # @option technical_committee [String] :name
+    # @option technical_committee [String] :type
+    # @option technical_committee [Integer] :number
+    #
+    # @param ics [Array<Hash>]
+    # @option ics [Integer] :field
+    # @option ics [Integer] :group
+    # @option ics [Integer] :subgroup
+    #
+    # @param dates [Array<Hash>]
+    # @option dates [String] :type
+    # @option dates [String] :from
+    # @option dates [String] :to
+    #
+    # @param abstract [Array<Hash>]
+    # @option abstract [String] :content
+    # @option abstract [String] :language
+    # @option abstract [String] :script
+    # @option abstract [String] :type
+    #
+    # @param contributors [Array<Hash>]
+    # @option contributors [Hash] :entity
+    # @option entity [String] :name
+    # @option entity [String] :url
+    # @option entity [String] :abbreviation
+    # @option contributors [Array<String>] :roles
+    #
+    # @param copyright [Hash]
+    # @option copyright [Hash] :owner
+    # @option owner [String] :name
+    # @option owner [String] :abbreviation
+    # @option owner [String] :url
+    # @option copyright [String] :from
+    # @option copyright [String] :to
+    #
+    # @param link [Array<Hash, RelatonIsoBib::TypedUri>]
+    # @option link [String] :type
+    # @option link [String] :content
+    #
+    # @param relations [Array<Hash>]
+    # @option relations [String] :type
+    # @option relations [RelatonIsoBib::IsoBibliographicItem] :bibitem
+    # @option relations [Array<RelatonBib::BibItemLocality>] :bib_locality
+    #
+    # @raise [ArgumentError]
+    def initialize(**args)
+      if args[:type] && !TYPES.include?(args[:type])
+        raise ArgumentError, "invalid type: #{args[:type]}"
+      end
+
+      args.fetch(:language, []).each do |lang|
+        unless %w[en fr].include? lang
+          raise ArgumentError, "invalid language: #{lang}"
+        end
+      end
+
+      args.fetch(:script, []).each do |scr|
+        raise ArgumentError, "invalid script: #{scr}" unless scr == "Latn"
+      end
+
+      super_args = args.select do |k|
+        %i[id docnumber language script docstatus dates abstract contributors
+           edition version relations biblionote series medium place copyright
+           link fetched docid formattedref extent accesslocation classification
+           validity].include? k
+      end
+      super(super_args)
+
+      @structuredidentifier = args[:structuredidentifier]
+
+      @title = args.fetch(:titles, []).reduce([]) do |a, t|
+        if t.is_a? Hash
+          a + typed_titles(t)
+        else
+          a << t
+        end
+      end
+
+      if args[:editorialgroup]
+        @editorialgroup = if args[:editorialgroup].is_a?(Hash)
+                            EditorialGroup.new(args[:editorialgroup])
+                          else args[:editorialgroup]
+                          end
+      end
+
+      @doctype = args[:type]
+      @ics = args.fetch(:ics, []).map { |i| i.is_a?(Hash) ? Ics.new(i) : i }
+      @link = args.fetch(:link, []).map do |s|
+        s.is_a?(Hash) ? RelatonBib::TypedUri.new(s) : s
+      end
+      @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 = DeepClone.clone(self)
+      me.disable_id_attribute
+      @relations << RelatonBib::DocumentRelation.new(
+        type: "partOf", bibitem: me,
+      )
+      @title.delete_if { |t| t.type == "title-part" }
+      @abstract = []
+      @docidentifier.each(&:remove_part)
+      @docidentifier.each(&:all_parts)
+      @structuredidentifier.remove_part
+      @structuredidentifier.all_parts
+      @all_parts = true
+    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 = DeepClone.clone(self)
+      me.disable_id_attribute
+      @relations << RelatonBib::DocumentRelation.new(type: "instance", bibitem: me)
+      @abstract = []
+      @dates = []
+      @docidentifier.each &:remove_date
+      @structuredidentifier.remove_date
+      @id&.sub! /-[12]\d\d\d/, ""
+    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)
+      if opts[:note] && !opts[:note].empty?
+        opts.fetch(:note, []).each do |n|
+          @biblionote << RelatonBib::BiblioNote.new(
+            content: n[:text], type: n[:type], format: "text/plain"
+          )
+        end
+      end
+      super builder, **opts do |b|
+        if opts[:bibdata]
+          b.ext do
+            b.doctype doctype if doctype
+            editorialgroup&.to_xml b
+            ics.each { |i| i.to_xml b }
+            structuredidentifier.to_xml b
+          end
+        end
+      end
+    end
+
+    private
+
+    # 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_main]
+        titles << TypedTitleString.new(
+          type: "title-main", content: title[:title_main],
+          language: title[:language], script: title[:script], format: "text/plain",
+        )
+      end
+
+      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_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
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    def makeid(id, attribute, _delim = '')
+      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
+
+    # def xml_attrs(type)
+    #   attrs = {}
+    #   attrs[:type] = type if type
+    #   # attr_id = makeid(nil, true)&.gsub(/ /, "")
+    #   # attrs[:id] = attr_id if attr_id
+    #   attrs
+    # end
+
+    # @param builder [Nokogiri::XML::Builder]
+    # def render_xml(builder, **opts)
+    #   builder.send("iso-standard", xml_attrs(type)) do
+    #     builder.fetched fetched if fetched
+    #     formattedref.to_xml builder if formattedref
+    #     title.each { |t| t.to_xml builder }
+    #     link.each { |s| s.to_xml builder }
+    #     docidentifier.each { |i| i.to_xml builder }
+    #     builder.docnumber docnumber if docnumber
+    #     dates.each { |d| d.to_xml builder, opts }
+    #     contributors.each do |c|
+    #       builder.contributor do
+    #         c.role.each { |r| r.to_xml builder }
+    #         c.to_xml builder
+    #       end
+    #     end
+    #     builder.edition edition if edition
+    #     version.to_xml builder if version
+    #     if opts[:note]
+    #       builder.note("ISO DATE: #{opts[:note]}", format: 'text/plain')
+    #     end
+    #     language.each { |l| builder.language l }
+    #     script.each { |s| builder.script s }
+    #     abstract.each { |a| builder.abstract { a.to_xml(builder) } }
+    #     status.to_xml builder if status
+    #     copyright.to_xml builder if copyright
+    #     relations.each { |r| r.to_xml builder }
+    #     series.each { |s| s.to_xml builder } if series
+    #     medium.to_xml builder if medium
+    #     place.each { |pl| builder.place pl }
+    #     extent.each { |e| e.to_xml builder }
+    #     accesslocation.each { |al| builder.accesslocation al }
+    #     classification.to_xml builder if classification
+    #     validity.to_xml builder if validity
+    #     editorialgroup.to_xml builder if editorialgroup
+    #     ics.each { |i| i.to_xml builder }
+    #     builder.allparts 'true' if @all_parts
+    #     yield(builder) if block_given?
+    #   end
+    # end
+  end
+end