u-attributes 2.0.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc53b00949ac8d0d8d8572443936ba537a637569be77e0b105a0b98f2d1ae9d0
-  data.tar.gz: 94f42f6da3c2cba68f6565e1bb413b5692bd700baa077555cd421e4aeb82e2ff
+  metadata.gz: 62c6ad9683f0824be6a32648028f25a97ba88a10c7fbdd0b9a2ccfbfe275961b
+  data.tar.gz: d110a1b4220af76a7f14753cb1ca5067428f06db026466e095d54a22ee46f86f
 SHA512:
-  metadata.gz: e5617a5fd34458de945dae2874bed24013e682871f19b70063e734156f2528e8b249e615632f90c978c203abf876560de9717940f9b81e48271f84a956456199
-  data.tar.gz: 50b19483c9e8f88169101306be67a34e4e8c6a26358b187fd119b41ca26e83d461619d6a149bfc898ab7b1208c6af6791b58acf039a3d92d0e8f912e007232b9
+  metadata.gz: 24703dcd81aa785fe00b77a741434ad84600243f4bb132d2bbbce2b5a310d4f2b931c2b6ea41e311a2bcf07876296bd03d8e6c39a92905bc9a4f745fdb30a094
+  data.tar.gz: 8172811ddaf44a3099e66f63cea5aed99d5c1a63a77944dc1e98c16fa0378603498fbdfe0c77f7220244c8d7b977801a75bd01facc875fb05f0bd1aed0171cc5

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 
-sudo: false
-
 rvm:
 - 2.2.2
 - 2.3.0
@@ -9,6 +7,7 @@ rvm:
 - 2.5.0
 - 2.6.0
 - 2.7.0
+- truffleruby-head
 
 cache: bundler
 

data/Gemfile

@@ -1,5 +1,7 @@
 source 'https://rubygems.org'
 
+gem 'u-case', '~> 4.0'
+
 activemodel_version = ENV.fetch('ACTIVEMODEL_VERSION', '6.1')
 
 activemodel = case activemodel_version
@@ -18,9 +20,16 @@ if activemodel_version < '6.1'
   gem 'activesupport', activemodel, require: false
 end
 
+simplecov_version =
+  case RUBY_VERSION
+  when /\A2.[23]/ then '~> 0.17.1'
+  when /\A2.4/ then '~> 0.18.5'
+  else '~> 0.19'
+  end
+
 group :test do
   gem 'minitest', activemodel_version < '4.1' ? '~> 4.2' : '~> 5.0'
-  gem 'simplecov', require: false
+  gem 'simplecov', simplecov_version, require: false
 end
 
 # Specify your gem's dependencies in u-attributes.gemspec

data/README.md

@@ -1,21 +1,41 @@
-![Ruby](https://img.shields.io/badge/ruby-2.2+-ruby.svg?colorA=99004d&colorB=cc0066)
-[![Gem](https://img.shields.io/gem/v/u-attributes.svg?style=flat-square)](https://rubygems.org/gems/u-attributes)
-[![Build Status](https://travis-ci.com/serradura/u-attributes.svg?branch=main)](https://travis-ci.com/serradura/u-attributes)
-[![Maintainability](https://api.codeclimate.com/v1/badges/b562e6b877a9edf4dbf6/maintainability)](https://codeclimate.com/github/serradura/u-attributes/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/b562e6b877a9edf4dbf6/test_coverage)](https://codeclimate.com/github/serradura/u-attributes/test_coverage)
+<p align="center">
+  <img src="./assets/u-attributes_logo_v1.png" alt='Create "immutable" objects. No setters, just getters!'>
 
-μ-attributes (Micro::Attributes) <!-- omit in toc -->
-================================
+  <p align="center"><i>Create "immutable" objects. No setters, just getters!</i></p>
+  <br>
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/ruby-2.2+-ruby.svg?colorA=99004d&colorB=cc0066" alt="Ruby">
+
+  <a href="https://rubygems.org/gems/u-attributes">
+    <img alt="Gem" src="https://img.shields.io/gem/v/u-attributes.svg?style=flat-square">
+  </a>
+
+  <a href="https://travis-ci.com/serradura/u-attributes">
+    <img alt="Build Status" src="https://travis-ci.com/serradura/u-attributes.svg?branch=main">
+  </a>
+
+  <a href="https://codeclimate.com/github/serradura/u-attributes/maintainability">
+    <img alt="Maintainability" src="https://api.codeclimate.com/v1/badges/b562e6b877a9edf4dbf6/maintainability">
+  </a>
+
+  <a href="https://codeclimate.com/github/serradura/u-attributes/test_coverage">
+    <img alt="Test Coverage" src="https://api.codeclimate.com/v1/badges/b562e6b877a9edf4dbf6/test_coverage">
+  </a>
+</p>
 
 This gem allows you to define "immutable" objects, and your objects will have only getters and no setters.
 So, if you change [[1](#with_attribute)] [[2](#with_attributes)] some object attribute, you will have a new object instance. That is, you transform the object instead of modifying it.
 
-## Table of contents <!-- omit in toc -->
+# Table of contents <!-- omit in toc -->
 - [Installation](#installation)
 - [Compatibility](#compatibility)
 - [Usage](#usage)
   - [How to define attributes?](#how-to-define-attributes)
     - [`Micro::Attributes#attributes=`](#microattributesattributes)
+      - [How to extract attributes from an object or hash?](#how-to-extract-attributes-from-an-object-or-hash)
+      - [Is it possible to define an attribute as required?](#is-it-possible-to-define-an-attribute-as-required)
     - [`Micro::Attributes#attribute`](#microattributesattribute)
     - [`Micro::Attributes#attribute!`](#microattributesattribute-1)
   - [How to define multiple attributes?](#how-to-define-multiple-attributes)
@@ -27,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)
@@ -38,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)
@@ -55,7 +85,7 @@ gem 'u-attributes'
 
 | u-attributes   | branch  | ruby     |  activemodel  |
 | -------------- | ------- | -------- | ------------- |
-| 2.0.0          | main    | >= 2.2.0 | >= 3.2, < 6.1 |
+| 2.4.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.
@@ -66,9 +96,9 @@ gem 'u-attributes'
 
 ## How to define attributes?
 
-```ruby
-# By default you must to define the class constructor.
+By default, you must define the class constructor.
 
+```ruby
 class Person
   include Micro::Attributes
 
@@ -116,6 +146,66 @@ person.age  # 20
 person.name # John Doe
 ```
 
+#### How to extract attributes from an object or hash?
+
+You can extract attributes using the `extract_attributes_from` method, it will try to fetch attributes from the
+object using either the `object[attribute_key]` accessor or the reader method `object.attribute_key`.
+
+```ruby
+class Person
+  include Micro::Attributes
+
+  attribute :age
+  attribute :name, default: 'John Doe'
+
+  def initialize(user:)
+    self.attributes = extract_attributes_from(user)
+  end
+end
+
+# extracting from an object
+
+class User
+  attr_accessor :age, :name
+end
+
+user = User.new
+user.age = 20
+
+person = Person.new(user: user)
+
+person.age  # 20
+person.name # John Doe
+
+# extracting from a hash
+
+another_person = Person.new(user: { age: 55, name: 'Julia Not Roberts' })
+
+another_person.age  # 55
+another_person.name # Julia Not Roberts
+```
+
+#### Is it possible to define an attribute as required?
+
+You only need to use the `required: true` option.
+
+But to this work, you need to assign the attributes using the [`#attributes=`](#microattributesattributes) method or the extensions: [initialize](#initialize-extension), [activemodel_validations](#activemodelvalidation-extension).
+
+```ruby
+class Person
+  include Micro::Attributes
+
+  attribute :age
+  attribute :name, required: true
+
+  def initialize(attributes)
+    self.attributes = attributes
+  end
+end
+
+Person.new(age: 32) # ArgumentError (missing keyword: :name)
+```
+
 [⬆️ Back to Top](#table-of-contents-)
 
 ### `Micro::Attributes#attribute`
@@ -185,7 +275,7 @@ Use `Micro::Attributes.with(:initialize)` to define a constructor to assign the
 class Person
   include Micro::Attributes.with(:initialize)
 
-  attribute :age
+  attribute :age, required: true
   attribute :name, default: 'John Doe'
 end
 
@@ -240,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
@@ -258,7 +347,9 @@ end
 
 ## The strict initializer
 
-Use `.with(initialize: :strict)` to forbids an instantiation without all the attribute keywords. e.g.
+Use `.with(initialize: :strict)` to forbids an instantiation without all the attribute keywords.
+
+In other words, it is equivalent to you define all the attributes using the [`required: true` option](#is-it-possible-to-define-an-attribute-as-required).
 
 ```ruby
 class StrictPerson
@@ -338,63 +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`
+
+Listing all the class attributes.
 
-#---------------#
-# .attributes() #
-#---------------#
+```ruby
+Person.attributes # ["age", "first_name", "last_name"]
+```
 
-Person.attributes # ['name', 'age']
+### `.attribute?()`
 
-#---------------#
-# .attribute?() #
-#---------------#
+Checking the existence of some attribute.
+
+```ruby
+Person.attribute?(:first_name)  # true
+Person.attribute?('first_name') # true
 
-Person.attribute?(:name)  # true
-Person.attribute?('name') # true
 Person.attribute?('foo') # false
 Person.attribute?(:foo)  # false
+```
 
-# ---
+### `#attribute?()`
 
-person = Person.new(age: 20)
+Checking the existence of some attribute in an instance.
 
-#---------------#
-# #attribute?() #
-#---------------#
+```ruby
+person = Person.new(age: 20)
 
 person.attribute?(:name)  # true
 person.attribute?('name') # true
+
 person.attribute?('foo') # false
 person.attribute?(:foo)  # false
+```
 
-#---------------#
-# #attributes() #
-#---------------#
+### `#attributes()`
 
-person.attributes                   # {'age'=>20, 'name'=>'John Doe'}
-Person.new(name: 'John').attributes # {'age'=>nil, 'name'=>'John'}
+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(*names) #
-#---------------------#
+#### `#attributes(keys_as:)`
 
-# Slices the attributes to include only the given keys.
-# Returns a hash containing the given keys (in their types).
+Use the `keys_as:` option with `Symbol`/`:symbol` or `String`/`:string` to transform the attributes hash keys.
 
-person.attributes(:age)             # {age: 20}
-person.attributes(:age, :name)      # {age: 20, name: 'John Doe'}
-person.attributes('age', 'name')    # {'age'=>20, 'name'=>'John Doe'}
+```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)
+
+person.attributes(without: :age)               # {"first_name"=>"John", "last_name"=>"Doe"}
+person.attributes(without: [:age, :last_name]) # {"first_name"=>"John"}
+
+person.attributes(with: [:name], without: [:first_name, :last_name]) # {"age"=>20, "name"=>"John Doe"}
+
+# To achieves the same output of the previous example, use the attribute names to slice only them.
+
+person.attributes(:age, with: [: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-)
@@ -412,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: :activemodel_validations, :diff, :initialize, :keys_as_symbol)
 end
 ```
 
@@ -438,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-)
@@ -638,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.