mutations 0.5.10 → 0.5.11

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mutations (0.5.9)
+    mutations (0.5.11)
       activesupport
 
 GEM

data/README.md

@@ -114,7 +114,7 @@ That being said, you can pass multiple hashes to run, and they are merged togeth
 ```ruby
 # A user comments on an article
 class CreateComment < Mutations::Command
-  requried do
+  required do
     model :user
     model :article
     string :comment, max_length: 500
@@ -138,7 +138,7 @@ Here, we pass two hashes to CreateComment. Even if the params[:comment] hash has
 1. Subclass Mutations::Command
 
     ```ruby
-    class YourMutation < Mutatons::Command
+    class YourMutation < Mutations::Command
       # ...
     end
     ```

data/TODO

@@ -1,2 +1,14 @@
  - Document default behavior discarding of nils for optional params
  - document string.discard_empty
+ 
+ - protected parameters:
+     optional do
+       boolean :skip_confirmation, protected: true
+     end
+     Given the above, skip_confirmation is only accepted as a parameter if it's passed in a later hash, eg this would make it take:
+     User::ChangeEmail.run!(params, user: current_user, skip_confirmation: true)
+     But this would not:
+     params = {user: current_user, skip_confirmation: true}
+     User::ChangeEmail.run!(params)
+
+

data/lib/mutations/command.rb

@@ -1,25 +1,10 @@
-# IDEA i just had (protected parameters):
-# optional do
-#   boolean :skip_confirmation, protected: true
-# end
-# Given the above, skip_confirmation is only accepted as a parameter if it's passed in a later hash, eg this would make it take:
-# User::ChangeEmail.run!(params, user: current_user, skip_confirmation: true)
-# But this would not:
-# params = {user: current_user, skip_confirmation: true}
-# User::ChangeEmail.run!(params)
-
-
 module Mutations
   class Command
-
-    ##
-    ##
-    ##
     class << self
-      def required(&block)
-        self.input_filters.required(&block)
-
-        self.input_filters.required_keys.each do |key|
+      def create_attr_methods(meth, &block)
+        self.input_filters.send(meth, &block)
+        keys = self.input_filters.send("#{meth}_keys")
+        keys.each do |key|
           define_method(key) do
             @filtered_input[key]
           end
@@ -33,41 +18,27 @@ module Mutations
           end
         end
       end
+      private :create_attr_methods
 
-      def optional(&block)
-        self.input_filters.optional(&block)
-
-        self.input_filters.optional_keys.each do |key|
-          define_method(key) do
-            @filtered_input[key]
-          end
-
-          define_method("#{key}_present?") do
-            @filtered_input.has_key?(key)
-          end
+      def required(&block)
+        create_attr_methods(:required, &block)
+      end
 
-          define_method("#{key}=") do |v|
-            @filtered_input[key] = v
-          end
-        end
+      def optional(&block)
+        create_attr_methods(:optional, &block)
       end
 
       def run(*args)
-        new(*args).execute!
+        new(*args).run
       end
 
       def run!(*args)
-        m = run(*args)
-        if m.success?
-          m.result
-        else
-          raise ValidationException.new(m.errors)
-        end
+        new(*args).run!
       end
 
       # Validates input, but doesn't call execute. Returns an Outcome with errors anyway.
       def validate(*args)
-        new(*args).validation_outcome
+        new(*args).validate
       end
 
       def input_filters
@@ -84,19 +55,10 @@ module Mutations
 
     # Instance methods
     def initialize(*args)
-      if args.length == 0
-        @original_hash = {}
-      else
-        @original_hash = args.shift
-        raise ArgumentError.new("All arguments must be hashes") unless @original_hash.is_a?(Hash)
-        @original_hash = @original_hash.with_indifferent_access
+      @original_hash = args.each_with_object({}.with_indifferent_access) do |arg, h|
+        raise ArgumentError.new("All arguments must be hashes") unless arg.is_a?(Hash)
+        h.merge!(arg)
       end
-
-      args.each do |a|
-        raise ArgumentError.new("All arguments must be hashes") unless a.is_a?(Hash)
-        @original_hash.merge!(a)
-      end
-
       @filtered_input, @errors = self.input_filters.filter(@original_hash)
     end
 
@@ -104,26 +66,37 @@ module Mutations
       self.class.input_filters
     end
 
-    def execute!
-      return Outcome.new(false, nil, @errors) if @errors
+    def has_errors?
+      !@errors.nil?
+    end
 
-      # IDEA/TODO: run validate block
+    def run
+      return validation_outcome if has_errors?
+      validation_outcome(execute)
+    end
 
-      r = execute
-      if @errors # Execute can add errors
-        return Outcome.new(false, nil, @errors)
+    def run!
+      outcome = run
+      if outcome.success?
+        outcome.result
       else
-        return Outcome.new(true, r, nil)
+        raise ValidationException.new(outcome.errors)
       end
     end
 
+    def validate
+      validation_outcome
+    end
+
     # Runs input thru the filter and sets @filtered_input and @errors
-    def validation_outcome
-      if @errors
-        Outcome.new(false, nil, @errors)
-      else
-        Outcome.new(true, nil,  nil)
-      end
+    def validation_outcome(result = nil)
+      Outcome.new(!has_errors?, has_errors? ? nil : result, @errors, @filtered_input)
+    end
+
+  protected
+
+    def execute
+      # Meant to be overridden
     end
 
     # add_error("name", :too_short)
@@ -134,18 +107,13 @@ module Mutations
       raise ArgumentError.new("Invalid kind") unless kind.is_a?(Symbol)
 
       @errors ||= ErrorHash.new
-      cur_errors = @errors
-      parts = key.to_s.split(".")
-      while part = parts.shift
-        part = part.to_sym
-        if parts.length > 0
-          cur_errors[part] = ErrorHash.new unless cur_errors[part].is_a?(ErrorHash)
-          cur_errors = cur_errors[part]
-        else
-          cur_errors[part] = ErrorAtom.new(key, kind, message: message)
+      @errors.tap do |errs|
+        *path, last = key.to_s.split(".")
+        inner = path.inject(errs) do |cut_errors,part|
+          cur_errors[part.to_sym] ||= ErrorHash.new
         end
+        inner[last] = ErrorAtom.new(key, kind, message: message)
       end
-      @errors
     end
 
     def merge_errors(hash)
@@ -156,9 +124,5 @@ module Mutations
     def inputs
       @filtered_input
     end
-
-    def execute
-      # Meant to be overridden
-    end
   end
 end

data/lib/mutations/float_filter.rb

@@ -2,7 +2,6 @@ module Mutations
   class FloatFilter < InputFilter
     @default_options = {
       nils: false,       # true allows an explicit nil to be valid. Overrides any other options
-      # TODO: add strict
       min: nil,          # lowest value, inclusive
       max: nil           # highest value, inclusive
     }

data/lib/mutations/hash_filter.rb

@@ -31,13 +31,11 @@ module Mutations
     end
 
     def required(&block)
-      # TODO: raise if nesting is wrong
       @current_inputs = @required_inputs
       instance_eval &block
     end
 
     def optional(&block)
-      # TODO: raise if nesting is wrong
       @current_inputs = @optional_inputs
       instance_eval &block
     end

data/lib/mutations/integer_filter.rb

@@ -2,7 +2,6 @@ module Mutations
   class IntegerFilter < InputFilter
     @default_options = {
       nils: false,       # true allows an explicit nil to be valid. Overrides any other options
-      # TODO: add strict
       min: nil,          # lowest value, inclusive
       max: nil           # highest value, inclusive
     }

data/lib/mutations/model_filter.rb

@@ -10,18 +10,26 @@ module Mutations
     def initialize(name, opts = {})
       super(opts)
       @name = name
-
-      class_const = options[:class] || @name.to_s.camelize
-      class_const = class_const.constantize if class_const.is_a?(String)
-      self.options[:class] = class_const
-
-      if options[:builder]
-        options[:builder] = options[:builder].constantize if options[:builder].is_a?(String)
+    end
+    
+    # Initialize the model class and builder
+    def initialize_constants!
+      @initialize_constants ||= begin
+        class_const = options[:class] || @name.to_s.camelize
+        class_const = class_const.constantize if class_const.is_a?(String)
+        self.options[:class] = class_const
+
+        if options[:builder]
+          options[:builder] = options[:builder].constantize if options[:builder].is_a?(String)
+        end
+        
+        true
       end
     end
 
     def filter(data)
-
+      initialize_constants!
+      
       # Handle nil case
       if data.nil?
         return [nil, nil] if options[:nils]
@@ -49,4 +57,4 @@ module Mutations
     end
 
   end
-end
+end

data/lib/mutations/outcome.rb

@@ -1,19 +1,13 @@
 module Mutations
   class Outcome
-    def initialize(is_success, result, errors)
-      @success, @result, @errors = is_success, result, errors
+    attr_reader :result, :errors, :inputs
+    
+    def initialize(is_success, result, errors, inputs)
+      @success, @result, @errors, @inputs = is_success, result, errors, inputs
     end
 
     def success?
       @success
     end
-
-    def result
-      @result
-    end
-
-    def errors
-      @errors
-    end
   end
 end

data/lib/mutations/version.rb

@@ -1,3 +1,3 @@
 module Mutations
-  VERSION = "0.5.10"
+  VERSION = "0.5.11"
 end

data/spec/command_spec.rb

@@ -72,11 +72,20 @@ describe "Command" do
       assert_raises ArgumentError do
         outcome = SimpleCommand.run(1)
       end
+
+      assert_raises ArgumentError do
+        outcome = SimpleCommand.run({name: "John"}, 1)
+      end
     end
 
     it "should accept nothing at all" do
       SimpleCommand.run # make sure nothing is raised
     end
+    
+    it "should return the filtered inputs in the outcome" do
+      outcome = SimpleCommand.run(name: " John ", email: "john@gmail.com", amount: "5")
+      assert_equal ({name: "John", email: "john@gmail.com", amount: 5}).stringify_keys, outcome.inputs
+    end
   end
 
   describe "EigenCommand" do

data/spec/default_spec.rb

@@ -0,0 +1,33 @@
+require_relative 'spec_helper'
+require 'simple_command'
+
+describe 'Mutations - defaults' do
+
+  class DefaultCommand < Mutations::Command
+    required do
+      string :name, default: "Bob Jones"
+    end
+    
+    def execute
+      inputs
+    end
+  end
+  
+  it "should have a default if no value is passed" do
+    outcome = DefaultCommand.run
+    assert_equal true, outcome.success?
+    assert_equal ({"name" => "Bob Jones"}), outcome.result
+  end
+  
+  it "should have the passed value if a value is passed" do
+    outcome = DefaultCommand.run(name: "Fred")
+    assert_equal true, outcome.success?
+    assert_equal ({"name" => "Fred"}), outcome.result
+  end
+  
+  it "should be an error if nil is passed on a required field with a default" do
+    outcome = DefaultCommand.run(name: nil)
+    assert_equal false, outcome.success?
+  end
+  
+end

data/spec/model_filter_spec.rb

@@ -27,21 +27,24 @@ describe "Mutations::ModelFilter" do
   # it "disallows different types of models" do
   # end
 
-  it "raises an exception during initialization if constantization fails" do
+  it "raises an exception during filtering if constantization fails" do
+    f = Mutations::ModelFilter.new(:complex_model)
     assert_raises NameError do
-      Mutations::ModelFilter.new(:complex_model)
+      f.filter(nil)
     end
   end
 
-  it "raises an exception during initialization if constantization of class fails" do
+  it "raises an exception during filtering if constantization of class fails" do
+    f = Mutations::ModelFilter.new(:simple_model, class: "ComplexModel")
     assert_raises NameError do
-      Mutations::ModelFilter.new(:simple_model, class: "ComplexModel")
+      f.filter(nil)
     end
   end
 
-  it "raises an exception during initialization if constantization of builder fails" do
+  it "raises an exception during filtering if constantization of builder fails" do
+    f = Mutations::ModelFilter.new(:simple_model, builder: "ComplexModel")
     assert_raises NameError do
-      Mutations::ModelFilter.new(:simple_model, builder: "ComplexModel")
+      f.filter(nil)
     end
   end
 
@@ -89,4 +92,4 @@ describe "Mutations::ModelFilter" do
   # it "makes sure that if you build a record from a hash, it still has to be of the right class" do
   # end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mutations
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.5.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-28 00:00:00.000000000 Z
+date: 2013-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Compose your business logic into commands that sanitize and validate input.