GASKIT-8: Alpha of v0.4.0, implementing Cattri backend

.github/workflows/main.yml

@@ -15,6 +15,9 @@ jobs:
       matrix:
         ruby:
           - '3.1.4'
+          - '3.2.9'
+          - '3.3.10'
+          - '3.4.7'
 
     steps:
     - uses: actions/checkout@v4

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+# v0.4.0
+
+- Refactored Castkit internals to build on Cattri registries for attributes, configuration, contracts, and attribute definitions
+- Added Cattri-powered introspection helpers, serialization toggle behavior and enhanced type/validator DSLs, plus coverage for the new plugin helpers
+
 ## [0.3.0] - 2025-04-16
 
 ### Added

README.md

@@ -60,14 +60,14 @@ Castkit comes with built-in support for primitive types and allows registration
 
 ```ruby
 {
-        array: Castkit::Types::Collection,
-        boolean: Castkit::Types::Boolean,
-        date: Castkit::Types::Date,
-        datetime: Castkit::Types::DateTime,
-        float: Castkit::Types::Float,
-        hash: Castkit::Types::Base,
-        integer: Castkit::Types::Integer,
-        string: Castkit::Types::String
+    array: Castkit::Types::Collection,
+    boolean: Castkit::Types::Boolean,
+    date: Castkit::Types::Date,
+    datetime: Castkit::Types::DateTime,
+    float: Castkit::Types::Float,
+    hash: Castkit::Types::Base,
+    integer: Castkit::Types::Integer,
+    string: Castkit::Types::String
 }
 ```
 

castkit.gemspec

@@ -33,12 +33,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Runtime dependencies
+  spec.add_dependency "cattri", ">=0.2.3"
   spec.add_dependency "thor"
 
   # Development dependencies
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "simplecov-cobertura"
+  spec.add_development_dependency "simplecov-html"
   spec.add_development_dependency "yard"
 end

lib/castkit/attribute.rb

@@ -23,6 +23,11 @@ module Castkit
   # @see Castkit::DSL::Attribute::Validation
   class Attribute
     include Castkit::DSL::Attribute
+    include Cattri
+
+    cattri :field, nil, expose: :read, final: true
+    cattri :type, nil, expose: :read, final: true
+    cattri :options, nil, expose: :read, final: true
 
     class << self
       # Defines a reusable attribute definition via a DSL wrapper.
@@ -71,26 +76,20 @@ def process_type(type)
       end
     end
 
-    # @return [Symbol] the attribute name
-    attr_reader :field
-
-    # @return [Symbol, Class, Array] the declared or normalized type
-    attr_reader :type
-
-    # @return [Hash] full option hash, including merged defaults
-    attr_reader :options
-
     # Initializes a new attribute definition.
     #
     # @param field [Symbol] the attribute name
     # @param type [Symbol, Class, Array<Symbol, Class>] the type (or list of types)
     # @param default [Object, Proc, nil] optional static or callable default
     # @param options [Hash] additional attribute options
     def initialize(field, type, default: nil, **options)
-      @field = field
-      @type = self.class.normalize_type(type)
+      super()
+
+      cattri_variable_set(:field, field, final: true)
+      cattri_variable_set(:type, self.class.normalize_type(type), final: true)
+
       @default = default
-      @options = populate_options(options)
+      cattri_variable_set(:options, populate_options(options), final: true)
 
       validate!
     end

lib/castkit/castkit.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "cattri"
 require_relative "core/attribute_types"
 
 # Castkit is a lightweight, type-safe data object system for Ruby.

lib/castkit/configuration.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
 require_relative "types"
+require "cattri"
 
 module Castkit
   # Configuration container for global Castkit settings.
   #
   # This includes type registration, validation, and enforcement flags
   # used throughout Castkit's attribute system.
   class Configuration
+    include Cattri
+
     # Default mapping of primitive type definitions.
     #
     # @return [Hash{Symbol => Castkit::Types::Base}]
@@ -36,56 +39,30 @@ class Configuration
       uuid: :string
     }.freeze
 
-    # @return [Hash{Symbol => Castkit::Types::Base}] registered types
-    attr_reader :types
-
-    # Set default plugins that will be used globally in all Castkit::DataObject subclasses.
-    # This is equivalent to calling `enable_plugins` in every class.
-    #
-    # @return [Array<Symbol>] default plugin names to be applied to all DataObject subclasses
-    attr_accessor :default_plugins
-
-    # Whether to raise an error if values should be validated before deserializing, e.g. true -> "true"
-    # @return [Boolean]
-    attr_accessor :enforce_typing
-
-    # Whether to raise an error if access mode is not recognized.
-    # @return [Boolean]
-    attr_accessor :enforce_attribute_access
-
-    # Whether to raise an error if a prefix is defined without `unwrapped: true`.
-    # @return [Boolean]
-    attr_accessor :enforce_unwrapped_prefix
-
-    # Whether to raise an error if an array attribute is missing the `of:` type.
-    # @return [Boolean]
-    attr_accessor :enforce_array_options
-
-    # Whether to raise an error for unknown and invalid type definitions.
-    # @return [Boolean]
-    attr_accessor :raise_type_errors
-
-    # Whether to emit warnings when Castkit detects misconfigurations.
-    # @return [Boolean]
-    attr_accessor :enable_warnings
-
-    # Whether the strict flag is enabled by default for all DataObjects and Contracts.
-    # @return [Boolean]
-    attr_accessor :strict_by_default
+    cattri :types, -> { DEFAULT_TYPES.dup }, expose: :read_write
+    cattri :default_plugins, [], expose: :read_write
+    cattri :enforce_typing, true, expose: :read_write
+    cattri :enforce_attribute_access, true, expose: :read_write
+    cattri :enforce_unwrapped_prefix, true, expose: :read_write
+    cattri :enforce_array_options, true, expose: :read_write
+    cattri :raise_type_errors, true, expose: :read_write
+    cattri :enable_warnings, true, expose: :read_write
+    cattri :strict_by_default, true, expose: :read_write
 
     # Initializes the configuration with default types and enforcement flags.
     #
     # @return [void]
     def initialize
-      @types = DEFAULT_TYPES.dup
-      @enforce_typing = true
-      @enforce_attribute_access = true
-      @enforce_unwrapped_prefix = true
-      @enforce_array_options = true
-      @raise_type_errors = true
-      @enable_warnings = true
-      @strict_by_default = true
-      @default_plugins = []
+      super
+      self.types = DEFAULT_TYPES.dup
+      self.enforce_typing = true
+      self.enforce_attribute_access = true
+      self.enforce_unwrapped_prefix = true
+      self.enforce_array_options = true
+      self.raise_type_errors = true
+      self.enable_warnings = true
+      self.strict_by_default = true
+      self.default_plugins = []
 
       apply_type_aliases!
     end
@@ -136,7 +113,7 @@ def register_plugin(name, plugin)
     # @return [Castkit::Types::Base]
     # @raise [Castkit::TypeError] if the type is not registered
     def fetch_type(type)
-      @types.fetch(type.to_sym) do
+      types.fetch(type.to_sym) do
         raise Castkit::TypeError, "Unknown type `#{type.inspect}`" if raise_type_errors
       end
     end
@@ -146,14 +123,14 @@ def fetch_type(type)
     # @param type [Symbol]
     # @return [Boolean]
     def type_registered?(type)
-      @types.key?(type.to_sym)
+      types.key?(type.to_sym)
     end
 
     # Restores the type registry to its default state.
     #
     # @return [void]
     def reset_types!
-      @types = DEFAULT_TYPES.dup
+      self.types = DEFAULT_TYPES.dup
       apply_type_aliases!
     end
 

lib/castkit/contract/base.rb

@@ -38,6 +38,8 @@ class Base
       ].freeze
 
       class << self
+        include Cattri
+
         # Defines an attribute for the contract.
         #
         # Only a subset of options is allowed inside a contract.
@@ -71,15 +73,9 @@ def validate!(input)
           Castkit::Contract::Result.new(definition[:name].to_s, input)
         end
 
-        # Returns internal contract metadata.
-        #
-        # @return [Hash]
-        def definition
-          @definition ||= {
-            name: :ephemeral,
-            attributes: {}
-          }
-        end
+        cattri :definition,
+               -> { { name: :ephemeral, attributes: {} } },
+               scope: :class, expose: :read_write
 
         # Returns the defined attributes.
         #
@@ -117,8 +113,8 @@ def define(name = :ephemeral, source = nil, validation_rules: {}, &block)
         def define_from_source(name, source)
           source_attributes = source.attributes.dup
 
-          @definition = {
-            name: name,
+          self.definition = {
+            name: name.to_sym,
             attributes: source_attributes.transform_values do |attr|
               Castkit::Attribute.new(attr.field, attr.type, **attr.options.slice(*ATTRIBUTE_OPTIONS))
             end
@@ -131,7 +127,8 @@ def define_from_source(name, source)
         # @yield [block]
         # @return [void]
         def define_from_block(name, &block)
-          definition[:name] = name
+          contract_name = name ? name.to_sym : :ephemeral
+          self.definition = { name: contract_name, attributes: {} }
 
           @__castkit_contract_dsl = true
           instance_eval(&block)

lib/castkit/contract/result.rb

@@ -7,24 +7,28 @@ module Contract
     # Provides access to the validation outcome, including whether it succeeded or failed,
     # and includes the full list of errors if any.
     class Result
+      include Cattri
+
       # @return [Symbol] the name of the contract
-      attr_reader :contract
+      cattri :contract, nil, expose: :read
 
       # @return [Hash{Symbol => Object}] the validated input
-      attr_reader :input
+      cattri :input, nil, expose: :read
 
       # @return [Hash{Symbol => Object}] the validation error hash
-      attr_reader :errors
+      cattri :errors, {}, expose: :read
 
       # Initializes a new result object.
       #
       # @param contract [Symbol, String] the name of the contract
       # @param input [Hash{Symbol => Object}] the validated input
       # @param errors [Hash{Symbol => Object}] the validation errors
       def initialize(contract, input, errors: {})
-        @contract = contract.to_sym.freeze
-        @input = input.freeze
-        @errors = errors.freeze
+        super()
+
+        cattri_variable_set(:contract, contract.to_sym.freeze)
+        cattri_variable_set(:input, input.freeze)
+        cattri_variable_set(:errors, errors.freeze)
       end
 
       # A debug-friendly representation of the validation result.

lib/castkit/core/attribute_types.rb

@@ -86,7 +86,9 @@ def array(field, **options)
       #
       # @param field [Symbol]
       # @param options [Hash]
-      def hash(field, **options)
+      def hash(field = nil, **options)
+        return super() if field.nil?
+
         attribute(field, :hash, **options)
       end