deco_lite 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e8cab024f00d573f418f6da7931159d211392b7e67994b6e5d736fa87e6858d
-  data.tar.gz: 75d52762639bda61821152dd7ee071c0c29571de02835d9ca2309dc3f645a380
+  metadata.gz: 74286df21784817e45f4d615081bfeac44d90f13d8200bc8f066107e8d0f773f
+  data.tar.gz: 57dcc52147494eb3caf59159cbb21bc23bb6788d0b6315ebc1ddd8cf1868c779
 SHA512:
-  metadata.gz: 073e6f539cae726483f065c873ab6b21c11a0f29cb497998c66ad85c9f1775c4c973f675c4138c07d2b7158455cf819555ca3b550ea38c7e6b3811dfb2bf9780
-  data.tar.gz: f69bc6b7d1052172c9603c1b2a0b49cd13ee863217c2303b49dbafe86dd68e0b5def92184948b80efd8760b6735878ff0ddad2ecdbb5b01135c7cbc3241b4ee5
+  metadata.gz: b79af6a65df899227821e4a02bf17587f1f423042a4280a54525c8469c1c3344f3dd2c3b16bd0de477c711d27ed04527295ca37e811c1c829037379509971ac6
+  data.tar.gz: 7d1b5dea80d0af672713d18675166207e2d62ab51aff84045411d02344529a32de513df76d394e3769dfb14a69d0742f18e850398dc9b4cc6bac10eb5c72ecec

data/CHANGELOG.md

@@ -1,13 +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
+  * 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
+* 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.2)
+    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/README.md

@@ -170,6 +170,29 @@ model.wife_info_age         #=> 20
 model.wife_info_address     #=> 1 street, boonton, nj 07005
 ```
 
+### Manually Defining Attributes
+
+Manually defining attributes on your subclass is possible; however, you
+must add your attr_reader name to the `DecoLite::Model@field_names` array, or an error will be reaised _if_ there are any conflicting field names being loaded
+using `DecoLite::Model#load!`, regardless of setting the `{ fields: :merge }`
+option. This is because DecoLite assumes any existing attributes not added to
+the model via `load!`to be native to the object created, and therefore will not
+allow you to create attr_accessors for existing attributes, as this can potentially be dangerous.
+
+To avoid errors when manually defining attributes on the model that could potentially be in conflict with fields loaded using `DecoLite::Model#load!`, do the following:
+
+```ruby
+class JustBecauseYouCanDoesntMeanYouShould < DecoLite::Model
+  attr_accessor :existing_field
+
+  def initialize(options: {})
+    super
+
+    @field_names = %i(existing_field)
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/deco_lite/field_conflictable.rb

@@ -1,23 +1,50 @@
 # 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 options.strict? && field_conflict?(field_name: field_name)
+      return unless field_conflict?(field_name: field_name, options: options)
 
-      raise "Field '#{field_name}' conflicts with existing attribute; " \
-        'this will raise an error when running in strict mode: ' \
-        "options: { #{OPTION_FIELDS}: :#{OPTION_FIELDS_STRICT} }."
+      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.).'
+    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.
+      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, options: options)
     end
 
-    def field_conflict?(field_name:)
-      respond_to? 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:, 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
 end

data/lib/deco_lite/field_creatable.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require_relative 'field_conflictable'
+require_relative 'field_validatable'
 
 module DecoLite
   # Takes an array of symbols and creates attr_accessors.
   module FieldCreatable
     include FieldConflictable
+    include FieldValidatable
 
     def create_field_accessors(field_names:, options:)
       return if field_names.blank?
@@ -16,9 +18,30 @@ module DecoLite
     end
 
     def create_field_accessor(field_name:, options:)
+      validate_field_name!(field_name: field_name, options: options)
       validate_field_conflicts!(field_name: field_name, options: options)
 
-      self.class.attr_accessor(field_name) if field_name.present?
+      # If we want to set a class-level attr_accessor
+      # self.class.attr_accessor(field_name) if field_name.present?
+
+      create_field_getter field_name: field_name, options: options
+      create_field_setter field_name: field_name, options: options
+    end
+
+    private
+
+    # rubocop:disable Lint/UnusedMethodArgument
+    def create_field_getter(field_name:, options:)
+      define_singleton_method(field_name) do
+        instance_variable_get "@#{field_name}"
+      end
+    end
+
+    def create_field_setter(field_name:, options:)
+      define_singleton_method("#{field_name}=") do |value|
+        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_names_persistable.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DecoLite
+  # Takes an array of symbols and creates attr_accessors.
+  module FieldNamesPersistable
+    def field_names
+      @field_names ||= instance_variable_get(:@field_names) || []
+    end
+
+    private
+
+    attr_writer :field_names
+  end
+end

data/lib/deco_lite/field_validatable.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DecoLite
+  # Defines methods validate field (attribute) names.
+  module FieldValidatable
+    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)
+      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/hash_loadable.rb

@@ -19,7 +19,7 @@ module DecoLite
       load_service.execute(hash: hash, options: load_service_options).tap do |h|
         h.each_pair do |field_name, value|
           create_field_accessor field_name: field_name, options: deco_lite_options
-          field_names << field_name
+          field_names << field_name unless field_names.include? field_name
           set_field_value(field_name: field_name, value: value, options: deco_lite_options)
         end
       end

data/lib/deco_lite/model.rb

@@ -3,6 +3,7 @@
 require 'active_model'
 require_relative 'field_creatable'
 require_relative 'field_requireable'
+require_relative 'field_names_persistable'
 require_relative 'hash_loadable'
 require_relative 'hashable'
 require_relative 'model_nameable'
@@ -14,6 +15,7 @@ module DecoLite
   class Model
     include ActiveModel::Model
     include FieldCreatable
+    include FieldNamesPersistable
     include FieldRequireable
     include HashLoadable
     include Hashable
@@ -23,7 +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
@@ -32,7 +33,7 @@ module DecoLite
       self.options = Options.with_defaults options
     end
 
-    def load(hash:, options: {})
+    def load!(hash:, options: {})
       # Merge options into the default options passed through the
       # constructor; these will override any options passed in when
       # this object was created, allowing us to retain any defaut
@@ -45,10 +46,11 @@ module DecoLite
       self
     end
 
-    attr_reader :field_names
-
-    private
+    def load(hash:, options: {})
+      puts 'WARNING: DecoLite::Model#load will be deprecated in a future release; ' \
+           'use DecoLite::Model#load! instead!'
 
-    attr_writer :field_names
+      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.2'
+  VERSION = '0.2.5'
 end

data/lib/deco_lite.rb

@@ -3,6 +3,8 @@
 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'
 require_relative 'deco_lite/fields_optionable'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deco_lite
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -261,8 +261,11 @@ 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
+- lib/deco_lite/field_validatable.rb
 - lib/deco_lite/fields_optionable.rb
 - lib/deco_lite/hash_loadable.rb
 - lib/deco_lite/hashable.rb