relaton-bib 2.0.0.pre.alpha.1 → 2.0.0

data/lib/relaton/bib/item_data.rb

@@ -4,20 +4,46 @@ module Relaton
     # It needed to keep data fot different types of representations (bibitem, bibdata ...).
     # @TODO: remove this class when Lutaml Model will support transformation between different types of models.
     class ItemData
-      attr_accessor :id, :type, :schema_version, :fetched, :formattedref,
-                    :docidentifier, :docnumber, :date, :contributor, :edition,
-                    :version, :note, :language, :locale, :script, :status,
-                    :copyright, :series, :medium, :place, :price, :extent,
-                    :size, :accesslocation, :license, :classification,
-                    :keyword, :validity, :depiction, :ext # , :all_parts
-
-      attr_writer :title, :abstract, :source, :relation
+      include Core::ArrayWrapper
+      include NamespaceHelper
+
+      ATTRIBUTES = %i[
+        type schema_version fetched formattedref docnumber edition status
+        medium size validity ext
+      ].freeze
+      COLLECTION_ATTRBUTES = %i[
+        date contributor version note language locale script
+        copyright series place price extent accesslocation license
+        classification keyword depiction
+      ].freeze
+      COLLECTION_WRITE_ONLY_ATTRIBUTES = %i[title abstract source relation].freeze
+
+      ATTRIBUTES.each { |attr| attr_accessor attr }
+      COLLECTION_ATTRBUTES.each { |attr| attr_accessor attr }
+      COLLECTION_WRITE_ONLY_ATTRIBUTES.each { |attr| attr_writer attr }
+
+      attr_reader :id, :docidentifier
 
       def initialize(**args)
-        args.each do |k, v|
-          instance_variable_set("@#{k}", v) if respond_to?("#{k}=")
+        ATTRIBUTES.each { |attr| instance_variable_set("@#{attr}", args[attr]) }
+
+        (COLLECTION_ATTRBUTES + COLLECTION_WRITE_ONLY_ATTRIBUTES).each do |attr|
+          instance_variable_set("@#{attr}", args[attr] || [])
         end
+
+        @docidentifier = args[:docidentifier] || []
         self.schema_version = schema
+        @id = args[:id]
+        create_id
+      end
+
+      def id=(value)
+        @id = value if value
+      end
+
+      def docidentifier=(value)
+        @docidentifier = value || []
+        create_id
       end
 
       #
@@ -65,7 +91,13 @@ module Relaton
       end
 
       def create_id(without_date: false)
-        raise NotImplementedError, "`create_id` method not implemented in #{self.class}"
+        return id if id && !id.empty?
+
+        docid = find_primary_docid
+        return unless docid
+
+        pubid = without_date ? docid.content.sub(/:\d{4}$/, "") : docid.content
+        self.id = pubid.to_s.gsub(/\W+/, "")
       end
 
       def title(lang = nil)
@@ -94,36 +126,50 @@ module Relaton
 
       def to_xml(bibdata: false, **opts)
         add_notes opts[:note] do
-          bibdata ? Bibdata.to_xml(self) : Bibitem.to_xml(self)
+          bibdata ? namespace::Bibdata.to_xml(self) : namespace::Bibitem.to_xml(self)
         end
       end
 
       def to_yaml(**opts)
         add_notes opts[:note] do
-          Item.to_yaml(self)
+          namespace::Item.to_yaml(self)
         end
       end
 
       def to_json(**opts)
         add_notes opts[:note] do
-          Item.to_json(self)
+          namespace::Item.to_json(self)
+        end
+      end
+
+      def to_h(**opts)
+        add_notes opts[:note] do
+          namespace::Item.to_hash(self)
         end
       end
 
       def to_bibtex
-        Renderer::BibtexBuilder.build(self).to_s
+        Converter::Bibtex.from_item(self).to_s
+      end
+
+      def to_asciibib
+        Converter::Asciibib.from_item(self)
       end
 
       def to_rfcxml
-        Renderer::Rfc.transform(self).to_xml
+        Converter::BibXml.from_item(self).to_xml
       end
 
       def deep_clone
-        Item.from_yaml Item.to_yaml(self)
+        namespace::Item.from_yaml namespace::Item.to_yaml(self)
       end
 
       def create_relation(**args)
-        Relation.new(**args)
+        if defined?(namespace::Relation)
+          namespace::Relation.new(**args)
+        else
+          Relation.new(**args)
+        end
       end
 
       def delete_title_part!
@@ -145,22 +191,37 @@ module Relaton
 
         # some flavor modles have structuredidentifier as not an array
         # so we need to make it an array use common method
-        Relaton.array(ext.structuredidentifier).each(&:to_all_parts!)
+        array(ext.structuredidentifier).each(&:to_all_parts!)
       end
 
       def ext_remove_date
         return unless ext
 
-        Relaton.array(ext.structuredidentifier).each(&:remove_date!)
+        array(ext.structuredidentifier).each(&:remove_date!)
       end
 
       private
 
+      def find_primary_docid
+        prim_docids = docidentifier.select(&:primary)
+        case prim_docids.size
+        when 0 then find_primary_or_english_docid(docidentifier)
+        when 1 then prim_docids.first
+        else find_primary_or_english_docid(prim_docids)
+        end
+      end
+
+      def find_primary_or_english_docid(docids) # rubocop:disable Metrics/CyclomaticComplexity
+        docids.reject(&:language).first ||
+          docids.find { |i| i.language&.casecmp("en")&.zero? } ||
+          docids.first
+      end
+
       def add_notes(notes)
         self.note ||= []
-        Relaton.array(notes).each { |nt| note << Bib::Note.new(**nt) }
+        array(notes).each { |nt| note << Bib::Note.new(**nt) }
         result = yield
-        Relaton.array(notes).each { note.pop }
+        array(notes).each { note.pop }
         result
       end
     end

data/lib/relaton/bib/model/abstract.rb

@@ -0,0 +1,16 @@
+module Relaton
+  module Bib
+    class Abstract < LocalizedMarkedUpString
+      attribute :format, :string
+
+      xml do
+        root "abstract"
+        map_attribute "format", to: :format
+      end
+
+      key_value do
+        map "format", to: :format
+      end
+    end
+  end
+end

data/lib/relaton/bib/model/date.rb

@@ -1,3 +1,5 @@
+require_relative "type/string_date"
+
 module Relaton
   module Bib
     class Date < Lutaml::Model::Serializable
@@ -9,11 +11,11 @@ module Relaton
       attribute :text, :string
       choice(min: 1, max: 2) do
         choice(min: 1, max: 2) do
-          attribute :from, :string
-          attribute :to, :string
+          attribute :from, StringDate
+          attribute :to, StringDate
         end
-        # `on` is reserved word in YAML, so use `at` instead to avoid remapping key-value formats
-        attribute :at, :string
+        # `on` is reserved word in YAML, so we use `at` to avoid remapping key-value formats
+        attribute :at, StringDate
       end
 
       xml do

data/lib/relaton/bib/model/depiction.rb

@@ -2,11 +2,13 @@ module Relaton
   module Bib
     class Depiction < Lutaml::Model::Serializable
       attribute :scope, :string
+      attribute :type, :string
       attribute :image, Image, collection: true, initialize_empty: true
 
       xml do
         root "depiction"
         map_attribute "scope", to: :scope
+        map_attribute "type", to: :type
         map_element "image", to: :image
       end
     end

data/lib/relaton/bib/model/ext.rb

@@ -1,5 +1,4 @@
 require_relative "doctype"
-require_relative "editorial_group"
 require_relative "ics"
 require_relative "structured_identifier"
 
@@ -10,7 +9,6 @@ module Relaton
       attribute :doctype, Doctype
       attribute :subdoctype, :string
       attribute :flavor, :string
-      attribute :editorialgroup, EditorialGroup
       attribute :ics, ICS, collection: true, initialize_empty: true
       attribute :structuredidentifier, StructuredIdentifier, collection: true, initialize_empty: true
 
@@ -20,7 +18,6 @@ module Relaton
         map_element "doctype", to: :doctype
         map_element "subdoctype", to: :subdoctype
         map_element "flavor", to: :flavor
-        map_element "editorialgroup", to: :editorialgroup
         map_element "ics", to: :ics
         map_element "structuredidentifier", to: :structuredidentifier
       end

data/lib/relaton/bib/model/formattedref.rb

@@ -0,0 +1,43 @@
+module Relaton
+  module Bib
+    class Formattedref < LocalizedMarkedUpString
+      attribute :format, :string
+
+      xml do
+        root "formattedref"
+        map_attribute "format", to: :format
+      end
+
+      key_value do
+        map "format", to: :format
+      end
+
+      # Handle plain string input from YAML/JSON deserialization
+      def self.from_yaml(value)
+        return new(content: value) if value.is_a?(String)
+
+        super
+      end
+
+      def self.from_json(value)
+        return new(content: value) if value.is_a?(String)
+
+        super
+      end
+
+      # Serialize as plain string when only content is present
+      def self.as(format, instance, options = {})
+        return instance.content if simple_content?(instance, format)
+
+        super
+      end
+
+      def self.simple_content?(instance, format)
+        return false if format == :xml
+
+        instance.format.nil? && instance.language.nil? &&
+          instance.script.nil? && instance.locale.nil?
+      end
+    end
+  end
+end

data/lib/relaton/bib/model/ics.rb

@@ -1,3 +1,5 @@
+require "isoics"
+
 module Relaton
   module Bib
     class ICS < Lutaml::Model::Serializable
@@ -9,6 +11,13 @@ module Relaton
         map_element "code", to: :code
         map_element "text", to: :text
       end
+
+      def text
+        val = @text
+        return val if val && !val.empty?
+
+        Isoics.fetch(code)&.description if code
+      end
     end
   end
 end

data/lib/relaton/bib/model/item.rb

@@ -2,6 +2,8 @@ require "lutaml/model"
 require "lutaml/model/xml_adapter/nokogiri_adapter"
 require_relative "localized_string_attrs"
 require_relative "localized_string"
+require_relative "formattedref"
+require_relative "abstract"
 require_relative "date"
 require_relative "locality"
 require_relative "locality_stack"
@@ -46,6 +48,8 @@ module Relaton
 
     # Item class repesents bibliographic item metadata.
     class Item < Lutaml::Model::Serializable
+      attr_accessor :type # in some cases mehod type is unavailable
+
       model ItemData
 
       attribute :id, :string
@@ -55,9 +59,9 @@ module Relaton
         graphic_work music patent inbook incollection inproceedings journal website
         webresource dataset archival social_media alert message convesation misc
       ]
-      attribute :schema_version, :string
+      attribute :schema_version, method: :get_schema_version
       attribute :fetched, :date
-      attribute :formattedref, :string, raw: true
+      attribute :formattedref, Formattedref
       attribute :title, Title, collection: true, initialize_empty: true
       attribute :source, Uri, collection: true, initialize_empty: true
       attribute :docidentifier, Docidentifier, collection: true, initialize_empty: true
@@ -70,7 +74,7 @@ module Relaton
       attribute :language, :string, collection: true, initialize_empty: true
       attribute :locale, :string, collection: true, initialize_empty: true
       attribute :script, :string, collection: true, initialize_empty: true
-      attribute :abstract, LocalizedMarkedUpString, collection: true, initialize_empty: true
+      attribute :abstract, Abstract, collection: true, initialize_empty: true
       attribute :status, Status
       attribute :copyright, Copyright, collection: true, initialize_empty: true
       attribute :relation, Relation, collection: true, initialize_empty: true
@@ -85,7 +89,7 @@ module Relaton
       attribute :classification, Docidentifier, collection: true, initialize_empty: true
       attribute :keyword, Keyword, collection: true, initialize_empty: true
       attribute :validity, Validity
-      attribute :depiction, Depiction
+      attribute :depiction, Depiction, collection: true, initialize_empty: true
       attribute :ext, Ext
 
       xml do # rubocop:disable Metrics/BlockLength
@@ -124,6 +128,10 @@ module Relaton
         map_element "depiction", to: :depiction
         map_element "ext", to: :ext
       end
+
+      def get_schema_version
+        Relaton.schema_versions["relaton-models"]
+      end
     end
   end
 end

data/lib/relaton/bib/model/item_base.rb

@@ -1,19 +1,27 @@
 module Relaton
   module Bib
+    # Module to remove id, schema-version, fetched & ext attributes from Item subclasses.
+    # Used for bibitem/relation instances that don't need these attributes.
+    module ItemBaseAttributes
+      def self.included(base)
+        # we don't need id, schema-version & fetched attributes in relation/bibitem
+        base.mappings[:xml].instance_variable_get(:@attributes).delete("id")
+        base.mappings[:xml].instance_variable_get(:@attributes).delete("schema-version")
+        base.mappings[:xml].instance_variable_get(:@elements).delete("fetched")
+        base.mappings[:xml].instance_variable_get(:@elements).delete("ext")
+        base.attributes.delete :id
+        base.attributes.delete :schema_version
+        base.attributes.delete :fetched
+        base.attributes.delete :ext
+      end
+    end
+
     # The class is for relaton bibitem instances.
     # The in relaton bibitem instances dosn't have schema-version & fetched attributes.
     class ItemBase < Item
       model ItemData
 
-      # we don't need id, schema-version & fetched attributes in reation/bibitem
-      mappings[:xml].instance_variable_get(:@attributes).delete("id")
-      mappings[:xml].instance_variable_get(:@attributes).delete("schema-version")
-      mappings[:xml].instance_variable_get(:@elements).delete("fetched")
-      mappings[:xml].instance_variable_get(:@elements).delete("ext")
-      attributes.delete :id
-      attributes.delete :schema_version
-      attributes.delete :fetched
-      attributes.delete :ext
+      include ItemBaseAttributes
     end
   end
 end

data/lib/relaton/bib/model/keyword.rb

@@ -15,9 +15,9 @@ module Relaton
         end
       end
 
-      attribute :vocab, LocalizedString, collection: true, initialize_empty: true
-      attribute :taxon, LocalizedString, collection: (1..), initialize_empty: true
-      attribute :vocabid, Vocabid
+      attribute :vocab, LocalizedString
+      attribute :taxon, LocalizedString, collection: true, initialize_empty: true
+      attribute :vocabid, Vocabid, collection: true, initialize_empty: true
 
       xml do
         root "keyword"

data/lib/relaton/bib/model/logo.rb

@@ -1,10 +1,12 @@
 module Relaton
   module Bib
     class Logo < Lutaml::Model::Serializable
+      attribute :type, :string
       attribute :image, Image
 
       xml do
         root "logo"
+        map_attribute "type", to: :type
         map_element "image", to: :image
       end
     end

data/lib/relaton/bib/model/organization_type.rb

@@ -22,7 +22,7 @@ module Relaton
           attribute :subdivision, Subdivision, collection: true, initialize_empty: true
           attribute :abbreviation, LocalizedString
           attribute :identifier, Identifier, collection: true, initialize_empty: true
-          attribute :logo, Logo
+          attribute :logo, Logo, collection: true, initialize_empty: true
 
           xml do
             map_element "name", to: :name

data/lib/relaton/bib/model/relation.rb

@@ -9,8 +9,8 @@ module Relaton
         hasManifestation reproductionOf hasReproduction reprintOf hasReprint
         expressionOf hasExpression translatedFrom hasTranslation arrangementOf
         hasArrangement abridgementOf hasAbridgement annotationOf hasAnnotation
-        draftOfhasDraft preliminaryDraftOf hasPreliminaryDraft revisionDraftOf
-        hasRevisionDraft editionOf hasEdition updates updatedBy derivedFrom
+        draftOf hasDraft predecessorDraftOf hasPredecessorDraft successorDraftOf
+        hasSuccessorDraft editionOf hasEdition updates updatedBy derivedFrom
         derives describes describedBy catalogues cataloguedBy hasSuccessor
         successorOf adaptedFrom hasAdaptation adoptedFrom adoptedAs reviewOf
         hasReview commentaryOf hasCommentary related hasComplement complementOf

data/lib/relaton/bib/model/series.rb

@@ -1,14 +1,16 @@
+require_relative "type/string_date"
+
 module Relaton
   module Bib
     class Series < Lutaml::Model::Serializable
       attribute :type, :string, values: %w[main alt]
-      attribute :formattedref, :string, raw: true
+      attribute :formattedref, Formattedref
       attribute :title, Title, collection: (1..)
       attribute :place, Place
       attribute :organization, :string
       attribute :abbreviation, LocalizedString
-      attribute :from, :date
-      attribute :to, :date
+      attribute :from, StringDate
+      attribute :to, StringDate
       attribute :number, :string
       attribute :partnumber, :string
       attribute :run, :string

data/lib/relaton/bib/model/subdivision.rb

@@ -4,10 +4,12 @@ module Relaton
       include OrganizationType
 
       attribute :type, :string
+      attribute :subtype, :string
 
       xml do
         root "subdivision"
         map_attribute "type", to: :type
+        map_attribute "subtype", to: :subtype
       end
     end
   end

data/lib/relaton/bib/model/title.rb

@@ -13,6 +13,44 @@ module Relaton
         map "type", to: :type
         map "format", to: :format
       end
+
+      class << self
+        def from_string(title, lang = nil, script = nil)
+          types = %w[title-intro title-main title-part]
+          ttls = split_title(title)
+          tts = ttls.map.with_index do |p, i|
+            next unless p
+
+            new type: types[i], content: p, language: lang, script: script
+          end.compact
+          tts << new(type: "main", content: ttls.compact.join(" - "), language: lang, script: script)
+          tts
+        end
+
+        private
+
+        # @param title [String]
+        # @return [Array<String, nil>]
+        def split_title(title)
+          ttls = title.sub(/\w\.Imp\s?\d+\u00A0:\u00A0/, "").split " - "
+          case ttls.size
+          when 0, 1 then [nil, ttls.first.to_s, nil]
+          else intro_or_part ttls
+          end
+        end
+
+        # @param ttls [Array<String>]
+        # @return [Array<String, nil>]
+        def intro_or_part(ttls)
+          if /^(Part|Partie) \d+:/.match? ttls[1]
+            [nil, ttls[0], ttls[1..].join(" -- ")]
+          else
+            parts = ttls.slice(2..-1)
+            part = parts.join " -- " if parts.any?
+            [ttls[0], ttls[1], part]
+          end
+        end
+      end
     end
   end
 end

data/lib/relaton/bib/model/type/string_date.rb

@@ -0,0 +1,48 @@
+require "forwardable"
+
+module Relaton
+  module Bib
+    class StringDate < Lutaml::Model::Type::Value
+      class Value
+        include Comparable
+        extend Forwardable
+        extend Core::DateParser
+        include Core::DateParser
+
+        def_delegators :@value, :split, :to_s
+
+        def initialize(value)
+          @value = value
+        end
+
+        def self.parse_date(date)
+          value = super
+          new value if value
+        end
+
+        def <=>(other)
+          return nil unless other.is_a?(Value)
+
+          @value <=> other.to_s
+        end
+
+        def to_date
+          parse_date(@value, str: false)
+        rescue ArgumentError
+          nil
+        end
+      end
+
+      def self.cast(value)
+        case value
+        when Value then value
+        when String then Value.parse_date(value)
+        end
+      end
+
+      def to_yaml
+        value.to_s
+      end
+    end
+  end
+end

data/lib/relaton/bib/model/validity.rb

@@ -1,9 +1,9 @@
 module Relaton
   module Bib
     class Validity < Lutaml::Model::Serializable
-      attribute :begins, :date
-      attribute :ends, :date
-      attribute :revision, :date
+      attribute :begins, :date_time
+      attribute :ends, :date_time
+      attribute :revision, :date_time
 
       xml do
         root "validity"

data/lib/relaton/bib/namespace_helper.rb

@@ -0,0 +1,21 @@
+module Relaton
+  module Bib
+    module NamespaceHelper
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def namespace
+          @namespace = Object.const_get name.split("::")[0..1].join("::")
+        end
+      end
+
+      private
+
+      def namespace
+        self.class.namespace
+      end
+    end
+  end
+end

data/lib/relaton/bib/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Bib
-    VERSION = "2.0.0-alpha.1".freeze
+    VERSION = "2.0.0".freeze
   end
 end