u-attributes 2.1.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7939bac74159eb5cd1e4307a80805ee0712fe5233148f550bd40c3ed99773d5d
-  data.tar.gz: ac33edcb92e41acf77e823d61e22c2b2b6abe3b4c74036dfbf82d741ee208724
+  metadata.gz: 484a7b770e8ae7dd141c7538e2bc50c1b82beb63e24ee53dd9f9445cbd91f057
+  data.tar.gz: 3d555771a3deba711dc4995cd12674461b94c82e65ccbdd9bba215d354adaa52
 SHA512:
-  metadata.gz: '0796ae31ef53f91844d02950c00f52fe263794d13af076b5814292bd63e73ff36939f5141888f9c0db9f7c5ff7e3a739be11d1b04e89b8e76ee0eff21068ab05'
-  data.tar.gz: 16423f86a33677355c35c4aa5184d2356739a16d2506faf94cc45c50b033139c81ff11c261d9e7383228bd500d583caafd1596e89d411c2d21238c540dc63608
+  metadata.gz: fc5f65eb1a10c5172f0b6a1fa5296f4470e024fa42559cfe0d64d89d0a07c0c203ae28ce1b66afae741669a8073b1c6cbb7d05d5373874946afefca6620d7874
+  data.tar.gz: db8895b0a85d803de7ec04f81fc83fb98eac4b487ed4224e7fb7b6bda3d66293758ce416341dddbd40ae630dfb96d4d26cdd380990a3fca2580df931b459311a

data/README.md

@@ -47,6 +47,15 @@ So, if you change [[1](#with_attribute)] [[2](#with_attributes)] some object att
   - [Is it possible to inherit the attributes?](#is-it-possible-to-inherit-the-attributes)
     - [`.attribute!()`](#attribute)
   - [How to query the attributes?](#how-to-query-the-attributes)
+    - [`.attributes`](#attributes)
+    - [`.attribute?()`](#attribute-1)
+    - [`#attribute?()`](#attribute-2)
+    - [`#attributes()`](#attributes-1)
+      - [`#attributes(keys_as:)`](#attributeskeys_as)
+      - [`#attributes(*names)`](#attributesnames)
+      - [`#attributes([names])`](#attributesnames-1)
+      - [`#attributes(with:, without:)`](#attributeswith-without)
+    - [`#defined_attributes`](#defined_attributes)
 - [Built-in extensions](#built-in-extensions)
   - [Picking specific features](#picking-specific-features)
     - [`Micro::Attributes.with`](#microattributeswith)
@@ -58,6 +67,7 @@ So, if you change [[1](#with_attribute)] [[2](#with_attributes)] some object att
     - [Diff extension](#diff-extension)
     - [Initialize extension](#initialize-extension)
       - [Strict mode](#strict-mode)
+    - [Keys as symbol extension](#keys-as-symbol-extension)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -75,7 +85,7 @@ gem 'u-attributes'
 
 | u-attributes   | branch  | ruby     |  activemodel  |
 | -------------- | ------- | -------- | ------------- |
-| 2.1.1          | main    | >= 2.2.0 | >= 3.2, < 6.1 |
+| 2.6.0          | main    | >= 2.2.0 | >= 3.2, < 6.1 |
 | 1.2.0          | v1.x    | >= 2.2.0 | >= 3.2, < 6.1 |
 
 > **Note**: The activemodel is an optional dependency, this module [can be enabled](#activemodelvalidation-extension) to validate the attributes.
@@ -320,10 +330,9 @@ class Person
 end
 ```
 
-There are 3 different strategies to define default values.
+There are two different strategies to define default values.
 1. Pass a regular object, like in the previous example.
 2. Pass a `proc`/`lambda`, and if it has an argument you will receive the attribute value to do something before assign it.
-3. Pass a **callable**, that is, a `class`, `module` or `instance` which responds to the `call` method. The behavior will be like the previous item (`proc`/`lambda`).
 
 ```ruby
 class Person
@@ -420,69 +429,155 @@ beta_person.age  # 0
 
 ## How to query the attributes?
 
+All of the methods that will be explained can be used with any of the built-in extensions.
+
+**PS:** We will use the class below for all of the next examples.
+
 ```ruby
 class Person
   include Micro::Attributes
 
   attribute :age
-  attribute :name, default: 'John Doe'
+  attribute :first_name, default: 'John'
+  attribute :last_name, default: 'Doe'
 
   def initialize(options)
     self.attributes = options
   end
+
+  def name
+    "#{first_name} #{last_name}"
+  end
 end
+```
 
-#---------------#
-# .attributes() #
-#---------------#
+### `.attributes`
 
-Person.attributes # ['name', 'age']
+Listing all the class attributes.
 
-#---------------#
-# .attribute?() #
-#---------------#
+```ruby
+Person.attributes # ["age", "first_name", "last_name"]
+```
 
-Person.attribute?(:name)  # true
-Person.attribute?('name') # true
-Person.attribute?('foo') # false
-Person.attribute?(:foo)  # false
+### `.attribute?()`
 
-# ---
+Checking the existence of some attribute.
 
-person = Person.new(age: 20)
+```ruby
+Person.attribute?(:first_name)  # true
+Person.attribute?('first_name') # true
 
-#---------------------#
-# #defined_attributes #
-#---------------------#
+Person.attribute?('foo') # false
+Person.attribute?(:foo)  # false
+```
 
-person.defined_attributes # ['name', 'age']
+### `#attribute?()`
 
-#---------------#
-# #attribute?() #
-#---------------#
+Checking the existence of some attribute in an instance.
+
+```ruby
+person = Person.new(age: 20)
 
 person.attribute?(:name)  # true
 person.attribute?('name') # true
+
 person.attribute?('foo') # false
 person.attribute?(:foo)  # false
+```
+
+### `#attributes()`
+
+Fetching all the attributes with their values.
+
+```ruby
+person1 = Person.new(age: 20)
+person1.attributes # {"age"=>20, "first_name"=>"John", "last_name"=>"Doe"}
+
+person2 = Person.new(first_name: 'Rodrigo', last_name: 'Rodrigues')
+person2.attributes # {"age"=>nil, "first_name"=>"Rodrigo", "last_name"=>"Rodrigues"}
+```
+
+#### `#attributes(keys_as:)`
+
+Use the `keys_as:` option with `Symbol`/`:symbol` or `String`/`:string` to transform the attributes hash keys.
+
+```ruby
+person1 = Person.new(age: 20)
+person2 = Person.new(first_name: 'Rodrigo', last_name: 'Rodrigues')
+
+person1.attributes(keys_as: Symbol) # {:age=>20, :first_name=>"John", :last_name=>"Doe"}
+person2.attributes(keys_as: String) # {"age"=>nil, "first_name"=>"Rodrigo", "last_name"=>"Rodrigues"}
+
+person1.attributes(keys_as: :symbol) # {:age=>20, :first_name=>"John", :last_name=>"Doe"}
+person2.attributes(keys_as: :string) # {"age"=>nil, "first_name"=>"Rodrigo", "last_name"=>"Rodrigues"}
+```
+
+#### `#attributes(*names)`
+
+Slices the attributes to include only the given keys (in their types).
+
+```ruby
+person = Person.new(age: 20)
+
+person.attributes(:age)               # {:age => 20}
+person.attributes(:age, :first_name)  # {:age => 20, :first_name => "John"}
+person.attributes('age', 'last_name') # {"age" => 20, "last_name" => "Doe"}
+
+person.attributes(:age, 'last_name') # {:age => 20, "last_name" => "Doe"}
+
+# You could also use the keys_as: option to ensure the same type for all of the hash keys.
+
+person.attributes(:age, 'last_name', keys_as: Symbol) # {:age=>20, :last_name=>"Doe"}
+```
+
+#### `#attributes([names])`
+
+As the previous example, this methods accepts a list of keys to slice the attributes.
+
+```ruby
+person = Person.new(age: 20)
+
+person.attributes([:age])               # {:age => 20}
+person.attributes([:age, :first_name])  # {:age => 20, :first_name => "John"}
+person.attributes(['age', 'last_name']) # {"age" => 20, "last_name" => "Doe"}
+
+person.attributes([:age, 'last_name']) # {:age => 20, "last_name" => "Doe"}
+
+# You could also use the keys_as: option to ensure the same type for all of the hash keys.
+
+person.attributes([:age, 'last_name'], keys_as: Symbol) # {:age=>20, :last_name=>"Doe"}
+```
+
+#### `#attributes(with:, without:)`
+
+Use the `with:` option to include any method value of the instance inside of the hash, and,
+you can use the `without:` option to exclude one or more attribute keys from the final hash.
+
+```ruby
+person = Person.new(age: 20)
 
-#---------------#
-# #attributes() #
-#---------------#
+person.attributes(without: :age)               # {"first_name"=>"John", "last_name"=>"Doe"}
+person.attributes(without: [:age, :last_name]) # {"first_name"=>"John"}
 
-person.attributes                   # {'age'=>20, 'name'=>'John Doe'}
-Person.new(name: 'John').attributes # {'age'=>nil, 'name'=>'John'}
+person.attributes(with: [:name], without: [:first_name, :last_name]) # {"age"=>20, "name"=>"John Doe"}
 
-#---------------------#
-# #attributes(*names) #
-#---------------------#
+# To achieves the same output of the previous example, use the attribute names to slice only them.
 
-# Slices the attributes to include only the given keys.
-# Returns a hash containing the given keys (in their types).
+person.attributes(:age, with: [:name]) # {:age=>20, "name"=>"John Doe"}
 
-person.attributes(:age)             # {age: 20}
-person.attributes(:age, :name)      # {age: 20, name: 'John Doe'}
-person.attributes('age', 'name')    # {'age'=>20, 'name'=>'John Doe'}
+# You could also use the keys_as: option to ensure the same type for all of the hash keys.
+
+person.attributes(:age, with: [:name], keys_as: Symbol) # {:age=>20, :name=>"John Doe"}
+```
+
+### `#defined_attributes`
+
+Listing all the available attributes.
+
+```ruby
+person = Person.new(age: 20)
+
+person.defined_attributes # ["age", "first_name", "last_name"]
 ```
 
 [⬆️ Back to Top](#table-of-contents-)
@@ -500,24 +595,30 @@ But, if you desire except one or more features, use the `Micro::Attributes.witho
 ```ruby
 Micro::Attributes.with(:initialize)
 
-Micro::Attributes.with(initialize: :strict)
+Micro::Attributes.with(:initialize, :keys_as_symbol)
+
+Micro::Attributes.with(:keys_as_symbol, initialize: :strict)
 
 Micro::Attributes.with(:diff, :initialize)
 
 Micro::Attributes.with(:diff, initialize: :strict)
 
+Micro::Attributes.with(:diff, :keys_as_symbol, initialize: :strict)
+
 Micro::Attributes.with(:activemodel_validations)
 
 Micro::Attributes.with(:activemodel_validations, :diff)
 
 Micro::Attributes.with(:activemodel_validations, :diff, initialize: :strict)
+
+Micro::Attributes.with(:activemodel_validations, :diff, :keys_as_symbol, initialize: :strict)
 ```
 
 The method `Micro::Attributes.with()` will raise an exception if no arguments/features were declared.
 
 ```ruby
 class Job
-  include Micro::Attributes.with() # ArgumentError (Invalid feature name! Available options: :activemodel_validations, :diff, :initialize)
+  include Micro::Attributes.with() # ArgumentError (Invalid feature name! Available options: :accept, :activemodel_validations, :diff, :initialize, :keys_as_symbol)
 end
 ```
 
@@ -526,15 +627,19 @@ end
 Picking *except* one or more features
 
 ```ruby
-Micro::Attributes.without(:diff) # will load :activemodel_validations and initialize: :strict
+Micro::Attributes.without(:diff) # will load :activemodel_validations, :keys_as_symbol and initialize: :strict
 
-Micro::Attributes.without(initialize: :strict) # will load :activemodel_validations and :diff
+Micro::Attributes.without(initialize: :strict) # will load :activemodel_validations, :diff and :keys_as_symbol
 ```
 
 ## Picking all the features
 
 ```ruby
 Micro::Attributes.with_all_features
+
+# This method returns the same of:
+
+Micro::Attributes.with(:activemodel_validations, :diff, :keys_as_symbol, initialize: :strict)
 ```
 
 [⬆️ Back to Top](#table-of-contents-)
@@ -726,6 +831,40 @@ job.state # 'sleeping'
 
 [⬆️ Back to Top](#table-of-contents-)
 
+### Keys as symbol extension
+
+Disables the indifferent access requiring the declaration/usage of the attributes as symbols.
+
+The advantage of this extension over the default behavior is because it avoids an unnecessary allocation in memory of strings. All the keys are transformed into strings in the indifferent access mode, but, with this extension, this typecasting will be avoided. So, it has a better performance and reduces the usage of memory/Garbage collector, but gives for you the responsibility to always use symbols to set/access the attributes.
+
+```ruby
+class Job
+  include Micro::Attributes.with(:initialize, :keys_as_symbol)
+
+  attribute :id
+  attribute :state, default: 'sleeping'
+end
+
+job = Job.new(id: 1)
+
+job.attributes # {:id => 1, :state => "sleeping"}
+
+job.attribute?(:id) # true
+job.attribute?('id') # false
+
+job.attribute(:id) # 1
+job.attribute('id') # nil
+
+job.attribute!(:id) # 1
+job.attribute!('id') # NameError (undefined attribute `id)
+```
+
+As you could see in the previous example only symbols will work to do something with the attributes.
+
+This extension also changes the `diff extension` making everything (arguments, outputs) working only with symbols.
+
+[⬆️ Back to Top](#table-of-contents-)
+
 # Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/micro/attributes.rb

@@ -15,7 +15,8 @@ module Micro
 
       base.class_eval do
         private_class_method :__attributes, :__attribute_reader
-        private_class_method :__attribute_assign, :__attributes_data_to_assign
+        private_class_method :__attribute_assign, :__attributes_groups
+        private_class_method :__attributes_required_add, :__attributes_data_to_assign
       end
 
       def base.inherited(subclass)
@@ -37,8 +38,8 @@ module Micro
       Features.all
     end
 
-    def attribute?(name)
-      self.class.attribute?(name)
+    def attribute?(name, include_all = false)
+      self.class.attribute?(name, include_all)
     end
 
     def attribute(name)
@@ -52,69 +53,108 @@ module Micro
     def attribute!(name, &block)
       attribute(name) { |name| return block ? block[name] : name }
 
-      raise NameError, "undefined attribute `#{name}"
+      raise NameError, __attribute_access_error_message(name)
+    end
+
+    def defined_attributes(option = nil)
+      return self.class.attributes_by_visibility if option == :by_visibility
+
+      @defined_attributes ||= self.class.attributes
     end
 
     def attributes(*names)
       return __attributes if names.empty?
 
-      names.each_with_object({}) do |name, memo|
-        memo[name] = attribute(name) if attribute?(name)
+      options = names.last.is_a?(Hash) ? names.pop : Kind::Empty::HASH
+
+      names.flatten!
+
+      without_option = Array(options.fetch(:without, Kind::Empty::ARRAY))
+
+      keys = names.empty? ? defined_attributes - without_option.map { |value| __attribute_key(value) } : names - without_option
+
+      data = keys.each_with_object({}) { |key, memo| memo[key] = attribute(key) if attribute?(key) }
+
+      with_option = Array(options.fetch(:with, Kind::Empty::ARRAY))
+
+      unless with_option.empty?
+        extra = with_option.each_with_object({}) { |key, memo| memo[__attribute_key(key)] = public_send(key) }
+
+        data.merge!(extra)
       end
-    end
 
-    def defined_attributes
-      @defined_attributes ||= self.class.attributes
+      Utils::Hashes.keys_as(options[:keys_as], data)
     end
 
     protected
 
       def attributes=(arg)
-        hash = Utils.stringify_hash_keys(arg)
+        hash = self.class.__attributes_keys_transform__(arg)
 
         __attributes_missing!(hash)
 
+        __call_before_attributes_assign
         __attributes_assign(hash)
+        __call_after_attributes_assign
+
+        __attributes
       end
 
     private
 
-      ExtractAttribute = -> (other, key) {
-        return Utils::HashAccess.(other, key) if other.respond_to?(:[])
-
-        other.public_send(key) if other.respond_to?(key)
-      }
+      def __call_before_attributes_assign; end
+      def __call_after_attributes_assign; end
 
       def extract_attributes_from(other)
-        defined_attributes.each_with_object({}) do |key, memo|
-          memo[key] = ExtractAttribute.(other, key)
-        end
+        Utils::ExtractAttribute.from(other, keys: defined_attributes)
+      end
+
+      def __attribute_access_error_message(name)
+        return "tried to access a private attribute `#{name}" if attribute?(name, true)
+
+        "undefined attribute `#{name}"
+      end
+
+      def __attribute_key(value)
+        self.class.__attribute_key_transform__(value)
       end
 
       def __attributes
         @__attributes ||= {}
       end
 
-      FetchValueToAssign = -> (value, default) do
-        if default.respond_to?(:call)
-          callable = default.is_a?(Proc) ? default : default.method(:call)
+      FetchValueToAssign = -> (value, attribute_data, keep_proc = false) do
+        default = attribute_data[0]
 
-          callable.arity > 0 ? callable.call(value) : callable.call
-        else
-          value.nil? ? default : value
-        end
+        value_to_assign =
+          if default.is_a?(Proc) && !keep_proc
+            default.arity > 0 ? default.call(value) : default.call
+          else
+            value.nil? ? default : value
+          end
+
+        return value_to_assign unless to_freeze = attribute_data[2]
+        return value_to_assign.freeze if to_freeze == true
+        return value_to_assign.dup.freeze if to_freeze == :after_dup
+        return value_to_assign.clone.freeze if to_freeze == :after_clone
+
+        raise NotImplementedError
       end
 
       def __attributes_assign(hash)
-        self.class.__attributes_data__.each do |name, default|
-          __attribute_assign(name, FetchValueToAssign.(hash[name], default)) if attribute?(name)
+        self.class.__attributes_data__.each do |name, attribute_data|
+          __attribute_assign(name, hash[name], attribute_data) if attribute?(name, true)
         end
 
         __attributes.freeze
       end
 
-      def __attribute_assign(name, value)
-        __attributes[name] = instance_variable_set("@#{name}", value)
+      def __attribute_assign(name, initialize_value, attribute_data)
+        value_to_assign = FetchValueToAssign.(initialize_value, attribute_data)
+
+        ivar_value = instance_variable_set("@#{name}", value_to_assign)
+
+        __attributes[name] = ivar_value if attribute_data[3] == :public
       end
 
       MISSING_KEYWORD = 'missing keyword'.freeze