action_figure 0.1.0 → 0.6.0

data/sig/action_figure.rbs

@@ -1,4 +1,160 @@
+# Type definitions for the ActionFigure gem
+
+# Response hash returned by formatter methods
+type ActionFigure::response = { json: Hash[Symbol, untyped], status: Symbol } | { status: Symbol }
+
+# Error hash mapping field names to arrays of error messages
+type ActionFigure::error_hash = Hash[Symbol, Array[String]]
+
 module ActionFigure
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  class IndeterminantEntryPointError < StandardError
+  end
+
+  extend Configuration
+  extend FormatRegistry
+
+  def self.[]: (?Symbol format) -> Module
+  def self.included: (Module base) -> void
+  def self.register_formatter: (**Module formatters) -> void
+  def self.clear_format_module_cache: (Symbol name) -> void
+
+  # Provides global configuration via ActionFigure.configure
+  module Configuration
+    class Settings
+      attr_accessor format: Symbol
+      attr_accessor whiny_extra_params: bool
+      attr_accessor api_version: untyped
+      attr_accessor activesupport_notifications: bool
+
+      def initialize: () -> void
+      def configure: () { (Settings) -> void } -> void
+      def register: (**Module formatters) -> void
+    end
+
+    def configure: () { (Settings) -> void } -> void
+    def configuration: () -> Settings
+  end
+
+  # Provides formatter registration and lookup
+  module FormatRegistry
+    class Formats
+      def initialize: () -> void
+      def register_formatter: (**Module formatters) -> void
+      def fetch: (Symbol name) -> Module
+    end
+
+    def register_formatter: (**Module formatters) -> void
+    def fetch: (Symbol name) -> Module
+  end
+
+  # Base module for response formatters
+  module Formatter
+    REQUIRED_METHODS: Array[Symbol]
+
+    def NoContent: () -> ActionFigure::response
+  end
+
+  # Validation pipeline and DSL mixed into action classes
+  module Core
+    # Cross-parameter rule helpers for dry-validation contracts
+    module CrossParamRuleHelpers
+      def exclusive_rule: (*Symbol fields, String message) -> void
+      def any_rule: (*Symbol fields, String message) -> void
+      def one_rule: (*Symbol fields, String message) -> void
+      def all_rule: (*Symbol fields, String message) -> void
+    end
+
+    # Class-level DSL extended into action classes
+    module ClassMethods
+      def params_schema: () { () -> void } -> void
+      def rules: () { () -> void } -> void
+      def entry_point: (Symbol name) -> void
+      def entry_point_name: () -> Symbol?
+      def api_version: (?untyped value) -> untyped
+      def contract: () -> untyped
+    end
+
+    def entry_point_name: () -> Symbol
+    def contract: () -> untyped
+    def validated_call: (**untyped kwargs) -> ActionFigure::response
+
+    # ActiveSupport::Notifications instrumentation
+    module Notifications
+    end
+  end
+
+  module Formatters
+    # Rails-style responses with { data: } envelope
+    module Default
+      include ActionFigure::Formatter
+
+      def Ok: (resource: untyped, ?meta: untyped?) -> ActionFigure::response
+      def Created: (resource: untyped, ?meta: untyped?) -> ActionFigure::response
+      def Accepted: (?resource: untyped?, ?meta: untyped?) -> ActionFigure::response
+      def UnprocessableContent: (errors: ActionFigure::error_hash) -> ActionFigure::response
+      def NotFound: (errors: ActionFigure::error_hash) -> ActionFigure::response
+      def Forbidden: (errors: ActionFigure::error_hash) -> ActionFigure::response
+    end
+
+    # JSend-formatted responses
+    module Jsend
+      include ActionFigure::Formatter
+
+      def Ok: (resource: untyped, ?meta: untyped?) -> ActionFigure::response
+      def Created: (resource: untyped, ?meta: untyped?) -> ActionFigure::response
+      def Accepted: (?resource: untyped?, ?meta: untyped?) -> ActionFigure::response
+      def UnprocessableContent: (errors: ActionFigure::error_hash) -> ActionFigure::response
+      def NotFound: (errors: ActionFigure::error_hash) -> ActionFigure::response
+      def Forbidden: (errors: ActionFigure::error_hash) -> ActionFigure::response
+    end
+
+    # JSON:API-formatted responses
+    module JsonApi
+      include ActionFigure::Formatter
+
+      def Ok: (resource: untyped, ?meta: untyped?) -> ActionFigure::response
+      def Created: (resource: untyped, ?meta: untyped?) -> ActionFigure::response
+      def Accepted: (?resource: untyped?, ?meta: untyped?) -> ActionFigure::response
+      def UnprocessableContent: (errors: ActionFigure::error_hash) -> ActionFigure::response
+      def NotFound: (errors: ActionFigure::error_hash) -> ActionFigure::response
+      def Forbidden: (errors: ActionFigure::error_hash) -> ActionFigure::response
+
+      # Simple resource serialization for JSON:API
+      class Resource
+        def self.serialize: (untyped resource) -> untyped
+      end
+    end
+
+    # Uniform { data:, errors:, status: } envelope
+    module Wrapped
+      include ActionFigure::Formatter
+
+      def Ok: (resource: untyped, ?meta: untyped?) -> ActionFigure::response
+      def Created: (resource: untyped, ?meta: untyped?) -> ActionFigure::response
+      def Accepted: (?resource: untyped?, ?meta: untyped?) -> ActionFigure::response
+      def UnprocessableContent: (errors: ActionFigure::error_hash) -> ActionFigure::response
+      def NotFound: (errors: ActionFigure::error_hash) -> ActionFigure::response
+      def Forbidden: (errors: ActionFigure::error_hash) -> ActionFigure::response
+    end
+  end
+
+  module Testing
+    # Minitest assertions for action response results
+    module Minitest
+      def assert_Ok: (ActionFigure::response result, ?String? msg) -> void
+      def assert_Created: (ActionFigure::response result, ?String? msg) -> void
+      def assert_Accepted: (ActionFigure::response result, ?String? msg) -> void
+      def assert_NoContent: (ActionFigure::response result, ?String? msg) -> void
+      def assert_UnprocessableContent: (ActionFigure::response result, ?String? msg) -> void
+      def assert_NotFound: (ActionFigure::response result, ?String? msg) -> void
+      def assert_Forbidden: (ActionFigure::response result, ?String? msg) -> void
+    end
+
+    # RSpec custom matchers (be_Ok, be_Created, etc.)
+    module RSpec
+      MATCHERS: Hash[Symbol, Symbol]
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_figure
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Tad Thorley
@@ -23,8 +23,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
-description: Replaces general service objects with classes specifically for use in
-  Rails controller action methods
+description: Replaces service objects with explicit, purpose-driven classes for Rails
+  controller actions
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -32,7 +32,27 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/actions.md
+- docs/activesupport-notifications.md
+- docs/configuration.md
+- docs/custom-formatters.md
+- docs/integration-patterns.md
+- docs/response-formatters.md
+- docs/status-codes.md
+- docs/testing.md
+- docs/validation.md
 - lib/action_figure.rb
+- lib/action_figure/configuration.rb
+- lib/action_figure/core.rb
+- lib/action_figure/format_registry.rb
+- lib/action_figure/formatter.rb
+- lib/action_figure/formatters/default.rb
+- lib/action_figure/formatters/jsend.rb
+- lib/action_figure/formatters/json_api.rb
+- lib/action_figure/formatters/json_api/resource.rb
+- lib/action_figure/formatters/wrapped.rb
+- lib/action_figure/testing/minitest.rb
+- lib/action_figure/testing/rspec.rb
 - lib/action_figure/version.rb
 - sig/action_figure.rbs
 homepage: https://github.com/phaedryx/action_figure
@@ -41,6 +61,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/phaedryx/action_figure
   source_code_uri: https://github.com/phaedryx/action_figure
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -48,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -57,5 +78,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.8
 specification_version: 4
-summary: Explicit, purpose-driven operation classes for Rails controller actions
+summary: Fully-articulated controller actions
 test_files: []