sequent 3.3.1 → 4.1.0

data/lib/sequent/core/helpers/attribute_support.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require_relative '../ext/ext'
 require_relative 'array_with_type'
@@ -9,33 +11,44 @@ require_relative 'association_validator'
 module Sequent
   module Core
     module Helpers
-      # Provides functionality for defining attributes with their types
+      # Provides functionality for defining attributes with their types.
       #
-      # Since our Commands and ValueObjects are not backed by a database like e.g. rails
+      # Since our Commands and ValueObjects are not backed by a database like e.g. Rails
       # we can not infer their types. We need the types to be able to parse from and to json.
-      # We could have stored te type information in the json, but we didn't.
-      #
       # You typically do not need to include this module in your classes. If you extend from
-      # Sequent::Core::ValueObject, Sequent::Core::Event or Sequent::Core::BaseCommand you will
+      # Sequent::ValueObject, Sequent::Event or Sequent::Command you will
       # get this functionality for free.
       #
+      # Example:
+      #
+      #   attrs name: String, age: Integer, born: Date
+      #
+      # Currently Sequent supports the following types:
+      #
+      # - String
+      # - Integer
+      # - Boolean
+      # - Date
+      # - DateTime
+      # - Subclasses of Sequent::ValueObject
+      # - Lists defined as `array(String)`
+      # - BigDecimal
+      # - Sequent::Secret
+      #
       module AttributeSupport
         class UnknownAttributeError < StandardError; end
 
         # module containing class methods to be added
         module ClassMethods
-
           def types
             @types ||= {}
-            if @merged_types
-              @merged_types
-            else
-              @merged_types = is_a?(Class) && superclass.respond_to?(:types) ? @types.merge(superclass.types) : @types
-              included_modules.select { |m| m.include? Sequent::Core::Helpers::AttributeSupport }.each do |mod|
-                @merged_types.merge!(mod.types)
-              end
-              @merged_types
+            return @merged_types if @merged_types
+
+            @merged_types = is_a?(Class) && superclass.respond_to?(:types) ? @types.merge(superclass.types) : @types
+            included_modules.select { |m| m.include? Sequent::Core::Helpers::AttributeSupport }.each do |mod|
+              @merged_types.merge!(mod.types)
             end
+            @merged_types
           end
 
           def attrs(args)
@@ -44,14 +57,15 @@ module Sequent
             associations = []
             args.each do |attribute, type|
               attr_accessor attribute
+
               if included_modules.include?(Sequent::Core::Helpers::TypeConversionSupport)
                 Sequent::Core::Helpers::DefaultValidators.for(type).add_validations_for(self, attribute)
               end
 
-              if type.class == Sequent::Core::Helpers::ArrayWithType
+              if type.instance_of?(Sequent::Core::Helpers::ArrayWithType)
                 associations << attribute
               elsif included_modules.include?(ActiveModel::Validations) &&
-                type.included_modules.include?(Sequent::Core::Helpers::AttributeSupport)
+                    type.included_modules.include?(Sequent::Core::Helpers::AttributeSupport)
                 associations << attribute
               end
             end
@@ -63,9 +77,9 @@ module Sequent
               def update_all_attributes(attrs)
                 super if defined?(super)
                 ensure_known_attributes(attrs)
-                #{@types.map { |attribute, _|
-              "@#{attribute} = attrs[:#{attribute}]"
-            }.join("\n            ")}
+                #{@types.map do |attribute, _|
+                    "@#{attribute} = attrs[:#{attribute}]"
+                  end.join("\n            ")}
                 self
               end
 EOS
@@ -73,9 +87,9 @@ EOS
             class_eval <<EOS
                def update_all_attributes_from_json(attrs)
                  super if defined?(super)
-                 #{@types.map { |attribute, type|
-              "@#{attribute} = #{type}.deserialize_from_json(attrs['#{attribute}'])"
-            }.join("\n           ")}
+                 #{@types.map do |attribute, type|
+                     "@#{attribute} = #{type}.deserialize_from_json(attrs['#{attribute}'])"
+                   end.join("\n           ")}
                end
 EOS
           end
@@ -92,17 +106,33 @@ EOS
 
           def deserialize_from_json(args)
             unless args.nil?
-              obj = allocate()
+              obj = allocate
+
+              upcast!(args)
+
               obj.update_all_attributes_from_json(args)
               obj
             end
           end
 
-
           def numeric?(object)
-            true if Float(object) rescue false
+            true if Float(object)
+          rescue StandardError
+            false
+          end
+
+          def upcast(&block)
+            @upcasters ||= []
+            @upcasters.push(block)
           end
 
+          def upcast!(hash)
+            return if @upcasters.nil?
+
+            @upcasters.each do |upcaster|
+              upcaster.call(hash)
+            end
+          end
         end
 
         # extend host class with class methods when we're included
@@ -110,11 +140,10 @@ EOS
           host_class.extend(ClassMethods)
         end
 
-
         def attributes
           hash = HashWithIndifferentAccess.new
           self.class.types.each do |name, _|
-            value = self.instance_variable_get("@#{name}")
+            value = instance_variable_get("@#{name}")
             hash[name] = if value.respond_to?(:attributes)
                            value.attributes
                          else
@@ -127,7 +156,7 @@ EOS
         def as_json(opts = {})
           hash = HashWithIndifferentAccess.new
           self.class.types.each do |name, _|
-            value = self.instance_variable_get("@#{name}")
+            value = instance_variable_get("@#{name}")
             hash[name] = if value.respond_to?(:as_json)
                            value.as_json(opts)
                          else
@@ -144,15 +173,15 @@ EOS
         def validation_errors(prefix = nil)
           result = errors.to_hash
           self.class.types.each do |field|
-            value = self.instance_variable_get("@#{field[0]}")
+            value = instance_variable_get("@#{field[0]}")
             if value.respond_to? :validation_errors
-              value.validation_errors.each { |k, v| result["#{field[0].to_s}_#{k.to_s}".to_sym] = v }
-            elsif field[1].class == ArrayWithType and value.present?
+              value.validation_errors.each { |k, v| result["#{field[0]}_#{k}".to_sym] = v }
+            elsif field[1].instance_of?(ArrayWithType) && value.present?
               value
                 .select { |val| val.respond_to?(:validation_errors) }
                 .each_with_index do |val, index|
                 val.validation_errors.each do |k, v|
-                  result["#{field[0].to_s}_#{index}_#{k.to_s}".to_sym] = v
+                  result["#{field[0]}_#{index}_#{k}".to_sym] = v
                 end
               end
             end
@@ -164,7 +193,9 @@ EOS
           return unless Sequent.configuration.strict_check_attributes_on_apply_events
 
           unknowns = attrs.keys.map(&:to_s) - self.class.types.keys.map(&:to_s)
-          raise UnknownAttributeError.new("#{self.class.name} does not specify attrs: #{unknowns.join(", ")}") if unknowns.any?
+          if unknowns.any?
+            fail UnknownAttributeError, "#{self.class.name} does not specify attrs: #{unknowns.join(', ')}"
+          end
         end
       end
     end

data/lib/sequent/core/helpers/autoset_attributes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sequent
   module Core
     module Helpers
@@ -24,8 +26,7 @@ module Sequent
       #
       module AutosetAttributes
         module ClassMethods
-
-          @@autoset_ignore_attributes = %w{aggregate_id sequence_number created_at}
+          @@autoset_ignore_attributes = %w[aggregate_id sequence_number created_at]
 
           def set_autoset_ignore_attributes(attribute_names)
             @@autoset_ignore_attributes = attribute_names
@@ -39,7 +40,7 @@ module Sequent
             event_classes.each do |event_class|
               on event_class do |event|
                 self.class.event_attribute_keys(event_class).each do |attribute_name|
-                  instance_variable_set(:"@#{attribute_name.to_s}", event.send(attribute_name.to_sym))
+                  instance_variable_set(:"@#{attribute_name}", event.send(attribute_name.to_sym))
                 end
               end
             end
@@ -53,4 +54,3 @@ module Sequent
     end
   end
 end
-

data/lib/sequent/core/helpers/boolean_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model'
 require_relative 'value_validators'
 
@@ -18,7 +20,10 @@ module Sequent
       # They will be converted to `true`, `false` or `nil`
       class BooleanValidator < ActiveModel::EachValidator
         def validate_each(subject, attribute, value)
-          subject.errors.add attribute, :invalid_boolean unless Sequent::Core::Helpers::ValueValidators.for(Boolean).valid_value?(value)
+          unless Sequent::Core::Helpers::ValueValidators.for(Boolean).valid_value?(value)
+            subject.errors.add attribute,
+                               :invalid_boolean
+          end
         end
       end
     end

data/lib/sequent/core/helpers/copyable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sequent
   module Core
     module Helpers
@@ -17,9 +19,7 @@ module Sequent
           end
           the_copy
         end
-
       end
     end
   end
 end
-

data/lib/sequent/core/helpers/date_time_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model'
 
 module Sequent
@@ -10,8 +12,9 @@ module Sequent
       class DateTimeValidator < ActiveModel::EachValidator
         def validate_each(subject, attribute, value)
           return if value.is_a?(DateTime)
+
           DateTime.deserialize_from_json(value)
-        rescue
+        rescue StandardError
           subject.errors.add attribute, :invalid_date_time
         end
       end

data/lib/sequent/core/helpers/date_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model'
 require_relative 'value_validators'
 
@@ -10,7 +12,10 @@ module Sequent
       #   attrs value: Date
       class DateValidator < ActiveModel::EachValidator
         def validate_each(subject, attribute, value)
-          subject.errors.add attribute, :invalid_date unless Sequent::Core::Helpers::ValueValidators.for(Date).valid_value?(value)
+          unless Sequent::Core::Helpers::ValueValidators.for(Date).valid_value?(value)
+            subject.errors.add attribute,
+                               :invalid_date
+          end
         end
       end
     end

data/lib/sequent/core/helpers/default_validators.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'string_validator'
 require_relative 'boolean_validator'
 require_relative 'date_time_validator'
@@ -13,18 +15,18 @@ module Sequent
             klass.validates_numericality_of field, only_integer: true, allow_nil: true, allow_blank: true
           end,
           Date => ->(klass, field) do
-            klass.validates field, "sequent::Core::Helpers::Date" => true
+            klass.validates field, 'sequent::Core::Helpers::Date' => true
           end,
           DateTime => ->(klass, field) do
-            klass.validates field, "sequent::Core::Helpers::DateTime" => true
+            klass.validates field, 'sequent::Core::Helpers::DateTime' => true
           end,
-          Boolean => -> (klass, field) do
-            klass.validates field, "sequent::Core::Helpers::Boolean" => true
+          Boolean => ->(klass, field) do
+            klass.validates field, 'sequent::Core::Helpers::Boolean' => true
           end,
-          String => -> (klass, field) do
-            klass.validates field, "sequent::Core::Helpers::String" => true
+          String => ->(klass, field) do
+            klass.validates field, 'sequent::Core::Helpers::String' => true
           end,
-          Sequent::Core::Helpers::Secret => -> (klass, field) do
+          Sequent::Core::Helpers::Secret => ->(klass, field) do
             klass.after_validation do |object|
               if object.errors&.any?
                 object.send("#{field}=", nil)
@@ -33,8 +35,8 @@ module Sequent
                 object.send("#{field}=", Sequent::Secret.new(raw_value)) if raw_value
               end
             end
-          end
-        }
+          end,
+        }.freeze
 
         def self.for(type)
           new(type)
@@ -46,7 +48,7 @@ module Sequent
 
         def add_validations_for(klass, field)
           validator = VALIDATORS[@type]
-          validator.call(klass, field) if validator
+          validator&.call(klass, field)
         end
       end
     end

data/lib/sequent/core/helpers/equal_support.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sequent
   module Core
     module Helpers
@@ -8,16 +10,17 @@ module Sequent
       #
       module EqualSupport
         def ==(other)
-          return false if other == nil
+          return false if other.nil?
           return false if self.class != other.class
+
           self.class.types.each do |name, _|
-            self_value = self.send(name)
+            self_value = send(name)
             other_value = other.send(name)
             if self_value.class == DateTime && other_value.class == DateTime
               # we don't care about milliseconds. If you know a better way of checking for equality please improve.
-              return false unless (self_value.iso8601 == other_value.iso8601)
+              return false unless self_value.iso8601 == other_value.iso8601
             else
-              return false unless (self_value == other_value)
+              return false unless self_value == other_value
             end
           end
           true
@@ -26,7 +29,7 @@ module Sequent
         def hash
           hash = 17
           self.class.types.each do |name, _|
-            hash = hash * 31 + self.send(name).hash
+            hash = hash * 31 + send(name).hash
           end
           hash
         end
@@ -35,7 +38,6 @@ module Sequent
           self == other
         end
       end
-
     end
   end
 end

data/lib/sequent/core/helpers/helpers.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 Dir["#{File.dirname(__FILE__)}/*rb"].each { |f| require_relative f }

data/lib/sequent/core/helpers/mergable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sequent
   module Core
     module Helpers
@@ -6,16 +8,16 @@ module Sequent
       #   ben = Person.new(name: 'Ben').merge!(name: 'Ben Vonk')
       #
       module Mergable
-
         def merge!(attrs = {})
+          warn <<~EOS
+            [DEPRECATION] `merge!` is deprecated. Please use `copy` instead. This method will no longer be included in the next version of Sequent. You can still use it but you will have to include the module `Sequent::Core::Helpers::Mergable` yourself.
+          EOS
           attrs.each do |name, value|
-            self.send("#{name}=", value)
+            send("#{name}=", value)
           end
           self
         end
-
       end
     end
   end
 end
-

data/lib/sequent/core/helpers/message_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sequent
   module Core
     module Helpers
@@ -56,7 +58,7 @@ module Sequent
 
         def handle_message(message)
           handlers = self.class.message_mapping[message.class]
-          handlers.each { |handler| self.instance_exec(message, &handler) } if handlers
+          handlers&.each { |handler| instance_exec(message, &handler) }
         end
       end
     end

data/lib/sequent/core/helpers/param_support.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 
 module Sequent
@@ -21,7 +23,6 @@ module Sequent
           def from_form_data(params = {})
             from_params(params, false)
           end
-
         end
 
         # extend host class with class methods when we're included
@@ -35,7 +36,8 @@ module Sequent
             value = params[attribute]
 
             next if strict_nil_check && value.nil?
-            next if (!strict_nil_check && value.blank?)
+            next if !strict_nil_check && value.blank?
+
             if type.respond_to? :from_params
               value = type.from_params(value)
             elsif value.is_a?(Array)
@@ -58,10 +60,12 @@ module Sequent
         def as_params
           hash = HashWithIndifferentAccess.new
           self.class.types.each do |field|
-            value = self.instance_variable_get("@#{field[0]}")
-            next if field[0] == "errors"
-            hash[field[0]] = if value.kind_of?(Array)
+            value = instance_variable_get("@#{field[0]}")
+            next if field[0] == 'errors'
+
+            hash[field[0]] = if value.is_a?(Array)
                                next if value.blank?
+
                                value.map { |v| value_to_string(v) }
                              else
                                value_to_string(value)
@@ -86,16 +90,16 @@ module Sequent
 
         def make_params(key, enumerable, memo = {})
           case enumerable
-            when Array
-              enumerable.each_with_index do |object, index|
-                make_params("#{key}[#{index}]", object, memo)
-              end
-            when Hash
-              enumerable.each do |hash_key, object|
-                make_params("#{key}[#{hash_key}]", object, memo)
-              end
-            else
-              memo[key] = enumerable
+          when Array
+            enumerable.each_with_index do |object, index|
+              make_params("#{key}[#{index}]", object, memo)
+            end
+          when Hash
+            enumerable.each do |hash_key, object|
+              make_params("#{key}[#{hash_key}]", object, memo)
+            end
+          else
+            memo[key] = enumerable
           end
           memo
         end

data/lib/sequent/core/helpers/secret.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'bcrypt'
 
 module Sequent
   module Core
     module Helpers
-
       #
       # You can use this in Commands to handle for instance passwords
       # safely. It uses BCrypt to encrypt the Secret.
@@ -55,7 +56,6 @@ module Sequent
       # See +re_encrypt_secret+
       # See +verify_secret+
       class Secret
-
         class << self
           def deserialize_from_json(value)
             new(value)
@@ -65,7 +65,8 @@ module Sequent
           # Creates a hash for the given clear text password.
           #
           def encrypt_secret(clear_text_secret)
-            fail ArgumentError.new('clear_text_secret can not be blank') if clear_text_secret.blank?
+            fail ArgumentError, 'clear_text_secret can not be blank' if clear_text_secret.blank?
+
             BCrypt::Password.create(clear_text_secret)
           end
 
@@ -74,8 +75,8 @@ module Sequent
           # (essentially re-creating the secret hash).
           #
           def re_encrypt_secret(clear_text_secret, hashed_secret)
-            fail ArgumentError.new('clear_text_secret can not be blank') if clear_text_secret.blank?
-            fail ArgumentError.new('hashed_secret can not be blank') if hashed_secret.blank?
+            fail ArgumentError, 'clear_text_secret can not be blank' if clear_text_secret.blank?
+            fail ArgumentError, 'hashed_secret can not be blank' if hashed_secret.blank?
 
             BCrypt::Engine.hash_secret(clear_text_secret, hashed_secret)
           end
@@ -84,7 +85,7 @@ module Sequent
           # Verifies that the hashed and clear text secret are equal.
           #
           def verify_secret(hashed_secret, clear_text_secret)
-            return false if (hashed_secret.blank? || clear_text_secret.blank?)
+            return false if hashed_secret.blank? || clear_text_secret.blank?
 
             BCrypt::Password.new(hashed_secret) == clear_text_secret
           end
@@ -93,12 +94,13 @@ module Sequent
         attr_reader :value
 
         def initialize(value)
-          fail ArgumentError.new('value can not be blank') if value.blank?
-          if value.is_a?(Secret)
-            @value = value.value
-          else
-            @value = value
-          end
+          fail ArgumentError, 'value can not be blank' if value.blank?
+
+          @value = if value.is_a?(Secret)
+                     value.value
+                   else
+                     value
+                   end
         end
 
         def encrypt

data/lib/sequent/core/helpers/string_support.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sequent
   module Core
     module Helpers
@@ -9,14 +11,13 @@ module Sequent
       module StringSupport
         def to_s
           s = "#{self.class.name}: "
-          self.instance_variables.each do |name|
-            value = self.instance_variable_get("#{name}")
+          instance_variables.each do |name|
+            value = instance_variable_get(name.to_s)
             s += "#{name}=[#{value}], "
           end
-          "{" + s.chomp(", ") + "}"
+          '{' + s.chomp(', ') + '}'
         end
       end
-
     end
   end
 end

data/lib/sequent/core/helpers/string_to_value_parsers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../ext/ext'
 require_relative 'array_with_type'
 
@@ -16,10 +18,11 @@ module Sequent
           ::DateTime => ->(value) { parse_to_date_time(value) },
           ::Sequent::Core::Helpers::ArrayWithType => ->(values, type_in_array) { parse_array(values, type_in_array) },
           ::Sequent::Core::Helpers::Secret => ->(value) { Sequent::Core::Helpers::Secret.new(value).encrypt },
-        }
+        }.freeze
 
         def self.parse_to_integer(value)
           return value if value.is_a?(Integer)
+
           Integer(value, 10) unless value.blank?
         end
 
@@ -35,12 +38,13 @@ module Sequent
           if value.blank? && !(value.is_a?(TrueClass) || value.is_a?(FalseClass))
             nil
           else
-            (value.is_a?(TrueClass) || value == "true")
+            (value.is_a?(TrueClass) || value == 'true')
           end
         end
 
         def self.parse_to_date(value)
           return if value.blank?
+
           value.is_a?(Date) ? value : Date.iso8601(value.dup)
         end
 
@@ -50,6 +54,7 @@ module Sequent
 
         def self.parse_array(values, type_in_array)
           fail "invalid value for array(): \"#{values}\"" unless values.is_a?(Array)
+
           values.map do |item|
             if item.respond_to?(:parse_attrs_to_correct_types)
               item.parse_attrs_to_correct_types

data/lib/sequent/core/helpers/string_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model'
 require_relative 'value_validators'
 
@@ -16,7 +18,10 @@ module Sequent
       #
       class StringValidator < ActiveModel::EachValidator
         def validate_each(subject, attribute, value)
-          subject.errors.add attribute, :invalid_string unless Sequent::Core::Helpers::ValueValidators.for(String).valid_value?(value)
+          unless Sequent::Core::Helpers::ValueValidators.for(String).valid_value?(value)
+            subject.errors.add attribute,
+                               :invalid_string
+          end
         end
       end
     end