deco_lite 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9cc4e271606535b0bb5daf708487f63f68c193709e4a2e2efa4e7c7fee60d49
-  data.tar.gz: d34b33b97c7b1554c35dc064e2a52908d9e007ee90608a876cbfac944d6d79e8
+  metadata.gz: 2d360b0607d72711264a19f807ad4367237f0e5e69efb385728ccbda66e72e05
+  data.tar.gz: f90e61477cc9dfa1ba8d19070c1490fcccfce413533436ed93b532d4933fad08
 SHA512:
-  metadata.gz: 785614c89432bb0dd43ec4fa24a3760205c606d5a25a16e7392d569a57b2a8509c307adbe53f622a80a509cbe88b17535bc0bb484071415f51252704a096782b
-  data.tar.gz: 28c95fb72bc380e4a568680375cbdaa03105aa0d7c05cd7f910c61bb910f0aa9a6a5056a5ed3254e11df4755b6c88a7ac6bfe932f3bfded7ebcd4003c5513749
+  metadata.gz: 87d78e241cd8aada8c09c8adbcb20cdb5997e96ff4f17cc8dd3a494e973fd10f13fe73927edb604e2125209119bd881522c79995753768fc0f64d049632d1751
+  data.tar.gz: d4ae03338d636d82d6a67996cea9e2143a07b0319a9ad6f3a1f1e4a508b2f9a4262ec5cb7e68c8cb2b7d29a8f0e046413ad7f9470f4a20c6fa470c20d9e3c907

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 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
 * Fix bug that added duplcate field names to Model#field_names.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    deco_lite (0.2.3)
+    deco_lite (0.2.4)
       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

@@ -9,15 +9,36 @@ module DecoLite
     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} }."
+      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
 
-    def field_conflict?(field_name:)
-      respond_to? field_name
+    # 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
+
+      # 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)
+    end
+
+    def field_names_include?(field_name:)
+      field_names.include? field_name
+    end
+
+    def attr_accessor_exist?(field_name:)
+      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,28 @@ 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
+
+    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
   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 = /\A(?:[a-z_]\w*[?!=]?|\[\]=?|<<|>>|\*\*|[!~+\*\/%&^|-]|[<>]=?|<=>|={2,3}|![=~]|=~)\z/i.freeze
+
+    module_function
+
+    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
+    end
+  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
@@ -24,6 +26,7 @@ module DecoLite
 
     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 +35,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 +48,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/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the version of this gem.
 module DecoLite
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 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_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.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-18 00:00:00.000000000 Z
+date: 2022-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -261,8 +261,10 @@ files:
 - lib/deco_lite/field_assignable.rb
 - lib/deco_lite/field_conflictable.rb
 - lib/deco_lite/field_creatable.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