u-attributes 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 386780594f0b0289f62e38984d59f847901e5257002fa4d1124a570304cf792e
-  data.tar.gz: 1d66e4474bbdd5a027ba91898ff3990ed72d76b2278f7c8e4ab303dacbf5b1a8
+  metadata.gz: a1f5001cf28666ddb39188b98a736ef80375e7ff91367aa3a84183e524b698e2
+  data.tar.gz: c260e6a0e12dd6d9edf251318b6667b3b13b7cd9d6964f8ff5defa80679b9a67
 SHA512:
-  metadata.gz: abe5248e77a398a3dbb14047c0ecfdd1fec83e5aa59cde4c2a2c99704c2a503f059f484682654e20d04f6e3cf2ae3c3038cf0103ab51922948375d1e58495917
-  data.tar.gz: 91152ebf4dafe6ce4c5a563068bee973b3c334b6600c8c16a81f62e98a120fc07116426c8d163a75b072561da25a50fe71c097fdcdf65c05d120c1ae6ec1bdc5
+  metadata.gz: 3855b41867f2b635d2687766baf6c6bcdc15c5b7a149879b3640ea327071e45f564b1438a66dfbd7f11a90b6a7f9b6c7265b2b8d6732ad71b1a2203839113d14
+  data.tar.gz: 3e322ab6d47de45fe6120969ae876be1fa936d6a639cbc7346ce70b5f400ad801d8a7b83640b864d80dd7f008327d9bc9d47af286a4feea59300a07aa3a459c2

data/Gemfile.lock

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

data/README.md

@@ -1,7 +1,29 @@
-# μ-attributes (Micro::Attributes) [![Build Status](https://travis-ci.com/serradura/u-attributes.svg?branch=master)](https://travis-ci.com/serradura/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)
+
+μ-attributes (Micro::Attributes)
+================================
 
 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)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -268,7 +290,7 @@ p Person.new(name: 'John').attributes # {"age"=>nil, "name"=>"John"}
 
 You can use the method `Micro::Attributes.features()` or `Micro::Attributes.with()` to combine and require only the features that better fit your needs.
 
-### Usage
+Note: If you desire require only one feature, use the `Micro::Attributes.feature()` method.
 
 ```ruby
 #----------------------------------#
@@ -278,7 +300,7 @@ You can use the method `Micro::Attributes.features()` or `Micro::Attributes.with
 # Loading specific features
 
 class Job
-  include Micro::Attributes.features(:diff)
+  include Micro::Attributes.feature(:diff)
 
   attribute :id
   attribute :state, 'sleeping'
@@ -331,8 +353,6 @@ end
 
 If your application uses ActiveModel as a dependency (like a regular Rails app). You will be enabled to use the `actimodel_validations` extension.
 
-#### Usage
-
 ```ruby
 class Job
   # include Micro::Attributes.with(:initialize, :activemodel_validations)
@@ -355,8 +375,6 @@ p job.state # "sleeping"
 
 Provides a way to track changes in your object attributes.
 
-#### Usage
-
 ```ruby
 require 'securerandom'
 
@@ -403,6 +421,53 @@ p job_changes.changed?(:state, from: 'sleeping', to: 'running') # true
 p job_changes.differences # {"state"=> {"from" => "sleeping", "to" => "running"}}
 ```
 
+### Initialize extension
+
+1. Creates a constructor to assign the attributes.
+2. Adds methods to build new instances when some data was assigned.
+
+```ruby
+class Job
+  # include Micro::Attributes.features(:initialize)
+  # include Micro::Attributes.with(:initialize)
+  # include Micro::Attributes.feature(:initialize)
+  include Micro::Attributes.to_initialize
+
+  attributes :id, :state
+end
+
+job = Job.new(id: 1, state: 'sleeping')
+
+p job.id    # 1
+p job.state # "sleeping"
+
+##############################################
+# Assigning new values to get a new instance #
+##############################################
+
+#-------------------#
+# #with_attribute() #
+#-------------------#
+
+new_job = job.with_attribute(:state, 'running')
+
+puts new_job.id          # 1
+puts new_job.state       # running
+puts new_job.equal?(job) # false
+
+#--------------------#
+# #with_attributes() #
+#--------------------#
+#
+# Use it to assign multiple attributes
+
+other_job = job.with_attributes(id: 2, state: 'killed')
+
+puts other_job.id          # 2
+puts other_job.state       # killed
+puts other_job.equal?(job) # false
+```
+
 ## 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.rb

@@ -25,7 +25,7 @@ module Micro
         With::ActiveModelValidationsAndDiffAndInitialize
       end
 
-      def self.fetch(names)
+      def self.with(names)
         option = OPTIONS[names.map { |name| name.to_s.downcase }.sort.join(':')]
         return option if option
         raise ArgumentError, INVALID_FEATURES

data/lib/micro/attributes/version.rb

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

data/lib/micro/attributes.rb

@@ -30,11 +30,15 @@ module Micro
     end
 
     def self.with(*names)
-      Features.fetch(names)
+      Features.with(names)
+    end
+
+    def self.feature(name)
+      self.with(name)
     end
 
     def self.features(*names)
-      names.empty? ? Features.all : Features.fetch(names)
+      names.empty? ? Features.all : Features.with(names)
     end
 
     def attributes=(arg)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: u-attributes
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-11 00:00:00.000000000 Z
+date: 2019-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -53,7 +53,7 @@ files:
 - lib/micro/attributes/version.rb
 - lib/micro/attributes/with.rb
 - lib/u-attributes.rb
-- run-tests.sh
+- test.sh
 - u-attributes.gemspec
 homepage: https://github.com/serradura/u-attributes
 licenses: