subroutine 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 395466c8997f2ba267ca8aeb4d2ab31cc4da5c84d1d5cc46c603191d32f52c35
-  data.tar.gz: dce7398c28cb192b05dc51823143cccc9200382d998e0afad835c2a3db8dffae
+  metadata.gz: 719502dade68ec34e525c97130a82e7ca6b3a5406002882a7916a93ad80d9099
+  data.tar.gz: 3eadd2bb114ef5d1724864b67462d0b563f241e21c3b61c92ea47366022aba9a
 SHA512:
-  metadata.gz: c61146f544f205efef0e653485a21d93a49843415bbf37ca3afc4c466e87e4a639cc142ca75b5c2f00d646b1453d59d881becbd852be984b96bf14a55b3b4fa5
-  data.tar.gz: 5ebf1feeb586fefc32707e7dd2c17b54f03eee51573be7d03aa048796cdd6acaec0b541756e84c2d00a62ba198ec07f2fda5d2c004c2e87a6674fd923c59c047
+  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/version.rb

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

data/subroutine.gemspec

@@ -14,11 +14,14 @@ Gem::Specification.new do |spec|
   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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: subroutine
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Mike Nelson
@@ -198,29 +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
-- gemfiles/rails_8.0.gemfile
-- gemfiles/rails_8.0.gemfile.lock
 - lib/subroutine.rb
 - lib/subroutine/association_fields.rb
 - lib/subroutine/association_fields/association_type_mismatch_error.rb
@@ -242,18 +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/guideline-tech/subroutine
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -268,25 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+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
-- gemfiles/rails_8.0.gemfile
-- gemfiles/rails_8.0.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.2, 3.3, 3.4]
-    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.3.7

data/Appraisals

@@ -1,26 +0,0 @@
-appraise "rails-6.1" do
-  gem 'activemodel', '~> 6.1.0'
-  gem 'actionpack', '~> 6.1.0'
-  gem 'concurrent-ruby', '1.3.4'
-end
-
-appraise "rails-7.0" do
-  gem 'activemodel', '~> 7.0.0'
-  gem 'actionpack', '~> 7.0.0'
-  gem 'concurrent-ruby', '1.3.4'
-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
-
-appraise "rails-8.0" do
-  gem 'activemodel', '~> 8.0.0'
-  gem 'actionpack', '~> 8.0.0'
-end

data/CHANGELOG.MD

@@ -1,189 +0,0 @@
-# Changelog
-
-## Subroutine 4.3.0
-
-Default repository to Ruby 3.3.7, and gem to a minimum version of 3.2.0.
-Tests continue to run against both Ruby 3.2 and Ruby 3.3.
-
-## 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"

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2015 Mike Nelson
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,88 +0,0 @@
-# Subroutine
-
-A gem that provides an interface for creating feature-driven operations. You've probably heard at least one of these terms: "service objects", "form objects", "intentions", or "commands". Subroutine calls these "ops" and really it's just about enabling clear, concise, testable, and meaningful code.
-
-## Example
-
-So you need to sign up a user? or maybe update one's account? or change a password? or maybe you need to sign up a business along with a user, associate them, send an email, and queue a worker in a single request? Not a problem, create an op for any of these use cases. Here's the signup example.
-
-```ruby
-class SignupOp < ::Subroutine::Op
-
-  string :name
-  string :email
-  string :password
-
-  string :company_name
-
-  validates :name, presence: true
-  validates :email, presence: true
-  validates :password, presence: true
-  validates :company_name, presence: true
-
-  outputs :user
-  outputs :business, type: Business # validate that output type is an instance of Business
-  outputs :heavy_operation, lazy: true # delay the execution of the output until accessed
-
-  protected
-
-  def perform
-    u = create_user!
-    b = create_business!(u)
-
-    deliver_welcome_email(u)
-
-    output :user, u
-    output :business, b
-    output :heavy_operation, -> { some_heavy_operation }
-  end
-
-  def create_user!
-    User.create!(name: name, email: email, password: password)
-  end
-
-  def create_business!(owner)
-    Business.create!(company_name: company_name, owner: owner)
-  end
-
-  def some_heavy_operation
-    # ...
-  end
-
-  def deliver_welcome_email(u)
-    UserMailer.welcome(u.id).deliver_later
-  end
-end
-```
-
-## So why use this?
-
-- Avoid cluttering models or controllers with logic only applicable to one intention. You also don't need strong parameters because the inputs to the Op are well-defined.
-- Test the Op in isolation
-- Clear and concise intention in a single file
-- Multi-model operations become simple
-
-## Continue Reading
-
-- [Implementing an Op](https://github.com/guideline-tech/subroutine/wiki/Implementing-an-Op)
-- [Using an Op](https://github.com/guideline-tech/subroutine/wiki/Using-an-Op)
-- [Errors](https://github.com/guideline-tech/subroutine/wiki/Errors)
-- [Basic Usage in Rails](https://github.com/guideline-tech/subroutine/wiki/Rails-Usage)
-
-## Development
-
-Run the test suite against current Rails version:
-
-```
-bundle exec rake test
-```
-
-Run the test suite against all supported Rails versions using `appraisal`:
-
-```
-bundle exec appraisal rake test
-```
-
-For help updating the `Gemfile` or changing supported Rails versions, see the `appraisal` gem [README](https://github.com/thoughtbot/appraisal#usage).
-
-Note that the gemfiles in `gemfiles/*` are auto-generated by `appraisal` and should not be modified directly.

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.pattern = "test/**/*_test.rb"
-end
-
-task :default => [:test]
-

data/gemfiles/rails_6.1.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal"
-gem "activemodel", "~> 6.1.0"
-gem "actionpack", "~> 6.1.0"
-gem "concurrent-ruby", "1.3.4"
-
-gemspec path: "../"