genericode 0.1.0 → 0.1.2

data/lib/genericode/column_set_ref.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 require_relative "annotation"
 
 module Genericode
-  class ColumnSetRef < Shale::Mapper
+  class ColumnSetRef < Lutaml::Model::Serializable
     attribute :annotation, Annotation
-    attribute :canonical_version_uri, Shale::Type::String
-    attribute :location_uri, Shale::Type::String, collection: true
+    attribute :canonical_version_uri, :string
+    attribute :location_uri, :string, collection: true
 
     json do
       map "Annotation", to: :annotation

data/lib/genericode/data.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 require_relative "annotation"
 require_relative "datatype_facet"
 
 module Genericode
-  class Data < Shale::Mapper
-    attribute :type, Shale::Type::String
-    attribute :datatype_library, Shale::Type::String
-    attribute :lang, Shale::Type::String
+  class Data < Lutaml::Model::Serializable
+    attribute :type, :string
+    attribute :datatype_library, :string
+    attribute :lang, :string
     attribute :annotation, Annotation
     attribute :parameter, DatatypeFacet, collection: true
 

data/lib/genericode/data_restrictions.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 require_relative "datatype_facet"
 
 module Genericode
-  class DataRestrictions < Shale::Mapper
-    attribute :lang, Shale::Type::String
+  class DataRestrictions < Lutaml::Model::Serializable
+    attribute :lang, :string
     attribute :parameter, DatatypeFacet, collection: true
 
     json do

data/lib/genericode/datatype_facet.rb

@@ -1,17 +1,20 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
+require_relative "json/short_name_mixin"
 
 module Genericode
-  class DatatypeFacet < Shale::Mapper
-    attribute :content, Shale::Type::String
-    attribute :short_name, Shale::Type::String
-    attribute :long_name, Shale::Type::String
+  class DatatypeFacet < Lutaml::Model::Serializable
+    include Json::ShortNameMixin
+
+    attribute :content, :string
+    attribute :short_name, :string
+    attribute :long_name, :string
 
     json do
-      map "_", to: :content
-      map "ShortName", to: :short_name
+      map "ShortName", to: :short_name, with: { from: :short_name_from_json, to: :short_name_to_json }
       map "LongName", to: :long_name
+      map "_", to: :content
     end
 
     xml do

data/lib/genericode/general_identifier.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 module Genericode
-  class GeneralIdentifier < Shale::Mapper
-    attribute :content, Shale::Type::String
-    attribute :identifier, Shale::Type::String
-    attribute :lang, Shale::Type::String
+  class GeneralIdentifier < Lutaml::Model::Serializable
+    attribute :content, :string
+    attribute :identifier, :string
+    attribute :lang, :string
 
     json do
-      map "_", to: :content
       map "Identifier", to: :identifier
       map "lang", to: :lang
+      map "_", to: :content
     end
 
     xml do

data/lib/genericode/identification.rb

@@ -1,34 +1,76 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 require_relative "agency"
 require_relative "long_name"
 require_relative "mime_typed_uri"
+require_relative "canonical_uri"
 require_relative "short_name"
+require_relative "json/short_name_mixin"
+require_relative "json/canonical_uri_mixin"
+require_relative "utils"
 
 module Genericode
-  class Identification < Shale::Mapper
+  class Identification < Lutaml::Model::Serializable
+    include Json::CanonicalUriMixin
+    include Json::ShortNameMixin
+
     attribute :short_name, ShortName
     attribute :long_name, LongName, collection: true
-    attribute :version, Shale::Type::String
-    attribute :canonical_uri, Shale::Type::String
-    attribute :canonical_version_uri, Shale::Type::String
-    attribute :location_uri, Shale::Type::String, collection: true
+    attribute :version, :string
+    attribute :canonical_uri, CanonicalUri
+    attribute :canonical_version_uri, :string
+    attribute :location_uri, :string, collection: true
     attribute :alternate_format_location_uri, MimeTypedUri, collection: true
     attribute :agency, Agency
 
     json do
-      map "ShortName", to: :short_name
-      map "LongName", to: :long_name
+      map "ShortName", to: :short_name, with: { from: :short_name_from_json, to: :short_name_to_json }
+      map "LongName", to: :long_name, with: { from: :long_name_from_json, to: :long_name_to_json }
       map "Version", to: :version
-      map "CanonicalUri", to: :canonical_uri
+      map "CanonicalUri", to: :canonical_uri, with: { from: :canonical_uri_from_json, to: :canonical_uri_to_json }
       map "CanonicalVersionUri", to: :canonical_version_uri
-      map "LocationUri", to: :location_uri
-      map "AlternateFormatLocationUri", to: :alternate_format_location_uri
+      map "LocationUri", to: :location_uri, with: { from: :location_uri_from_json, to: :location_uri_to_json }
+      map "AlternateFormatLocationUri", to: :alternate_format_location_uri,
+                                        with: { from: :alternate_format_location_uri_from_json,
+                                                to: :alternate_format_location_uri_to_json, }
       map "Agency", to: :agency
     end
 
+    def long_name_from_json(model, value)
+      model.long_name = LongName.of_json(value)
+    end
+
+    def long_name_to_json(model, doc)
+      return if model.long_name.empty?
+
+      doc["LongName"] = LongName.as_json(model.long_name)
+    end
+
+    def location_uri_from_json(model, value)
+      # model.location_uri = Shale::Type::String.of_json(Utils.array_wrap(value))
+      model.location_uri = Utils.array_wrap(value).map do |val|
+        Lutaml::Model::Type::String.cast(val)
+      end
+    end
+
+    def location_uri_to_json(model, doc)
+      return if model.location_uri.empty?
+
+      doc["LocationUri"] = Lutaml::Model::Type::String.cast(Utils.one_or_all(model.location_uri))
+    end
+
+    def alternate_format_location_uri_from_json(model, value)
+      model.alternate_format_location_uri = MimeTypedUri.of_json(Utils.array_wrap(value))
+    end
+
+    def alternate_format_location_uri_to_json(model, doc)
+      return if model.alternate_format_location_uri.empty?
+
+      doc["AlternateFormatLocationUri"] = MimeTypedUri.as_json(Utils.one_or_all(model.alternate_format_location_uri))
+    end
+
     xml do
       root "Identification"
       namespace "http://docs.oasis-open.org/codelist/ns/genericode/1.0/", "gc"

data/lib/genericode/json/canonical_uri_mixin.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Genericode
+  module Json
+    module CanonicalUriMixin
+      def canonical_uri_from_json(model, value)
+        model.canonical_uri = CanonicalUri.new(content: value) if value
+      end
+
+      def canonical_uri_to_json(model, doc)
+        return if model.canonical_uri.nil?
+
+        doc["CanonicalUri"] = model.canonical_uri&.content
+      end
+    end
+  end
+end

data/lib/genericode/json/short_name_mixin.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Genericode
+  module Json
+    module ShortNameMixin
+      def short_name_from_json(model, value)
+        model.short_name = ShortName.new(content: value) if value
+      end
+
+      def short_name_to_json(model, doc)
+        return if model.short_name.nil?
+
+        doc["ShortName"] = model.short_name.content
+      end
+    end
+  end
+end

data/lib/genericode/key.rb

@@ -1,30 +1,55 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 require_relative "annotation"
 require_relative "key_column_ref"
+require_relative "canonical_uri"
 require_relative "long_name"
 require_relative "short_name"
+require_relative "json/short_name_mixin"
+require_relative "json/canonical_uri_mixin"
+require_relative "utils"
 
 module Genericode
-  class Key < Shale::Mapper
-    attribute :id, Shale::Type::String
+  class Key < Lutaml::Model::Serializable
+    include Json::CanonicalUriMixin
+    include Json::ShortNameMixin
+
+    attribute :id, :string
     attribute :annotation, Annotation
     attribute :short_name, ShortName
     attribute :long_name, LongName, collection: true
-    attribute :canonical_uri, Shale::Type::String
-    attribute :canonical_version_uri, Shale::Type::String
+    attribute :canonical_uri, CanonicalUri
+    attribute :canonical_version_uri, :string
     attribute :column_ref, KeyColumnRef, collection: true
 
     json do
       map "Id", to: :id
       map "Annotation", to: :annotation
-      map "ShortName", to: :short_name
-      map "LongName", to: :long_name
-      map "CanonicalUri", to: :canonical_uri
+      map "ShortName", to: :short_name, with: { from: :short_name_from_json, to: :short_name_to_json }
+      map "LongName", to: :long_name, with: { from: :long_name_from_json, to: :long_name_to_json }
+      map "CanonicalUri", to: :canonical_uri, with: { from: :canonical_uri_from_json, to: :canonical_uri_to_json }
       map "CanonicalVersionUri", to: :canonical_version_uri
-      map "ColumnRef", to: :column_ref
+      map "ColumnRef", to: :column_ref, with: { from: :column_ref_from_json, to: :column_ref_to_json }
+    end
+
+    def long_name_from_json(model, value)
+      model.long_name = LongName.of_json(value)
+    end
+
+    def long_name_to_json(model, doc)
+      return if model.long_name.empty?
+
+      doc["LongName"] = LongName.as_json(model.long_name)
+    end
+
+    def column_ref_from_json(model, value)
+      model.column_ref = Utils.array_wrap(value).map { |n| KeyColumnRef.new(ref: n) }
+    end
+
+    def column_ref_to_json(model, doc)
+      doc["ColumnRef"] = Utils.one_or_all(model.column_ref.map(&:ref))
     end
 
     xml do

data/lib/genericode/key_column_ref.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 require_relative "annotation"
 
 module Genericode
-  class KeyColumnRef < Shale::Mapper
-    attribute :ref, Shale::Type::String
+  class KeyColumnRef < Lutaml::Model::Serializable
+    attribute :ref, :string
     attribute :annotation, Annotation
 
     json do

data/lib/genericode/key_ref.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 require_relative "annotation"
 
 module Genericode
-  class KeyRef < Shale::Mapper
-    attribute :id, Shale::Type::String
-    attribute :external_ref, Shale::Type::String
+  class KeyRef < Lutaml::Model::Serializable
+    attribute :id, :string
+    attribute :external_ref, :string
     attribute :annotation, Annotation
-    attribute :canonical_version_uri, Shale::Type::String
-    attribute :location_uri, Shale::Type::String, collection: true
+    attribute :canonical_version_uri, :string
+    attribute :location_uri, :string, collection: true
 
     json do
       map "Id", to: :id

data/lib/genericode/long_name.rb

@@ -1,17 +1,27 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 module Genericode
-  class LongName < Shale::Mapper
-    attribute :content, Shale::Type::String
-    attribute :identifier, Shale::Type::String
-    attribute :lang, Shale::Type::String
+  class LongName < Lutaml::Model::Serializable
+    attribute :content, :string
+    attribute :identifier, :string
+    attribute :lang, :string
 
     json do
-      map "_", to: :content
       map "Identifier", to: :identifier
-      map "lang", to: :lang
+      map "http://www.w3.org/XML/1998/namespace", to: :lang, with: { from: :lang_from_json, to: :lang_to_json }
+      map "_", to: :content
+    end
+
+    def lang_from_json(model, value)
+      model.lang = value["lang"]
+    end
+
+    def lang_to_json(model, doc)
+      return if model.lang.nil?
+
+      doc["http://www.w3.org/XML/1998/namespace"] = { "lang" => model.lang }
     end
 
     xml do

data/lib/genericode/mime_typed_uri.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 module Genericode
-  class MimeTypedUri < Shale::Mapper
-    attribute :content, Shale::Type::String
-    attribute :mime_type, Shale::Type::String
+  class MimeTypedUri < Lutaml::Model::Serializable
+    attribute :content, :string
+    attribute :mime_type, :string
 
     json do
-      map "_", to: :content
       map "MimeType", to: :mime_type
+      map "_", to: :content
     end
 
     xml do

data/lib/genericode/row.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 require_relative "annotation"
 require_relative "value"
 
 module Genericode
-  class Row < Shale::Mapper
+  class Row < Lutaml::Model::Serializable
     attribute :annotation, Annotation
     attribute :value, Value, collection: true
 

data/lib/genericode/short_name.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 module Genericode
-  class ShortName < Shale::Mapper
-    attribute :content, Shale::Type::String
-    attribute :lang, Shale::Type::String
+  class ShortName < Lutaml::Model::Serializable
+    attribute :content, :string
+    attribute :lang, :string
 
     json do
-      map "_", to: :content
       map "lang", to: :lang
+      map "_", to: :content
     end
 
     xml do
@@ -19,5 +19,10 @@ module Genericode
       map_content to: :content
       map_attribute "lang", to: :lang, prefix: "xml", namespace: "http://www.w3.org/XML/1998/namespace"
     end
+
+    # Rule 39: Must not contain whitespace characters
+    def valid?
+      !content.match(/\s/)
+    end
   end
 end

data/lib/genericode/simple_code_list.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 require_relative "annotation"
 require_relative "row"
 
 module Genericode
-  class SimpleCodeList < Shale::Mapper
+  class SimpleCodeList < Lutaml::Model::Serializable
     attribute :annotation, Annotation
     attribute :row, Row, collection: true
 

data/lib/genericode/simple_value.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 module Genericode
-  class SimpleValue < Shale::Mapper
-    attribute :content, Shale::Type::String
+  class SimpleValue < Lutaml::Model::Serializable
+    attribute :content, :string
 
     json do
       map "_", to: :content

data/lib/genericode/utils.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Genericode
+  # Utility functions
+  #
+  # @api private
+  module Utils
+    # Wraps object in an array unless it is already an array (or array-like)
+    #
+    # @param [Object] object
+    #
+    # @example
+    #   Utils.array_wrap(nil)       # => []
+    #   Utils.array_wrap([1, 2, 3]) # => [1, 2, 3]
+    #   Utils.array_wrap(0)         # => [0]
+    #   Utils.array_wrap(foo: :bar) # => [{:foo=>:bar}]
+    #
+    # @return [Array] An array containing the object. If the object is nil,
+    #   returns an empty array. If the object responds to `to_ary`, converts it
+    #   to an array. Otherwise, wraps the object in an array.
+    #
+    # @api private
+    def self.array_wrap(object)
+      if object.nil?
+        []
+      elsif object.respond_to?(:to_ary)
+        object.to_ary
+      else
+        [object]
+      end
+    end
+
+    # Returns either the only element of the array or the array itself
+    #
+    # @param [Array] array
+    #
+    # @example
+    #   Utils.one_or_all([0])       # => 0
+    #   Utils.one_or_all([1, 2, 3]) # => [1, 2, 3]
+    #   Utils.one_or_all([])        # => []
+    #
+    # @return [Object, Array] The first element of the array if the array has
+    #   only one element, otherwise returns the entire array.
+    #
+    # @api private
+    def self.one_or_all(array)
+      array.one? ? array.first : array
+    end
+  end
+end

data/lib/genericode/value.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 require_relative "annotation"
 require_relative "any_other_content"
 require_relative "simple_value"
+require_relative "column_ref"
 
 module Genericode
-  class Value < Shale::Mapper
-    attribute :column_ref, Shale::Type::String
+  class Value < Lutaml::Model::Serializable
+    attribute :column_ref, :string
     attribute :annotation, Annotation
     attribute :simple_value, SimpleValue
     attribute :complex_value, AnyOtherContent
@@ -24,7 +25,7 @@ module Genericode
       root "Value"
       namespace "http://docs.oasis-open.org/codelist/ns/genericode/1.0/", "gc"
 
-      map_attribute "ColumnRef", to: :column_ref
+      map_attribute "ColumnRef", to: :column_ref, prefix: nil, namespace: nil
       map_element "Annotation", to: :annotation, prefix: nil, namespace: nil
       map_element "SimpleValue", to: :simple_value, prefix: nil, namespace: nil
       map_element "ComplexValue", to: :complex_value, prefix: nil, namespace: nil

data/lib/genericode/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Genericode
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/genericode.rb

@@ -1,8 +1,20 @@
 # frozen_string_literal: true
 
+require "lutaml/model"
+
+Lutaml::Model::Config.configure do |config|
+  require "lutaml/model/xml_adapter/nokogiri_adapter"
+  config.xml_adapter = Lutaml::Model::XmlAdapter::NokogiriAdapter
+end
+
 require_relative "genericode/version"
 require_relative "genericode/code_list"
 
 module Genericode
   class Error < StandardError; end
+
+  def self.validate(file_path)
+    code_list = CodeList.from_file(file_path)
+    code_list.validate_verbose
+  end
 end

data/oasis-reqs-implemented.md

@@ -0,0 +1,31 @@
+| Rule | Supported | Implementation |
+|------|-----------|----------------|
+| Rule 1 | Yes | Implemented in `CodeList#validate_verbose` method |
+| Rule 2 | No | Not applicable (xml:base) |
+| Rule 3 | No | Not implemented (external reference validation) |
+| Rule 4 | Yes | Implemented in `CodeList#validate_verbose` method (valid_uri? check) |
+| Rule 5 | No | Not applicable (runtime behavior) |
+| Rule 6 | Yes | Implemented in `CodeList#validate_verbose` method (valid_uri? check) |
+| Rule 7 | No | Not applicable (runtime behavior) |
+| Rule 8 | No | Not implemented (external reference validation) |
+| Rule 9 | No | Not applicable (runtime behavior) |
+| Rule 10-18 | No | Not applicable (xml:base) |
+| Rule 19 | No | Not implemented (datatype ID validation) |
+| Rule 20 | No | Not implemented (complex data validation) |
+| Rule 21 | No | Not applicable (runtime behavior) |
+| Rule 22 | No | Not implemented (complex data validation) |
+| Rule 23 | No | Not implemented (language attribute validation) |
+| Rule 24 | No | Not applicable (external reference format) |
+| Rule 25 | Yes | Implemented in `CodeList#validate_verbose` method (valid_uri? check) |
+| Rule 26-33 | No | Not applicable (runtime behavior or URI usage) |
+| Rule 34 | Yes | Implemented in `CodeList#validate_verbose` method |
+| Rule 35-36 | No | Not applicable (external reference validation or xml:base) |
+| Rule 37 | Yes | Implemented in `CodeList#validate_verbose` method |
+| Rule 38 | No | Not implemented (implicit column reference) |
+| Rule 39 | No | Not implemented (ShortName whitespace check) |
+| Rule 40 | No | Not applicable (runtime behavior) |
+| Rule 41 | Yes | Partially implemented in `CodeList#validate_verbose` method (value_matches_type? check) |
+| Rule 42-43 | No | Not implemented (ComplexValue validation) |
+| Rule 44 | Yes | Implemented in `CodeList#validate_verbose` method (valid_uri? check) |
+| Rule 45-46 | No | Not applicable (runtime behavior) |
+| Rule 47-54 | No | Not implemented (CodeListSet validation) |