lutaml-model 0.3.29 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fba70c8a3fca206b3109603109812019773027580c47b2e3615d873df6e0ce2d
-  data.tar.gz: 21313fbfb52c29c620eb1020672d337689eed963c25fe56c20baeef139e569b5
+  metadata.gz: fa60d5495804e6bfc0203ba1a237f38b89b9626d036beeb2be8ca7aebb22426f
+  data.tar.gz: 63d8d18127bee85cfaa73973f57554bc56385805dfeea1dad343c552277089d6
 SHA512:
-  metadata.gz: 274739542b8473ae58b4fc6b78e1152aaef604a55f3c9db0ec5678743573d683b4afdd2429d97d6a24c03fdb2c14a72904bf4e057f480e6bafc635a21fde085a
-  data.tar.gz: b1a7ad49313463676b3afe8732f94ed8ab37f79935f33449c70011bd8a8449934425aa27b9dd25d2a7e25a064afa1e665bf95f8b2eac4ec7cd63be4bcfdb7b8d
+  metadata.gz: 322a29941e7685a6e118d083f1b6e11ce6b8abc1cacb5508dd501f874c5ea3f2dc6f0e6719ce4895deb31c877319a3afe0e20d0820a81b8fd60d9fe59c408472
+  data.tar.gz: ce087acefc221ed41180658b8c40d4cff5c0196c208647b9d1c5d0d39799849860abf80b981fe753b30a1176ca8633ed696440beeddef5a4493c1e829340f250

data/.github/workflows/dependent-repos.json

@@ -0,0 +1,15 @@
+{
+  "repo": [
+    "lutaml/genericode",
+    "lutaml/ogc-gml",
+    "metanorma/modspec-ruby",
+    "metanorma/rfcxml",
+    "metanorma/niso-jats",
+    "metanorma/sts-ruby",
+    "lutaml/metaschema",
+    "glossarist/termium",
+    "lutaml/oasis-etm",
+    "lutaml/ali",
+    "lutaml/reqif"
+  ]
+}

data/.github/workflows/dependent-tests.yml

@@ -0,0 +1,14 @@
+name: dependent-gems-test
+
+on:
+  push:
+    branches: [ main ]
+    tags: [ v* ]
+  pull_request:
+  workflow_dispatch:
+  repository_dispatch:
+    types: [ release-passed ]
+
+jobs:
+  rake:
+    uses: metanorma/ci/.github/workflows/dependent-rake.yml@main

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-11-25 13:01:09 UTC using RuboCop version 1.66.1.
+# on 2024-12-03 11:13:42 UTC using RuboCop version 1.66.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: 185
+# Offense count: 224
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
@@ -51,7 +51,7 @@ Metrics/AbcSize:
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 47
+  Max: 46
 
 # Offense count: 28
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
@@ -65,7 +65,7 @@ Metrics/CyclomaticComplexity:
     - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
     - 'lib/lutaml/model/xml_adapter/xml_document.rb'
 
-# Offense count: 55
+# Offense count: 54
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 46
@@ -97,7 +97,15 @@ RSpec/ContextWording:
     - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
     - 'spec/lutaml/model/xml_mapping_spec.rb'
 
-# Offense count: 127
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: SkipBlocks, EnforcedStyle, OnlyStaticConstants.
+# SupportedStyles: described_class, explicit
+RSpec/DescribedClass:
+  Exclude:
+    - 'spec/lutaml/model/xml_mapping_spec.rb'
+
+# Offense count: 133
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 54
@@ -127,7 +135,7 @@ RSpec/MultipleDescribes:
     - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
     - 'spec/lutaml/model/xml_adapter_spec.rb'
 
-# Offense count: 153
+# Offense count: 157
 RSpec/MultipleExpectations:
   Max: 14
 
@@ -136,7 +144,7 @@ RSpec/MultipleExpectations:
 RSpec/MultipleMemoizedHelpers:
   Max: 9
 
-# Offense count: 11
+# Offense count: 15
 # Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:
   Max: 4

data/README.adoc

@@ -569,6 +569,12 @@ The values set inside the `values:` option can be of any type, but they must
 match the type of the attribute. The values are compared using the `==` operator,
 so the type must implement the `==` method.
 
+Also, If all the elements in `values` directive are strings then `lutaml-model` add some enum convenience methods, for each of the value the following three methods are added
+
+* `value1`: will return value if set
+* `value1?`: will return true if value is set, false otherwise
+* `value1=`: will set the value of `name_of_attribute` equal to `value1` if truthy value is given, and remove it otherwise.
+
 .Using the `values` directive to define acceptable values for an attribute (basic types)
 [example]
 ====

data/lib/lutaml/model/attribute.rb

@@ -76,6 +76,10 @@ module Lutaml
         @raw
       end
 
+      def enum?
+        !enum_values.empty?
+      end
+
       def default
         value = if delegate
                   type.attributes[to].default
@@ -98,7 +102,7 @@ module Lutaml
 
       def valid_value!(value)
         return true if value.nil? && !collection?
-        return true if enum_values.empty?
+        return true unless enum?
 
         unless valid_value?(value)
           raise Lutaml::Model::InvalidValueError.new(name, value, enum_values)
@@ -208,7 +212,7 @@ module Lutaml
             serialize(v, format, options)
           end
         elsif type <= Serialize
-          type.hash_representation(value, format, options)
+          type.public_send(:"as_#{format}", value, options)
         else
           # Convert to Value instance if not already
           value = type.new(value) unless value.is_a?(Type::Value)

data/lib/lutaml/model/json_adapter/json_document.rb

@@ -7,7 +7,7 @@ module Lutaml
     module JsonAdapter
       # Base class for JSON documents
       class JsonDocument < JsonObject
-        def self.parse(json)
+        def self.parse(json, _options = {})
           raise NotImplementedError, "Subclasses must implement `parse`."
         end
 

data/lib/lutaml/model/json_adapter/multi_json_adapter.rb

@@ -5,7 +5,7 @@ module Lutaml
   module Model
     module JsonAdapter
       class MultiJsonAdapter < JsonDocument
-        def self.parse(json)
+        def self.parse(json, _options = {})
           data = MultiJson.load(json)
           new(data)
         end

data/lib/lutaml/model/json_adapter/standard_json_adapter.rb

@@ -5,7 +5,7 @@ module Lutaml
   module Model
     module JsonAdapter
       class StandardJsonAdapter < JsonDocument
-        def self.parse(json)
+        def self.parse(json, _options = {})
           JSON.parse(json, create_additions: false)
         end
 

data/lib/lutaml/model/serialize.rb

@@ -51,6 +51,7 @@ module Lutaml
           Utils.add_boolean_accessor_if_not_defined(klass, :ordered)
           Utils.add_boolean_accessor_if_not_defined(klass, :mixed)
           Utils.add_accessor_if_not_defined(klass, :element_order)
+          Utils.add_accessor_if_not_defined(klass, :encoding)
 
           Utils.add_method_if_not_defined(klass,
                                           :using_default_for) do |attribute_name|
@@ -80,16 +81,104 @@ module Lutaml
           attr = Attribute.new(name, type, options)
           attributes[name] = attr
 
-          define_method(name) do
-            instance_variable_get(:"@#{name}")
+          if attr.enum?
+            add_enum_methods_to_model(
+              model,
+              name,
+              options[:values],
+              collection: options[:collection],
+            )
+          else
+            define_method(name) do
+              instance_variable_get(:"@#{name}")
+            end
+
+            define_method(:"#{name}=") do |value|
+              value_set_for(name)
+              instance_variable_set(:"@#{name}", attr.cast_value(value))
+            end
           end
+        end
 
-          define_method(:"#{name}=") do |value|
-            value_set_for(name)
-            instance_variable_set(:"@#{name}", attr.cast_value(value))
+        def add_enum_methods_to_model(klass, enum_name, values, collection: false)
+          add_enum_getter_if_not_defined(klass, enum_name, collection)
+          add_enum_setter_if_not_defined(klass, enum_name, values, collection)
+
+          return unless values.all?(::String)
+
+          values.each do |value|
+            Utils.add_method_if_not_defined(klass, "#{value}?") do
+              curr_value = public_send(:"#{enum_name}")
+
+              if collection
+                curr_value.include?(value)
+              else
+                curr_value == value
+              end
+            end
+
+            Utils.add_method_if_not_defined(klass, value.to_s) do
+              public_send(:"#{value}?")
+            end
+
+            Utils.add_method_if_not_defined(klass, "#{value}=") do |val|
+              value_set_for(enum_name)
+              enum_vals = public_send(:"#{enum_name}")
+
+              enum_vals = if !!val
+                            if collection
+                              enum_vals << value
+                            else
+                              [value]
+                            end
+                          elsif collection
+                            enum_vals.delete(value)
+                            enum_vals
+                          else
+                            []
+                          end
+
+              instance_variable_set(:"@#{enum_name}", enum_vals)
+            end
+
+            Utils.add_method_if_not_defined(klass, "#{value}!") do
+              public_send(:"#{value}=", true)
+            end
           end
         end
 
+        def add_enum_getter_if_not_defined(klass, enum_name, collection)
+          Utils.add_method_if_not_defined(klass, enum_name) do
+            i = instance_variable_get(:"@#{enum_name}") || []
+
+            if !collection && i.is_a?(Array)
+              i.first
+            else
+              i.uniq
+            end
+          end
+        end
+
+        def add_enum_setter_if_not_defined(klass, enum_name, _values, collection)
+          Utils.add_method_if_not_defined(klass, "#{enum_name}=") do |value|
+            value = [value] unless value.is_a?(Array)
+
+            value_set_for(enum_name)
+
+            if collection
+              curr_value = public_send(:"#{enum_name}")
+
+              instance_variable_set(:"@#{enum_name}", curr_value + value)
+            else
+              instance_variable_set(:"@#{enum_name}", value)
+            end
+          end
+        end
+
+        def enums
+          attributes.select { |_, attr| attr.enum? }
+        end
+
         Lutaml::Model::Config::AVAILABLE_FORMATS.each do |format|
           define_method(format) do |&block|
             klass = format == :xml ? XmlMapping : KeyValueMapping
@@ -101,23 +190,22 @@ module Lutaml
             end
           end
 
-          define_method(:"from_#{format}") do |data|
+          define_method(:"from_#{format}") do |data, options = {}|
             adapter = Lutaml::Model::Config.send(:"#{format}_adapter")
 
-            doc = adapter.parse(data)
-            public_send(:"of_#{format}", doc)
+            doc = adapter.parse(data, options)
+            public_send(:"of_#{format}", doc, options)
           end
 
-          define_method(:"of_#{format}") do |doc|
+          define_method(:"of_#{format}") do |doc, options = {}|
             if doc.is_a?(Array)
-              return doc.map do |item|
-                       send(:"of_#{format}", item)
-                     end
+              return doc.map { |item| send(:"of_#{format}", item) }
             end
 
             if format == :xml
               doc_hash = doc.parse_element(doc.root, self, :xml)
-              apply_mappings(doc_hash, format)
+              options[:encoding] = doc.encoding
+              apply_mappings(doc_hash, format, options)
             else
               apply_mappings(doc.to_h, format)
             end
@@ -135,7 +223,7 @@ module Lutaml
             end
           end
 
-          define_method(:"as_#{format}") do |instance|
+          define_method(:"as_#{format}") do |instance, options = {}|
             if instance.is_a?(Array)
               return instance.map { |item| public_send(:"as_#{format}", item) }
             end
@@ -147,7 +235,7 @@ module Lutaml
 
             return instance if format == :xml
 
-            hash_representation(instance, format)
+            hash_representation(instance, format, options)
           end
         end
 
@@ -166,7 +254,7 @@ module Lutaml
           mappings.each_with_object({}) do |rule, hash|
             name = rule.to
             next if except&.include?(name) || (only && !only.include?(name))
-            next if !rule.render_default? && instance.using_default?(rule.to)
+            next if !rule.custom_methods[:to] && (!rule.render_default? && instance.using_default?(rule.to))
 
             next handle_delegate(instance, rule, hash, format) if rule.delegate
 
@@ -176,15 +264,15 @@ module Lutaml
 
             value = instance.send(name)
 
-            next if value.nil? && !rule.render_nil
+            next if Utils.blank?(value) && !rule.render_nil
 
             attribute = attributes[name]
 
-            hash[rule.from] = if rule.child_mappings
-                                generate_hash_from_child_mappings(value, rule.child_mappings)
-                              else
-                                attribute.serialize(value, format, options)
-                              end
+            hash[rule.from.to_s] = if rule.child_mappings
+                                     generate_hash_from_child_mappings(value, rule.child_mappings)
+                                   else
+                                     attribute.serialize(value, format, options)
+                                   end
           end
         end
 
@@ -194,7 +282,7 @@ module Lutaml
           return if value.nil? && !rule.render_nil
 
           attribute = instance.send(rule.delegate).class.attributes[name]
-          hash[rule.from] = attribute.serialize(value, format)
+          hash[rule.from.to_s] = attribute.serialize(value, format)
         end
 
         def mappings_for(format)
@@ -315,6 +403,7 @@ module Lutaml
         end
 
         def apply_xml_mapping(doc, instance, options = {})
+          instance.encoding = options[:encoding]
           return instance unless doc
 
           if options[:default_namespace].nil?
@@ -347,6 +436,8 @@ module Lutaml
           mappings.each do |rule|
             raise "Attribute '#{rule.to}' not found in #{self}" unless valid_rule?(rule)
 
+            attr = attribute_for_rule(rule)
+
             value = if rule.raw_mapping?
                       doc.node.inner_xml
                     elsif rule.content_mapping?
@@ -355,10 +446,10 @@ module Lutaml
                       doc.fetch(rule.namespaced_name(options[:default_namespace]))
                     else
                       defaults_used << rule.to
-                      rule.to_value_for(instance)
+                      attr&.default || rule.to_value_for(instance)
                     end
 
-            value = normalize_xml_value(value, rule, options)
+            value = normalize_xml_value(value, rule, attr, options)
             rule.deserialize(instance, value, attributes, self)
           end
 
@@ -376,10 +467,10 @@ module Lutaml
 
             attr = attribute_for_rule(rule)
 
-            value = if doc.key?(rule.name) || doc.key?(rule.name.to_sym)
-                      doc[rule.name] || doc[rule.name.to_sym]
+            value = if doc.key?(rule.name.to_s) || doc.key?(rule.name.to_sym)
+                      doc[rule.name.to_s] || doc[rule.name.to_sym]
                     else
-                      attr.default
+                      attr&.default
                     end
 
             if rule.custom_methods[:from]
@@ -399,9 +490,7 @@ module Lutaml
           instance
         end
 
-        def normalize_xml_value(value, rule, options = {})
-          attr = attribute_for_rule(rule)
-
+        def normalize_xml_value(value, rule, attr, options = {})
           value = [value].compact if attr&.collection? && !value.is_a?(Array)
 
           value = if value.is_a?(Array)
@@ -459,7 +548,7 @@ module Lutaml
         end
       end
 
-      attr_accessor :element_order, :schema_location
+      attr_accessor :element_order, :schema_location, :encoding
       attr_writer :ordered, :mixed
 
       def initialize(attrs = {})
@@ -489,7 +578,9 @@ module Lutaml
             value = []
           end
 
-          instance_variable_set(:"@#{name}", self.class.ensure_utf8(value))
+          default = using_default?(name)
+          public_send(:"#{name}=", self.class.ensure_utf8(value))
+          using_default_for(name) if default
         end
       end
 
@@ -538,6 +629,14 @@ module Lutaml
         hash[key.to_sym] || hash[key.to_s]
       end
 
+      def pretty_print_instance_variables
+        (instance_variables - %i[@using_default]).sort
+      end
+
+      def to_yaml_hash
+        self.class.as_yaml(self)
+      end
+
       Lutaml::Model::Config::AVAILABLE_FORMATS.each do |format|
         define_method(:"to_#{format}") do |options = {}|
           adapter = Lutaml::Model::Config.public_send(:"#{format}_adapter")
@@ -548,6 +647,7 @@ module Lutaml
                                                             options)
                            end
 
+          options[:parse_encoding] = encoding if encoding
           adapter.new(representation).public_send(:"to_#{format}", options)
         end
       end

data/lib/lutaml/model/toml_adapter/toml_document.rb

@@ -7,7 +7,7 @@ module Lutaml
     module TomlAdapter
       # Base class for TOML documents
       class TomlDocument < TomlObject
-        def self.parse(toml)
+        def self.parse(toml, _options = {})
           raise NotImplementedError, "Subclasses must implement `parse`."
         end
 

data/lib/lutaml/model/toml_adapter/toml_rb_adapter.rb

@@ -5,7 +5,7 @@ module Lutaml
   module Model
     module TomlAdapter
       class TomlRbAdapter < TomlDocument
-        def self.parse(toml)
+        def self.parse(toml, _options = {})
           data = TomlRB.parse(toml)
           new(data)
         end

data/lib/lutaml/model/toml_adapter/tomlib_adapter.rb

@@ -5,7 +5,7 @@ module Lutaml
   module Model
     module TomlAdapter
       class TomlibAdapter < TomlDocument
-        def self.parse(toml)
+        def self.parse(toml, _options = {})
           data = Tomlib.load(toml)
           new(data)
         end

data/lib/lutaml/model/type/time.rb

@@ -34,10 +34,10 @@ module Lutaml
         #   value&.iso8601
         # end
 
-        # # YAML timestamp format (native)
-        # def to_yaml
-        #   value
-        # end
+        # YAML timestamp format (native)
+        def to_yaml
+          value&.iso8601
+        end
 
         # # TOML time format (HH:MM:SS.mmm)
         # def to_toml

data/lib/lutaml/model/utils.rb

@@ -39,7 +39,7 @@ module Lutaml
         end
 
         def blank?(value)
-          value.respond_to?(:empty?) ? value.empty? : !value
+          value.respond_to?(:empty?) ? value.empty? : value.nil?
         end
 
         def add_method_if_not_defined(klass, method_name, &block)

data/lib/lutaml/model/validation.rb

@@ -4,9 +4,13 @@ module Lutaml
       def validate
         errors = []
         self.class.attributes.each do |name, attr|
-          value = instance_variable_get(:"@#{name}")
+          value = public_send(:"#{name}")
           begin
-            attr.validate_value!(value)
+            if value.respond_to?(:validate!)
+              value.validate!
+            else
+              attr.validate_value!(value)
+            end
           rescue Lutaml::Model::InvalidValueError,
                  Lutaml::Model::CollectionCountOutOfRangeError,
                  PatternNotMatchedError => e

data/lib/lutaml/model/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Model
-    VERSION = "0.3.29"
+    VERSION = "0.4.0"
   end
 end

data/lib/lutaml/model/xml_adapter/builder/nokogiri.rb

@@ -51,6 +51,16 @@ module Lutaml
             end
           end
 
+          def add_xml_fragment(element, content)
+            if element.is_a?(self.class)
+              element = element.xml.parent
+            end
+
+            fragment = ::Nokogiri::XML::DocumentFragment.parse(content)
+
+            element.add_child(fragment)
+          end
+
           def add_text(element, text, cdata: false)
             return add_cdata(element, text) if cdata
 

data/lib/lutaml/model/xml_adapter/builder/ox.rb

@@ -66,10 +66,14 @@ module Lutaml
             xml.text(text)
           end
 
+          def add_xml_fragment(element, content)
+            element.raw(content)
+          end
+
           def add_text(element, text, cdata: false)
             return element.cdata(text) if cdata
 
-            element << text
+            element.text(text)
           end
 
           def add_cdata(element, value)

data/lib/lutaml/model/xml_adapter/nokogiri_adapter.rb

@@ -6,10 +6,10 @@ module Lutaml
   module Model
     module XmlAdapter
       class NokogiriAdapter < XmlDocument
-        def self.parse(xml)
-          parsed = Nokogiri::XML(xml)
+        def self.parse(xml, options = {})
+          parsed = Nokogiri::XML(xml, nil, options[:encoding])
           root = NokogiriElement.new(parsed.root)
-          new(root)
+          new(root, parsed.encoding)
         end
 
         def to_xml(options = {})
@@ -17,6 +17,8 @@ module Lutaml
 
           if options.key?(:encoding)
             builder_options[:encoding] = options[:encoding] unless options[:encoding].nil?
+          elsif options.key?(:parse_encoding)
+            builder_options[:encoding] = options[:parse_encoding]
           else
             builder_options[:encoding] = "UTF-8"
           end

data/lib/lutaml/model/xml_adapter/oga_adapter.rb

@@ -5,7 +5,7 @@ module Lutaml
   module Model
     module XmlAdapter
       class OgaAdapter < XmlDocument
-        def self.parse(xml)
+        def self.parse(xml, _options = {})
           parsed = Oga.parse_xml(xml)
           root = OgaElement.new(parsed)
           new(root)