subroutine 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25c11b61b2c6af19a7be888c2ba66284cb799cf72131e9f7a7893ccf188babd6
-  data.tar.gz: b22a8fec39573b99429fb27ad07340c1e0fa3133562a5190b8d6d088eeb9dbab
+  metadata.gz: a8871d701ab81402f275e38e7bf632c629bffc4320d31040119d99b12db05caf
+  data.tar.gz: edba79a803523a74e4e53d5e9cf62bf0dbdb2087592e7503b7b2d18395e5a8a6
 SHA512:
-  metadata.gz: 559745dc62dde51e43bde01b4b5fd2598a40edf6b02945abc2f7d71a0b948e5c76d259ac8239ba91fe8aadd4f23db4569feeaf01320287744b25dd9b168b4c29
-  data.tar.gz: b8bb15b169ddd8fe7a8e64bb4dcd8f6815b458fda0dc6f035310c2e2ea483a92196357f4893945f982ed661e1dd01ca4d51a43a9250e4b96fd5eeda1459ff22f
+  metadata.gz: 9953dd7a8ac11f4c842773c88a338e255c254bbf38f50a3437f204406a8136eca15544cd87aa9641395faf933ca9a00ddf9b3951a2a76326302e677988240143
+  data.tar.gz: 900b42b891947630463f3700a5df207d5e689a91dbe2e1970987f41b565fac7889083161d9d39bfd36082a7d0f4d1667d9b8bd549e7804371c58ad2987d238a0

data/CHANGELOG.MD

@@ -0,0 +1,111 @@
+## 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 as 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/README.md

@@ -12,7 +12,7 @@ class SignupOp < ::Subroutine::Op
   string :name
   string :email
   string :password
-  
+
   string :company_name
 
   validates :name, presence: true
@@ -28,7 +28,7 @@ class SignupOp < ::Subroutine::Op
   def perform
     u = create_user!
     b = create_business!(u)
-    
+
     deliver_welcome_email(u)
 
     output :user, u
@@ -38,7 +38,7 @@ class SignupOp < ::Subroutine::Op
   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
@@ -56,7 +56,9 @@ end
 - Clear and concise intention in a single file
 - Multi-model operations become simple
 
-[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)
+## 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)

data/lib/subroutine/association_fields.rb

@@ -100,8 +100,7 @@ module Subroutine
 
       excepts = []
       association_fields.each_pair do |_name, config|
-        excepts << config.foreign_key_method
-        excepts << config.foreign_type_method if config.polymorphic?
+        excepts |= config.related_field_names
       end
 
       out = params.except(*excepts)

data/lib/subroutine/association_fields/configuration.rb

@@ -19,6 +19,13 @@ module Subroutine
         super + [::Subroutine::AssociationFields]
       end
 
+      def related_field_names
+        out = super
+        out << foreign_key_method
+        out << foreign_type_method if polymorphic?
+        out
+      end
+
       def polymorphic?
         !!config[:polymorphic]
       end
@@ -40,11 +47,11 @@ module Subroutine
       end
 
       def foreign_key_method
-        foreign_key || "#{field_name}_id"
+        (foreign_key || "#{field_name}_id").to_sym
       end
 
       def foreign_type_method
-        foreign_key_method.gsub(/_id$/, "_type")
+        foreign_key_method.to_s.gsub(/_id$/, "_type").to_sym
       end
 
       def build_foreign_key_field

data/lib/subroutine/fields.rb

@@ -58,9 +58,12 @@ module Subroutine
         onlys = options.key?(:only) ? Array(options.delete(:only)) : nil
 
         things.each do |thing|
+          local_excepts = excepts.map { |field| thing.get_field_config(field)&.related_field_names }.flatten.compact.uniq if excepts
+          local_onlys = onlys.map { |field| thing.get_field_config(field)&.related_field_names }.flatten.compact.uniq if onlys
+
           thing.field_configurations.each_pair do |field_name, config|
-            next if excepts&.include?(field_name)
-            next if onlys && !onlys.include?(field_name)
+            next if local_excepts&.include?(field_name)
+            next if local_onlys && !local_onlys.include?(field_name)
 
             config.required_modules.each do |mod|
               include mod unless included_modules.include?(mod)

data/lib/subroutine/fields/configuration.rb

@@ -22,7 +22,7 @@ module Subroutine
       attr_reader :field_name
 
       def initialize(field_name, options)
-        @field_name = field_name
+        @field_name = field_name.to_sym
         config = sanitize_options(options)
         super(config)
         validate!
@@ -38,6 +38,10 @@ module Subroutine
         []
       end
 
+      def related_field_names
+        [field_name]
+      end
+
       def behavior
         nil
       end

data/lib/subroutine/version.rb

@@ -4,7 +4,7 @@ module Subroutine
 
   MAJOR = 1
   MINOR = 0
-  PATCH = 0
+  PATCH = 1
   PRE   = nil
 
   VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join(".")

data/test/subroutine/base_test.rb

@@ -42,6 +42,13 @@ module Subroutine
       assert_equal [:baz], op.field_configurations.keys.sort
     end
 
+    def test_fields_from_ignores_except_association_fields
+      op = ::ExceptAssociationOp.new
+      refute op.field_configurations.key?(:admin)
+      refute op.field_configurations.key?(:admin_id)
+      refute op.field_configurations.key?(:admin_type)
+    end
+
     def test_fields_from_only_fields
       op = ::OnlyFooBarOp.new
       assert op.field_configurations.key?(:foo)
@@ -49,6 +56,13 @@ module Subroutine
       refute_equal [:baz], op.field_configurations.keys.sort
     end
 
+    def test_fields_from_only_association_fields
+      op = ::OnlyAssociationOp.new
+      assert op.field_configurations.key?(:admin)
+      assert op.field_configurations.key?(:admin_type)
+      assert op.field_configurations.key?(:admin_id)
+    end
+
     def test_defaults_declaration_options
       op = ::DefaultsOp.new
       assert_equal "foo", op.foo

data/test/support/ops.rb

@@ -208,7 +208,7 @@ class CustomAuthorizeOp < OpWithAuth
   protected
 
   def authorize_user_is_correct
-    unauthorized! unless current_user.email_address.to_s =~ /example\.com$/
+    unauthorized! unless current_user.email_address.to_s =~ /example\.com$/ # rubocop:disable Performance/RegexpMatch
   end
 
 end
@@ -304,6 +304,18 @@ class AssociationWithClassOp < ::OpWithAssociation
 
 end
 
+class ExceptAssociationOp < ::Subroutine::Op
+
+  fields_from ::PolymorphicAssociationOp, except: %i[admin]
+
+end
+
+class OnlyAssociationOp < ::Subroutine::Op
+
+  fields_from ::PolymorphicAssociationOp, only: %i[admin]
+
+end
+
 class InheritedSimpleAssociation < ::Subroutine::Op
 
   fields_from SimpleAssociationOp

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: subroutine
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-19 00:00:00.000000000 Z
+date: 2020-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -161,6 +161,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.MD
 - Gemfile
 - LICENSE.txt
 - README.md