interactor_support 1.0.1 → 1.0.3

data/lib/interactor_support.rb

@@ -12,15 +12,59 @@ require_relative 'interactor_support/configuration'
 
 Dir[File.join(__dir__, 'interactor_support/concerns/*.rb')].sort.each { |file| require file }
 
+##
+# InteractorSupport is a modular DSL for building expressive, validated, and
+# transactional service objects using the [Interactor](https://github.com/collectiveidea/interactor) gem.
+#
+# It enhances interactors with powerful helpers like:
+# - `Actions` for data loading, transformation, and persistence
+# - `Validations` for context-aware presence/type/inclusion checks
+# - `RequestObject` for clean, validated, form-like parameter objects
+#
+# It also provides configuration options to control request object behavior.
+#
+# @example Basic usage
+#   class CreateUser
+#     include Interactor
+#     include InteractorSupport
+#
+#     required :email, :name
+#
+#     transform :email, with: [:strip, :downcase]
+#
+#     find_by :account
+#
+#     update :user, attributes: { email: :email, name: :name }
+#   end
+#
+# @example Configuration
+#   InteractorSupport.configure do |config|
+#     config.request_object_behavior = :returns_self
+#     config.request_object_key_type = :symbol
+#   end
+#
+# @see InteractorSupport::Actions
+# @see InteractorSupport::Validations
+# @see InteractorSupport::RequestObject
+# @see InteractorSupport::Configuration
 module InteractorSupport
   extend ActiveSupport::Concern
 
   class << self
+    ##
+    # Allows external configuration of InteractorSupport.
+    #
+    # @yieldparam config [InteractorSupport::Configuration] the global configuration object
+    # @return [void]
     def configure
       self.configuration ||= Configuration.new
       yield(configuration) if block_given?
     end
 
+    ##
+    # Returns the global InteractorSupport configuration object.
+    #
+    # @return [InteractorSupport::Configuration]
     def configuration
       @configuration ||= Configuration.new
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: interactor_support
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Charlie Mitchell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-26 00:00:00.000000000 Z
+date: 2025-04-04 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -17,8 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".prettierignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt