deco_lite 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d360b0607d72711264a19f807ad4367237f0e5e69efb385728ccbda66e72e05
-  data.tar.gz: f90e61477cc9dfa1ba8d19070c1490fcccfce413533436ed93b532d4933fad08
+  metadata.gz: 74286df21784817e45f4d615081bfeac44d90f13d8200bc8f066107e8d0f773f
+  data.tar.gz: 57dcc52147494eb3caf59159cbb21bc23bb6788d0b6315ebc1ddd8cf1868c779
 SHA512:
-  metadata.gz: 87d78e241cd8aada8c09c8adbcb20cdb5997e96ff4f17cc8dd3a494e973fd10f13fe73927edb604e2125209119bd881522c79995753768fc0f64d049632d1751
-  data.tar.gz: d4ae03338d636d82d6a67996cea9e2143a07b0319a9ad6f3a1f1e4a508b2f9a4262ec5cb7e68c8cb2b7d29a8f0e046413ad7f9470f4a20c6fa470c20d9e3c907
+  metadata.gz: b79af6a65df899227821e4a02bf17587f1f423042a4280a54525c8469c1c3344f3dd2c3b16bd0de477c711d27ed04527295ca37e811c1c829037379509971ac6
+  data.tar.gz: 7d1b5dea80d0af672713d18675166207e2d62ab51aff84045411d02344529a32de513df76d394e3769dfb14a69d0742f18e850398dc9b4cc6bac10eb5c72ecec

data/CHANGELOG.md

@@ -1,24 +1,32 @@
+### 0.2.5
+* Changes
+  * Remove init of `@field_names = []` in `Model#initialize` as unnecessary - FieldNamesPersistable takes care of this.
+* Bug fixes
+  * Fix but that does not take into account option :namespace when determining whether or not a field name conflicts with an existing attribute (already exists).
+
 ### 0.2.4
 * Changes
   * Change DecoLite::Model#load to #load! as it alters the object, give deprecation warning when calling #load.
   * FieldConflictable now expliticly prohibits loading fields that conflict with attributes that are native to the receiver. In other words, you cannot load fields with names like :to_s, :tap, :hash, etc.
   * FieldCreatable now creates attr_accessors on the instance using #define_singleton_method, not at the class level (i.e. self.class.attr_accessor) (see bug fixes).
-* bug fixes
+* Bug fixes
   * Fix bug that used self.class.attr_accessor in DecoLite::FieldCreatable to create attributes, which forced every object of that class subsequently created have the accessors created which caused field name conflicts across DecoLite::Model objects.
 
 ### 0.2.3
-* Fix bug that added duplcate field names to Model#field_names.
+* Bug fixes
+  * Fix bug that added duplcate field names to Model#field_names.
 
 ### 0.2.2
-* Fix bug requiring support codez in lib/deco_lite.rb.
+* Bug fixes
+  * Fix bug requiring support codez in lib/deco_lite.rb.
 
 ### 0.2.1
-* changes
+* Changes
   * Add mad_flatter gem runtime dependency.
   * Refactor to let mad_flatter handle the Hash flattening.
 
 ### 0.1.1
-* changes
+* Changes
   * Update gems and especially rake gem version to squash CVE-2020-8130, see https://github.com/advisories/GHSA-jppv-gw3r-w3q8.
   * Fix rubocop violations.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    deco_lite (0.2.4)
+    deco_lite (0.2.5)
       activemodel (~> 7.0, >= 7.0.3.1)
       activesupport (~> 7.0, >= 7.0.3.1)
       immutable_struct_ex (~> 0.2.0)

data/lib/deco_lite/field_conflictable.rb

@@ -1,43 +1,49 @@
 # frozen_string_literal: true
 
+require_relative 'field_name_namespaceable'
 require_relative 'fields_optionable'
 
 module DecoLite
   # Defines methods to to manage fields that conflict with
   # existing model attributes.
   module FieldConflictable
+    include FieldNameNamespaceable
     include FieldsOptionable
 
     def validate_field_conflicts!(field_name:, options:)
       return unless field_conflict?(field_name: field_name, options: options)
 
+      field_name = field_name_or_field_name_with_namespace field_name: field_name, options: options
+
       raise "Field :#{field_name} conflicts with existing method(s) " \
-        ":#{field_name} and/or :#{field_name}=; " \
-        'this will raise an error when loading using strict mode ' \
-        "(i.e. options: { #{OPTION_FIELDS}: :#{OPTION_FIELDS_STRICT} }) " \
-        'or if the method(s) are native to the object (e.g :to_s, :==, etc.).'
+            ":#{field_name} and/or :#{field_name}=; " \
+            'this will raise an error when loading using strict mode ' \
+            "(i.e. options: { #{OPTION_FIELDS}: :#{OPTION_FIELDS_STRICT} }) " \
+            'or if the method(s) are native to the object (e.g :to_s, :==, etc.).'
     end
 
     # This method returns true
     def field_conflict?(field_name:, options:)
       # If field_name was already added using Model#load, there is only a
       # conflict if options.strict? is true.
-      if field_names_include?(field_name: field_name)
-        return options.strict?
-      end
+      return options.strict? if field_names_include?(field_name: field_name, options: options)
 
       # If we get here, we know that :field_name does not exist as an
       # attribute on the model. If the attribute already exists on the
       # model, this is a conflict because we cannot override an attribute
       # that already exists on the model
-      attr_accessor_exist?(field_name: field_name)
+      attr_accessor_exist?(field_name: field_name, options: options)
     end
 
-    def field_names_include?(field_name:)
+    def field_names_include?(field_name:, options:)
+      field_name = field_name_or_field_name_with_namespace field_name: field_name, options: options
+
       field_names.include? field_name
     end
 
-    def attr_accessor_exist?(field_name:)
+    def attr_accessor_exist?(field_name:, options:)
+      field_name = field_name_or_field_name_with_namespace field_name: field_name, options: options
+
       respond_to?(field_name) || respond_to?(:"#{field_name}=")
     end
   end

data/lib/deco_lite/field_creatable.rb

@@ -30,6 +30,7 @@ module DecoLite
 
     private
 
+    # rubocop:disable Lint/UnusedMethodArgument
     def create_field_getter(field_name:, options:)
       define_singleton_method(field_name) do
         instance_variable_get "@#{field_name}"
@@ -41,5 +42,6 @@ module DecoLite
         instance_variable_set "@#{field_name}", value
       end
     end
+    # rubocop:enable Lint/UnusedMethodArgument
   end
 end

data/lib/deco_lite/field_name_namespaceable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DecoLite
+  # Defines methods to transform a field name into a field name
+  # with a namespace.
+  module FieldNameNamespaceable
+    def field_name_or_field_name_with_namespace(field_name:, options:)
+      return field_name unless options.namespace?
+
+      field_name_with_namespace(field_name: field_name, namespace: options.namespace)
+    end
+
+    def field_name_with_namespace(field_name:, namespace:)
+      "#{namespace}_#{field_name}"
+    end
+  end
+end

data/lib/deco_lite/field_validatable.rb

@@ -3,14 +3,14 @@
 module DecoLite
   # Defines methods validate field (attribute) names.
   module FieldValidatable
-    FIELD_NAME_REGEX = /\A(?:[a-z_]\w*[?!=]?|\[\]=?|<<|>>|\*\*|[!~+\*\/%&^|-]|[<>]=?|<=>|={2,3}|![=~]|=~)\z/i.freeze
+    FIELD_NAME_REGEX = %r{\A(?:[a-z_]\w*[?!=]?|\[\]=?|<<|>>|\*\*|[!~+*/%&^|-]|[<>]=?|<=>|={2,3}|![=~]|=~)\z}i
 
     module_function
 
+    # rubocop:disable Lint/UnusedMethodArgument
     def validate_field_name!(field_name:, options: nil)
-      unless field_name =~ FIELD_NAME_REGEX
-        raise "field_name '#{field_name}' is not a valid field name."
-      end
+      raise "field_name '#{field_name}' is not a valid field name." unless FIELD_NAME_REGEX.match?(field_name)
     end
+    # rubocop:enable Lint/UnusedMethodArgument
   end
 end

data/lib/deco_lite/model.rb

@@ -25,8 +25,6 @@ module DecoLite
     validate :validate_required_fields
 
     def initialize(options: {})
-      @field_names = []
-
       # Accept whatever options are sent, but make sure
       # we have defaults set up. #options_with_defaults
       # will merge options into OptionsDefaultable::DEFAULT_OPTIONS
@@ -49,10 +47,10 @@ module DecoLite
     end
 
     def load(hash:, options: {})
-      puts 'WARNING: DecoLite::Model#load will be deprecated in a future release;' \
-        ' use DecoLite::Model#load! instead!'
+      puts 'WARNING: DecoLite::Model#load will be deprecated in a future release; ' \
+           'use DecoLite::Model#load! instead!'
 
-        load!(hash: hash, options: options)
+      load!(hash: hash, options: options)
     end
   end
 end

data/lib/deco_lite/options_validatable.rb

@@ -35,7 +35,7 @@ module DecoLite
 
       raise ArgumentError,
         "option :fields value or type is invalid. #{OPTION_FIELDS_VALUES} (Symbol) " \
-          "was expected, but '#{fields}' (#{fields.class}) was received."
+        "was expected, but '#{fields}' (#{fields.class}) was received."
     end
 
     def validate_option_namespace!(namespace:)
@@ -43,7 +43,7 @@ module DecoLite
       return if namespace.blank? || namespace.is_a?(Symbol)
 
       raise ArgumentError, 'option :namespace value or type is invalid. A Symbol was expected, ' \
-        "but '#{namespace}' (#{namespace.class}) was received."
+                           "but '#{namespace}' (#{namespace.class}) was received."
     end
   end
 end

data/lib/deco_lite/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the version of this gem.
 module DecoLite
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
 end

data/lib/deco_lite.rb

@@ -3,6 +3,7 @@
 require_relative 'deco_lite/field_assignable'
 require_relative 'deco_lite/field_conflictable'
 require_relative 'deco_lite/field_creatable'
+require_relative 'deco_lite/field_name_namespaceable'
 require_relative 'deco_lite/field_names_persistable'
 require_relative 'deco_lite/field_requireable'
 require_relative 'deco_lite/field_retrievable'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deco_lite
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-21 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -261,6 +261,7 @@ files:
 - lib/deco_lite/field_assignable.rb
 - lib/deco_lite/field_conflictable.rb
 - lib/deco_lite/field_creatable.rb
+- lib/deco_lite/field_name_namespaceable.rb
 - lib/deco_lite/field_names_persistable.rb
 - lib/deco_lite/field_requireable.rb
 - lib/deco_lite/field_retrievable.rb