subroutine 4.2.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc5cab16c1cf40e71f51c8572e1a9ecfe7ec0ff7bdabf8ebcae795bd4c30a4f3
-  data.tar.gz: bee1cf68aba104515cfd2917837d2574a12a61949f2602346da1e7a4d0b029a2
+  metadata.gz: 719502dade68ec34e525c97130a82e7ca6b3a5406002882a7916a93ad80d9099
+  data.tar.gz: 3eadd2bb114ef5d1724864b67462d0b563f241e21c3b61c92ea47366022aba9a
 SHA512:
-  metadata.gz: fcb6f7393b6dfa6525cd344511321f4c3915696311230966ffdbb005128328b0e6d05ebf94b9088911c5d4abf17dd1988bd0d3deb013eaa81d517f1dfdd1c83b
-  data.tar.gz: 8ee46d11ded0b78432da1e86f7ebd05e30d9a54d55e53b3a336f074a294fc831444bef04381c0659a514c68f19bf6fef13dbd4ff46f321096d179360c10dcf95
+  metadata.gz: a57ccde1e224deab1dd2854091b5a1117b026b3feabb2d47626b7227a9905c370fdd95d3aadce201d0f1a84d7409ff225bff20fb9fba07b8444c7b77b069f30c
+  data.tar.gz: 750f373e085dfa7a91b78c49f187f9df728a7a03794bde4806d49ae8742c52dcc2f462ba9d4ef2db203e6df190d24dede8f124ef2811af5d5ca4085f7c475411

data/lib/subroutine/op.rb

@@ -135,7 +135,7 @@ module Subroutine
         end
 
         if field_config
-          errors.add(field_config.field_name, error.message)
+          errors.add(field_config.field_name, error.type, message: error.message)
         else
           errors.add(:base, error_object.full_message(field_name, error.message))
         end

data/lib/subroutine/outputs/configuration.rb

@@ -13,7 +13,10 @@ module Subroutine
         end
       end
 
-      DEFAULT_OPTIONS = { required: true }.freeze
+      DEFAULT_OPTIONS = {
+        required: true,
+        lazy: false
+      }.freeze
 
       attr_reader :output_name
 
@@ -28,6 +31,10 @@ module Subroutine
         !!config[:required]
       end
 
+      def lazy?
+        !!config[:lazy]
+      end
+
       def inspect
         "#<#{self.class}:#{object_id} name=#{output_name} config=#{config.inspect}>"
       end

data/lib/subroutine/outputs.rb

@@ -10,11 +10,27 @@ module Subroutine
 
     extend ActiveSupport::Concern
 
+    class LazyExecutor
+      def initialize(value)
+        @value_block = value
+        @executed = false
+      end
+
+      def value
+        return @value if @executed
+        @value = @value_block.respond_to?(:call) ? @value_block.call : @value
+        @executed = true
+        @value
+      end
+
+      def executed?
+        @executed
+      end
+    end
+
     included do
       class_attribute :output_configurations
       self.output_configurations = {}
-
-      attr_reader :outputs
     end
 
     module ClassMethods
@@ -39,20 +55,42 @@ module Subroutine
       @outputs = {} # don't do with_indifferent_access because it will turn provided objects into with_indifferent_access objects, which may not be the desired behavior
     end
 
+    def outputs
+      unless @outputs_executed
+        @outputs.each_pair do |key, value|
+          @outputs[key] = value.is_a?(LazyExecutor) ? value.value : value
+        end
+        @outputs_executed = true
+      end
+
+      @outputs
+    end
+
     def output(name, value)
       name = name.to_sym
       unless output_configurations.key?(name)
         raise ::Subroutine::Outputs::UnknownOutputError, name
       end
 
-      outputs[name] = value
+      @outputs[name] = output_configurations[name].lazy? ? LazyExecutor.new(value) : value
     end
 
     def get_output(name)
       name = name.to_sym
       raise ::Subroutine::Outputs::UnknownOutputError, name unless output_configurations.key?(name)
 
-      outputs[name]
+      output = @outputs[name]
+      unless output.is_a?(LazyExecutor)
+        output
+      else
+        # if its not executed, validate the type
+        unless output.executed?
+          @outputs[name] = output.value
+          ensure_output_type_valid!(name)
+        end
+
+        @outputs[name]
+      end
     end
 
     def validate_outputs!
@@ -60,21 +98,27 @@ module Subroutine
         if config.required? && !output_provided?(name)
           raise ::Subroutine::Outputs::OutputNotSetError, name
         end
-        unless valid_output_type?(name)
-          name = name.to_sym
-          raise ::Subroutine::Outputs::InvalidOutputTypeError.new(
-            name: name,
-            actual_type: outputs[name].class,
-            expected_type: output_configurations[name][:type]
-          )
+        unless output_configurations[name].lazy?
+          ensure_output_type_valid!(name)
         end
       end
     end
 
+    def ensure_output_type_valid!(name)
+      return if valid_output_type?(name)
+
+      name = name.to_sym
+      raise ::Subroutine::Outputs::InvalidOutputTypeError.new(
+        name: name,
+        actual_type: @outputs[name].class,
+        expected_type: output_configurations[name][:type]
+      )
+    end
+
     def output_provided?(name)
       name = name.to_sym
 
-      outputs.key?(name)
+      @outputs.key?(name)
     end
 
     def valid_output_type?(name)
@@ -84,9 +128,9 @@ module Subroutine
 
       output_configuration = output_configurations[name]
       return true unless output_configuration[:type]
-      return true if !output_configuration.required? && outputs[name].nil?
+      return true if !output_configuration.required? && @outputs[name].nil?
 
-      outputs[name].is_a?(output_configuration[:type])
+      @outputs[name].is_a?(output_configuration[:type])
     end
   end
 end

data/lib/subroutine/version.rb

@@ -3,7 +3,7 @@
 module Subroutine
 
   MAJOR = 4
-  MINOR = 2
+  MINOR = 5
   PATCH = 0
   PRE   = nil
 

data/subroutine.gemspec

@@ -11,16 +11,23 @@ Gem::Specification.new do |spec|
   spec.email         = ["mike@mnelson.io"]
   spec.summary       = "Feature-driven operation objects."
   spec.description   = "An interface for creating feature-driven operations."
-  spec.homepage      = "https://github.com/mnelson/subroutine"
+  spec.homepage      = "https://github.com/guideline-tech/subroutine"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir["lib/**/*"] + Dir["*.gemspec"]
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(gemfiles|test)/})
   spec.require_paths = ["lib"]
 
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
   spec.add_dependency "activemodel", ">= 6.1"
   spec.add_dependency "activesupport", ">= 6.1"
+  spec.add_dependency "base64"
+  spec.add_dependency "bigdecimal"
+  spec.add_dependency "logger"
+  spec.add_dependency "mutex_m"
 
   spec.add_development_dependency "actionpack", ">= 6.1"
   spec.add_development_dependency "byebug"
@@ -29,4 +36,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "mocha"
   spec.add_development_dependency "rake"
+
+  spec.required_ruby_version = ">= 3.2.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: subroutine
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Mike Nelson
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -38,6 +37,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: base64
+  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: bigdecimal
+  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: logger
+  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: mutex_m
+  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: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -143,27 +198,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".bundler-version"
-- ".github/CODEOWNERS"
-- ".github/dependabot.yml"
-- ".github/workflows/build.yml"
-- ".gitignore"
-- ".ruby-gemset"
-- ".ruby-version"
-- Appraisals
-- CHANGELOG.MD
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- gemfiles/rails_6.1.gemfile
-- gemfiles/rails_6.1.gemfile.lock
-- gemfiles/rails_7.0.gemfile
-- gemfiles/rails_7.0.gemfile.lock
-- gemfiles/rails_7.1.gemfile
-- gemfiles/rails_7.1.gemfile.lock
-- gemfiles/rails_7.2.gemfile
-- gemfiles/rails_7.2.gemfile.lock
 - lib/subroutine.rb
 - lib/subroutine/association_fields.rb
 - lib/subroutine/association_fields/association_type_mismatch_error.rb
@@ -185,19 +219,12 @@ files:
 - lib/subroutine/type_caster.rb
 - lib/subroutine/version.rb
 - subroutine.gemspec
-- test/subroutine/association_test.rb
-- test/subroutine/auth_test.rb
-- test/subroutine/base_test.rb
-- test/subroutine/fields_test.rb
-- test/subroutine/outputs_test.rb
-- test/subroutine/type_caster_test.rb
-- test/support/ops.rb
-- test/test_helper.rb
-homepage: https://github.com/mnelson/subroutine
+homepage: https://github.com/guideline-tech/subroutine
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -205,31 +232,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Feature-driven operation objects.
-test_files:
-- gemfiles/rails_6.1.gemfile
-- gemfiles/rails_6.1.gemfile.lock
-- gemfiles/rails_7.0.gemfile
-- gemfiles/rails_7.0.gemfile.lock
-- gemfiles/rails_7.1.gemfile
-- gemfiles/rails_7.1.gemfile.lock
-- gemfiles/rails_7.2.gemfile
-- gemfiles/rails_7.2.gemfile.lock
-- test/subroutine/association_test.rb
-- test/subroutine/auth_test.rb
-- test/subroutine/base_test.rb
-- test/subroutine/fields_test.rb
-- test/subroutine/outputs_test.rb
-- test/subroutine/type_caster_test.rb
-- test/support/ops.rb
-- test/test_helper.rb
+test_files: []

data/.bundler-version

@@ -1 +0,0 @@
-2.5.22

data/.github/CODEOWNERS

@@ -1 +0,0 @@
-.github/workflows     @guideline-tech/engineering

data/.github/dependabot.yml

@@ -1,24 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    open-pull-requests-limit: 20
-    schedule:
-      interval: "daily"
-      time: "09:00"
-      timezone: "America/New_York"
-    commit-message:
-      prefix: "[github-actions] "
-  - package-ecosystem: "bundler"
-    directory: "/"
-    schedule:
-      interval: "daily"
-      time: "08:30"
-      timezone: "America/New_York"
-    versioning-strategy: increase
-    open-pull-requests-limit: 20
-    insecure-external-code-execution: deny
-    allow:
-      - dependency-type: "all"
-    commit-message:
-      prefix: "[bundler] "

data/.github/workflows/build.yml

@@ -1,27 +0,0 @@
-name: build
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby-version: [3.0, 3.1, 3.2, 3.3]
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          show-progress: "false"
-      - name: get bundler version
-        run: echo "BUNDLER=$(cat .bundler-version)" >> $GITHUB_ENV
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-          bundler: ${{ env.BUNDLER }}
-          bundler-cache: true
-      - run: bundle install
-      - run: bundle exec appraisal install
-      - run: bundle exec appraisal rake test

data/.gitignore

@@ -1,16 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-*.gem
-.byebug_history

data/.ruby-gemset

@@ -1 +0,0 @@
-subroutine

data/.ruby-version

@@ -1 +0,0 @@
-3.2.6

data/Appraisals

@@ -1,19 +0,0 @@
-appraise "rails-6.1" do
-  gem 'activemodel', '~> 6.1.0'
-  gem 'actionpack', '~> 6.1.0'
-end
-
-appraise "rails-7.0" do
-  gem 'activemodel', '~> 7.0.0'
-  gem 'actionpack', '~> 7.0.0'
-end
-
-appraise "rails-7.1" do
-  gem 'activemodel', '~> 7.1.0'
-  gem 'actionpack', '~> 7.1.0'
-end
-
-appraise "rails-7.2" do
-  gem 'activemodel', '~> 7.2.0'
-  gem 'actionpack', '~> 7.2.0'
-end

data/CHANGELOG.MD

@@ -1,184 +0,0 @@
-# Changelog
-
-## Subroutine 4.2.0
-
-If you are using polymorphic association fields, you can now customize how Subroutine
-resolves those class names to a ruby class by setting a global callable/lambda/proc:
-
-```ruby
-::Subroutine.constantize_polymorphic_class_name = ->(class_name) do
-  class_name.classify.constantize
-end
-```
-
-## Subroutine 4.1.4
-
-Fields using the time/timestamp/datetime caster will now default back to the old behavior, and use a `precision:` option to opt-in to the new behavior introduced in `v4.1.1`.
-
-`precision: :seconds` will retain the old behavior of always parsing to a new Time object
-with floored sub-second precision, but applied more forcefully than before as it would have parsed whatever you passed to it. (This is the default, now.)
-
-`precision: :high` will now use the new functionality of re-using Time objects when they
-are passed in, or if not parsing exactly the provided string as to a Time object.
-
-## Subroutine 4.1.1
-
-Fields using the time/timestamp/datetime caster will now return exactly the passed in value
-if it acts like a time object (`acts_like?(:time)`/`acts_like_time?`), instead of serializing
-to string and re-parsing to a Time object. This fixes issues with losing usec precision.
-
-## Subroutine 4.1.0
-
-A field can now opt out of the natural assignment behavior of ActiveSupport::HashWithIndifferentAccess. Top level param groups are still accessible via indifferent access but if a field sets the `bypass_indifferent_assignment` option to `true` the HashWithIndifferentAccess assignment behavior will be bypassed in favor of direct Hash-like assignment.
-
-```ruby
-class MyOp < Subroutine::Op
-
-  object :some_hash
-  object :some_other_hash, bypass_indifferent_assignment: true
-
-end
-```
-
-## Subroutine 4.0.1
-
-Association fields can now use `find_by()` instead of `find_by!()` by passing a `raise_on_miss: false` option. This places the responsibility on the op to manage nil cases rather than handling RecordNotFound errors.
-
-## Subroutine 4.0
-
-The `Subroutine::Fields` module now contains a class_attribute that allows the altering of param accessor behaviors. `include_defaults_in_params` is now available to opt into including the default values in usage of the `all_params (alias params)` method. Backwards compatibility is preserved by defaulting the value to `false`. If switched to true, when an input is omitted and the field is configured with a default value, it will be included in the `all_params` object.
-
-Removed all usage of `ungrouped` params and refactored the storage of grouped params. Params are now stored in either the provided group or the defaults group and accessed via provided_params, params, default_params, and params_with_defaults. Grouped params are accessed the same way but with the group name prefixed eg. `my_private_default_params`.
-
-Polymorphic association fields now resolve class names via `klass.camelize.constantize`,
-previously was `klass.classify.constantize`.
-
-## Subroutine 3.0
-
-Add support for Rails 6.1. Drop support for Rails 6.0 and lower.
-
-## Subroutine 2.3
-
-Support dynamic types for foreign keys on association fields. The class type is used at runtime to determine the casting behavior of the foreign key field.
-
-## Subroutine 2.2
-
-Add `type` validation for Output.
-
-## Subroutine 2.0
-
-The updates between 1.0 and 2.0 are relatively minor and are focused more on cleaning up the codebase and extending the use of the 0.9->1.0 refactor. There are, however, breaking changes to how associations are loaded. The association is no longer loaded via `find()` but rather `find_by!(id:)`. Given this, a major version was released.
-
-**Note:** 2.0.0 was released with a bug and subsequently yanked. 2.0.1 is the first available 2.x version.
-
-## Subroutine 1.0
-
-A massive refactor took place between 0.9 and 1.0, including breaking changes. The goal was to reduce complexity, simplify backtraces, and increase the overall safety and reliability of the library.
-
-### Subroutine::Fields
-
-`Subroutine::Fields` was completely refactored to manage field declaration, configuration, and access in a more systematic and safer way.
-
-`Op._fields` was removed in favor of `Op.field_configurations`. `field_configurations` is a hash with keys of the field name and values of `FieldConfiguration` objects. FieldConfiguration objects are SimpleDelegates to the underlying option hashes. They answer questions and provide a mechanism for validating the configuration of a field.
-
-Fields can be accessed via helpers and accessors can be managed by the field declration. Helpers include `get_field`, `set_field`, and `clear_field`.
-
-```ruby
-class SomeOp < ::Subroutine::Op
-  string :foo, read_accessor: field_reader: false, field_writer: true
-
-  def perform
-    self.foo = "bar"
-    self.foo # NoMethodError
-    self.get_field(:foo) # => "bar"
-  end
-end
-```
-
-Fields can be omitted from mass assignment, meaning they would not be respected via constructor signatures.
-
-```ruby
-class SomeOp < ::Subroutine::Op
-  string :foo, mass_assignable: false
-  def perform
-    puts foo
-  end
-end
-
-SomeOp.submit!(foo: "Hello World!") # raises ::Subroutine::Fields::MassAssignmentError
-SomeOp.new{|op| op.foo = "Hello World!" }.submit! # prints "Hello World!"
-```
-
-This is especially useful when dealing with user input and potentially unsafe attributes.
-
-```ruby
-class UserUpdateOp < ::Op
-  association :user
-  string :first_name
-  string :last_name
-  integer :credit_balance_cents, mass_assignable: false
-
-  def perform
-    user.update(params)
-  end
-end
-
-# some_controller.rb
-def update
-  UserUpdateOp.submit!(params.merge(user: current_user))
-end
-```
-
-Field groups were added as well, allowing you to access subsets of the fields easily.
-
-```ruby
-class AccountUpdateOp < ::Op
-  association :account
-
-  with_options group: :user do
-    string :first_name
-    string :last_name
-    date :dob
-  end
-
-  with_options group: :business do
-    string :company_name
-    string :ein
-  end
-
-  def perform
-    account.user.update(user_params)
-    account.business.update(business_params)
-  end
-
-end
-```
-
-ActionController::Parameters from Rails 5+ are now transformed to a hash in `Subroutine::Fields` by default. This means strong parameters are essentially unused when passing `Subroutine::Fields`.
-
-Read more about field management and access in https://github.com/guideline-tech/subroutine/wiki/Param-Usage
-
-### Subroutine::Association
-
-The `Subroutine::Association` module has been moved to `Subroutine::AssociationFields`.
-
-Only native types are stored in params now. The objects loaded from associations are stored in an `association_cache`. This ensures access to fields are consistent regardless of the inputs.
-
-```ruby
-class SomeOp < ::Subroutine::Op
-  association :user
-  association :resource, polymorphic: true
-end
-
-user = User.find(4)
-
-op = SomeOp.new(user: user, resource: user)
-op.params #=> { user_id: 4, resource_type: "User", resource_id: 4 }
-op.params_with_association #=> { user: <User:103204 @id=4>, resource: <User:103204 @id=4> }
-
-op = SomeOp.new(user_id: user.id, resource_type: "User", resource_id: user.id)
-op.params #=> { user_id: 4, resource_type: "User", resource_id: 4 }
-op.params_with_association #=> { user: <User:290053 @id=4>, resource: <User:29042 @id=4> }
-```
-
-Assignment of associations now validates the type. If an association is not polymorphic, the type will be validated against the expected type.

data/Gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in subroutine.gemspec
-gemspec
-
-gem "appraisal"