u-attributes 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc53b00949ac8d0d8d8572443936ba537a637569be77e0b105a0b98f2d1ae9d0
-  data.tar.gz: 94f42f6da3c2cba68f6565e1bb413b5692bd700baa077555cd421e4aeb82e2ff
+  metadata.gz: d105f8057ad000b717972d8b2b5624d3f5d7608256f82402878ae0929c6462c7
+  data.tar.gz: 20f7b0132c445194fb3189b81c7c29c482a2fbeffdb1574444f833ede5619308
 SHA512:
-  metadata.gz: e5617a5fd34458de945dae2874bed24013e682871f19b70063e734156f2528e8b249e615632f90c978c203abf876560de9717940f9b81e48271f84a956456199
-  data.tar.gz: 50b19483c9e8f88169101306be67a34e4e8c6a26358b187fd119b41ca26e83d461619d6a149bfc898ab7b1208c6af6791b58acf039a3d92d0e8f912e007232b9
+  metadata.gz: 7d5e1d415a6b94dfa9c90aad9f8700829696d1e1b2fa054d6bf62c9eac477f618604c59695b55c3a18dd2405b28c4af63c886057f2ef740cba747f19b2273706
+  data.tar.gz: 4493325bbeed30c82c13690ad35d87926a9913b3b33d18cc0ef2dedae8eca2e976fc43d2485bb65715b2cb6c51bc383dfd8b0c59b50885bd5099624b568455d6

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)
@@ -55,7 +75,7 @@ gem 'u-attributes'
 
 | u-attributes   | branch  | ruby     |  activemodel  |
 | -------------- | ------- | -------- | ------------- |
-| 2.0.0          | main    | >= 2.2.0 | >= 3.2, < 6.1 |
+| 2.1.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 +86,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 +136,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 +265,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
 
@@ -258,7 +338,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
@@ -369,6 +451,12 @@ Person.attribute?(:foo)  # false
 
 person = Person.new(age: 20)
 
+#---------------------#
+# #defined_attributes #
+#---------------------#
+
+person.defined_attributes # ['name', 'age']
+
 #---------------#
 # #attribute?() #
 #---------------#

data/lib/micro/attributes.rb

@@ -14,7 +14,8 @@ module Micro
       base.extend(::Micro::Attributes.const_get(:Macros))
 
       base.class_eval do
-        private_class_method :__attributes, :__attribute_set, :__attribute_reader
+        private_class_method :__attributes, :__attribute_reader
+        private_class_method :__attribute_assign, :__attributes_data_to_assign
       end
 
       def base.inherited(subclass)
@@ -62,40 +63,78 @@ module Micro
       end
     end
 
+    def defined_attributes
+      @defined_attributes ||= self.class.attributes
+    end
+
     protected
 
       def attributes=(arg)
         hash = Utils.stringify_hash_keys(arg)
 
-        __attributes_set(hash, self.class.__attributes_data__)
+        __attributes_missing!(hash)
+
+        __attributes_assign(hash)
       end
 
     private
 
-      def __attributes
-        @__attributes ||= {}
+      ExtractAttribute = -> (other, key) {
+        return Utils::HashAccess.(other, key) if other.respond_to?(:[])
+
+        other.public_send(key) if other.respond_to?(key)
+      }
+
+      def extract_attributes_from(other)
+        defined_attributes.each_with_object({}) do |key, memo|
+          memo[key] = ExtractAttribute.(other, key)
+        end
       end
 
-      def __attribute_set(name, value)
-        __attributes[name] = instance_variable_set("@#{name}", value) if attribute?(name)
+      def __attributes
+        @__attributes ||= {}
       end
 
-      def __attributes_set(hash, att_data)
-        att_data.each do |key, default|
-          value = hash[key]
+      FetchValueToAssign = -> (value, default) do
+        if default.respond_to?(:call)
+          callable = default.is_a?(Proc) ? default : default.method(:call)
 
-          final_value =
-            if default.respond_to?(:call)
-              callable = default.is_a?(Proc) ? default : default.method(:call)
-              callable.arity > 0 ? callable.call(value) : callable.call
-            else
-              value.nil? ? default : value
-            end
+          callable.arity > 0 ? callable.call(value) : callable.call
+        else
+          value.nil? ? default : value
+        end
+      end
 
-          __attribute_set(key, final_value)
+      def __attributes_assign(hash)
+        self.class.__attributes_data__.each do |name, default|
+          __attribute_assign(name, FetchValueToAssign.(hash[name], default)) if attribute?(name)
         end
 
         __attributes.freeze
       end
+
+      def __attribute_assign(name, value)
+        __attributes[name] = instance_variable_set("@#{name}", value)
+      end
+
+      MISSING_KEYWORD = 'missing keyword'.freeze
+      MISSING_KEYWORDS = 'missing keywords'.freeze
+
+      def __attributes_missing!(hash)
+        required_keys = self.class.__attributes_required__
+
+        return if required_keys.empty?
+
+        missing_keys = required_keys.map { |name| ":#{name}" if !hash.key?(name) }
+        missing_keys.compact!
+
+        return if missing_keys.empty?
+
+        label = missing_keys.size == 1 ? MISSING_KEYWORD : MISSING_KEYWORDS
+
+        raise ArgumentError, "#{label}: #{missing_keys.join(', ')}"
+      end
+
+      private_constant :FetchValueToAssign, :MISSING_KEYWORD, :MISSING_KEYWORDS
   end
 end

data/lib/micro/attributes/features/activemodel_validations.rb

@@ -14,7 +14,7 @@ module Micro::Attributes
       end
 
       module ClassMethods
-        def __call_after_attribute_set__(attr_name, options)
+        def __call_after_attribute_assign__(attr_name, options)
           validate, validates = options.values_at(:validate, :validates)
 
           self.validate(validate) if validate

data/lib/micro/attributes/features/initialize/strict.rb

@@ -4,35 +4,15 @@ module Micro::Attributes
   module Features
     module Initialize
       module Strict
-        MISSING_KEYWORD = 'missing keyword'.freeze
-        MISSING_KEYWORDS = 'missing keywords'.freeze
-
-        protected def attributes=(arg)
-          arg_hash = Utils.stringify_hash_keys(arg)
-          att_data = self.class.__attributes_data__
-
-          attributes_missing!(ref: att_data, arg: arg_hash)
-
-          __attributes_set(arg_hash, att_data)
-        end
-
-        private def attributes_missing!(ref:, arg:)
-          missing_keys = attributes_missing(ref, arg)
-
-          return if missing_keys.empty?
-
-          label = missing_keys.size == 1 ? MISSING_KEYWORD : MISSING_KEYWORDS
-
-          raise ArgumentError, "#{label}: #{missing_keys.join(', ')}"
-        end
-
-        private def attributes_missing(ref, arg)
-          ref.each_with_object([]) do |(key, val), memo|
-            memo << ":#{key}" if val.nil? && !arg.has_key?(key)
+        module ClassMethods
+          def attributes_are_all_required?
+            true
           end
         end
 
-        private_constant :MISSING_KEYWORD, :MISSING_KEYWORDS
+        def self.included(base)
+          base.send(:extend, ClassMethods)
+        end
       end
     end
   end

data/lib/micro/attributes/macros.rb

@@ -3,10 +3,33 @@
 module Micro
   module Attributes
     module Macros
+      def attributes_are_all_required?
+        false
+      end
+
+      # NOTE: can't be renamed! It is used by u-case v4.
       def __attributes_data__
         @__attributes_data__ ||= {}
       end
 
+      def __attributes_required__
+        @__attributes_required__ ||= Set.new
+      end
+
+      def __attributes_required_add(name, is_required, hasnt_default)
+        if is_required || (attributes_are_all_required? && hasnt_default)
+          __attributes_required__.add(name)
+        end
+
+        nil
+      end
+
+      def __attributes_data_to_assign(name, options)
+        hasnt_default = !options.key?(:default)
+
+        hasnt_default ? __attributes_required_add(name, options[:required], hasnt_default) : options[:default]
+      end
+
       def __attributes
         @__attributes ||= Set.new
       end
@@ -17,20 +40,24 @@ module Micro
         attr_reader(name)
       end
 
-      def __attribute_set(key, can_overwrite, options)
+      def __attribute_assign(key, can_overwrite, options)
         name = key.to_s
         has_attribute = attribute?(name)
 
         __attribute_reader(name) unless has_attribute
-        __attributes_data__[name] = options[:default] if can_overwrite || !has_attribute
 
-        __call_after_attribute_set__(name, options)
+        __attributes_data__[name] = __attributes_data_to_assign(name, options) if can_overwrite || !has_attribute
+
+        __call_after_attribute_assign__(name, options)
       end
 
-      def __call_after_attribute_set__(attr_name, options); end
+      def __call_after_attribute_assign__(attr_name, options); end
 
+      # NOTE: can't be renamed! It is used by u-case v4.
       def __attributes_set_after_inherit__(arg)
-        arg.each { |key, val| __attribute_set(key, true, default: val) }
+        arg.each do |key, val|
+          __attribute_assign(key, true, val ? { default: val } : {})
+        end
       end
 
       def attribute?(name)
@@ -38,7 +65,7 @@ module Micro
       end
 
       def attribute(name, options = Kind::Empty::HASH)
-        __attribute_set(name, false, options)
+        __attribute_assign(name, false, options)
       end
 
       def attributes(*args)
@@ -47,18 +74,19 @@ module Micro
         args.flatten!
         args.each do |arg|
           if arg.is_a?(String) || arg.is_a?(Symbol)
-            __attribute_set(arg, false, Kind::Empty::HASH)
+            __attribute_assign(arg, false, Kind::Empty::HASH)
           else
             raise Kind::Error.new('String/Symbol'.freeze, arg)
           end
         end
       end
 
+      # NOTE: can't be renamed! It is used by u-case v4.
       module ForSubclasses
         WRONG_NUMBER_OF_ARGS = 'wrong number of arguments (given 0, expected 1 or more)'.freeze
 
         def attribute!(name, options = Kind::Empty::HASH)
-          __attribute_set(name, true, options)
+          __attribute_assign(name, true, options)
         end
 
         private_constant :WRONG_NUMBER_OF_ARGS

data/lib/micro/attributes/utils.rb

@@ -14,6 +14,12 @@ module Micro
           hash.each_with_object({}) { |(key, val), memo| memo[key.to_s] = val }
         end
       end
+
+      HashAccess = -> (hash, key) {
+        return hash[key.to_s] unless hash[key.to_s].nil?
+
+        hash[key.to_sym]
+      }
     end
   end
 end

data/lib/micro/attributes/version.rb

@@ -2,6 +2,6 @@
 
 module Micro
   module Attributes
-    VERSION = '2.0.1'.freeze
+    VERSION = '2.1.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: u-attributes
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2020-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kind
@@ -76,6 +76,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/u-attributes_logo_v1.png
 - bin/console
 - bin/setup
 - lib/micro/attributes.rb