u-attributes 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63911d6718fe30f139ee9acfb5b4a4577a71c3e01222087a17a4d0f349b31935
-  data.tar.gz: 8a3a4266c67d1e8eade0d742cf2d057c0bafb2f2e25c26c768f73cea4d40aa97
+  metadata.gz: e37bcd7fa7880973930c3a455850708bf22962266c5d2b09f69885dc0c7b9a8d
+  data.tar.gz: ed08290e3bca0a590a88a7720deb3c6e94eae93d64a12884eb108806ce2a13ce
 SHA512:
-  metadata.gz: 927eb73d0b9cfce21e9d8abe11ab899296a6f45721d7821ea175e0bc58d144015ba22e488f1bdb6be563821a8b4e25a1082eba4c103ceedbed556ded654ab721
-  data.tar.gz: 85bf3683290458bfb863b215fe5eca4e57e041bb2dd167e1908a629c9081d9c8417584b847b9a775d46658f8069c5d960484a9c7a2be7ffb462eac1104f4b4ca
+  metadata.gz: 031f5deb4ece3c5be0004290675a4bbd72e90a8b1436068054dc1acf8d949e7b4957e6b20d4f53112136cd35d15ede29d648576e7b3fe52fe0216e73012afad7
+  data.tar.gz: 6191e30d97bdf5cdeb06a5ece5db65877ca14304af432dc8f69077cb691fc0458a4adb1124ebf1acdbdeae4eae2682944770cb1268708680ebafd0062165a38c

data/.travis.yml

@@ -3,5 +3,13 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.3
-before_install: gem install bundler -v 2.0.1
+  - 2.2.0
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+  - 2.6.0
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
+env:
+  - DISABLE_SIMPLECOV=true

data/Gemfile.lock

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

data/README.md

@@ -1,4 +1,4 @@
-# μ-attributes (Micro::Attributes)
+# μ-attributes (Micro::Attributes) [![Build Status](https://travis-ci.com/serradura/u-attributes.svg?branch=master)](https://travis-ci.com/serradura/u-attributes)
 
 This gem allows defining read-only attributes, that is, your objects will have only getters to access their attributes data.
 
@@ -98,9 +98,9 @@ person.attribute(:name) { |value| puts value } # John Doe
 person.attribute('age') { |value| puts value } # 20
 person.attribute('foo') { |value| puts value } # !! Nothing happened, because of the attribute not exists.
 
-#--------------#
-# #attribute() #
-#--------------#
+#---------------#
+# #attribute!() #
+#---------------#
 #
 # Works like the #attribute() method, but will raise an exception when the attribute not exist.
 
@@ -264,6 +264,99 @@ p person.attributes                   # {"age"=>20, "name"=>"John Doe"}
 p Person.new(name: 'John').attributes # {"age"=>nil, "name"=>"John"}
 ```
 
+## Built-in extensions
+
+You can use the method `Micro::Attributes.features()` to combine and require only the features that better fit your needs.
+
+Note: The method `Micro::Attributes.with()` is an alias for `Micro::Attributes.features()`.
+
+### Diff extension
+
+Provides a way to track changes in your object attributes.
+
+#### How to enable?
+
+```ruby
+#----------------------------------#
+# Via Micro::Attributes.features() #
+#----------------------------------#
+class Job
+  include Micro::Attributes.features(:diff)
+
+  attributes :id, state: 'sleeping'
+
+  def initialize(options)
+    self.options = options
+  end
+end
+
+# --------------------------------------------------------------------#
+# Using the .with() method alias and adding the initialize extension. #
+# --------------------------------------------------------------------#
+
+class Job
+  include Micro::Attributes.with(:initialize, :diff)
+
+  attributes :id, state: 'sleeping'
+end
+
+#---------------------------------------#
+# Via Micro::Attributes.to_initialize() #
+#---------------------------------------#
+class Job
+  include Micro::Attributes.to_initialize(diff: true)
+
+  attribute :id
+  attribute :state, 'sleeping'
+end
+```
+
+#### Usage
+
+```ruby
+require 'securerandom'
+
+class Job
+  include Micro::Attributes.features(:initialize, :diff)
+
+  attributes :id, state: 'sleeping'
+end
+
+job = Job.new(id: SecureRandom.uuid())
+
+p job.id    # A random UUID generated from SecureRandom.uuid(). e.g: "e68bcc74-b91c-45c2-a904-12f1298cc60e"
+p job.state # "sleeping"
+
+job_running = job.with_attribute(:state, 'running')
+
+p job_running.state # "running"
+
+job_changes = job.diff_attributes(job_running)
+
+#-----------------------------#
+# #present?, #blank?, #empty? #
+#-----------------------------#
+
+p job_changes.present? # true
+p job_changes.blank?   # false
+p job_changes.empty?   # false
+
+#-----------#
+# #changed? #
+#-----------#
+p job_changes.changed? # true
+
+p job_changes.changed?(:id)    # false
+
+p job_changes.changed?(:state) # true
+p job_changes.changed?(:state, from: 'sleeping', to: 'running') # true
+
+#----------------#
+# #differences() #
+#----------------#
+p job_changes.differences # {"state"=>"running"}
+```
+
 ## 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

@@ -3,7 +3,7 @@
 require "micro/attributes/version"
 require "micro/attributes/attributes_utils"
 require "micro/attributes/macros"
-require "micro/attributes/to_initialize"
+require "micro/attributes/features"
 
 module Micro
   module Attributes
@@ -22,23 +22,32 @@ module Micro
       end
     end
 
-    def self.to_initialize
-      @to_initialize ||= ::Micro::Attributes.const_get(:ToInitialize)
+    def self.to_initialize(diff: false)
+      options = [:initialize]
+      options << :diff if diff
+      features(*options)
     end
 
+    def self.features(*names)
+      Features.fetch(names)
+    end
+    singleton_class.send(:alias_method, :with, :features)
+
     def attributes=(arg)
       self.class.attributes_data(AttributesUtils.hash_argument!(arg)).each do |name, value|
-        instance_variable_set("@#{name}", value) if attribute?(name)
+        __attributes[name] = instance_variable_set("@#{name}", value) if attribute?(name)
       end
+      __attributes.freeze
     end
     protected :attributes=
 
-    def attributes
-      state = self.class.attributes.each_with_object({}) do |name, memo|
-        memo[name] = public_send(name) if respond_to?(name)
-      end
+    def __attributes
+      @__attributes ||= {}
+    end
+    private :__attributes
 
-      self.class.attributes_data(state)
+    def attributes
+      __attributes
     end
 
     def attribute?(name)

data/lib/micro/attributes/features.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "micro/attributes/features/diff"
+require "micro/attributes/features/initialize"
+
+module Micro
+  module Attributes
+    module Features
+      module InitializeAndDiff
+        def self.included(base)
+          base.send(:include, ::Micro::Attributes::Features::Initialize)
+          base.send(:include, ::Micro::Attributes::Features::Diff)
+        end
+      end
+
+      OPTIONS = {
+        'diff' => Diff,
+        'initialize' => Initialize,
+        'diff:initialize' => InitializeAndDiff
+      }.freeze
+
+      private_constant :OPTIONS
+
+      def self.fetch(names)
+        option = OPTIONS[names.map { |name| name.to_s.downcase }.sort.join(':')]
+        return option if option
+        raise ArgumentError, 'Invalid feature name! Available options: diff, initialize'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Micro::Attributes
+  module Features
+    module Diff
+      class Changes
+        attr_reader :from, :to, :differences
+
+        def initialize(from:, to:)
+          raise ArgumentError, "expected an instance of #{from.class}" unless to.is_a?(from.class)
+          @from, @to = from, to
+          @differences = diff(from.attributes, to.attributes).freeze
+        end
+
+        def empty?
+          @differences.empty?
+        end
+        alias_method :blank?, :empty?
+
+        def present?
+          !empty?
+        end
+
+        def changed?(name = nil, from: nil, to: nil)
+          if name.nil?
+            return present? if from.nil? && to.nil?
+            raise ArgumentError, 'pass the attribute name with the :from and :to values'
+          elsif from.nil? && to.nil?
+            differences.has_key?(name.to_s)
+          else
+            key = name.to_s
+            @from_attributes[key] == from && @to_attributes[key] == to
+          end
+        end
+
+        private
+
+        def diff(from_attributes, to_attributes)
+          @to_attributes = to_attributes
+          @from_attributes = from_attributes
+          @from_attributes.each_with_object({}) do |(from_key, from_val), acc|
+            to_value = @to_attributes[from_key]
+            acc[from_key] = to_value if from_val != to_value
+          end
+        end
+      end
+      private_constant :Changes
+
+      def diff_attributes(to)
+        return Changes.new(from: self, to: to) if to.is_a?(::Micro::Attributes)
+        raise ArgumentError, "#{to.inspect} must implement Micro::Attributes"
+      end
+    end
+  end
+end

data/lib/micro/attributes/{to_initialize.rb → features/initialize.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-module Micro
-  module Attributes
-    module ToInitialize
+module Micro::Attributes
+  module Features
+    module Initialize
       def self.included(base)
         base.send(:include, ::Micro::Attributes)
       end
@@ -19,7 +19,5 @@ module Micro
         self.class.new(attributes.merge(arg))
       end
     end
-
-    private_constant :ToInitialize
   end
 end

data/lib/micro/attributes/version.rb

@@ -2,6 +2,6 @@
 
 module Micro
   module Attributes
-    VERSION = "0.9.0"
+    VERSION = "0.10.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: u-attributes
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-08 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,8 +58,10 @@ files:
 - bin/setup
 - lib/micro/attributes.rb
 - lib/micro/attributes/attributes_utils.rb
+- lib/micro/attributes/features.rb
+- lib/micro/attributes/features/diff.rb
+- lib/micro/attributes/features/initialize.rb
 - lib/micro/attributes/macros.rb
-- lib/micro/attributes/to_initialize.rb
 - lib/micro/attributes/version.rb
 - lib/u-attributes.rb
 - u-attributes.gemspec