eventsimple 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acb33cb7729c0927eb994c24269a1c265cc323972ff29e146acc8e9c9593a718
-  data.tar.gz: b2dd04a605cb7f7df941bf71ede2ab6287ad2816d020ee3de5e4cba9c147561d
+  metadata.gz: 7ef0bd1c392a5de3db450d1ba8f29a933ec2fd885ff2c5cc170b0b9e661788ea
+  data.tar.gz: 0ccb0b0a628c852c4a79077a7659e179be9b16e3bef54b3b09d30f102892763e
 SHA512:
-  metadata.gz: f9f44bd3ef7ec08202f586442cacf900cd7cb2f4ebcad9566c202ae0b9c06e0f7dbf0cfd1626fc43c39cea6d4a8b681dcc601375be55011d4f5e63a37fc56485
-  data.tar.gz: 2ffd06cbeb50c9f79c879678ca94902bf0f6e63e1762fbd3f0c22afc6bb1e97e6fccc8cb6df6ca797d807d1dc5f9996a607fb8b5e95fbf5d67e1ea85770adbae
+  metadata.gz: cbb0c7fe1c90d56ea050ee03ccac8b29e2180842b43fdafe6c91e73d76fe5d92ba6caee5dd401260da63525bd67612f7d27c9c6896594c77cf1e1e98e78cc1c8
+  data.tar.gz: f874bffb16acb3a98c90d1b7f525614fb6611554c2931f3cb20009ef60ef4dd22750d007fba7cbe1d5d37b462a6bdd47e471f3f3b91afed1367fb72d0c31b57a

data/CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 2.0.1 - 2025-12-11
+### Changed
+- Switch back to using dry-struct for Message class, for better compatibility with existing code.
+- Fix Eventsimple type enforcement in Message class.
+- Fix wiki links in README.md
+
 ## 2.0.0 - 2025-12-07
 ### Changed
 - Remove dry-types dependency and replace with custom type system.

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    eventsimple (2.0.0)
+    eventsimple (2.0.1)
       concurrent-ruby (>= 1.2.3)
+      dry-struct (>= 1.8.0)
       dry-types (>= 1.7.0)
       pg (~> 1.4)
       rails (>= 7.0, < 9.0)
@@ -114,6 +115,11 @@ GEM
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.1)
       zeitwerk (~> 2.6)
+    dry-struct (1.8.0)
+      dry-core (~> 1.1)
+      dry-types (~> 1.8, >= 1.8.2)
+      ice_nine (~> 0.11)
+      zeitwerk (~> 2.6)
     dry-types (1.8.3)
       bigdecimal (~> 3.0)
       concurrent-ruby (~> 1.0)
@@ -160,6 +166,7 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
     io-console (0.8.1)
     irb (1.15.3)
       pp (>= 0.6.0)

data/README.md

@@ -54,14 +54,14 @@ end
 
 ## Quick Start
 
-- **[Home](Home)** - Installation, configuration, and getting started
-- **[Usage-Events](Usage-Events)** - How to create and use events
-- **[Usage-Reactors](Usage-Reactors)** - Handle side effects with sync and async reactors
-- **[Encryption](Encryption)** - Encrypt sensitive data in event messages
-- **[Outbox-Pattern](Outbox-Pattern)** - Implement ordered event processing
-- **[Best-Practices](Best-Practices)** - Development guidelines and best practices
-- **[Testing](Testing)** - Testing best practices for events and reactors
-- **[Helper-Methods](Helper-Methods)** - Convenience methods for common tasks
-- **[Data-Migrations](Data-Migrations)** - Migrating event data
-- **[Existing-Models](Existing-Models)** - Adding Eventsimple to existing models
-- **[Factory-Bot-Compatibility](Factory-Bot-Compatibility)** - Using Factory Bot with Eventsimple
+- **[Home](https://github.com/wealthsimple/eventsimple/wiki/Home)** - Installation, configuration, and getting started
+- **[Usage-Events](https://github.com/wealthsimple/eventsimple/wiki/Usage-Events)** - How to create and use events
+- **[Usage-Reactors](https://github.com/wealthsimple/eventsimple/wiki/Usage-Reactors)** - Handle side effects with sync and async reactors
+- **[Encryption](https://github.com/wealthsimple/eventsimple/wiki/Encryption)** - Encrypt sensitive data in event messages
+- **[Outbox-Pattern](https://github.com/wealthsimple/eventsimple/wiki/Outbox-Pattern)** - Implement ordered event processing
+- **[Best-Practices](https://github.com/wealthsimple/eventsimple/wiki/Best-Practices)** - Development guidelines and best practices
+- **[Testing](https://github.com/wealthsimple/eventsimple/wiki/Testing)** - Testing best practices for events and reactors
+- **[Helper-Methods](https://github.com/wealthsimple/eventsimple/wiki/Helper-Methods)** - Convenience methods for common tasks
+- **[Data-Migrations](https://github.com/wealthsimple/eventsimple/wiki/Data-Migrations)** - Migrating event data
+- **[Existing-Models](https://github.com/wealthsimple/eventsimple/wiki/Existing-Models)** - Adding Eventsimple to existing models
+- **[Factory-Bot-Compatibility](https://github.com/wealthsimple/eventsimple/wiki/Factory-Bot-Compatibility)** - Using Factory Bot with Eventsimple

data/eventsimple.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'concurrent-ruby', '>= 1.2.3'
+  spec.add_runtime_dependency 'dry-struct', '>= 1.8.0'
   spec.add_runtime_dependency 'dry-types', '>= 1.7.0'
   spec.add_runtime_dependency 'pg', '~> 1.4'
   spec.add_runtime_dependency 'rails', '>= 7.0', '< 9.0'

data/lib/eventsimple/message.rb

@@ -1,193 +1,66 @@
 # frozen_string_literal: true
 
+require 'dry-struct'
+
 module Eventsimple
-  class Message # rubocop:disable Metrics/ClassLength
-    class << self
-      def attribute(name, type)
-        validate_type(type)
-        optional = type.respond_to?(:optional?) ? type.optional? : false
-        define_attribute(name.to_sym, type, optional: optional, required: true)
+  class Message < Dry::Struct
+    transform_keys(&:to_sym)
+
+    # dry types will apply default values only on missing keys
+    # modify the behaviour so the default is used even when the key is present but nil
+    transform_types do |type|
+      if type.default?
+        type.constructor do |value|
+          value.nil? ? Dry::Types::Undefined : value
+        end
+      else
+        type
       end
+    end
 
-      def attribute?(name, type)
-        validate_type(type)
-        optional = type.respond_to?(:optional?) ? type.optional? : false
-        define_attribute(name.to_sym, type, optional: optional, required: false)
-      end
+    def inspect
+      as_json
+    end
 
-      def schema
-        @schema ||= if superclass.respond_to?(:schema)
-                      Schema.new(superclass.schema)
-                    else
-                      Schema.new
-                    end
-      end
+    def self.attribute(name, type = Dry::Types::Any, **options)
+      validate_type(type)
+      super
+    end
 
-      private
+    def self.attribute?(name, type = Dry::Types::Any, **options)
+      validate_type(type)
+      super
+    end
 
+    class << self
       def validate_type(type)
         return if valid_eventsimple_type?(type)
 
+        source_location = begin
+          source = const_source_location(name)&.first if respond_to?(:const_source_location) && name
+          source || caller_locations.find { |loc| !loc.path.include?('eventsimple') }&.path
+        rescue StandardError
+          'unknown'
+        end
+
+        message = [
+          "Only Eventsimple::Types are allowed in Message attributes. \n",
+          "File: #{source_location} \n",
+          "Received: #{type.inspect} \n",
+          "Use Eventsimple::Types::String, Eventsimple::Types::Integer, etc. \n",
+        ].join(' ')
+
         deprecator = ActiveSupport::Deprecation.new
         deprecator.behavior = Rails.application.config.active_support.deprecation
-
-        deprecator.warn(
-          "Only Eventsimple::Types are allowed in Message attributes. " \
-          "Received: #{type.inspect}. " \
-          "Use Eventsimple::Types::String, Eventsimple::Types::Integer, etc.",
-        )
+        deprecator.warn(message)
       end
 
       def valid_eventsimple_type?(type)
-        return true if Eventsimple::Types.constants(false).any? { |const_name|
-          next if const_name == :BuilderExtension
-
-          const = Eventsimple::Types.const_get(const_name, false)
-          const == type || const.equal?(type)
-        }
-
-        # For Default types, check the underlying type
-        if type.respond_to?(:default?) && type.default? && type.respond_to?(:type)
-          underlying_type = type.type
-          return valid_eventsimple_type?(underlying_type)
-        end
-
-        # For Sum types (optional), check the right side
-        if type.respond_to?(:right)
-          return valid_eventsimple_type?(type.right)
-        end
-
-        # For EncryptedType, check the wrapped type
-        if type.is_a?(Eventsimple::Types::EncryptedType)
-          return valid_eventsimple_type?(type.instance_variable_get(:@type))
-        end
-
-        # For Enum types, check the underlying type
-        if type.respond_to?(:type) && type.respond_to?(:values)
-          return valid_eventsimple_type?(type.type)
-        end
-
-        # Check if the type's primitive matches any base type's primitive
-        # This allows Enum, Constrained, and other derived types
-        if type.respond_to?(:primitive)
-          type_primitive = type.primitive
-          return true if Eventsimple::Types.constants(false).any? { |const_name|
-            next if const_name == :BuilderExtension
-
-            base_type = Eventsimple::Types.const_get(const_name, false)
-            base_type.respond_to?(:primitive) && base_type.primitive == type_primitive
-          }
-        end
+        return true if type.respond_to?(:meta) && type.meta[:eventsimple] == true
+        return true if type.is_a?(Class) && type < Eventsimple::Message
 
         false
       end
-
-      def define_attribute(name, type, optional:, required:)
-        schema.register(name, type, optional: optional, required: required)
-        define_method(name) { @attributes[name] }
-        define_method("#{name}=") do |value|
-          new_value = coerce(name, value, type)
-          @attributes[name] = new_value
-        end
-      end
-    end
-
-    class Schema
-      def initialize(parent_schema = nil)
-        @definitions = parent_schema ? parent_schema.definitions.dup : {}
-      end
-
-      def register(name, type, optional:, required:)
-        @definitions[name] = { type: type, optional: optional, required: required }
-      end
-
-      def keys
-        @definitions.map { |name, definition| AttributeKey.new(name, definition[:type]) }
-      end
-
-      def [](name) # rubocop:disable Rails/Delegate
-        @definitions[name]
-      end
-
-      attr_reader :definitions
-
-      class AttributeKey
-        attr_reader :name, :type
-
-        def initialize(name, type)
-          @name = name
-          @type = type
-        end
-      end
-    end
-
-    def initialize(attributes = {})
-      @attributes = {}
-      attributes = attributes.transform_keys(&:to_sym)
-
-      self.class.schema.keys.each do |key| # rubocop:disable Style/HashEachMethods
-        name = key.name
-        definition = self.class.schema[name]
-
-        if !definition[:required] && !attributes.key?(name)
-          next unless default?(definition[:type])
-
-          value = nil
-        else
-          value = attributes[name]
-        end
-
-        @attributes[name] = coerce(name, value, definition[:type])
-      end
-    end
-
-    def attributes
-      @attributes.dup
-    end
-
-    def to_h
-      attributes
-    end
-
-    def as_json(*)
-      attributes.transform_keys(&:to_s)
-    end
-
-    def inspect
-      "#<#{self.class.name} #{as_json}>"
-    end
-
-    def ==(other)
-      return false unless other.is_a?(self.class)
-
-      attributes == other.attributes
-    end
-
-    private
-
-    def coerce(name, value, type)
-      return get_default_value(type) if value.nil? && default?(type)
-      return nil if value.nil? && optional?(type)
-      raise ArgumentError, "Missing required attribute: #{name}" if value.nil?
-
-      type.call(value)
-    rescue StandardError => e
-      raise ArgumentError, "Invalid value for #{name}: #{e.message}"
-    end
-
-    def get_default_value(type)
-      return type.default_value if type.respond_to?(:default_value)
-
-      default_val = type.value
-      default_val.respond_to?(:call) ? default_val.call : default_val
-    end
-
-    def default?(type)
-      type.respond_to?(:default?) && type.default?
-    end
-
-    def optional?(type)
-      type.respond_to?(:optional?) && type.optional?
     end
   end
 end

data/lib/eventsimple/metadata.rb

@@ -3,7 +3,9 @@
 # Event metadata store information on the event, for example the user who triggered the event.
 module Eventsimple
   class Metadata < Eventsimple::Message
-    attribute :actor_id, Eventsimple::Types::String.optional
-    attribute :reason, Eventsimple::Types::String.optional
+    schema schema.strict
+
+    attribute? :actor_id, Eventsimple::Types::String.optional
+    attribute? :reason, Eventsimple::Types::String.optional
   end
 end

data/lib/eventsimple/types/encrypted_type.rb

@@ -16,6 +16,12 @@ module Eventsimple
         freeze
       end
 
+      def meta(data = nil)
+        return { eventsimple: true } if data.nil?
+
+        self.class.new(@type.meta(data))
+      end
+
       def encrypt(value)
         return value if value.blank?
 

data/lib/eventsimple/types.rb

@@ -8,25 +8,44 @@ module Eventsimple
   end
 
   module Types
-    Bool = DryTypes::Strict::Bool
-    Array = DryTypes::Strict::Array
-    Hash = DryTypes::Strict::Hash
-    Integer = DryTypes::Strict::Integer
-    String = DryTypes::Strict::String
-
-    Decimal = DryTypes::JSON::Decimal
-    Date = DryTypes::JSON::Date
-    DateTime = DryTypes::JSON::DateTime
-    Time = DryTypes::JSON::Time
-
-    module BuilderExtension
+    EVENTSIMPLE_META = { eventsimple: true }.freeze
+
+    # Extension that preserves eventsimple meta through all type transformations
+    module MetaPreservingBuilder
+      CHAINABLE_METHODS = %i[optional default enum constrained of].freeze
+
+      CHAINABLE_METHODS.each do |method_name|
+        define_method(method_name) do |*args, &block|
+          result = super(*args, &block)
+          # Re-apply eventsimple meta if the original type had it
+          if respond_to?(:meta) && meta[:eventsimple]
+            result.meta(EVENTSIMPLE_META)
+          else
+            result
+          end
+        end
+      end
+
       def encrypted
-        raise ArgumentError, "encrypted is only supported for String types" unless self == String
+        is_string_type = respond_to?(:primitive) && primitive == ::String
+        raise ArgumentError, "encrypted is only supported for String types" unless is_string_type
 
         EncryptedType.new(self)
       end
     end
 
-    Dry::Types::Builder.include(BuilderExtension)
+    # Include the meta-preserving builder in Dry::Types
+    Dry::Types::Builder.prepend(MetaPreservingBuilder)
+
+    Bool = DryTypes::Strict::Bool.meta(EVENTSIMPLE_META)
+    Array = DryTypes::Strict::Array.meta(EVENTSIMPLE_META)
+    Hash = DryTypes::Strict::Hash.meta(EVENTSIMPLE_META)
+    Integer = DryTypes::Strict::Integer.meta(EVENTSIMPLE_META)
+    String = DryTypes::Strict::String.meta(EVENTSIMPLE_META)
+
+    Decimal = DryTypes::JSON::Decimal.meta(EVENTSIMPLE_META)
+    Date = DryTypes::JSON::Date.meta(EVENTSIMPLE_META)
+    DateTime = DryTypes::JSON::DateTime.meta(EVENTSIMPLE_META)
+    Time = DryTypes::JSON::Time.meta(EVENTSIMPLE_META)
   end
 end

data/lib/eventsimple/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Eventsimple
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eventsimple
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Zulfiqar Ali
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.3
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement