domainic-attributer 0.1.0

data/sig/domainic/attributer/dsl/method_injector.rbs

@@ -0,0 +1,66 @@
+module Domainic
+  module Attributer
+    module DSL
+      # A class responsible for injecting attribute methods into classes.
+      #
+      # This class handles the creation of reader and writer methods for attributes,
+      # ensuring they are injected safely without overwriting existing methods. It
+      # respects visibility settings and properly handles value assignment through
+      # the attribute system.
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.1.0
+      class MethodInjector
+        @attribute: Attribute
+
+        @base: __todo__
+
+        # Inject methods for an attribute into a class.
+        #
+        # @param base [Class, Module] the class to inject methods into
+        # @param attribute [Attribute] the attribute to create methods for
+        #
+        # @return [void]
+        def self.inject!: (__todo__ base, Attribute attribute) -> void
+
+        # Initialize a new MethodInjector.
+        #
+        # @param base [Class, Module] the class to inject methods into
+        # @param attribute [Attribute] the attribute to create methods for
+        #
+        # @return [void]
+        def initialize: (__todo__ base, Attribute attribute) -> void
+
+        # Inject reader and writer methods.
+        #
+        # @return [void]
+        def inject!: () -> void
+
+        private
+
+        # Define a method if it doesn't already exist.
+        #
+        # @param method_name [Symbol] the name of the method to define
+        # @yield the method body to define
+        #
+        # @return [void]
+        def define_safe_method: (Symbol method_name) { (?) [self: untyped] -> void } -> void
+
+        # Inject the attribute reader method.
+        #
+        # Creates a reader method with the configured visibility.
+        #
+        # @return [void]
+        def inject_reader!: () -> void
+
+        # Inject the attribute writer method.
+        #
+        # Creates a writer method that processes values through the attribute
+        # system before assignment. Sets the configured visibility.
+        #
+        # @return [void]
+        def inject_writer!: () -> void
+      end
+    end
+  end
+end

data/sig/domainic/attributer/dsl.rbs

@@ -0,0 +1 @@
+

data/sig/domainic/attributer/instance_methods.rbs

@@ -0,0 +1,53 @@
+module Domainic
+  module Attributer
+    # A module providing instance-level attribute functionality.
+    #
+    # This module defines instance methods for objects that include Domainic::Attributer.
+    # It provides initialization handling and attribute serialization capabilities, making
+    # it easy to work with attribute values in a consistent way.
+    #
+    # @example Basic usage
+    #   class Person
+    #     include Domainic::Attributer
+    #
+    #     argument :name
+    #     option :age, default: nil
+    #     option :role, default: 'user', private_read: true
+    #   end
+    #
+    #   person = Person.new('Alice', age: 30)
+    #   person.to_h  # => { name: 'Alice', age: 30 }  # role is private, not included
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.1.0
+    module InstanceMethods
+      # Initialize a new instance with attribute values.
+      #
+      # Handles both positional arguments and keyword options, applying them to their
+      # corresponding attributes. This process includes:
+      # 1. Validating required arguments
+      # 2. Applying default values
+      # 3. Type validation and coercion
+      # 4. Change notifications
+      #
+      # @raise [ArgumentError] if required arguments are missing
+      # @return [void]
+      def initialize: (*untyped arguments, **untyped keyword_arguments) -> void
+
+      # Convert public attribute values to a hash.
+      #
+      # Creates a hash containing all public readable attributes and their current values.
+      # Any attributes marked as private or protected for reading are excluded from
+      # the result.
+      #
+      # @example Basic conversion
+      #   person = Person.new('Alice', age: 30)
+      #   person.to_h  # => { name: 'Alice', age: 30 }
+      #
+      # @return [Hash{Symbol => Object}] hash of attribute names to values
+      def to_hash: () -> Hash[Symbol, untyped]
+
+      alias to_h to_hash
+    end
+  end
+end

data/sig/domainic/attributer/undefined.rbs

@@ -0,0 +1,14 @@
+module Domainic
+  module Attributer
+    # A singleton object representing an undefined value.
+    #
+    # This object is used throughout Domainic::Attributer to represent values that
+    # are explicitly undefined, as opposed to nil which represents the absence of
+    # a value. It is immutable and implements custom string representations for
+    # debugging purposes.
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.1.0
+    Undefined: Object
+  end
+end

data/sig/domainic/attributer.rbs

@@ -0,0 +1,69 @@
+module Domainic
+  # Core functionality for defining and managing Ruby class attributes.
+  #
+  # This module provides a flexible attribute system for Ruby classes that supports
+  # positional arguments and keyword options with features like type validation,
+  # coercion, and visibility control.
+  #
+  # Can be included directly with default method names or customized via {Domainic.Attributer}.
+  #
+  # @example Basic usage with default method names
+  #   class Person
+  #     include Domainic::Attributer
+  #
+  #     argument :name
+  #     option :age
+  #   end
+  #
+  # @example Custom method names
+  #   class Person
+  #     include Domainic.Attributer(argument: :param, option: :opt)
+  #
+  #     param :name
+  #     opt :age
+  #   end
+  #
+  # @author {https://aaronmallen.me Aaron Allen}
+  # @since 0.1.0
+  module Attributer
+    # Create a customized Attributer module.
+    #
+    # @param argument [Symbol, String] custom name for the argument method
+    # @param option [Symbol, String] custom name for the option method
+    # @return [Module] configured Attributer module
+    def self.call: (?argument: (String | Symbol)?, ?option: (String | Symbol)?) -> Module
+
+    # Handle direct module inclusion.
+    #
+    # @param base [Class, Module] the including class/module
+    # @return [void]
+    def self.included: (untyped base) -> void
+
+    # Configure base class with Attributer functionality.
+    #
+    # @param base [Class, Module] the target class/module
+    # @param options [Hash] method name customization options
+    # @return [void]
+    private def self.include_attributer: (untyped base, ?argument: (String | Symbol)?, ?option: (String | Symbol)?) -> void
+
+    # Set up custom method names.
+    #
+    # @param base [Class, Module] the target class/module
+    # @param options [Hash] method name customization options
+    # @return [void]
+    private def self.inject_custom_methods!: (untyped base, ?argument: (String | Symbol)?, ?option: (String | Symbol)?) -> void
+  end
+
+  # Create a customized Attributer module.
+  #
+  # Provides a convenient way to include Attributer with customized method names.
+  #
+  # @example
+  #   class Person
+  #     include Domainic.Attributer(argument: :param, option: :opt)
+  #   end
+  #
+  # @param options [Hash] method name customization options
+  # @return [Module] configured Attributer module
+  def self.Attributer: (?argument: (String | Symbol)?, ?option: (String | Symbol)?) -> Module
+end

data/sig/domainic-attributer.rbs

@@ -0,0 +1 @@
+

data/sig/manifest.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - name: forwardable

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: domainic-attributer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Allen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-12 00:00:00.000000000 Z
+dependencies: []
+description: Your domain objects deserve better than plain old attributes. Level up
+  your DDD game with powerful, configurable, and well-documented class attributes
+  that actually know what they want in life!
+email:
+- hello@aaronmallen.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/domainic-attributer.rb
+- lib/domainic/attributer.rb
+- lib/domainic/attributer/attribute.rb
+- lib/domainic/attributer/attribute/callback.rb
+- lib/domainic/attributer/attribute/coercer.rb
+- lib/domainic/attributer/attribute/mixin/belongs_to_attribute.rb
+- lib/domainic/attributer/attribute/signature.rb
+- lib/domainic/attributer/attribute/validator.rb
+- lib/domainic/attributer/attribute_set.rb
+- lib/domainic/attributer/class_methods.rb
+- lib/domainic/attributer/dsl.rb
+- lib/domainic/attributer/dsl/attribute_builder.rb
+- lib/domainic/attributer/dsl/attribute_builder/option_parser.rb
+- lib/domainic/attributer/dsl/initializer.rb
+- lib/domainic/attributer/dsl/method_injector.rb
+- lib/domainic/attributer/instance_methods.rb
+- lib/domainic/attributer/undefined.rb
+- sig/domainic-attributer.rbs
+- sig/domainic/attributer.rbs
+- sig/domainic/attributer/attribute.rbs
+- sig/domainic/attributer/attribute/callback.rbs
+- sig/domainic/attributer/attribute/coercer.rbs
+- sig/domainic/attributer/attribute/mixin/belongs_to_attribute.rbs
+- sig/domainic/attributer/attribute/signature.rbs
+- sig/domainic/attributer/attribute/validator.rbs
+- sig/domainic/attributer/attribute_set.rbs
+- sig/domainic/attributer/class_methods.rbs
+- sig/domainic/attributer/dsl.rbs
+- sig/domainic/attributer/dsl/attribute_builder.rbs
+- sig/domainic/attributer/dsl/attribute_builder/option_parser.rbs
+- sig/domainic/attributer/dsl/initializer.rbs
+- sig/domainic/attributer/dsl/method_injector.rbs
+- sig/domainic/attributer/instance_methods.rbs
+- sig/domainic/attributer/undefined.rbs
+- sig/manifest.yaml
+homepage: https://github.com/domainic/domainic/tree/domainic-attributer-v0.1.0/domainic-attributer
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/domainic/domainic/issues
+  changelog_uri: https://github.com/domainic/domainic/releases/tag/domainic-attributer-v0.1.0
+  homepage_uri: https://github.com/domainic/domainic/tree/domainic-attributer-v0.1.0/domainic-attributer
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/domainic/domainic/tree/domainic-attributer-v0.1.0/domainic-attributer
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: A toolkit for creating self-documenting, type-safe class attributes with
+  built-in validation, coercion, and default values.
+test_files: []