u-attributes 2.4.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62c6ad9683f0824be6a32648028f25a97ba88a10c7fbdd0b9a2ccfbfe275961b
-  data.tar.gz: d110a1b4220af76a7f14753cb1ca5067428f06db026466e095d54a22ee46f86f
+  metadata.gz: 75a44be0f1b71d41abdfd3e9c81f67527760a4a8f0202818fd7f04782680922b
+  data.tar.gz: bbb26faf04daffd2e92b18eb4e363d85c7677ed5ed3fb09bda485d8b34c8296d
 SHA512:
-  metadata.gz: 24703dcd81aa785fe00b77a741434ad84600243f4bb132d2bbbce2b5a310d4f2b931c2b6ea41e311a2bcf07876296bd03d8e6c39a92905bc9a4f745fdb30a094
-  data.tar.gz: 8172811ddaf44a3099e66f63cea5aed99d5c1a63a77944dc1e98c16fa0378603498fbdfe0c77f7220244c8d7b977801a75bd01facc875fb05f0bd1aed0171cc5
+  metadata.gz: 9e7da00d4786086edc9607533ef9c9632b10dd2200ddee29a46551d311c8e5ee8c5549d161f8ea6881c95c529abbdd4a2c48fd28635464606a7877b0d94a6488
+  data.tar.gz: aa42ef9c78b7f60514ef062b78d1b6f4eb3589ce1d39ab13d6459d2a164e3dcfa8b4f54660598df76afe4b42b8087cf9060f57398609f59508952bfd49c0cda1

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+
+name: build
+on: [push]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.2, 2.3, 2.4, 2.5, 2.6, 3.0]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Test and generate coverage
+        run: bin/test
+      - name: Format coverage
+        if: ${{ matrix.ruby >= 3 }}
+        run: bin/prepare_coverage
+      - uses: paambaati/codeclimate-action@v2.7.5
+        if: ${{ matrix.ruby >= 3 }}
+        env:
+          CC_TEST_REPORTER_ID: 9015766fe58e0abd5ab58050ddfc67708e0b11430b3d3999ac17139ffcb4d3e7
+        with:
+          debug: true
+          coverageLocations: coverage/.resultset.json:simplecov

data/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "cSpell.enabled": true,
+  "cSpell.ignoreWords": [
+    "paambaati",
+    "resultset",
+    "simplecov"
+  ]
+}

data/Gemfile

@@ -1,8 +1,8 @@
 source 'https://rubygems.org'
 
-gem 'u-case', '~> 4.0'
+gem 'u-case', '~> 4.5', '>= 4.5.1'
 
-activemodel_version = ENV.fetch('ACTIVEMODEL_VERSION', '6.1')
+activemodel_version = ENV['ACTIVEMODEL_VERSION']
 
 activemodel = case activemodel_version
               when '3.2' then '3.2.22'
@@ -11,26 +11,31 @@ activemodel = case activemodel_version
               when '4.2' then '4.2.11'
               when '5.0' then '5.0.7'
               when '5.1' then '5.1.7'
-              when '5.2' then '5.2.3'
-              when '6.0' then '6.0.0'
+              when '5.2' then '5.2.4'
+              when '6.0' then '6.0.3.4'
+              when '6.1' then '6.1.2'
               end
 
-if activemodel_version < '6.1'
-  gem 'activemodel', activemodel, require: false
-  gem 'activesupport', activemodel, require: false
-end
-
 simplecov_version =
   case RUBY_VERSION
-  when /\A2.[23]/ then '~> 0.17.1'
+  when /\A2.[23]/ then '0.17.1'
   when /\A2.4/ then '~> 0.18.5'
-  else '~> 0.19'
+  else '~> 0.21.2'
   end
 
 group :test do
-  gem 'minitest', activemodel_version < '4.1' ? '~> 4.2' : '~> 5.0'
+  if activemodel_version
+    gem 'activesupport', activemodel, require: false
+    gem 'activemodel', activemodel, require: false
+    gem 'minitest', activemodel_version < '4.1' ? '~> 4.2' : '~> 5.0'
+  else
+    gem 'minitest', '~> 5.0'
+  end
+
   gem 'simplecov', simplecov_version, require: false
 end
 
+gem 'rake', '~> 13.0'
+
 # Specify your gem's dependencies in u-attributes.gemspec
 gemspec

data/README.md

@@ -1,19 +1,19 @@
 <p align="center">
   <img src="./assets/u-attributes_logo_v1.png" alt='Create "immutable" objects. No setters, just getters!'>
 
-  <p align="center"><i>Create "immutable" objects. No setters, just getters!</i></p>
+  <p align="center"><i>Create "immutable" objects with 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">
+  <img src="https://img.shields.io/badge/ruby->%3D%202.2.0-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 href="https://github.com/serradura/u-attributes/actions/workflows/ci.yml">
+    <img alt="Build Status" src="https://github.com/serradura/u-attributes/actions/workflows/ci.yml/badge.svg">
   </a>
 
   <a href="https://codeclimate.com/github/serradura/u-attributes/maintainability">
@@ -25,8 +25,16 @@
   </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.
+This gem allows you to define "immutable" objects, when using it your objects will only have getters and no setters.
+So, if you change [[1](#with_attribute)] [[2](#with_attributes)] an attribute of the object, you’ll have a new object instance. That is, you transform the object instead of modifying it.
+
+## Documentation <!-- omit in toc -->
+
+Version    | Documentation
+---------- | -------------
+unreleased | https://github.com/serradura/u-case/blob/main/README.md
+2.8.0      | https://github.com/serradura/u-case/blob/v2.x/README.md
+1.2.0      | https://github.com/serradura/u-case/blob/v1.x/README.md
 
 # Table of contents <!-- omit in toc -->
 - [Installation](#installation)
@@ -85,7 +93,8 @@ gem 'u-attributes'
 
 | u-attributes   | branch  | ruby     |  activemodel  |
 | -------------- | ------- | -------- | ------------- |
-| 2.4.0          | main    | >= 2.2.0 | >= 3.2, < 6.1 |
+| unreleased     | main    | >= 2.2.0 | >= 3.2, < 7   |
+| 2.8.0          | v2.x    | >= 2.2.0 | >= 3.2, < 7   |
 | 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.
@@ -618,7 +627,7 @@ The method `Micro::Attributes.with()` will raise an exception if no arguments/fe
 
 ```ruby
 class Job
-  include Micro::Attributes.with() # ArgumentError (Invalid feature name! Available options: :activemodel_validations, :diff, :initialize, :keys_as_symbol)
+  include Micro::Attributes.with() # ArgumentError (Invalid feature name! Available options: :accept, :activemodel_validations, :diff, :initialize, :keys_as_symbol)
 end
 ```
 

data/bin/prepare_coverage

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# Borrowed from https://gist.github.com/qortex/7e7c49f3731391a91ee898336183acef
+
+# Temporary hack to get CodeClimate to work with SimpleCov 0.18 JSON format until issue is fixed
+# upstream: https://github.com/codeclimate/test-reporter/issues/413
+
+require "json"
+
+filename = "coverage/.resultset.json"
+contents = JSON.parse(File.read(filename))
+
+def remove_lines_key(obj)
+  case obj
+  when Hash
+    obj.transform_values do |val|
+      val.is_a?(Hash) && val.key?("lines") ? val["lines"] : remove_lines_key(val)
+    end
+  else
+    obj
+  end
+end
+
+# overwrite
+File.write(filename, JSON.generate(remove_lines_key(contents)))
+
+puts Dir['coverage/.*.json']

data/bin/test

@@ -0,0 +1,48 @@
+#!/bin/bash
+
+set -e
+
+RUBY_V=$(ruby -v)
+
+function reset_gemfile_and_test {
+  rm Gemfile.lock
+
+  eval "$1 bundle update"
+  eval "$1 bundle exec rake test"
+}
+
+function test_with_activemodel {
+  reset_gemfile_and_test "ACTIVEMODEL_VERSION=$1"
+}
+
+RUBY_2_2345="ruby 2.[2345]."
+RUBY_2_234="ruby 2.[234]."
+RUBY_2_567="ruby 2.[567]."
+RUBY_2_2="ruby 2.2."
+RUBY_3_X="ruby 3.0."
+
+if [[ $RUBY_V =~ $RUBY_2_2345 ]]; then
+  if [[ $RUBY_V =~ $RUBY_2_234 ]]; then
+    reset_gemfile_and_test
+  fi
+
+  if [[ $RUBY_V =~ $RUBY_2_2 ]]; then
+    test_with_activemodel "3.2"
+  fi
+
+  test_with_activemodel "4.0"
+  test_with_activemodel "4.1"
+  test_with_activemodel "4.2"
+  test_with_activemodel "5.0"
+  test_with_activemodel "5.1"
+  test_with_activemodel "5.2"
+fi
+
+if [[ $RUBY_V =~ $RUBY_2_567 ]] || [[ $RUBY_V =~ $RUBY_3_X ]]; then
+  gem install bundler -v ">= 2" --no-doc
+
+  reset_gemfile_and_test
+
+  test_with_activemodel "6.0"
+  test_with_activemodel "6.1"
+fi

data/lib/micro/attributes/diff.rb

@@ -12,7 +12,7 @@ module Micro::Attributes
       def initialize(from:, to:)
         @from_class = from.class
 
-        @from, @to = from, Kind::Of.(@from_class, to)
+        @from, @to = from, Kind.of(@from_class, to)
 
         @from_key, @to_key =
           @from_class.attributes_access == :symbol ? FROM_TO_SYM : FROM_TO_STR
@@ -35,17 +35,17 @@ module Micro::Attributes
 
           raise ArgumentError, FROM_TO_ERROR
         elsif from.nil? && to.nil?
-          differences.has_key?(key_access(name))
+          differences.has_key?(key_transform(name))
         else
-          result = @differences[key_access(name)]
+          result = @differences[key_transform(name)]
           result ? result[@from_key] == from && result[@to_key] == to : false
         end
       end
 
       private
 
-        def key_access(key)
-          @from_class.__attribute_key__(key)
+        def key_transform(key)
+          @from_class.__attribute_key_transform__(key)
         end
 
         def diff(from_attributes, to_attributes)

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Micro::Attributes
+  module Features
+    module Accept
+
+      module Strict
+        ATTRIBUTES_REJECTED = "One or more attributes were rejected. Errors:\n".freeze
+
+        def __call_after_attributes_assign
+          return unless attributes_errors?
+
+          __raise_error_if_found_attributes_errors
+        end
+
+        def __raise_error_if_found_attributes_errors
+          raise ArgumentError, [
+            ATTRIBUTES_REJECTED,
+            attributes_errors.map { |key, msg| "* #{key.inspect} #{msg}" }.join("\n")
+          ].join
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Micro::Attributes
+  module Features
+    module Accept
+      def attributes_errors
+        @__attributes_errors
+      end
+
+      def attributes_errors?
+        !@__attributes_errors.empty?
+      end
+
+      def rejected_attributes
+        @__rejected_attributes ||= attributes_errors.keys
+      end
+
+      def accepted_attributes
+        @__accepted_attributes ||= defined_attributes - rejected_attributes
+      end
+
+      def rejected_attributes?
+        attributes_errors?
+      end
+
+      def accepted_attributes?
+        !rejected_attributes?
+      end
+
+      private
+
+        def __call_before_attributes_assign
+          @__attributes_errors = {}
+        end
+
+        KeepProc = -> validation_data { validation_data[0] == :accept && validation_data[1] == Proc }
+
+        def __attribute_assign(key, init_hash, attribute_data)
+          validation_data = attribute_data[1]
+
+          value_to_assign = FetchValueToAssign.(init_hash, init_hash[key], attribute_data, KeepProc.(validation_data))
+
+          value = __attributes[key] = instance_variable_set("@#{key}", value_to_assign)
+
+          __attribute_accept_or_reject(key, value, validation_data) if !validation_data.empty?
+        end
+
+        def __attribute_accept_or_reject(key, value, validation_data)
+          context = Context.with(key, value, validation_data)
+
+          error_msg = context.rejection_message(Validate.call(context))
+
+          @__attributes_errors[key] = error_msg if error_msg
+        end
+
+        Context = Struct.new(:key, :value, :validation, :expected, :allow_nil, :rejection) do
+          def self.with(key, value, data)
+            new(key, value, data[0], data[1], data[2], data[3])
+          end
+
+          def allow_nil?
+            allow_nil && value.nil?
+          end
+
+          def accept?
+            validation == :accept
+          end
+
+          def rejection_message(default_msg)
+            return unless default_msg
+
+            return default_msg unless rejection || expected.respond_to?(:rejection_message)
+
+            rejection_msg = rejection || expected.rejection_message
+
+            return rejection_msg unless rejection_msg.is_a?(Proc)
+
+            rejection_msg.arity == 0 ? rejection_msg.call : rejection_msg.call(key)
+          end
+        end
+
+        module Validate
+          module Callable
+            MESSAGE = 'is invalid'.freeze
+
+            def self.call?(exp); exp.respond_to?(:call); end
+            def self.call(exp, val); exp.call(val); end
+            def self.accept_failed(_exp); MESSAGE; end
+            def self.reject_failed(_exp); MESSAGE; end
+          end
+
+          module KindOf
+            def self.call?(exp); exp.is_a?(Class) || exp.is_a?(Module); end
+            def self.call(exp, val); val.kind_of?(exp); end
+            def self.accept_failed(exp); "expected to be a kind of #{exp}"; end
+            def self.reject_failed(exp); "expected to not be a kind of #{exp}"; end
+          end
+
+          module Predicate
+            QUESTION_MARK = '?'.freeze
+
+            def self.call?(exp); exp.is_a?(Symbol) && exp.to_s.end_with?(QUESTION_MARK); end
+            def self.call(exp, val); val.public_send(exp); end
+            def self.accept_failed(exp); "expected to be #{exp}"; end
+            def self.reject_failed(exp); "expected to not be #{exp}"; end
+          end
+
+          def self.with(expected)
+            return Callable if Callable.call?(expected)
+            return KindOf if KindOf.call?(expected)
+            return Predicate if Predicate.call?(expected)
+          end
+
+          def self.call(context)
+            return if context.allow_nil?
+
+            validate = self.with(expected = context.expected)
+
+            return unless validate
+
+            truthy = validate.call(expected, context.value)
+
+            return truthy ? nil : validate.accept_failed(expected) if context.accept?
+
+            validate.reject_failed(expected) if truthy
+          end
+        end
+
+        private_constant :KeepProc, :Context, :Validate
+    end
+  end
+end

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

@@ -3,13 +3,45 @@
 module Micro::Attributes
   module Features
     module ActiveModelValidations
-      def self.included(base)
-        begin
-          require 'active_model'
+      module Standard
+        private def __call_after_attributes_assign
+          run_validations!
+        end
+      end
 
-          base.send(:include, ::ActiveModel::Validations)
-          base.extend(ClassMethods)
-        rescue LoadError
+      module CheckActivemodelValidationErrors
+        private def __check_activemodel_validation_errors
+          return if errors.blank?
+
+          errors_hash = errors.to_hash
+
+          defined_attributes.each do |key|
+            value = Utils::Hashes.assoc(errors_hash, key)
+
+            @__attributes_errors[key] = value.join(', ') if value.present?
+          end
+        end
+      end
+
+      module WithAccept
+        include CheckActivemodelValidationErrors
+
+        private def __call_after_attributes_assign
+          run_validations! unless attributes_errors?
+
+          __check_activemodel_validation_errors
+        end
+      end
+
+      module WithAcceptStrict
+        include CheckActivemodelValidationErrors
+
+        private def __call_after_attributes_assign
+          __raise_error_if_found_attributes_errors if attributes_errors?
+
+          run_validations!
+
+          __check_activemodel_validation_errors
         end
       end
 
@@ -22,11 +54,23 @@ module Micro::Attributes
         end
       end
 
-      private
+      def self.included(base)
+        begin
+          require 'active_model'
+
+          base.send(:include, ::ActiveModel::Validations)
+          base.extend(ClassMethods)
 
-        def __call_after_micro_attribute
-          run_validations! if respond_to?(:run_validations!, true)
+          case
+          when base <= Features::Accept::Strict then base.send(:include, WithAcceptStrict)
+          when base <= Features::Accept then base.send(:include, WithAccept)
+          else base.send(:include, Standard)
+          end
+        rescue LoadError
         end
+      end
+
+      private_constant :Standard, :CheckActivemodelValidationErrors, :WithAccept, :WithAcceptStrict
     end
   end
 end