u-attributes 0.14.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1f5001cf28666ddb39188b98a736ef80375e7ff91367aa3a84183e524b698e2
-  data.tar.gz: c260e6a0e12dd6d9edf251318b6667b3b13b7cd9d6964f8ff5defa80679b9a67
+  metadata.gz: b3daaa2daf1f8ce4a90b6053e8a5a35d5f066197a15b4353f8f5e09717639bba
+  data.tar.gz: '0499ade9185a2406a06acbc9d33b2e3de808ee23e5625af436253f0d654c7762'
 SHA512:
-  metadata.gz: 3855b41867f2b635d2687766baf6c6bcdc15c5b7a149879b3640ea327071e45f564b1438a66dfbd7f11a90b6a7f9b6c7265b2b8d6732ad71b1a2203839113d14
-  data.tar.gz: 3e322ab6d47de45fe6120969ae876be1fa936d6a639cbc7346ce70b5f400ad801d8a7b83640b864d80dd7f008327d9bc9d47af286a4feea59300a07aa3a459c2
+  metadata.gz: 8a8ca5c7ee283753e8cbc1a6bf43580d71d98578bb0462464753da03df03c4c2a967629ae54be767a35b5d25720d38b07b85b992546eead410fcbd2180b547f1
+  data.tar.gz: b1cf4055d9e3cc08c87d4fefe2a6b91797fcab85904f0697299cfd22525a0615a3e0d947339bac23ae3fd8b3113c11b05cd8c1609f38adaaaabb1b3781513e1a

data/.travis.yml

@@ -1,18 +1,28 @@
----
-sudo: false
 language: ruby
-cache: bundler
+
+sudo: false
+
 rvm:
-  - 2.2.2
-  - 2.3.0
-  - 2.4.0
-  - 2.5.0
-  - 2.6.0
+- 2.2.2
+- 2.3.0
+- 2.4.0
+- 2.5.0
+- 2.6.0
+
+cache: bundler
+
 before_install:
   - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
   - gem install bundler -v '< 2'
+
 install: bundle install --jobs=3 --retry=3
-env:
-  - DISABLE_SIMPLECOV=true
-script: ./.travis.sh
 
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - "./cc-test-reporter before-build"
+
+script: "./.travis.sh"
+
+after_success:
+  - "./cc-test-reporter after-build -t simplecov"

data/Gemfile

@@ -1,7 +1,5 @@
 source 'https://rubygems.org'
 
-gem 'simplecov', require: false, group: :test
-
 activemodel_version = ENV.fetch('ACTIVEMODEL_VERSION', '6.1')
 
 activemodel = case activemodel_version
@@ -20,9 +18,10 @@ if activemodel_version < '6.1'
   gem 'activesupport', activemodel, require: false
 end
 
-minitest = activemodel_version < '4.1' ? '~> 4.2' : '~> 5.0'
-
-gem 'minitest', minitest
+group :test do
+  gem 'minitest', activemodel_version < '4.1' ? '~> 4.2' : '~> 5.0'
+  gem 'simplecov', require: false
+end
 
 # Specify your gem's dependencies in u-attributes.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    u-attributes (0.14.0)
+    u-attributes (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,4 +1,7 @@
-[![Build Status](https://travis-ci.com/serradura/u-attributes.svg?branch=master)](https://travis-ci.com/serradura/u-attributes) [![Maintainability](https://api.codeclimate.com/v1/badges/b562e6b877a9edf4dbf6/maintainability)](https://codeclimate.com/github/serradura/u-attributes/maintainability)
+[![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=master)](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)
 
 μ-attributes (Micro::Attributes)
 ================================
@@ -6,23 +9,25 @@
 This gem allows defining read-only attributes, that is, your objects will have only getters to access their attributes data.
 
 ## Table of contents
-- [μ-attributes (Micro::Attributes)](#%CE%BC-attributes-MicroAttributes)
-  - [Table of contents](#Table-of-contents)
-  - [Installation](#Installation)
-  - [Usage](#Usage)
-    - [How to require?](#How-to-require)
-    - [How to define attributes?](#How-to-define-attributes)
-    - [How to define multiple attributes?](#How-to-define-multiple-attributes)
-    - [How to define attributes with a constructor to assign them?](#How-to-define-attributes-with-a-constructor-to-assign-them)
-    - [How to query the attributes?](#How-to-query-the-attributes)
-  - [Built-in extensions](#Built-in-extensions)
-    - [ActiveModel::Validations extension](#ActiveModelValidations-extension)
-    - [Diff extension](#Diff-extension)
-    - [Initialize extension](#Initialize-extension)
-  - [Development](#Development)
-  - [Contributing](#Contributing)
-  - [License](#License)
-  - [Code of Conduct](#Code-of-Conduct)
+- [μ-attributes (Micro::Attributes)](#%ce%bc-attributes-microattributes)
+  - [Table of contents](#table-of-contents)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [How to require?](#how-to-require)
+    - [How to define attributes?](#how-to-define-attributes)
+    - [How to define multiple attributes?](#how-to-define-multiple-attributes)
+    - [How to define attributes with a constructor to assign them?](#how-to-define-attributes-with-a-constructor-to-assign-them)
+    - [How to inherit the attributes?](#how-to-inherit-the-attributes)
+    - [How to query the attributes?](#how-to-query-the-attributes)
+  - [Built-in extensions](#built-in-extensions)
+    - [ActiveModel::Validations extension](#activemodelvalidations-extension)
+    - [Diff extension](#diff-extension)
+    - [Initialize extension](#initialize-extension)
+    - [Strict initialize extension](#strict-initialize-extension)
+  - [Development](#development)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Code of Conduct](#code-of-conduct)
 
 ## Installation
 
@@ -198,9 +203,40 @@ puts other_person.equal?(person) # false
 # Person.new(1)
 # ArgumentError (argument must be a Hash)
 
-################
-# Inheritance  #
-################
+#--------------------#
+# Strict initializer #
+#--------------------#
+
+# Use .to_initialize! to forbids an instantiation without all keywords.
+
+class StrictPerson
+  include Micro::Attributes.to_initialize!
+
+  attributes :age, name: 'John Doe'
+end
+
+StrictPerson.new({})
+
+# The code above will raise:
+# ArgumentError (missing keyword: :age)
+
+person_without_age = StrictPerson.new(age: nil)
+
+p person_without_age.name # "John Doe"
+p person_without_age.age  # nil
+
+# Except for this validation when initializing,
+# the `to_initialize!` method will works in the same ways of `to_initialize`.
+```
+
+### How to inherit the attributes?
+
+```ruby
+class Person
+  include Micro::Attributes.to_initialize
+
+  attributes :age, name: 'John Doe'
+end
 
 class Subclass < Person # Will preserve the parent class attributes
   attribute :foo
@@ -322,11 +358,11 @@ end
 # Note:
 # If `Micro::Attributes.features()` be invoked without arguments, a module with all features will be returned.
 
-# --------------------------------------------------------------------#
-# Using the .with() method alias and adding the initialize extension. #
-# --------------------------------------------------------------------#
+#----------------------------------------------------------------------------#
+# Using the .with() method alias and adding the strict initialize extension. #
+#----------------------------------------------------------------------------#
 class Job
-  include Micro::Attributes.with(:initialize, :diff)
+  include Micro::Attributes.with(:strict_initialize, :diff)
 
   attributes :id, state: 'sleeping'
 end
@@ -338,14 +374,26 @@ end
 #   include Micro::Attributes.with() # ArgumentError (Invalid feature name! Available options: diff, initialize, activemodel_validations)
 # end
 
+#===================================#
+# Alternatives to the methods above #
+#===================================#
+
 #---------------------------------------#
 # Via Micro::Attributes.to_initialize() #
 #---------------------------------------#
 class Job
-  include Micro::Attributes.to_initialize(diff: false, activemodel_validations: true)
+  include Micro::Attributes.to_initialize(diff: true, activemodel_validations: true)
 
-  attributes :id, state: 'sleeping'
-  validates! :id, :state, presence: true
+  # Same of `include Micro::Attributes.with(:initialize, :diff, :activemodel_validations)`
+end
+
+#----------------------------------------#
+# Via Micro::Attributes.to_initialize!() #
+#----------------------------------------#
+class Job
+  include Micro::Attributes.to_initialize!(diff: false, activemodel_validations: true)
+
+  # Same of `include Micro::Attributes.with(:strict_initialize, :activemodel_validations)`
 end
 ```
 
@@ -428,14 +476,19 @@ p job_changes.differences # {"state"=> {"from" => "sleeping", "to" => "running"}
 
 ```ruby
 class Job
-  # include Micro::Attributes.features(:initialize)
   # include Micro::Attributes.with(:initialize)
   # include Micro::Attributes.feature(:initialize)
+  # include Micro::Attributes.features(:initialize)
   include Micro::Attributes.to_initialize
 
   attributes :id, :state
 end
 
+job_null = Job.new({})
+
+p job.id    # nil
+p job.state # nil
+
 job = Job.new(id: 1, state: 'sleeping')
 
 p job.id    # 1
@@ -468,6 +521,50 @@ puts other_job.state       # killed
 puts other_job.equal?(job) # false
 ```
 
+### Strict initialize extension
+
+1. Creates a constructor to assign the attributes.
+2. Adds methods to build new instances when some data was assigned.
+3. **Forbids missing keywords**.
+
+```ruby
+class Job
+  # include Micro::Attributes.with(:strict_initialize)
+  # include Micro::Attributes.feature(:strict_initialize)
+  # include Micro::Attributes.features(:strict_initialize)
+  include Micro::Attributes.to_initialize!
+
+  attributes :id, :state
+end
+#----------------------------------------------------------------------------#
+# The strict_initialize extension will require all the keys when initialize. #
+#----------------------------------------------------------------------------#
+
+Job.new({})
+
+# The code above will raise:
+# ArgumentError (missing keywords: :id, :state)
+
+#---------------------------#
+# Samples passing some data #
+#---------------------------#
+
+job_null = Job.new({})
+
+p job.id    # nil
+p job.state # nil
+
+job = Job.new(id: 1, state: 'sleeping')
+
+p job.id    # 1
+p job.state # "sleeping"
+
+
+# Note:
+#   This extension works like the `initialize` extension.
+#   So, look at its section to understand all the other features.
+```
+
 ## 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/features/strict_initialize.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Micro::Attributes
+  module Features
+    module StrictInitialize
+      MISSING_KEYWORD = 'missing keyword'.freeze
+      MISSING_KEYWORDS = 'missing keywords'.freeze
+
+      def self.included(base)
+        base.send(:include, ::Micro::Attributes::Features::Initialize)
+      end
+
+      protected def attributes=(arg)
+        arg_hash = AttributesUtils.stringify_hash_keys!(arg)
+        att_data = self.class.attributes_data({})
+
+        attributes_missing!(ref: att_data, arg: arg_hash)
+
+        att_data.merge(arg_hash).each { |name, value| __attribute_set(name, value) }
+
+        __attributes.freeze
+      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)
+        end
+      end
+
+      private_constant :MISSING_KEYWORD, :MISSING_KEYWORDS
+    end
+  end
+end

data/lib/micro/attributes/features.rb

@@ -5,18 +5,22 @@ require "micro/attributes/with"
 module Micro
   module Attributes
     module Features
-      INVALID_FEATURES = 'Invalid feature name! Available options: :initialize, :diff, :activemodel_validations'.freeze
+      INVALID_FEATURES = 'Invalid feature name! Available options: :initialize, :strict_initialize, :diff, :activemodel_validations'.freeze
 
       OPTIONS = {
         # Features
         'diff' => With::Diff,
         'initialize' => With::Initialize,
+        'strict_initialize' => With::StrictInitialize,
         'activemodel_validations' => With::ActiveModelValidations,
         # Combinations
         'diff:initialize' => With::DiffAndInitialize,
+        'diff:strict_initialize' => With::DiffAndStrictInitialize,
         'activemodel_validations:diff' => With::ActiveModelValidationsAndDiff,
         'activemodel_validations:initialize' => With::ActiveModelValidationsAndInitialize,
-        'activemodel_validations:diff:initialize' => With::ActiveModelValidationsAndDiffAndInitialize
+        'activemodel_validations:strict_initialize' => With::ActiveModelValidationsAndStrictInitialize,
+        'activemodel_validations:diff:initialize' => With::ActiveModelValidationsAndDiffAndInitialize,
+        'activemodel_validations:diff:strict_initialize' => With::ActiveModelValidationsAndDiffAndStrictInitialize
       }.freeze
 
       private_constant :OPTIONS
@@ -30,6 +34,13 @@ module Micro
         return option if option
         raise ArgumentError, INVALID_FEATURES
       end
+
+      def self.options(init, diff, activemodel_validations)
+        [init].tap do |options|
+          options << :diff if diff
+          options << :activemodel_validations if activemodel_validations
+        end
+      end
     end
   end
 end

data/lib/micro/attributes/version.rb

@@ -2,6 +2,6 @@
 
 module Micro
   module Attributes
-    VERSION = '0.14.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/lib/micro/attributes/with.rb

@@ -3,6 +3,7 @@
 require 'micro/attributes/features/diff'
 require 'micro/attributes/features/initialize'
 require 'micro/attributes/features/activemodel_validations'
+require 'micro/attributes/features/strict_initialize'
 
 module Micro
   module Attributes
@@ -31,6 +32,13 @@ module Micro
         end
       end
 
+      module StrictInitialize
+        def self.included(base)
+          base.send(:include, ::Micro::Attributes)
+          base.send(:include, ::Micro::Attributes::Features::StrictInitialize)
+        end
+      end
+
       #
       # Combinations
       #
@@ -42,6 +50,14 @@ module Micro
         end
       end
 
+      module DiffAndStrictInitialize
+        def self.included(base)
+          base.send(:include, ::Micro::Attributes)
+          base.send(:include, ::Micro::Attributes::Features::StrictInitialize)
+          base.send(:include, ::Micro::Attributes::Features::Diff)
+        end
+      end
+
       module ActiveModelValidationsAndDiff
         def self.included(base)
           base.send(:include, ::Micro::Attributes)
@@ -58,6 +74,14 @@ module Micro
         end
       end
 
+      module ActiveModelValidationsAndStrictInitialize
+        def self.included(base)
+          base.send(:include, ::Micro::Attributes)
+          base.send(:include, ::Micro::Attributes::Features::StrictInitialize)
+          base.send(:include, ::Micro::Attributes::Features::ActiveModelValidations)
+        end
+      end
+
       module ActiveModelValidationsAndDiffAndInitialize
         def self.included(base)
           base.send(:include, ::Micro::Attributes)
@@ -66,6 +90,15 @@ module Micro
           base.send(:include, ::Micro::Attributes::Features::Diff)
         end
       end
+
+      module ActiveModelValidationsAndDiffAndStrictInitialize
+        def self.included(base)
+          base.send(:include, ::Micro::Attributes)
+          base.send(:include, ::Micro::Attributes::Features::StrictInitialize)
+          base.send(:include, ::Micro::Attributes::Features::ActiveModelValidations)
+          base.send(:include, ::Micro::Attributes::Features::Diff)
+        end
+      end
     end
   end
 end

data/lib/micro/attributes.rb

@@ -23,10 +23,11 @@ module Micro
     end
 
     def self.to_initialize(diff: false, activemodel_validations: false)
-      options = [:initialize]
-      options << :diff if diff
-      options << :activemodel_validations if activemodel_validations
-      features(*options)
+      features(*Features.options(:initialize, diff, activemodel_validations))
+    end
+
+    def self.to_initialize!(diff: false, activemodel_validations: false)
+      features(*Features.options(:strict_initialize, diff, activemodel_validations))
     end
 
     def self.with(*names)
@@ -41,18 +42,21 @@ module Micro
       names.empty? ? Features.all : Features.with(names)
     end
 
-    def attributes=(arg)
-      self.class.attributes_data(AttributesUtils.hash_argument!(arg)).each do |name, value|
-        __attributes[name] = instance_variable_set("@#{name}", value) if attribute?(name)
-      end
+    protected def attributes=(arg)
+      self.class
+          .attributes_data(AttributesUtils.hash_argument!(arg))
+          .each { |name, value| __attribute_set(name, value) }
+
       __attributes.freeze
     end
-    protected :attributes=
 
-    def __attributes
+    private def __attributes
       @__attributes ||= {}
     end
-    private :__attributes
+
+    private def __attribute_set(name, value)
+      __attributes[name] = instance_variable_set("@#{name}", value) if attribute?(name)
+    end
 
     def attributes
       __attributes

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: u-attributes
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-27 00:00:00.000000000 Z
+date: 2019-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -49,6 +49,7 @@ files:
 - lib/micro/attributes/features/activemodel_validations.rb
 - lib/micro/attributes/features/diff.rb
 - lib/micro/attributes/features/initialize.rb
+- lib/micro/attributes/features/strict_initialize.rb
 - lib/micro/attributes/macros.rb
 - lib/micro/attributes/version.rb
 - lib/micro/attributes/with.rb