deco_lite 0.1.1 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9b6003b4b875144ddc599d65ace8b397b3bb010cacc95aebf3360b71a7ccda9
-  data.tar.gz: 82e1860ba9e6f5762e6bc52233160fae55e4f0a715ec3bb8a555ec3b3d24ac23
+  metadata.gz: 2d360b0607d72711264a19f807ad4367237f0e5e69efb385728ccbda66e72e05
+  data.tar.gz: f90e61477cc9dfa1ba8d19070c1490fcccfce413533436ed93b532d4933fad08
 SHA512:
-  metadata.gz: c2f7ddce5f5d6bc1367ae5da30e2043cc60b443c93f4df0f4caac435c415b0dfeeffdff424460810cb0a9996f00e3fee4e9d0138bbac4d8515138613c5b9a0a5
-  data.tar.gz: 492a9602f01f7615049039e0dccc80debce0cbc1ec57d5927e72ca6b6f4f320fb5526b8f2384c81b4a3c12e70a278d4dcc4978c73b3ff56436d628390480e850
+  metadata.gz: 87d78e241cd8aada8c09c8adbcb20cdb5997e96ff4f17cc8dd3a494e973fd10f13fe73927edb604e2125209119bd881522c79995753768fc0f64d049632d1751
+  data.tar.gz: d4ae03338d636d82d6a67996cea9e2143a07b0319a9ad6f3a1f1e4a508b2f9a4262ec5cb7e68c8cb2b7d29a8f0e046413ad7f9470f4a20c6fa470c20d9e3c907

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+### 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.
+
+### 0.2.2
+* Fix bug requiring support codez in lib/deco_lite.rb.
+
+### 0.2.1
+* changes
+  * Add mad_flatter gem runtime dependency.
+  * Refactor to let mad_flatter handle the Hash flattening.
+
 ### 0.1.1
 * changes
   * Update gems and especially rake gem version to squash CVE-2020-8130, see https://github.com/advisories/GHSA-jppv-gw3r-w3q8.

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    deco_lite (0.1.1)
+    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)
+      mad_flatter (~> 1.0.0.pre.beta)
 
 GEM
   remote: https://rubygems.org/
@@ -24,20 +25,23 @@ GEM
     docile (1.4.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    immutable_struct_ex (0.2.1)
+    immutable_struct_ex (0.2.2)
     json (2.6.2)
     kwalify (0.7.2)
+    mad_flatter (1.0.1.pre.beta)
+      activesupport (~> 7.0, >= 7.0.3.1)
+      immutable_struct_ex (~> 0.2.0)
     method_source (1.0.0)
-    minitest (5.16.2)
+    minitest (5.16.3)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.9.0)
+    pry-byebug (3.10.1)
       byebug (~> 11.0)
-      pry (~> 0.13.0)
+      pry (>= 0.13, < 0.15)
     rainbow (3.1.1)
     rake (13.0.6)
     reek (6.1.1)
@@ -46,19 +50,19 @@ GEM
       rainbow (>= 2.0, < 4.0)
     regexp_parser (2.5.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.2)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.2)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.3)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     rubocop (1.35.0)
       json (~> 2.3)
       parallel (~> 1.10)

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/deco_lite.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activemodel', '~> 7.0', '>= 7.0.3.1'
   spec.add_runtime_dependency 'activesupport', '~> 7.0', '>= 7.0.3.1'
   spec.add_runtime_dependency 'immutable_struct_ex', '~> 0.2.0'
+  spec.add_runtime_dependency 'mad_flatter', '~> 1.0.0.pre.beta'
   spec.add_development_dependency 'bundler', '~> 2.2', '>= 2.2.17'
   spec.add_development_dependency 'pry-byebug', '~> 3.9'
   spec.add_development_dependency 'reek', '~> 6.1', '>= 6.1.1'

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/hash_loadable.rb

@@ -1,24 +1,37 @@
 # frozen_string_literal: true
 
+require 'mad_flatter'
 require_relative 'field_assignable'
-require_relative 'field_informable'
 
 module DecoLite
   # Provides methods to load and return information about a given hash.
   module HashLoadable
     include FieldAssignable
-    include FieldInformable
 
     private
 
-    def load_hash(hash:, options:)
+    def load_hash(hash:, deco_lite_options:)
       raise ArgumentError, "Argument hash is not a Hash (#{hash.class})" unless hash.is_a? Hash
 
-      return if hash.blank?
+      return {} if hash.blank?
 
-      field_info = get_field_info(hash: hash, namespace: options.namespace)
-      set_field_values(hash: hash, field_info: field_info, options: options)
-      merge_field_info! field_info: field_info
+      load_service_options = merge_with_load_service_options deco_lite_options: deco_lite_options
+      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 unless field_names.include? field_name
+          set_field_value(field_name: field_name, value: value, options: deco_lite_options)
+        end
+      end
+    end
+
+    def load_service
+      @load_service ||= MadFlatter::Service.new
+    end
+
+    def merge_with_load_service_options(deco_lite_options:)
+      load_service.options.to_h.merge \
+        deco_lite_options.to_h.slice(*MadFlatter::OptionsDefaultable::DEFAULT_OPTIONS.keys)
     end
   end
 end

data/lib/deco_lite/model.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require 'active_model'
+require_relative 'field_creatable'
 require_relative 'field_requireable'
-require_relative 'hashable'
+require_relative 'field_names_persistable'
 require_relative 'hash_loadable'
+require_relative 'hashable'
 require_relative 'model_nameable'
 require_relative 'optionable'
 
@@ -12,16 +14,19 @@ module DecoLite
   # dynamic models that can be used as decorators.
   class Model
     include ActiveModel::Model
+    include FieldCreatable
+    include FieldNamesPersistable
     include FieldRequireable
-    include Hashable
     include HashLoadable
+    include Hashable
     include ModelNameable
     include Optionable
 
     validate :validate_required_fields
 
     def initialize(options: {})
-      @field_info = {}
+      @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
@@ -30,16 +35,24 @@ 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
       # options while loading, but also provide option customization
       # of options when needed.
       options = Options.with_defaults(options, defaults: self.options)
-      load_hash(hash: hash, options: options)
+
+      load_hash(hash: hash, deco_lite_options: options)
 
       self
     end
+
+    def load(hash:, options: {})
+      puts 'WARNING: DecoLite::Model#load will be deprecated in a future release;' \
+        ' use DecoLite::Model#load! instead!'
+
+        load!(hash: hash, options: options)
+    end
   end
 end

data/lib/deco_lite/options.rb

@@ -22,7 +22,7 @@ module DecoLite
           end
 
           def namespace?
-            namespace || false
+            namespace.present? || false
           end
         end
         validate_options! options: immutable_struct_ex.to_h

data/lib/deco_lite/version.rb

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

data/lib/deco_lite.rb

@@ -1,5 +1,19 @@
 # frozen_string_literal: true
 
-Dir[File.join('.', 'lib/deco_lite/**/*.rb')].each do |f|
-  require f
-end
+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'
+require_relative 'deco_lite/hash_loadable'
+require_relative 'deco_lite/hashable'
+require_relative 'deco_lite/model'
+require_relative 'deco_lite/model_nameable'
+require_relative 'deco_lite/namespace_optionable'
+require_relative 'deco_lite/optionable'
+require_relative 'deco_lite/options'
+require_relative 'deco_lite/options_defaultable'
+require_relative 'deco_lite/options_validatable'
+require_relative 'deco_lite/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deco_lite
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.4
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-14 00:00:00.000000000 Z
+date: 2022-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -64,6 +64,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: mad_flatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre.beta
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -247,9 +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_informable.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

data/lib/deco_lite/field_informable.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-module DecoLite
-  # Creates and returns a hash given the parameters that are used to
-  # dynamically create fields and assign values to a model.
-  module FieldInformable
-    # This method simply navigates the payload hash received and creates qualified
-    # hash key names that can be used to verify/map to our field names in this model.
-    # This can be used to qualify nested hash fields and saves us some headaches
-    # if there are nested field names with the same name:
-    #
-    # given:
-    #
-    # hash = {
-    #   first_name: 'first_name',
-    #   ...
-    #   address: {
-    #     street: '',
-    #     ...
-    #   }
-    # }
-    #
-    # get_field_info(hash: hash) #=>
-    #
-    # {
-    #   :first_name=>{:field_name=>:first_name, :dig=>[]},
-    #   ...
-    #   :address_street=>{:field_name=>:street, :dig=>[:address]},
-    #   ...
-    # }
-    #
-    # The generated, qualified field names expected to map to our model, because we named
-    # them as such.
-    #
-    # :field_name is the actual, unqualified field name found in the payload hash sent.
-    # :dig is the hash key by which :field_name can be found in the payload hash if need be -
-    #   retained across recursive calls.
-    def get_field_info(hash:, namespace: nil, dig: [], field_info: {})
-      hash.each do |key, value|
-        if value.is_a? Hash
-          get_field_info hash: value,
-                         namespace: namespace,
-                         dig: dig << key,
-                         field_info: field_info
-          dig.pop
-        else
-          set_field_info!(field_info: field_info,
-                          key: key,
-                          namespace: namespace,
-                          dig: dig)
-        end
-      end
-
-      field_info
-    end
-
-    def set_field_info!(field_info:, key:, namespace:, dig:)
-      field_key = [namespace, *dig, key].compact.join('_').to_sym
-
-      field_info[field_key] = {
-        field_name: key,
-        dig: dig.dup
-      }
-    end
-
-    def merge_field_info!(field_info:)
-      @field_info.merge!(field_info)
-    end
-
-    def field_names
-      field_info&.keys || []
-    end
-
-    attr_reader :field_info
-
-    private
-
-    attr_writer :field_info
-
-    module_function :get_field_info, :set_field_info!, :merge_field_info!
-  end
-end