subroutine 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 212d37192891dfad2e6fced663590d50f37302ee
-  data.tar.gz: 2ded356bfcfe49f9b697aba9784325fe2ce4426a
+  metadata.gz: 4f44648d17e8af9de061d865e831e95811de6ff4
+  data.tar.gz: b5347035ebf89c8e17a45b49333fb9b1a0812555
 SHA512:
-  metadata.gz: b4dc8ba20210de9eb5d2260f5cc98f95fe6a9c74e9a0ee625434a683a1773273efdc5461e2356238ca63bd7457c9554748f35fecad40a2153b665b81953ac5d1
-  data.tar.gz: cf30411572f31668031cc96ac76cb0ce4edb6132b22f9990a38023d32e312b53468179a31dea8604e25e54e0ac69189a7df13f338559c000d8980bb4aada2a2e
+  metadata.gz: 9e8cb47942615ef6cee08df82ff32c026a1824aac18e3e07dacc74e71bb23c30f9959493491d3cb358ec6e4daccbe155c0562b4fa0794efd85b29a9ffa39a5cd
+  data.tar.gz: aedf7e3533db2a99570634e97a74cc82bb95673ed9f256153b7844a94638ce49436717c7912b7a552dbe13985c603078977270ff3f527128379b28cc03be5680

data/README.md

@@ -213,6 +213,32 @@ class MyOp < ::Subroutine::Op
 end
 ```
 
+All **provided** params are accessible via the `params` accessor. All default values are accessible via the `defaults` accessor. The combination of the two is available via `params_with_defaults`.
+
+```ruby
+class MyOp < ::Subroutine::Op
+  string :name
+  string :status, default: "browsing"
+
+  def perform
+    puts params.inspect
+    puts defaults.inspect
+    puts params_with_defaults.inspect
+    true
+  end
+end
+
+MyOp.submit(name: "foobar", status: nil)
+# => { name: "foobar" }
+# => { status: "browsing" }
+# => { name: "foobar", status: nil }
+
+MyOp.submit(name: "foobar")
+# => { name: "foobar" }
+# => { status: "browsing" }
+# => { name: "foobar", status: "browsing" }
+```
+
 #### Execution
 
 Every op must implement a `perform` instance method. This is the method which will be executed if all validations pass.

data/lib/subroutine/op.rb

@@ -101,7 +101,7 @@ module Subroutine
           end
 
           def #{field_name}
-            @params["#{field_name}"]
+            @params.has_key?("#{field_name}") ? @params["#{field_name}"] : @defaults["#{field_name}"]
           end
 
           def #{field_name}_config
@@ -129,12 +129,13 @@ module Subroutine
     self._error_ignores = {}
 
     attr_reader :original_params
-    attr_reader :params
+    attr_reader :params, :defaults
 
 
     def initialize(inputs = {})
       @original_params  = inputs.with_indifferent_access
       @params = sanitize_params(@original_params)
+      @defaults = sanitize_defaults
     end
 
     def errors
@@ -164,6 +165,10 @@ module Subroutine
       end
     end
 
+    def params_with_defaults
+      @defaults.merge(@params)
+    end
+
     protected
 
     def type_caster
@@ -236,16 +241,27 @@ module Subroutine
       self._fields.each_pair do |field, config|
         if inputs.has_key?(field)
           out[field] = type_caster.cast(inputs[field], config[:type])
-        elsif config[:default]
+        end
+      end
+
+      out
+    end
+
+    def sanitize_defaults
+      defaults = {}.with_indifferent_access
+
+      self._fields.each_pair do |field, config|
+        if config[:default]
           deflt = config[:default]
           deflt = deflt.call if deflt.respond_to?(:call)
-          out[field] = type_caster.cast(deflt, config[:type])
+          defaults[field] = type_caster.cast(deflt, config[:type])
         end
       end
 
-      out
+      defaults
     end
 
+
   end
 
 end

data/lib/subroutine/version.rb

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

data/test/subroutine/base_test.rb

@@ -144,12 +144,38 @@ module Subroutine
       assert_equal [], op.errors[:whatever]
     end
 
-    def test_it_sets_the_params_immediately_and_includes_defaults
+    def test_it_sets_the_params_and_defaults_immediately
       op = ::AdminSignupOp.new(email: "foo")
       assert_equal({
-        "priveleges" => "min",
         "email" => "foo"
       }, op.params)
+
+      assert_equal({
+        "priveleges" => "min",
+      }, op.defaults)
+
+      assert_equal({
+        "email" => "foo",
+        "priveleges" => "min",
+      }, op.params_with_defaults)
+    end
+
+    def test_it_allows_defaults_to_be_overridden
+      op = ::AdminSignupOp.new(email: "foo", priveleges: nil)
+
+      assert_equal({
+        "email" => "foo",
+        "priveleges" => nil
+      }, op.params)
+
+      assert_equal({
+        "priveleges" => "min",
+      }, op.defaults)
+
+      assert_equal({
+        "email" => "foo",
+        "priveleges" => nil,
+      }, op.params_with_defaults)
     end
 
     def test_it_overrides_defaults_with_nils
@@ -162,10 +188,10 @@ module Subroutine
 
     def test_it_casts_params_on_the_way_in
       op = ::TypeCastOp.new(integer_input: "25")
-      assert_equal(25, op.params["integer_input"])
+      assert_equal(25, op.params_with_defaults["integer_input"])
 
       op.decimal_input = "25.3"
-      assert_equal(BigDecimal("25.3"), op.params["decimal_input"])
+      assert_equal(BigDecimal("25.3"), op.params_with_defaults["decimal_input"])
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: subroutine
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-19 00:00:00.000000000 Z
+date: 2016-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel