u-attributes 1.1.0 → 2.1.0

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

@@ -7,6 +7,7 @@ module Micro::Attributes
         base.class_eval(<<-RUBY)
           def initialize(arg)
             self.attributes = arg
+            __call_after_micro_attribute
           end
         RUBY
       end
@@ -18,6 +19,10 @@ module Micro::Attributes
       def with_attributes(arg)
         self.class.new(attributes.merge(arg))
       end
+
+      private
+
+        def __call_after_micro_attribute; end
     end
   end
 end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Micro::Attributes
+  module Features
+    module Initialize
+      module Strict
+        module ClassMethods
+          def attributes_are_all_required?
+            true
+          end
+        end
+
+        def self.included(base)
+          base.send(:extend, ClassMethods)
+        end
+      end
+    end
+  end
+end

data/lib/micro/attributes/macros.rb

@@ -3,8 +3,31 @@
 module Micro
   module Attributes
     module Macros
-      def __attributes_data
-        @__attributes_data ||= {}
+      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
@@ -13,58 +36,65 @@ module Micro
 
       def __attribute_reader(name)
         __attributes.add(name)
+
         attr_reader(name)
       end
 
-      def __attribute_set(key, value, can_overwrite)
+      def __attribute_assign(key, can_overwrite, options)
         name = key.to_s
         has_attribute = attribute?(name)
+
         __attribute_reader(name) unless has_attribute
-        __attributes_data[name] = value if can_overwrite || !has_attribute
-      end
 
-      def __attributes_def(arg, can_overwrite)
-        return __attribute_set(arg, nil, can_overwrite) unless arg.is_a?(::Hash)
-        arg.each { |key, val| __attribute_set(key, val, can_overwrite) }
+        __attributes_data__[name] = __attributes_data_to_assign(name, options) if can_overwrite || !has_attribute
+
+        __call_after_attribute_assign__(name, options)
       end
 
-      def __attributes_set(args, can_overwrite)
-        args.flatten.each { |arg| __attributes_def(arg, can_overwrite) }
+      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 do |key, val|
+          __attribute_assign(key, true, val ? { default: val } : {})
+        end
       end
 
       def attribute?(name)
         __attributes.member?(name.to_s)
       end
 
-      def attribute(name, value=nil)
-        __attribute_set(name, value, false)
+      def attribute(name, options = Kind::Empty::HASH)
+        __attribute_assign(name, false, options)
       end
 
       def attributes(*args)
         return __attributes.to_a if args.empty?
-        __attributes_set(args, can_overwrite: false)
-      end
 
-      def attributes_data(arg)
-        __attributes_data.merge(AttributesUtils.stringify_hash_keys!(arg))
+        args.flatten!
+        args.each do |arg|
+          if arg.is_a?(String) || arg.is_a?(Symbol)
+            __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, value=nil)
-          __attribute_set(name, value, true)
-        end
-
-        def attributes!(*args)
-          return __attributes_set(args, can_overwrite: true) unless args.empty?
-          raise ArgumentError, WRONG_NUMBER_OF_ARGS
+        def attribute!(name, options = Kind::Empty::HASH)
+          __attribute_assign(name, true, options)
         end
 
         private_constant :WRONG_NUMBER_OF_ARGS
       end
+
       private_constant :ForSubclasses
     end
+
     private_constant :Macros
   end
 end

data/lib/micro/attributes/utils.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Micro
+  module Attributes
+    module Utils
+      def self.stringify_hash_keys(arg)
+        hash = Kind::Of.(::Hash, arg)
+
+        return hash if hash.empty?
+
+        if hash.respond_to?(:transform_keys)
+          hash.transform_keys { |key| key.to_s }
+        else
+          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 = '1.1.0'.freeze
+    VERSION = '2.1.0'.freeze
   end
 end

data/lib/micro/attributes/with.rb

@@ -2,8 +2,8 @@
 
 require 'micro/attributes/features/diff'
 require 'micro/attributes/features/initialize'
+require 'micro/attributes/features/initialize/strict'
 require 'micro/attributes/features/activemodel_validations'
-require 'micro/attributes/features/strict_initialize'
 
 module Micro
   module Attributes
@@ -35,7 +35,7 @@ module Micro
       module StrictInitialize
         def self.included(base)
           base.send(:include, Initialize)
-          base.send(:include, ::Micro::Attributes::Features::StrictInitialize)
+          base.send(:include, ::Micro::Attributes::Features::Initialize::Strict)
         end
       end
 
@@ -53,7 +53,7 @@ module Micro
       module DiffAndStrictInitialize
         def self.included(base)
           base.send(:include, DiffAndInitialize)
-          base.send(:include, ::Micro::Attributes::Features::StrictInitialize)
+          base.send(:include, ::Micro::Attributes::Features::Initialize::Strict)
         end
       end
 
@@ -76,7 +76,7 @@ module Micro
       module ActiveModelValidationsAndStrictInitialize
         def self.included(base)
           base.send(:include, ActiveModelValidationsAndInitialize)
-          base.send(:include, ::Micro::Attributes::Features::StrictInitialize)
+          base.send(:include, ::Micro::Attributes::Features::Initialize::Strict)
         end
       end
 
@@ -92,7 +92,7 @@ module Micro
       module ActiveModelValidationsAndDiffAndStrictInitialize
         def self.included(base)
           base.send(:include, ActiveModelValidationsAndDiffAndInitialize)
-          base.send(:include, ::Micro::Attributes::Features::StrictInitialize)
+          base.send(:include, ::Micro::Attributes::Features::Initialize::Strict)
         end
       end
     end

data/u-attributes.gemspec

@@ -1,28 +1,35 @@
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "micro/attributes/version"
+require 'micro/attributes/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "u-attributes"
+  spec.name          = 'u-attributes'
   spec.version       = Micro::Attributes::VERSION
-  spec.authors       = ["Rodrigo Serradura"]
-  spec.email         = ["rodrigo.serradura@gmail.com"]
+  spec.authors       = ['Rodrigo Serradura']
+  spec.email         = ['rodrigo.serradura@gmail.com']
 
-  spec.summary       = %q{Define read-only attributes}
-  spec.description   = %q{This gem allows defining read-only attributes, that is, your objects will have only getters to access their attributes data.}
-  spec.homepage      = "https://github.com/serradura/u-attributes"
-  spec.license       = "MIT"
+  spec.summary       = %q{Create "immutable" objects. No setters, just getters!}
+  spec.description   =
+    "This gem allows you to define \"immutable\" objects, and your objects will have only getters and no setters. "\
+    "So, if you change some object attribute, you will have a new object instance. " \
+    "That is, you transform the object instead of modifying it."
+  spec.homepage      = 'https://github.com/serradura/u-attributes'
+  spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.2.0'
-  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency 'kind', '>= 3.0', '< 5.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 13.0'
 end

metadata

@@ -1,31 +1,67 @@
 --- !ruby/object:Gem::Specification
 name: u-attributes
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-05 00:00:00.000000000 Z
+date: 2020-08-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: kind
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: This gem allows defining read-only attributes, that is, your objects
-  will have only getters to access their attributes data.
+        version: '13.0'
+description: This gem allows you to define "immutable" objects, and your objects will
+  have only getters and no setters. So, if you change some object attribute, you will
+  have a new object instance. That is, you transform the object instead of modifying
+  it.
 email:
 - rodrigo.serradura@gmail.com
 executables: []
@@ -37,20 +73,21 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/u-attributes_logo_v1.png
 - bin/console
 - bin/setup
 - lib/micro/attributes.rb
-- lib/micro/attributes/attributes_utils.rb
+- lib/micro/attributes/diff.rb
 - lib/micro/attributes/features.rb
 - 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/features/initialize/strict.rb
 - lib/micro/attributes/macros.rb
+- lib/micro/attributes/utils.rb
 - lib/micro/attributes/version.rb
 - lib/micro/attributes/with.rb
 - lib/u-attributes.rb
@@ -75,8 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: Define read-only attributes
+summary: Create "immutable" objects. No setters, just getters!
 test_files: []

data/Gemfile.lock

@@ -1,29 +0,0 @@
-PATH
-  remote: .
-  specs:
-    u-attributes (1.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    docile (1.3.2)
-    json (2.2.0)
-    minitest (5.11.3)
-    rake (10.5.0)
-    simplecov (0.17.0)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  minitest (~> 5.0)
-  rake (~> 10.0)
-  simplecov
-  u-attributes!
-
-BUNDLED WITH
-   1.17.3

data/lib/micro/attributes/attributes_utils.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Micro
-  module Attributes
-    module AttributesUtils
-      ARGUMENT_ERROR_MSG = 'argument must be a Hash'.freeze
-
-      def self.hash_argument!(arg)
-        return arg if arg.is_a?(Hash)
-
-        raise ArgumentError, ARGUMENT_ERROR_MSG
-      end
-
-      def self.stringify_hash_keys!(arg)
-        hash_argument!(arg).each_with_object({}) do |(key, val), memo|
-          memo[key.to_s] = val
-        end
-      end
-    end
-  end
-end