castkit 0.2.0 → 0.3.0

data/lib/generators/type.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "thor/group"
+require "castkit/inflector"
+require_relative "base"
+
+module Castkit
+  module Generators
+    # Generator for creating a new Castkit type.
+    #
+    # Types define custom deserialization, serialization, and validation behavior
+    # for attributes used in `Castkit::DataObject` or `Castkit::Contract`.
+    #
+    # Example usage:
+    #   $ castkit generate type Money
+    #
+    # Generates:
+    # - lib/castkit/types/money.rb
+    # - spec/castkit/types/money_spec.rb
+    #
+    # These files scaffold a `Castkit::Types::Money` class inheriting from `Castkit::Types::Base`,
+    # along with a basic RSpec test suite.
+    #
+    # @see Castkit::Generators::Base
+    class Type < Castkit::Generators::Base
+      component :type
+    end
+  end
+end

data/lib/generators/validator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "thor/group"
+require "castkit/inflector"
+require_relative "base"
+
+module Castkit
+  module Generators
+    # Generator for creating a new Castkit validator.
+    #
+    # Validators are responsible for asserting that a given value conforms to a rule.
+    # They are typically used inside a type’s `#validate!` method or within custom contract logic.
+    #
+    # Example usage:
+    #   $ castkit generate validator Money
+    #
+    # Generates:
+    # - lib/castkit/validators/money.rb
+    # - spec/castkit/validators/money_spec.rb
+    #
+    # These files scaffold a `Castkit::Validators::Money` class with a `#call` method
+    # and a corresponding RSpec test suite.
+    #
+    # @see Castkit::Generators::Base
+    class Validator < Castkit::Generators::Base
+      component :validator
+
+      private
+
+      # Provides extra context used within ERB templates for this generator.
+      #
+      # @return [Hash]
+      def config
+        super.merge(
+          default_value: "example",
+          sample_context: "field_name"
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: castkit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nathan Lucas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-16 00:00:00.000000000 Z
+date: 2025-04-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -73,10 +87,14 @@ files:
 - lib/castkit.rb
 - lib/castkit/attribute.rb
 - lib/castkit/castkit.rb
+- lib/castkit/cli.rb
+- lib/castkit/cli/generate.rb
+- lib/castkit/cli/list.rb
+- lib/castkit/cli/main.rb
 - lib/castkit/configuration.rb
 - lib/castkit/contract.rb
+- lib/castkit/contract/base.rb
 - lib/castkit/contract/data_object.rb
-- lib/castkit/contract/generic.rb
 - lib/castkit/contract/result.rb
 - lib/castkit/contract/validator.rb
 - lib/castkit/core/attribute_types.rb
@@ -84,7 +102,6 @@ files:
 - lib/castkit/core/config.rb
 - lib/castkit/core/registerable.rb
 - lib/castkit/data_object.rb
-- lib/castkit/default_serializer.rb
 - lib/castkit/error.rb
 - lib/castkit/ext/attribute/access.rb
 - lib/castkit/ext/attribute/error_handling.rb
@@ -92,23 +109,49 @@ files:
 - lib/castkit/ext/attribute/validation.rb
 - lib/castkit/ext/data_object/contract.rb
 - lib/castkit/ext/data_object/deserialization.rb
+- lib/castkit/ext/data_object/plugins.rb
 - lib/castkit/ext/data_object/serialization.rb
 - lib/castkit/inflector.rb
-- lib/castkit/serializer.rb
+- lib/castkit/plugins.rb
+- lib/castkit/serializers/base.rb
+- lib/castkit/serializers/default_serializer.rb
 - lib/castkit/types.rb
+- lib/castkit/types/base.rb
 - lib/castkit/types/boolean.rb
 - lib/castkit/types/collection.rb
 - lib/castkit/types/date.rb
 - lib/castkit/types/date_time.rb
 - lib/castkit/types/float.rb
-- lib/castkit/types/generic.rb
 - lib/castkit/types/integer.rb
 - lib/castkit/types/string.rb
 - lib/castkit/validator.rb
-- lib/castkit/validators/base_validator.rb
+- lib/castkit/validators/base.rb
+- lib/castkit/validators/boolean_validator.rb
+- lib/castkit/validators/collection_validator.rb
+- lib/castkit/validators/float_validator.rb
+- lib/castkit/validators/integer_validator.rb
 - lib/castkit/validators/numeric_validator.rb
 - lib/castkit/validators/string_validator.rb
 - lib/castkit/version.rb
+- lib/generators/base.rb
+- lib/generators/contract.rb
+- lib/generators/data_object.rb
+- lib/generators/plugin.rb
+- lib/generators/serializer.rb
+- lib/generators/templates/contract.rb.tt
+- lib/generators/templates/contract_spec.rb.tt
+- lib/generators/templates/data_object.rb.tt
+- lib/generators/templates/data_object_spec.rb.tt
+- lib/generators/templates/plugin.rb.tt
+- lib/generators/templates/plugin_spec.rb.tt
+- lib/generators/templates/serializer.rb.tt
+- lib/generators/templates/serializer_spec.rb.tt
+- lib/generators/templates/type.rb.tt
+- lib/generators/templates/type_spec.rb.tt
+- lib/generators/templates/validator.rb.tt
+- lib/generators/templates/validator_spec.rb.tt
+- lib/generators/type.rb
+- lib/generators/validator.rb
 - sig/castkit.rbs
 homepage: https://github.com/bnlucas/castkit
 licenses:

data/lib/castkit/default_serializer.rb

@@ -1,154 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "serializer"
-
-module Castkit
-  # Default serializer for Castkit::DataObject instances.
-  #
-  # Serializes attributes into a plain Ruby hash, applying access rules, nil/blank filtering,
-  # and nested structure handling. The output format supports JSON-compatible structures
-  # and respects the class-level serialization configuration.
-  class DefaultSerializer < Castkit::Serializer
-    # @return [Hash{Symbol => Castkit::Attribute}] the attributes to serialize
-    attr_reader :attributes
-
-    # @return [Hash{Symbol => Object}] unrecognized attributes captured during deserialization
-    attr_reader :unknown_attributes
-
-    # @return [Hash] serialization config flags like :root, :ignore_nil, :allow_unknown
-    attr_reader :options
-
-    # Serializes the object to a hash.
-    #
-    # Includes unknown attributes if configured, and wraps in a root key if defined.
-    #
-    # @return [Hash] the fully serialized result
-    def call
-      result = serialize_attributes
-      result.merge!(unknown_attributes) if options[:allow_unknown]
-
-      options[:root] ? { options[:root].to_sym => result } : result
-    end
-
-    private
-
-    # Initializes the serializer.
-    #
-    # @param obj [Castkit::DataObject] the object to serialize
-    # @param visited [Set, nil] tracks circular references
-    def initialize(obj, visited: nil)
-      super
-
-      @skip_flag = "__castkit_#{obj.object_id}"
-      @attributes = obj.class.attributes.freeze
-      @unknown_attributes = obj.unknown_attributes.freeze
-      @options = {
-        root: obj.class.root,
-        ignore_nil: obj.class.ignore_nil || false,
-        allow_unknown: obj.class.allow_unknown || false
-      }
-    end
-
-    # Serializes all defined attributes.
-    #
-    # @return [Hash] serialized attribute key-value pairs
-    def serialize_attributes
-      attributes.values.each_with_object({}) do |attribute, hash|
-        next if attribute.skip_serialization?
-
-        serialized_value = serialize_attribute(attribute)
-        next if serialized_value == @skip_flag
-
-        assign_attribute_key!(attribute, serialized_value, hash)
-      end
-    end
-
-    # Serializes a single attribute.
-    #
-    # @param attribute [Castkit::Attribute]
-    # @return [Object] the serialized value or skip flag
-    def serialize_attribute(attribute)
-      value = obj.public_send(attribute.field)
-      return @skip_flag if skip_nil?(attribute, value)
-
-      serialized_value = process_attribute(attribute, value)
-      return @skip_flag if skip_blank?(attribute, serialized_value)
-
-      serialized_value
-    end
-
-    # Delegates serialization based on type.
-    #
-    # @param attribute [Castkit::Attribute]
-    # @param value [Object]
-    # @return [Object]
-    def process_attribute(attribute, value)
-      if attribute.dataobject?
-        serialize_dataobject(attribute, value)
-      elsif attribute.dataobject_collection?
-        Array(value).map { |v| serialize_dataobject(attribute, v) }
-      else
-        type = Array(attribute.type).first
-        Castkit.type_serializer(type).call(value)
-      end
-    end
-
-    # Assigns value into nested hash structure based on key path.
-    #
-    # @param attribute [Castkit::Attribute]
-    # @param value [Object]
-    # @param hash [Hash]
-    # @return [void]
-    def assign_attribute_key!(attribute, value, hash)
-      key_path = attribute.key_path
-      last = key_path.pop
-      current = hash
-
-      key_path.each do |key|
-        current[key] ||= {}
-        current = current[key]
-      end
-
-      current[last] = value
-    end
-
-    # Whether to skip serialization for nil values.
-    #
-    # @param attribute [Castkit::Attribute]
-    # @param value [Object]
-    # @return [Boolean]
-    def skip_nil?(attribute, value)
-      value.nil? && (attribute.ignore_nil? || options[:ignore_nil])
-    end
-
-    # Whether to skip serialization for blank values.
-    #
-    # @param attribute [Castkit::Attribute]
-    # @param value [Object]
-    # @return [Boolean]
-    def skip_blank?(attribute, value)
-      blank?(value) && (attribute.ignore_blank? || options[:ignore_blank])
-    end
-
-    # True if value is nil or empty.
-    #
-    # @param value [Object]
-    # @return [Boolean]
-    def blank?(value)
-      value.nil? || (value.respond_to?(:empty?) && value.empty?)
-    end
-
-    # Serializes a DataObject using the proper serializer.
-    #
-    # @param attribute [Castkit::Attribute]
-    # @param value [Castkit::DataObject]
-    # @return [Object]
-    def serialize_dataobject(attribute, value)
-      serializer = attribute.options[:serializer]
-      serializer ||= value.class.serializer
-      serializer ||= Castkit::DefaultSerializer
-
-      serializer.call(value, visited: visited)
-    end
-  end
-end

data/lib/castkit/serializer.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-require "set"
-
-module Castkit
-  # Abstract base class for defining custom serializers for Castkit::DataObject instances.
-  #
-  # Handles circular reference detection and provides a consistent `call` API.
-  #
-  # Subclasses must implement an instance method `#call` that returns a hash-like representation.
-  #
-  # @example Usage
-  #   class CustomSerializer < Castkit::Serializer
-  #     private
-  #
-  #     def call
-  #       { type: obj.class.name, data: obj.to_h }
-  #     end
-  #   end
-  #
-  #   CustomSerializer.call(user_dto)
-  class Serializer
-    class << self
-      # Entrypoint for serializing an object.
-      #
-      # @param obj [Castkit::DataObject] the object to serialize
-      # @param visited [Set, nil] used to track visited object IDs
-      # @return [Object] result of custom serialization
-      def call(obj, visited: nil)
-        new(obj, visited: visited).send(:serialize)
-      end
-    end
-
-    # @return [Castkit::DataObject] the object being serialized
-    attr_reader :obj
-
-    protected
-
-    # Fallback to the default serializer.
-    #
-    # @return [Hash]
-    def serialize_with_default
-      Castkit::DefaultSerializer.call(obj, visited: visited)
-    end
-
-    private
-
-    # @return [Set<Integer>] a set of visited object IDs to detect circular references
-    attr_reader :visited
-
-    # Initializes the serializer instance.
-    #
-    # @param obj [Castkit::DataObject]
-    # @param visited [Set, nil]
-    def initialize(obj, visited: nil)
-      @obj = obj
-      @visited = visited || Set.new
-    end
-
-    # Subclasses must override this method to implement serialization logic.
-    #
-    # @raise [NotImplementedError]
-    # @return [Object]
-    def call
-      raise NotImplementedError, "#{self.class.name} must implement `#call`"
-    end
-
-    # Wraps the actual serialization logic with circular reference detection.
-    #
-    # @return [Object]
-    # @raise [Castkit::SerializationError] if a circular reference is detected
-    def serialize
-      check_circular_reference!
-      visited << obj.object_id
-
-      result = call
-      visited.delete(obj.object_id)
-
-      result
-    end
-
-    # Raises if the object has already been visited (circular reference).
-    #
-    # @raise [Castkit::SerializationError]
-    # @return [void]
-    def check_circular_reference!
-      return unless visited.include?(obj.object_id)
-
-      raise Castkit::SerializationError, "Circular reference detected for #{obj.class}"
-    end
-  end
-end

data/lib/castkit/validators/base_validator.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Castkit
-  module Validators
-    # Abstract base class for all attribute validators.
-    #
-    # Validators ensure that a value conforms to specific rules (e.g., type, format, range).
-    # Subclasses must implement the instance method `#call`.
-    #
-    # @abstract
-    class BaseValidator
-      class << self
-        # Invokes the validator with the given arguments.
-        #
-        # @param value [Object] the attribute value to validate
-        # @param options [Hash] the attribute options (e.g., `min`, `max`, `format`)
-        # @param context [Symbol, String, Hash] the attribute name or context for error reporting
-        # @return [void]
-        # @raise [Castkit::AttributeError] if validation fails
-        def call(value, options:, context:)
-          new.call(value, options: options, context: context)
-        end
-      end
-
-      # Validates the attribute value.
-      #
-      # @abstract Override in subclasses.
-      #
-      # @param value [Object] the attribute value to validate
-      # @param options [Hash] the attribute options
-      # @param context [Symbol, String, Hash] the attribute name or context
-      # @return [void]
-      # @raise [NotImplementedError] unless implemented in a subclass
-      def call(value, options:, context:)
-        raise NotImplementedError, "#{self.class.name} must implement `#call`"
-      end
-    end
-  end
-end