verbalize 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28277ada3b560d5fd8ed11a9b568dd03f8c0156a
-  data.tar.gz: 9ff1315685ffa11c9a997a15a07206fe0e21f112
+  metadata.gz: 906d5dc6f28ab649fe2d08a666726e7b6718957f
+  data.tar.gz: 5689edea2dbfa8a0789eb07622420ff3753fe506
 SHA512:
-  metadata.gz: e4049ff78ca84f4e44f34c6525089edb96b74206ca6318f3b84c78779dd303863a612f0be86059e9e6bd1d8fce2f364a62e3d65b6269575ee13cd1dc7bbd44b9
-  data.tar.gz: a6528d2fa2ec1dc97d9524f6feb75426a249cc6a8bd2b656d7491d2bb5698512ec9718c836f16b33c0bc85d65aba5551a6d135170e2e1ebfb5fdf37c86770948
+  metadata.gz: 2e80ec6ed639bf4e17cd88ac5c03074d79a2f38250193ccb7586c711c4fde1a84851228a93e8550f3af53cb8d7eeec966fff4a04ace5b41af7f4265dc8b16035
+  data.tar.gz: f25395a64d6255547806f218cec5c6c2615b82245865394c1fd1cf4af19f5f9c40c74fb75451e2cbff667aa8fa8387f8ddc76d49b8bc5c99767a16fe4b1655b0

data/README.md

@@ -69,6 +69,33 @@ result = Divide.call(a: 1, b: 0) # => [:error, 'You can’t divide by 0']
 result.failed? # => true
 ```
 
+### Reflection
+```ruby
+class Add
+  include Verbalize::Action
+
+  input :a, :b, optional: [:c, :d]
+
+  def call
+    a + b + c + d
+  end
+
+  private
+
+  def c
+    @c ||= 0
+  end
+
+  def d
+    @d ||= 0
+  end
+end
+
+Add.required_inputs # [:a, :b]
+Add.optional_inputs # [:c, :d]
+Add.inputs # [:a, :b, :c, :d]
+```
+
 ## Comparison/Benchmark
 ```ruby
 require 'verbalize'
@@ -155,15 +182,15 @@ Comparison:
 ### Happy Path
 
 When testing positive cases of a `Verbalize::Action`, it is recommended to test using the `call!` class method and
-assert on the result.  This implicitly ensures a successful result, and your tests will fail with a bang! if 
+assert on the result.  This implicitly ensures a successful result, and your tests will fail with a bang! if
 something goes wrong:
 
 ```ruby
 class MyAction
   include Verbalize::Action
-  
+
   input :a
-  
+
   def call
     fail!('#{a} is greater than than 100!') if a >= 100
     a + 1
@@ -178,28 +205,28 @@ end
 
 ### Sad Path
 
-When testing negative cases of a `Verbalize::Action`, it is recommended to test using the `call` non-bang 
+When testing negative cases of a `Verbalize::Action`, it is recommended to test using the `call` non-bang
 class method which will return a `Verbalize::Failure` on failure.
 
-Use of `call!` here is not advised as it will result in an exception being thrown. Set assertions on both 
+Use of `call!` here is not advised as it will result in an exception being thrown. Set assertions on both
 the failure outcome and value:
 
 ```ruby
 class MyAction
   include Verbalize::Action
-  
+
   input :a
-  
+
   def call
     fail!('#{a} is greater than 100!') if a >= 100
     a + 1
   end
 end
-  
+
 # rspec:
 it 'fails when the input is out of bounds' do
   result = MyAction.call(a: 1000)
-  
+
   expect(result).to be_failed
   expect(result.failure).to eq '1000 is greater than 100!'
 end
@@ -208,11 +235,11 @@ end
 ### Stubbing Responses
 
 When unit testing, it may be necessary to stub the responses of Verbalize actions.  To correctly stub responses,
-you should __always__ stub the `MyAction.perform` class method on the action class being stubbed per the 
+you should __always__ stub the `MyAction.perform` class method on the action class being stubbed per the
 instructions below.  __Never__ stub the `call` or `call!` methods directly.
 
 Stubbing `.perform` will enable `Verbalize` to wrap results correctly for references to either `call` or `call!`.
- 
+
 #### Stubbing Successful Responses
 
 To simulate a successful response of the `Verbalize::Action` being stubbed, you should stub the `MyAction.perform`
@@ -225,7 +252,7 @@ class Foo
   def self.multiply_by(multiple)
     result = MyAction.call(a: 1)
     raise "I couldn't do the thing!" if result.failure?
-    
+
     result.value * multiple
   end
 end
@@ -238,9 +265,9 @@ describe Foo do
       allow(MyAction).to receive(:perform)
         .with(a: 1)
         .and_return(123)
-      
+
       result = described_class.multiply_by(100)
-      
+
       expect(result).to eq 12300
     end
   end
@@ -266,7 +293,7 @@ describe Foo do
       allow(MyAction).to receive(:perform)
         .with(a: 1)
         .and_throw(::Verbalize::THROWN_SYMBOL, 'Y U NO!')
-      
+
       expect {
         described_class.multiply_by(100)
       }.to raise_error "I couldn't do the thing!"
@@ -305,4 +332,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/taylor
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/verbalize/action.rb

@@ -17,9 +17,24 @@ module Verbalize
 
     module ClassMethods
       def input(*required_keywords, optional: [])
+        @required_inputs = required_keywords
+        @optional_inputs = optional
+
         class_eval Build.call(required_keywords, Array(optional))
       end
 
+      def required_inputs
+        @required_inputs || []
+      end
+
+      def optional_inputs
+        @optional_inputs || []
+      end
+
+      def inputs
+        required_inputs + optional_inputs
+      end
+
       # Because call/call! are defined when Action.input is called, they would
       # not be defined when there is no input. So we pre-define them here, and
       # if there is any input, they are overwritten
@@ -30,6 +45,7 @@ module Verbalize
       def call!
         __proxied_call!
       end
+      alias_method :!, :call!
 
       private
 

data/lib/verbalize/build.rb

@@ -10,13 +10,18 @@ module Verbalize
     end
 
     def call
+      # We have to re-alias `!` to `call!` here, otherwise it will be pointing
+      # to the original `call!` method
       <<-CODE
-def self.call(#{declaration_arguments_string})
-  __proxied_call(#{forwarding_arguments_string})
-end
+class << self
+  def call(#{declaration_arguments_string})
+    __proxied_call(#{forwarding_arguments_string})
+  end
 
-def self.call!(#{declaration_arguments_string})
-  __proxied_call!(#{forwarding_arguments_string})
+  def call!(#{declaration_arguments_string})
+    __proxied_call!(#{forwarding_arguments_string})
+  end
+  alias_method :!, :call!
 end
 
 def initialize(#{declaration_arguments_string})

data/lib/verbalize/version.rb

@@ -1,3 +1,3 @@
 module Verbalize
-  VERSION = '2.0.1'.freeze
+  VERSION = '2.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verbalize
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Zach Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-16 00:00:00.000000000 Z
+date: 2017-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler