actionizer 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6623871ec5ccf598b08a3b75723eb62ea51228b
-  data.tar.gz: ebfa581c615814d6091f9774774457809f4b6690
+  metadata.gz: a63a9ba128ed80a4d5090ddb1934f44a5281387f
+  data.tar.gz: b8d54516906e1766cefebc20e31c4831f9b95dd0
 SHA512:
-  metadata.gz: 9e68faae5f420695bc7b15f3adb04d9cf17d9e6ad0496457e6b88befff41eb23c4158c28892e906350519110591ab64f31197678882ff5476cacc9bcd7fc943a
-  data.tar.gz: 42c6e70e2f872ada9122833a433fffba6b2e098504e15582da91e0de97d251e231d7e9a099649e3c5cdf1d581ec0df4627d439dff80604e96c029b162a9957a0
+  metadata.gz: 4aa44e386f9957c7f52177084fb9e60d0ba3b0fe572f5eef09f30be13e62732059489f8e4927319e0554d27ea2b4c4538bc618f5e0df0e26315dff1dcdeb2432
+  data.tar.gz: ea3037ed552d5d9ae3b5aeb3ce37cef181c9a9cc612b18386e3abf3d2790ece33a3eb31c449c322d61c1c401107e49ba346525341e4a7e13b33c94e2a754a3bf

data/.rubocop.yml

@@ -1,5 +1,5 @@
 Metrics/AbcSize:
-  Max: 20
+  Max: 25
 Metrics/LineLength:
   Max: 120
 Metrics/MethodLength:
@@ -11,7 +11,11 @@ Style/EmptyLinesAroundBlockBody:
   Enabled: false
 Style/EmptyLinesAroundClassBody:
   Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
 Style/MutableConstant:
   Enabled: false
+Style/NegatedIf:
+  Enabled: false
 Style/TrivialAccessors:
   Enabled: false

data/lib/actionizer.rb

@@ -2,6 +2,7 @@ require 'ostruct'
 require 'actionizer/result'
 require 'actionizer/failure'
 require 'actionizer/version'
+require 'actionizer/inputs'
 
 module Actionizer
   attr_reader :input, :output
@@ -15,6 +16,9 @@ module Actionizer
       instance = new(*args)
 
       if instance.respond_to?(method_name)
+        error = defined_inputs.check_for_param_error(method_name, *args)
+        raise ArgumentError, error if error
+
         instance.tap(&method_name).output
       else
         super
@@ -26,6 +30,32 @@ module Actionizer
     def respond_to_missing?(method_name, include_private = false)
       new.respond_to?(method_name, include_private)
     end
+
+    def defined_inputs
+      @defined_inputs ||= Actionizer::Inputs.new
+    end
+
+    def inputs_for(method)
+      raise ArgumentError, 'inputs_for requires a block' if !block_given?
+
+      defined_inputs.start(method)
+      yield
+      defined_inputs.end
+
+      raise 'You must define at least one optional or required param' if defined_inputs.no_params_declared?(method)
+    end
+
+    def optional(param)
+      raise 'You must call optional from inside an inputs_for block' if defined_inputs.outside_inputs_for_block?
+
+      defined_inputs.add(param: param, required: false)
+    end
+
+    def required(param)
+      raise 'You must call required from inside an inputs_for block' if defined_inputs.outside_inputs_for_block?
+
+      defined_inputs.add(param: param, required: true)
+    end
   end
 
   def initialize(initial_input = {})
@@ -43,23 +73,20 @@ module Actionizer
 
   # Allows you to call *_or_fail
   def method_missing(method_name, *args, &block)
-    return super unless method_name.to_s.end_with?('_or_fail')
+    return super if !method_name.to_s.end_with?('_or_fail')
 
     action_class, *params = args
     underlying_method = method_name.to_s.chomp('_or_fail')
 
-    unless action_class.respond_to?(underlying_method)
+    if !action_class.respond_to?(underlying_method)
       raise ArgumentError, "#{action_class.name} must define ##{underlying_method}"
     end
 
     result = action_class.send(underlying_method, *params)
 
-    unless result.respond_to?(:failure?)
-      raise ArgumentError, "#{action_class.name}##{underlying_method}'s result must respond to :failure?"
-    end
+    verify_result_is_conforming!(result, "#{action_class.name}##{underlying_method}")
 
-    errors = result.to_h.select { |k, _v| k.to_s.start_with? 'error' }
-    errors[:error] = "Unknown: Your result doesn't respond to a method beginning with 'error'" unless errors.any?
+    errors = result.to_h.select { |key, _value| key.to_s.start_with?('error') }
     fail!(errors) if result.failure?
 
     result
@@ -68,4 +95,12 @@ module Actionizer
   def respond_to_missing?(method_name, _include_private = false)
     method_name.to_s.end_with?('_or_fail')
   end
+
+  private
+
+  def verify_result_is_conforming!(result, class_and_method)
+    raise ArgumentError, "#{class_and_method}'s result must respond to :to_h" if !result.respond_to?(:to_h)
+
+    raise ArgumentError, "#{class_and_method}'s result must respond to :failure?" if !result.respond_to?(:failure?)
+  end
 end

data/lib/actionizer/inputs.rb

@@ -0,0 +1,48 @@
+module Actionizer
+  class Inputs
+    attr_reader :declared_params_by_method, :method
+
+    def initialize
+      @declared_params_by_method = {}
+    end
+
+    def check_for_param_error(method_name, params = {})
+      # If no inputs_for was declared, don't do any checking
+      return false if !declared_params_by_method.key?(method_name)
+
+      params.each_key do |param|
+        return "Param #{param} not declared" if !declared_params_by_method.fetch(method_name).include?(param)
+      end
+
+      declared_params_by_method.fetch(method_name, {}).each_pair do |param, attrs|
+        next if !attrs.fetch(:required)
+
+        return "Param #{param} is required for #{method_name}" if !params.include?(param)
+      end
+
+      false
+    end
+
+    def start(method)
+      @method = method
+      @declared_params_by_method[method] = {}
+    end
+
+    def end
+      @method = nil
+    end
+
+    def add(args)
+      @declared_params_by_method[method][args.fetch(:param)] = { required: args.fetch(:required) }
+    end
+
+    def no_params_declared?(method)
+      declared_params_by_method.fetch(method, {}).empty?
+    end
+
+    def outside_inputs_for_block?
+      method.nil?
+    end
+
+  end
+end

data/lib/actionizer/version.rb

@@ -1,3 +1,3 @@
 module Actionizer
-  VERSION = '0.7.4'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionizer
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Mike Nichols
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-17 00:00:00.000000000 Z
+date: 2016-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,7 @@ files:
 - bin/setup
 - lib/actionizer.rb
 - lib/actionizer/failure.rb
+- lib/actionizer/inputs.rb
 - lib/actionizer/result.rb
 - lib/actionizer/version.rb
 homepage: https://github.com/mikenichols/actionizer