subroutine 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adec63683815f30335f67edb81ae73e313cf7046
-  data.tar.gz: 07726344ba242224d384a4ad6c38af2f9985cddd
+  metadata.gz: 3acb651d981b9e158e41c5e36b9fcf2fc644fb51
+  data.tar.gz: ff3571355496f5202702a26ab935a1d7944c73a3
 SHA512:
-  metadata.gz: 7cfbdb1c872febd5ed53e2d6ef3466faf32fb20e02cfb4a8485c8c8e0f528ddfd3b10671063a22c173c6c81409337fd1e4f29fe218f5ae3e8797231108f207c5
-  data.tar.gz: 048c5ad5a14f44aba3f8bfedbdb02ed8617e7d6ffe92656b8a7f99140eda49d0216aac64f368da7182f9fd7a0ed515f6062a57af23ab6b9049a49d18a315bae2
+  metadata.gz: e651e0bbbcb6a355d6f07613becee56d67c08b7016b72660cda62608956a0b7db58006ed8ff45b58346ec827b02b8af2d1b2b6ad191d55ccb42c9935f24a4dff
+  data.tar.gz: 9fbb7f7d91c60a1c71ac4a965179efd9f45a665e93bc9c9bfb70da2ef0d07d06cdebeb2ef3526f968477c71c7eaa4515b20c097aa5bf66d8cdbd5141150a11f9

data/.travis.yml

@@ -2,7 +2,6 @@ language: ruby
 sudo: false
 
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.1
   - jruby
@@ -10,19 +9,4 @@ rvm:
 gemfile:
   - gemfiles/am40.gemfile
   - gemfiles/am41.gemfile
-  - gemfiles/am42.gemfile
-
-matrix:
-  exclude:
-    - rvm: 1.8.7
-      gemfile: gemfiles/am40.gemfile
-    - rvm: 1.8.7
-      gemfile: gemfiles/am41.gemfile
-    - rvm: 1.8.7
-      gemfile: gemfiles/am42.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/am40.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/am41.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/am42.gemfile
+  - gemfiles/am42.gemfile

data/README.md

@@ -1,6 +1,6 @@
 # Subroutine
 
-A gem that provides an interface for creating feature-driven operations. It utilizes the command pattern, enables the usage of "ops" as "form objects", and just all-around enables clear, concise, meaningful code.
+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", or maybe even "commands". Subroutine calls these "ops" and really it's just about enabling clear, concise, testable, and meaningful code.
 
 ## Examples
 
@@ -17,21 +17,18 @@ class SignupOp < ::Subroutine::Op
   validates :email, presence: true
   validates :password, presence: true
 
-  attr_reader :signed_up_user
+  outputs :signed_up_user
 
   protected
 
   def perform
-    u = build_user
-    u.save!
-
+    u = create_user!
     deliver_welcome_email!(u)
 
-    @signed_up_user = u
-    true
+    output :signed_up_user, u
   end
 
-  def build_user
+  def create_user
     User.new(params)
   end
 
@@ -106,7 +103,7 @@ class Api::Controller < ApplicationController
 end
 ```
 
-With ops, your controllers are essentially just connections between routes, operations, and templates.
+With ops, your controllers are essentially just connections between routes, operations, and whatever you use to build responses.
 
 ```ruby
 class UsersController < ::Api::Controller
@@ -201,14 +198,9 @@ class MyOp < ::Subroutine::Op
   end
 
   def validate_first_name_is_not_bob
-    return true unless field_provided?(:first_name)
-
-    if first_name.downcase == 'bob'
+    if field_provided?(:first_name) && first_name.downcase == 'bob'
       errors.add(:first_name, 'should not be bob')
-      return false
     end
-
-    true
   end
 end
 ```
@@ -224,7 +216,6 @@ class MyOp < ::Subroutine::Op
     puts params.inspect
     puts defaults.inspect
     puts params_with_defaults.inspect
-    true
   end
 end
 
@@ -241,20 +232,18 @@ MyOp.submit(name: "foobar")
 
 #### Execution
 
-Every op must implement a `perform` instance method. This is the method which will be executed if all validations pass.
-The return value of this op determines whether the operation was a success or not. Truthy values are assumed to be successful,
-while falsy values are assumed to be failures. In general, returning `true` at the end of the perform method is desired.
+Every op must implement a `perform` method. This is the method which will be executed if all validations pass.
+When the the `perform` method is complete, the Op determins success based on whether `errors` is empty.
 
 ```ruby
-class MyOp < ::Subroutine::Op
+class MyFailingOp < ::Subroutine::Op
   field :first_name
   validates :first_name, presence: true
 
   protected
 
   def perform
-    $logger.info "#{first_name} submitted this op"
-    true
+    errors.add(:base, "This will never succeed")
   end
 
 end
@@ -266,10 +255,10 @@ Notice we do not declare `perform` as a public method. This is to ensure the "pu
 
 Reporting errors is very important in Subroutine Ops since these can be used as form objects. Errors can be reported a couple different ways:
 
-1. `errors.add(:key, :error)` That is, the way you add errors to an ActiveModel object. Then either return false from your op OR raise an error like `raise ::Subroutine::Failure.new(this)`.
+1. `errors.add(:key, :error)` That is, the way you add errors to an ActiveModel object.
 2. `inherit_errors(error_object_or_activemodel_object)` Same as `errors.add`, but it iterates an existing error hash and inherits the errors. As part of this iteration,
-it checks whether the key in the provided error_object matches a field (or aka of a field) in our op. If there is a match, the error will be placed on
-that field, but if there is not, the error will be placed on `:base`. Again, after adding the errors to our op, we must return `false` from the perform method or raise a Subroutine::Failure.
+it checks whether the key in the provided error_object matches a field (or alias of a field) in our op. If there is a match, the error will be placed on
+that field, but if there is not, the error will be placed on `:base`.
 
 ```ruby
 class MyOp < ::Subroutine::Op
@@ -283,12 +272,12 @@ class MyOp < ::Subroutine::Op
 
     if first_name == 'bill'
       errors.add(:first_name, 'cannot be bill')
-      return false
+      return
     end
 
     if first_name == 'john'
       errors.add(:first_name, 'cannot be john')
-      raise Subroutine::Failure.new(this)
+      return
     end
 
     unless _user.valid?
@@ -296,10 +285,7 @@ class MyOp < ::Subroutine::Op
       # if there are :first_name or :firstname errors on _user, they will be added to our :first_name
       # if there are :last_name, :lastname, or :surname errors on _user, they will be added to our :last_name
       inherit_errors(_user)
-      return false
     end
-
-    true
   end
 
   def _user
@@ -317,7 +303,7 @@ The `Subroutine::Op` class' `submit` and `submit!` methods have identical signat
 
 ```ruby
 op = MyOp.submit({foo: 'bar'})
-# if the op succeeds it will be returned, otherwise it false will be returned.
+# if the op succeeds it will be returned, otherwise false will be returned.
 ```
 
 #### Via the class' `submit!` method
@@ -364,8 +350,6 @@ class UserUpdateOp < ::Subroutine::Op
       first_name: first_name,
       last_name: last_name
     )
-
-    true
   end
 end
 ```
@@ -380,8 +364,6 @@ class RecordTouchOp < ::Subroutine::Op
 
   def perform
     record.touch
-
-    true
   end
 end
 ```
@@ -402,8 +384,6 @@ class SayHiOp < ::Subroutine::Op
 
   def perform
     puts "#{current_user.name} says: #{say_what}"
-
-    true
   end
 end
 ```
@@ -435,7 +415,11 @@ class AccountSetSecretOp < ::Subroutine::Op
 
   require_user!
   authorize :authorize_first_name_is_john
-
+  
+  # If you use a policy-based authorization framework like pundit:
+  # `policy` is a shortcut for the following:
+  # authorize -> { unauthorized! unless policy.can_set_secret? }
+  
   policy :can_set_secret?
 
   string :secret
@@ -446,8 +430,6 @@ class AccountSetSecretOp < ::Subroutine::Op
   def perform
     account.secret = secret
     current_user.save!
-
-    true
   end
 
   def authorize_first_name_is_john
@@ -478,7 +460,7 @@ Subroutine::Factory.define :signup do
   inputs :password, "password123"
 
   # by default, the op will be returned when the factory is used.
-  # this `output` returns the value of the accessor on the resulting op
+  # this `output` returns the value of the `user` output on the resulting op
   output :user
 end
 

data/lib/subroutine/auth.rb

@@ -15,6 +15,12 @@ module Subroutine
 
     end
 
+    class AuthorizationNotDeclaredError < ::StandardError
+      def initialize(msg = nil)
+        super(msg || "Authorization management has not been declared on this class")
+      end
+    end
+
     def self.included(base)
       base.instance_eval do
         extend ::Subroutine::Auth::ClassMethods
@@ -67,7 +73,7 @@ module Subroutine
     end
 
     def initialize(*args)
-      raise "Authorization management has not been declared on this class" if(!self.class.authorization_declared)
+      raise Subroutine::Auth::AuthorizationNotDeclaredError.new if(!self.class.authorization_declared)
 
       super(args.extract_options!)
       @skip_auth_checks = false

data/lib/subroutine/op.rb

@@ -1,4 +1,6 @@
 require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/object/duplicable'
+require 'active_support/core_ext/object/deep_dup'
 require 'active_model'
 
 require "subroutine/failure"
@@ -307,7 +309,13 @@ module Subroutine
       self._fields.each_pair do |field, config|
         unless config[:default].nil?
           deflt = config[:default]
-          deflt = deflt.call if deflt.respond_to?(:call)
+          if deflt.respond_to?(:call)
+            deflt = deflt.call
+          elsif deflt.duplicable? # from active_support
+            # Some classes of default values need to be duplicated, or the instance field value will end up referencing
+            # the class global default value, and potentially modify it.
+            deflt = deflt.deep_dup # from active_support
+          end
           defaults[field] = type_caster.cast(deflt, config[:type])
         end
       end
@@ -315,7 +323,6 @@ module Subroutine
       defaults
     end
 
-
   end
 
 end

data/lib/subroutine/version.rb

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

data/test/subroutine/auth_test.rb

@@ -8,7 +8,7 @@ module Subroutine
     end
 
     def test_it_throws_an_error_if_authorization_is_not_defined
-      assert_raises "Authorization management has not been declared on this class" do
+      assert_raises ::Subroutine::Auth::AuthorizationNotDeclaredError do
         MissingAuthOp.new
       end
     end

data/test/subroutine/base_test.rb

@@ -10,7 +10,7 @@ module Subroutine
 
     def test_inherited_fields
       op = ::AdminSignupOp.new
-      assert_equal [:email, :password, :priveleges], op._fields.keys.sort
+      assert_equal [:email, :password, :privileges], op._fields.keys.sort
     end
 
     def test_class_attribute_usage
@@ -70,10 +70,10 @@ module Subroutine
 
       assert_nil op.email
       assert_nil op.password
-      assert_equal 'min', op.priveleges
+      assert_equal 'min', op.privileges
 
-      op.priveleges = 'max'
-      assert_equal 'max', op.priveleges
+      op.privileges = 'max'
+      assert_equal 'max', op.privileges
     end
 
     def test_validations_are_evaluated_before_perform_is_invoked
@@ -157,37 +157,58 @@ module Subroutine
       }, op.params)
 
       assert_equal({
-        "priveleges" => "min",
+        "privileges" => "min",
       }, op.defaults)
 
       assert_equal({
         "email" => "foo",
-        "priveleges" => "min",
+        "privileges" => "min",
       }, op.params_with_defaults)
     end
 
     def test_it_allows_defaults_to_be_overridden
-      op = ::AdminSignupOp.new(email: "foo", priveleges: nil)
+      op = ::AdminSignupOp.new(email: "foo", privileges: nil)
 
       assert_equal({
         "email" => "foo",
-        "priveleges" => nil
+        "privileges" => nil
       }, op.params)
 
       assert_equal({
-        "priveleges" => "min",
+        "privileges" => "min",
       }, op.defaults)
 
       assert_equal({
         "email" => "foo",
-        "priveleges" => nil,
+        "privileges" => nil,
       }, op.params_with_defaults)
     end
 
+    def test_it_overriding_default_does_not_alter_default
+      op = ::AdminSignupOp.new(email: "foo")
+      op.privileges << "bangbang"
+
+      op = ::AdminSignupOp.new(email: "foo", privileges: nil)
+
+      assert_equal({
+                     "email" => "foo",
+                     "privileges" => nil
+                   }, op.params)
+
+      assert_equal({
+                     "privileges" => "min",
+                   }, op.defaults)
+
+      assert_equal({
+                     "email" => "foo",
+                     "privileges" => nil,
+                   }, op.params_with_defaults)
+    end
+
     def test_it_overrides_defaults_with_nils
-      op = ::AdminSignupOp.new(email: "foo", priveleges: nil)
+      op = ::AdminSignupOp.new(email: "foo", privileges: nil)
       assert_equal({
-        "priveleges" => nil,
+        "privileges" => nil,
         "email" => "foo"
       }, op.params)
     end

data/test/subroutine/type_caster_test.rb

@@ -9,7 +9,7 @@ module Subroutine
 
     def test_integer_inputs
       op.integer_input = nil
-      assert_equal nil, op.integer_input
+      assert_nil op.integer_input
 
       op.integer_input = 'foo'
       assert_equal 0, op.integer_input
@@ -29,7 +29,7 @@ module Subroutine
 
     def test_number_inputs
       op.number_input = nil
-      assert_equal nil, op.number_input
+      assert_nil op.number_input
 
       op.number_input = 4
       assert_equal 4.0, op.number_input
@@ -43,7 +43,7 @@ module Subroutine
 
     def test_string_inputs
       op.string_input = nil
-      assert_equal nil, op.string_input
+      assert_nil op.string_input
 
       op.string_input = ""
       assert_equal '', op.string_input
@@ -60,7 +60,7 @@ module Subroutine
 
     def test_boolean_inputs
       op.boolean_input = nil
-      assert_equal nil, op.boolean_input
+      assert_nil op.boolean_input
 
       op.boolean_input = 'yes'
       assert_equal true, op.boolean_input
@@ -101,7 +101,7 @@ module Subroutine
 
     def test_hash_inputs
       op.object_input = nil
-      assert_equal nil, op.object_input
+      assert_nil op.object_input
 
       op.object_input = ''
       assert_equal({}, op.object_input)
@@ -121,7 +121,7 @@ module Subroutine
 
     def test_array_inputs
       op.array_input = nil
-      assert_equal nil, op.array_input
+      assert_nil op.array_input
 
       op.array_input = ''
       assert_equal [], op.array_input
@@ -138,7 +138,7 @@ module Subroutine
 
     def test_date_inputs
       op.date_input = nil
-      assert_equal nil, op.date_input
+      assert_nil op.date_input
 
       op.date_input = "2022-12-22"
       assert_equal ::Date, op.date_input.class
@@ -172,7 +172,7 @@ module Subroutine
 
     def test_time_inputs
       op.time_input = nil
-      assert_equal nil, op.time_input
+      assert_nil op.time_input
 
       op.time_input = "2022-12-22"
       assert_equal ::Time, op.time_input.class
@@ -199,7 +199,7 @@ module Subroutine
 
     def test_iso_date_inputs
       op.iso_date_input = nil
-      assert_equal nil, op.iso_date_input
+      assert_nil op.iso_date_input
 
       op.iso_date_input = "2022-12-22"
       assert_equal ::String, op.iso_date_input.class
@@ -212,7 +212,7 @@ module Subroutine
 
     def test_iso_time_inputs
       op.iso_time_input = nil
-      assert_equal nil, op.iso_time_input
+      assert_nil op.iso_time_input
 
       op.iso_time_input = "2022-12-22T10:30:24Z"
       assert_equal ::String, op.iso_time_input.class

data/test/support/ops.rb

@@ -67,7 +67,7 @@ end
 
 class AdminSignupOp < ::SignupOp
 
-  field :priveleges, :default => 'min'
+  field :privileges, :default => 'min'
 
   protected
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: subroutine
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-20 00:00:00.000000000 Z
+date: 2017-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel