lutaml-model 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 223c53c673e167e5bf85d7eec79a95011e37db1e07849a6a005d935bd5586c0f
-  data.tar.gz: 4adc0dc4bc3d30b15c7901b2b997c3e4ff24ff9d92896020d038e443dda99925
+  metadata.gz: 2b948b6c3373e3a5cbe98462e88fe5b945542d9f509b313dd21af2f333859884
+  data.tar.gz: 0c53660f6ff3f8ad249c3368c6c1477eb4d5ea1d426d9c4db44216efec9e5b56
 SHA512:
-  metadata.gz: 34a4d857e96d2955581a6df37c0aff10466edb1eb57293d6a818c62b998ba2244609ac9963d676ff789c0c2e08593296bd96bf7d8c6bd628ff867718e9f8e31a
-  data.tar.gz: a0e0c005f90ce0d029f119f1d2013da1b2ea7d61e8a8f149c46fce3c6bbfea79237d90cb9b8fc4a5eed7ef40939f2b4a35d121ab2be034b04a897103e78b7c0e
+  metadata.gz: 032c506ddc4f5173281092dae4828c63717454dbcdf8ed44fb30bc94482552bffbfbf830084c9ae1b832c49db802f940b81adf684ea94d684d0496bd804e5dbf
+  data.tar.gz: 4b75612301d6df11570f30b04ddd7800b666ae354a9c2171d553fc14cce21846795c54f88e25c4a35896ee66701b14c27fd825f9146fdd3ec469ede544405bd3

data/.github/workflows/rake.yml

@@ -12,4 +12,4 @@ jobs:
   rake:
     uses: metanorma/ci/.github/workflows/generic-rake.yml@main
     secrets:
-      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+      pat_token: ${{ secrets.LUTAML_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -19,5 +19,5 @@ jobs:
     with:
       next_version: ${{ github.event.inputs.next_version }}
     secrets:
-      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
-      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+      rubygems-api-key: ${{ secrets.LUTAML_CI_RUBYGEMS_API_KEY }}
+      pat_token: ${{ secrets.LUTAML_CI_PAT_TOKEN }}

data/.gitignore

@@ -1,3 +1,5 @@
+.rubocop-https---*
+
 /.bundle/
 /.yardoc
 /_yardoc/

data/.rubocop.yml

@@ -1,11 +1,18 @@
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+  - .rubocop_todo.yml
 
 # local repo-specific modifications
 # ...
+#
+require:
+- rubocop-performance
+- rubocop-rails
+- rubocop-rake
+- rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
   NewCops: enable
   Exclude:
     - 'lib/sts/mapper.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,207 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-07-31 10:20:40 UTC using RuboCop version 1.64.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequireMFA:
+  Exclude:
+    - 'lutaml-model.gemspec'
+
+# Offense count: 15
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'lib/lutaml/model/serialize.rb'
+    - 'lib/lutaml/model/type.rb'
+    - 'lib/lutaml/model/xml_adapter.rb'
+    - 'lib/lutaml/model/xml_adapter/nokogiri_adapter.rb'
+    - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
+    - 'spec/lutaml/model/xml_namespace_spec.rb'
+
+# Offense count: 20
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/lutaml/model/serialize.rb'
+    - 'lib/lutaml/model/type.rb'
+    - 'lib/lutaml/model/xml_adapter.rb'
+    - 'lib/lutaml/model/xml_adapter/nokogiri_adapter.rb'
+    - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
+
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 30
+
+# Offense count: 17
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/lutaml/model/serialize.rb'
+    - 'lib/lutaml/model/type.rb'
+    - 'lib/lutaml/model/xml_adapter.rb'
+    - 'lib/lutaml/model/xml_adapter/nokogiri_adapter.rb'
+    - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
+
+# Offense count: 24
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 42
+
+# Offense count: 3
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
+Metrics/ParameterLists:
+  Max: 9
+
+# Offense count: 16
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/lutaml/model/serialize.rb'
+    - 'lib/lutaml/model/type.rb'
+    - 'lib/lutaml/model/xml_adapter.rb'
+    - 'lib/lutaml/model/xml_adapter/nokogiri_adapter.rb'
+    - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+RSpec/BeEq:
+  Exclude:
+    - 'spec/lutaml/model/collection_spec.rb'
+    - 'spec/lutaml/model/simple_model_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: be, be_nil
+RSpec/BeNil:
+  Exclude:
+    - 'spec/lutaml/model_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/lutaml/model/xml_adapter/nokogiri_adapter_spec.rb'
+    - 'spec/lutaml/model/xml_adapter/oga_adapter_spec.rb'
+    - 'spec/lutaml/model/xml_adapter/ox_adapter_spec.rb'
+
+# Offense count: 18
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: SkipBlocks, EnforcedStyle, OnlyStaticConstants.
+# SupportedStyles: described_class, explicit
+RSpec/DescribedClass:
+  Exclude:
+    - 'spec/address_spec.rb'
+    - 'spec/lutaml/model/custom_serialization_spec.rb'
+    - 'spec/lutaml/model/defaults_spec.rb'
+    - 'spec/lutaml/model/render_nil_spec.rb'
+    - 'spec/person_spec.rb'
+
+# Offense count: 60
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 36
+
+# Offense count: 2
+# Configuration parameters: Max, AllowedIdentifiers, AllowedPatterns.
+RSpec/IndexedLet:
+  Exclude:
+    - 'spec/address_spec.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AutoCorrect.
+RSpec/LetBeforeExamples:
+  Exclude:
+    - 'spec/lutaml/model/defaults_spec.rb'
+    - 'spec/person_spec.rb'
+
+# Offense count: 4
+RSpec/MultipleDescribes:
+  Exclude:
+    - 'spec/lutaml/model/json_adapter_spec.rb'
+    - 'spec/lutaml/model/toml_adapter_spec.rb'
+    - 'spec/lutaml/model/xml_adapter_spec.rb'
+    - 'spec/lutaml/model/xml_namespace_spec.rb'
+
+# Offense count: 54
+RSpec/MultipleExpectations:
+  Max: 15
+
+# Offense count: 1
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 9
+
+# Offense count: 3
+RSpec/PendingWithoutReason:
+  Exclude:
+    - 'spec/lutaml/model/xml_adapter/oga_adapter_spec.rb'
+    - 'spec/lutaml/model/xml_adapter_spec.rb'
+    - 'spec/lutaml/model/xml_namespace_spec.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AutoCorrect.
+RSpec/ScatteredLet:
+  Exclude:
+    - 'spec/lutaml/model/defaults_spec.rb'
+    - 'spec/person_spec.rb'
+
+# Offense count: 5
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
+# Include: **/*_spec.rb
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - 'spec/lutaml/model/collection_spec.rb'
+    - 'spec/lutaml/model/xml_adapter/nokogiri_adapter_spec.rb'
+    - 'spec/lutaml/model/xml_adapter/oga_adapter_spec.rb'
+    - 'spec/lutaml/model/xml_adapter/ox_adapter_spec.rb'
+    - 'spec/lutaml/model/yaml_adapter_spec.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Whitelist, AllowedMethods, AllowedReceivers.
+# Whitelist: find_by_sql, find_by_token_for
+# AllowedMethods: find_by_sql, find_by_token_for
+# AllowedReceivers: Gem::Specification, page
+Rails/DynamicFindBy:
+  Exclude:
+    - 'lib/lutaml/model/xml_adapter/nokogiri_adapter.rb'
+    - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Rails/NegateInclude:
+  Exclude:
+    - 'lib/lutaml/model/serialize.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: NotNilAndNotEmpty, NotBlank, UnlessBlank.
+Rails/Present:
+  Exclude:
+    - 'lib/lutaml/model/serialize.rb'
+    - 'lib/lutaml/model/xml_namespace.rb'
+
+# Offense count: 6
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: strict, flexible
+Rails/TimeZone:
+  Exclude:
+    - 'lib/lutaml/model/type.rb'
+    - 'lib/lutaml/model/type/time_without_date.rb'
+    - 'spec/person_spec.rb'

data/Gemfile

@@ -10,3 +10,27 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
+
+gem "equivalent-xml"
+
+gem "multi_json"
+
+gem "nokogiri"
+
+gem "oga"
+
+gem "ox"
+
+gem "pry"
+
+gem "rubocop-performance", require: false
+
+gem "rubocop-rails", require: false
+
+gem "rubocop-rake", require: false
+
+gem "rubocop-rspec", require: false
+
+gem "tomlib"
+
+gem "toml-rb"

data/README.adoc

@@ -105,6 +105,8 @@ class Example < Lutaml::Model::Serializable
 end
 ----
 
+NOTE: If root is not given then the class name will be used as the root.
+
 === Key Value Data Models: JSON, YAML, TOML
 
 Define key-value data models like JSON, YAML, and TOML using the `map` method.
@@ -294,16 +296,31 @@ end
 
 === XML Namespace on Attribute
 
+If the namespace is defined on an attribute then that will be given priority over the one defined in the class. In the example below `glz` will be used for `Glaze` if it is added inside the `Ceramic` class, and `glaze` will be used otherwise.
+
 [source,ruby]
 ----
+class Glaze < Lutaml::Model::Serializable
+  attribute :color, Lutaml::Model::Type::String
+  attribute :temperature, Lutaml::Model::Type::Integer
+
+  xml do
+    root 'Glaze'
+    namespace 'http://example.com/old_glaze', 'glaze'
+
+    map_element 'color', to: :color
+    map_element 'temperature', to: :temperature
+  end
+end
+
 class Ceramic < Lutaml::Model::Serializable
   attribute :type, Lutaml::Model::Type::String
-  attribute :glaze, Lutaml::Model::Type::String
+  attribute :glaze, Glaze
 
   xml do
     root 'Ceramic'
     map_element 'Type', to: :type
-    map_element 'Glaze', to: :glaze
+    map_element 'Glaze', to: :glaze, namespace: 'http://example.com/glaze', prefix: "glz"
     map_attribute 'xmlns', to: :namespace, namespace: 'http://example.com/ceramic'
   end
 end
@@ -326,6 +343,60 @@ class Ceramic < Lutaml::Model::Serializable
 end
 ----
 
+== Using XML `mixed` option
+
+In XML there can be some tags that containg content mixed with other tags for example `<description><p>My name is <bold>John Doe</bold>, and I'm <i>28</i> years old</p></description>`
+
+To map this to Lutaml::Model we can use the mixed option when defining the model or when referencing it. 
+
+=== Adding mixed option when defining a Model
+
+This will always treat the content of `<p>` tag as mixed content.
+
+[source,ruby]
+----
+class Paragraph < Lutaml::Model::Serializable
+  attribute :bold, Lutaml::Model::Type::String
+  attribute :italic, Lutaml::Model::Type::String
+
+  xml do
+    root 'p', mixed: true
+
+    map_element 'bold', to: :bold
+    map_element 'i', to: :italic
+  end
+end
+----
+
+=== Adding mixed option when referencing a Model
+
+This will only treat the content of `<p>` tag as mixed content if the `mixed: true` is added when referencing it.
+
+[source,ruby]
+----
+class Paragraph < Lutaml::Model::Serializable
+  attribute :bold, Lutaml::Model::Type::String
+  attribute :italic, Lutaml::Model::Type::String
+
+  xml do
+    root 'p'
+
+    map_element 'bold', to: :bold
+    map_element 'i', to: :italic
+  end
+end
+
+class Description < Lutaml::Model::Serializable
+  attribute :paragraph, Paragraph
+
+  xml do
+    root 'description'
+
+    map_element 'p', to: :paragraph, mixed: true
+  end
+end
+----
+
 == Adapters
 
 Lutaml::Model uses an adapter pattern to support multiple libraries for each serialization format.
@@ -377,4 +448,4 @@ end
 
 This project is licensed under the BSD 2-clause License - see the LICENSE file for details.
 
-This project is maintained by Ribose.
+This project is maintained by Ribose.

data/lib/lutaml/model/attribute.rb

@@ -8,6 +8,10 @@ module Lutaml
         @name = name
         @type = type
         @options = options
+
+        if collection? && !options[:default]
+          @options[:default] = -> { [] }
+        end
       end
 
       def collection?
@@ -15,7 +19,9 @@ module Lutaml
       end
 
       def default
-        options[:default].is_a?(Proc) ? options[:default].call : options[:default]
+        return options[:default].call if options[:default].is_a?(Proc)
+
+        options[:default]
       end
 
       def render_nil?

data/lib/lutaml/model/key_value_mapping.rb

@@ -11,7 +11,13 @@ module Lutaml
       end
 
       def map(name, to:, render_nil: false, with: {}, delegate: nil)
-        @mappings << KeyValueMappingRule.new(name, to: to, render_nil: render_nil, with: with, delegate: delegate)
+        @mappings << KeyValueMappingRule.new(
+          name,
+          to: to,
+          render_nil: render_nil,
+          with: with,
+          delegate: delegate,
+        )
       end
 
       alias map_element map

data/lib/lutaml/model/mapping_hash.rb

@@ -0,0 +1,42 @@
+# lib/lutaml/model/type.rb
+
+module Lutaml
+  module Model
+    class MappingHash < Hash
+      attr_accessor :ordered
+
+      def initialize
+        @ordered = false
+        @item_order = []
+
+        super
+      end
+
+      def item_order
+        @item_order&.map { |key| normalize(key) } || keys
+      end
+
+      def item_order=(order)
+        raise "`item order` must be an array" unless order.is_a?(Array)
+
+        @item_order = order
+      end
+
+      def ordered?
+        @ordered
+      end
+
+      private
+
+      def normalize(key)
+        if self[key.to_s]
+          key.to_s
+        elsif self[key.to_sym]
+          key.to_sym
+        else
+          key
+        end
+      end
+    end
+  end
+end

data/lib/lutaml/model/mapping_rule.rb

@@ -2,17 +2,41 @@
 module Lutaml
   module Model
     class MappingRule
-      attr_reader :name, :to, :render_nil, :custom_methods, :delegate
+      attr_reader :name,
+                  :to,
+                  :render_nil,
+                  :custom_methods,
+                  :delegate,
+                  :mixed_content
 
-      def initialize(name, to:, render_nil: false, with: {}, delegate: nil)
+      def initialize(
+        name,
+        to:,
+        render_nil: false,
+        with: {},
+        delegate: nil,
+        mixed_content: false,
+        namespace_set: false
+      )
         @name = name
         @to = to
         @render_nil = render_nil
         @custom_methods = with
         @delegate = delegate
+        @mixed_content = mixed_content
+        @namespace_set = namespace_set
       end
 
       alias from name
+      alias render_nil? render_nil
+
+      def prefixed_name
+        if prefix
+          "#{prefix}:#{name}"
+        else
+          name
+        end
+      end
 
       def serialize(model, value)
         if custom_methods[:to]
@@ -29,6 +53,10 @@ module Lutaml
           doc[name.to_s]
         end
       end
+
+      def namespace_set?
+        @namespace_set
+      end
     end
   end
 end

data/lib/lutaml/model/schema/json_schema.rb

@@ -17,8 +17,6 @@ module Lutaml
           options[:pretty] ? JSON.pretty_generate(schema) : schema.to_json
         end
 
-        private
-
         def self.generate_definitions(klass)
           {
             klass.name => {
@@ -30,8 +28,8 @@ module Lutaml
         end
 
         def self.generate_properties(klass)
-          klass.attributes.each_with_object({}) do |(name, attr), properties|
-            properties[name] = generate_property_schema(attr)
+          klass.attributes.transform_values do |attr|
+            generate_property_schema(attr)
           end
         end
 
@@ -40,22 +38,14 @@ module Lutaml
         end
 
         def self.get_json_type(type)
-          case type
-          when Lutaml::Model::Type::String
-            "string"
-          when Lutaml::Model::Type::Integer
-            "integer"
-          when Lutaml::Model::Type::Boolean
-            "boolean"
-          when Lutaml::Model::Type::Float
-            "number"
-          when Lutaml::Model::Type::Array
-            "array"
-          when Lutaml::Model::Type::Hash
-            "object"
-          else
-            "string" # Default to string for unknown types
-          end
+          {
+            Lutaml::Model::Type::String => "string",
+            Lutaml::Model::Type::Integer => "integer",
+            Lutaml::Model::Type::Boolean => "boolean",
+            Lutaml::Model::Type::Float => "number",
+            Lutaml::Model::Type::Array => "array",
+            Lutaml::Model::Type::Hash => "object",
+          }[type] || "string" # Default to string for unknown types
         end
       end
     end

data/lib/lutaml/model/schema/relaxng_schema.rb

@@ -5,7 +5,7 @@ module Lutaml
   module Model
     module Schema
       class RelaxngSchema
-        def self.generate(klass, options = {})
+        def self.generate(klass, _options = {})
           schema = Nokogiri::XML::Builder.new do |xml|
             xml.element(name: klass.name) do
               xml.complexType do
@@ -18,8 +18,6 @@ module Lutaml
           schema.to_xml
         end
 
-        private
-
         def self.generate_elements(klass, xml)
           klass.attributes.each do |name, attr|
             xml.element(name: name, type: get_relaxng_type(attr.type))
@@ -27,22 +25,14 @@ module Lutaml
         end
 
         def self.get_relaxng_type(type)
-          case type
-          when Lutaml::Model::Type::String
-            "string"
-          when Lutaml::Model::Type::Integer
-            "integer"
-          when Lutaml::Model::Type::Boolean
-            "boolean"
-          when Lutaml::Model::Type::Float
-            "float"
-          when Lutaml::Model::Type::Array
-            "array"
-          when Lutaml::Model::Type::Hash
-            "object"
-          else
-            "string" # Default to string for unknown types
-          end
+          {
+            Lutaml::Model::Type::String => "string",
+            Lutaml::Model::Type::Integer => "integer",
+            Lutaml::Model::Type::Boolean => "boolean",
+            Lutaml::Model::Type::Float => "float",
+            Lutaml::Model::Type::Array => "array",
+            Lutaml::Model::Type::Hash => "object",
+          }[type] || "string" # Default to string for unknown types
         end
       end
     end