mutations 0.6.0 → 0.7.0

data/.gitignore

@@ -1,2 +1,4 @@
 .rvmrc
+.ruby-version
 *.gem
+Gemfile.lock

data/.travis.yml

@@ -1,10 +1,7 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.3
   - jruby-19mode
-  - rbx-19mode
+  - rbx
   - 2.0.0
-branches:
-  only:
-    - master
+  - 2.1.0

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+0.7.0
+-----------
+
+- Ruby 2.1 support added.
+- Ruby 1.8.7 support removed.
+- Rubinius support updated.
+- Gemfile.lock removed (Rails 4 support, etc)
+- API change: Add ability to implement a 'validate' method
+- ```discard_invalid``` option added
+- AdditionFilters: Gain ability to pass blocks to filters.
+
 0.6.0
 -----------
 

data/Gemfile

@@ -3,6 +3,12 @@ gemspec
 
 gem 'activesupport'
 
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'psych'
+  gem 'rubinius-developer_tools'
+end
+
 group :test do
   gem 'minitest', '~> 4.0'
 end

data/README.md

@@ -233,7 +233,23 @@ unless outcome.success?
 end
 ```
 
-You can add errors within execute if the default validations are insufficient:
+You can add errors in a validate method if the default validations are insufficient. Errors added by validate will prevent the execute method from running.
+
+```ruby
+#...
+def validate
+  if password != password_confirmation
+    add_error(:password_confirmation, :doesnt_match, "Your passwords don't match")
+  end
+end
+# ...
+
+# That error would show up in the errors hash:
+outcome.errors.symbolic # => {password_confirmation: :doesnt_match}
+outcome.errors.message # => {password_confirmation: "Your passwords don't match"}
+```
+
+Alternatively you can also add these validations in the execute method:
 
 ```ruby
 #...
@@ -271,4 +287,3 @@ Yes, but I don't think it's a very good idea. Better to compose.
 ### Can I use this with Rails forms helpers?
 
 Somewhat. Any form can submit to your server, and mutations will happily accept that input. However, if there are errors, there's no built-in way to bake the errors into the HTML with Rails form tag helpers. Right now this is really designed to support a JSON API.  You'd probably have to write an adapter of some kind.
-

data/lib/mutations.rb

@@ -1,4 +1,3 @@
-require 'active_support'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/string/inflections'
 require 'date'
@@ -30,11 +29,11 @@ module Mutations
     def error_message_creator=(creator)
       @error_message_creator = creator
     end
-    
+
     def cache_constants=(val)
       @cache_constants = val
     end
-    
+
     def cache_constants?
       @cache_constants
     end

data/lib/mutations/additional_filter.rb

@@ -4,7 +4,7 @@ require 'mutations/array_filter'
 module Mutations
   class AdditionalFilter < InputFilter
     def self.inherited(subclass)
-      type_name = subclass.name[/^Mutations::([a-zA-Z]*)Filter$/, 1].downcase
+      type_name = subclass.name[/^Mutations::([a-zA-Z]*)Filter$/, 1].underscore
 
       Mutations::HashFilter.register_additional_filter(subclass, type_name)
       Mutations::ArrayFilter.register_additional_filter(subclass, type_name)

data/lib/mutations/array_filter.rb

@@ -57,15 +57,15 @@ module Mutations
         data.each_with_index do |el, i|
           el_filtered, el_error = filter_element(el)
           el_error = ErrorAtom.new(@name, el_error, :index => i) if el_error.is_a?(Symbol)
-
           errors << el_error
-          found_error = true if el_error
-          if !found_error
+          if el_error
+            found_error = true
+          else
             filtered_data << el_filtered
           end
         end
 
-        if found_error
+        if found_error && !(@element_filter && @element_filter.discard_invalid?)
           [data, errors]
         else
           [filtered_data, nil]

data/lib/mutations/command.rb

@@ -38,7 +38,7 @@ module Mutations
 
       # Validates input, but doesn't call execute. Returns an Outcome with errors anyway.
       def validate(*args)
-        new(*args).validate
+        new(*args).validation_outcome
       end
 
       def input_filters
@@ -60,7 +60,11 @@ module Mutations
         h.merge!(arg)
       end
 
+      # Do field-level validation / filtering:
       @inputs, @errors = self.input_filters.filter(@raw_inputs)
+
+      # Run a custom validation method if supplied:
+      validate unless has_errors?
     end
 
     def input_filters
@@ -85,10 +89,6 @@ module Mutations
       end
     end
 
-    def validate
-      validation_outcome
-    end
-
     def validation_outcome(result = nil)
       Outcome.new(!has_errors?, has_errors? ? nil : result, @errors, @inputs)
     end
@@ -97,6 +97,10 @@ module Mutations
 
     attr_reader :inputs, :raw_inputs
 
+    def validate
+      # Meant to be overridden
+    end
+
     def execute
       # Meant to be overridden
     end
@@ -112,7 +116,7 @@ module Mutations
       @errors.tap do |errs|
         path = key.to_s.split(".")
         last = path.pop
-        inner = path.inject(errs) do |cut_errors,part|
+        inner = path.inject(errs) do |cur_errors,part|
           cur_errors[part.to_sym] ||= ErrorHash.new
         end
         inner[last] = ErrorAtom.new(key, kind, :message => message)
@@ -120,8 +124,10 @@ module Mutations
     end
 
     def merge_errors(hash)
-      @errors ||= ErrorHash.new
-      @errors.merge!(hash)
+      if hash.any?
+        @errors ||= ErrorHash.new
+        @errors.merge!(hash)
+      end
     end
 
   end

data/lib/mutations/hash_filter.rb

@@ -1,11 +1,11 @@
 module Mutations
   class HashFilter < InputFilter
     def self.register_additional_filter(type_class, type_name)
-      define_method(type_name) do | *args |
+      define_method(type_name) do | *args, &block |
         name = args[0]
         options = args[1] || {}
 
-        @current_inputs[name.to_sym] = type_class.new(options)
+        @current_inputs[name.to_sym] = type_class.new(options, &block)
       end
     end
 
@@ -103,7 +103,7 @@ module Mutations
 
           # First, discard optional nils/empty params
           data.delete(key) if !is_required && data.has_key?(key) && filterer.discard_nils? && data_element.nil?
-          data.delete(key) if !is_required && data.has_key?(key) && filterer.discard_empty? && data_element == ""
+          data.delete(key) if !is_required && data.has_key?(key) && filterer.discard_empty? && data_element == "" # BUG: this doesn't account for data_elem being " "
 
           default_used = false
           if !data.has_key?(key) && filterer.has_default?
@@ -116,6 +116,8 @@ module Mutations
 
             if sub_error.nil?
               filtered_data[key] = sub_data
+            elsif !is_required && filterer.discard_invalid?
+              data.delete(key)
             else
               sub_error = ErrorAtom.new(key, sub_error) if sub_error.is_a?(Symbol)
               errors[key] = sub_error
@@ -139,6 +141,8 @@ module Mutations
           sub_data, sub_error = wildcard_filterer.filter(data_element)
           if sub_error.nil?
             filtered_data[key] = sub_data
+          elsif wildcard_filterer.discard_invalid?
+            data.delete(key)
           else
             sub_error = ErrorAtom.new(key, sub_error) if sub_error.is_a?(Symbol)
             errors[key] = sub_error

data/lib/mutations/input_filter.rb

@@ -34,5 +34,9 @@ module Mutations
     def discard_empty?
       options[:discard_empty]
     end
+
+    def discard_invalid?
+      self.options[:discard_invalid]
+    end
   end
 end

data/lib/mutations/string_filter.rb

@@ -2,7 +2,7 @@ module Mutations
   class StringFilter < AdditionalFilter
     @default_options = {
       :strip => true,          # true calls data.strip if data is a string
-      :strict => false,        # If false, then symbols, numbers, and booleans are converted to a string with to_s. # TODO: TEST
+      :strict => false,        # If false, then symbols, numbers, and booleans are converted to a string with to_s.
       :nils => false,          # true allows an explicit nil to be valid. Overrides any other options
       :empty => false,         # false disallows "".  true allows "" and overrides any other validations (b/c they couldn't be true if it's empty)
       :min_length => nil,      # Can be a number like 5, meaning that 5 codepoints are required

data/lib/mutations/version.rb

@@ -1,3 +1,3 @@
 module Mutations
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/mutations.gemspec

@@ -15,4 +15,4 @@ Gem::Specification.new do |s|
   s.add_dependency 'activesupport'
   s.add_development_dependency 'minitest', '~> 4'
   s.add_development_dependency 'rake'
-end
+end

data/spec/additional_filter_spec.rb

@@ -13,20 +13,31 @@ describe "Mutations::AdditionalFilter" do
           return [data, nil]
         end
       end
+
+      class MultiWordTestFilter < Mutations::AdditionalFilter
+        @default_options = {
+          :nils => false
+        }
+
+        def filter(data)
+          return [data, nil]
+        end
+      end
     end
 
     class TestCommandUsingAdditionalFilters < Mutations::Command
       required do
         sometest :first_name
+        multi_word_test :last_name
       end
 
       def execute
-        { :first_name => first_name }
+        { :first_name => first_name, :last_name => last_name }
       end
     end
 
     it "should recognize additional filters" do
-      outcome = TestCommandUsingAdditionalFilters.run(:first_name => "John")
+      outcome = TestCommandUsingAdditionalFilters.run(:first_name => "John", :last_name => "Doe")
       assert outcome.success?
       assert_equal nil, outcome.errors
     end
@@ -45,7 +56,7 @@ describe "Mutations::AdditionalFilter" do
 
     it "should be useable in hashes" do
       outcome = TestCommandUsingAdditionalFiltersInHashes.run(
-        :a_hash => { :first_name => "John" } 
+        :a_hash => { :first_name => "John" }
       )
 
       assert outcome.success?
@@ -72,5 +83,47 @@ describe "Mutations::AdditionalFilter" do
       assert outcome.success?
       assert_equal nil, outcome.errors
     end
+
+    module Mutations
+      class AdditionalWithBlockFilter < Mutations::AdditionalFilter
+
+        def initialize(opts={}, &block)
+          super(opts)
+
+          if block_given?
+            instance_eval &block
+          end
+        end
+
+        def should_be_called
+          @was_called = true
+        end
+
+        def filter(data)
+          if @was_called
+            [true, nil]
+          else
+            [nil, :not_called]
+          end
+        end
+      end
+    end
+
+    class TestCommandUsingBlockArgument < Mutations::Command
+      required do
+        additional_with_block :foo do
+          should_be_called
+        end
+      end
+
+      def execute
+        true
+      end
+    end
+
+    it "can have a block constructor" do
+      assert_equal true, TestCommandUsingBlockArgument.run!(:foo => 'bar')
+    end
+
   end
 end

data/spec/array_filter_spec.rb

@@ -181,4 +181,12 @@ describe "Mutations::ArrayFilter" do
     assert_equal ["Array[2] isn't a string", "Array[0] can't be blank"], errors.message_list
   end
 
+  it "strips invalid elements" do
+    f = Mutations::ArrayFilter.new(:arr) do
+      integer :discard_invalid => true
+    end
+    filtered, errors = f.filter([1, "2", "three", "4", 5, [6]])
+    assert_equal [1,2,4,5], filtered
+    assert_equal nil, errors
+  end
 end

data/spec/command_spec.rb

@@ -50,6 +50,29 @@ describe "Command" do
       assert_equal :max_length, outcome.errors.symbolic[:name]
     end
 
+    it "should execute a custom validate method" do
+      outcome = SimpleCommand.validate(:name => "JohnLong", :email => "xxxx")
+
+      assert !outcome.success?
+      assert_equal :invalid, outcome.errors.symbolic[:email]
+    end
+
+    it "should execute custom validate method during run" do
+      outcome = SimpleCommand.run(:name => "JohnLong", :email => "xxxx")
+      
+      assert !outcome.success?
+      assert_nil outcome.result
+      assert_equal :invalid, outcome.errors.symbolic[:email]
+    end
+    
+    it "should execute custom validate method only if regular validations succeed" do
+      outcome = SimpleCommand.validate(:name => "JohnTooLong", :email => "xxxx")
+
+      assert !outcome.success?
+      assert_equal :max_length, outcome.errors.symbolic[:name]
+      assert_equal nil, outcome.errors.symbolic[:email]
+    end
+
     it "should merge multiple hashes" do
       outcome = SimpleCommand.run({:name => "John", :email => "john@gmail.com"}, {:email => "bob@jones.com", :amount => 5})
 
@@ -145,6 +168,28 @@ describe "Command" do
     end
   end
 
+  describe "NestingErrorfulCommand" do
+    class NestingErrorfulCommand < Mutations::Command
+
+      required { string :name }
+      optional { string :email }
+
+      def execute
+        add_error("people.bob", :is_a_bob)
+
+        1
+      end
+    end
+
+    it "should let you add errors nested under a namespace" do
+      outcome = NestingErrorfulCommand.run(:name => "John", :email => "john@gmail.com")
+
+      assert !outcome.success?
+      assert_nil outcome.result
+      assert :is_a_bob, outcome.errors[:people].symbolic[:bob]
+    end
+  end
+
   describe "MultiErrorCommand" do
     class ErrorfulCommand < Mutations::Command
 

data/spec/hash_filter_spec.rb

@@ -186,4 +186,48 @@ describe "Mutations::HashFilter" do
     end
   end
 
+  describe "discarding invalid values" do
+    it "should discard invalid optional values" do
+      hf = Mutations::HashFilter.new do
+        required do
+          string :foo
+        end
+        optional do
+          integer :bar, :discard_invalid => true
+        end
+      end
+
+      filtered, errors = hf.filter(:foo => "bar", :bar => "baz")
+      assert_equal ({"foo" => "bar"}), filtered
+      assert_equal nil, errors
+    end
+
+    it "should discard invalid optional values for wildcards" do
+      hf = Mutations::HashFilter.new do
+        required do
+          string :foo
+        end
+        optional do
+          integer :*, :discard_invalid => true
+        end
+      end
+
+      filtered, errors = hf.filter(:foo => "bar", :bar => "baz", :wat => 1)
+      assert_equal ({"foo" => "bar", "wat" => 1}), filtered
+      assert_equal nil, errors
+    end
+
+
+    it "should not discard invalid require values" do
+      hf = Mutations::HashFilter.new do
+        required do
+          integer :foo, :discard_invalid => true
+        end
+      end
+
+      filtered, errors = hf.filter(:foo => "bar")
+      assert_equal ({"foo" => :integer}), errors.symbolic
+    end
+  end
+
 end

data/spec/simple_command.rb

@@ -9,7 +9,14 @@ class SimpleCommand < Mutations::Command
     integer :amount
   end
 
+  def validate
+    unless email && email.include?('@')
+      add_error(:email, :invalid, 'Email must contain @')
+    end
+  end
+
   def execute
     inputs
   end
+
 end

data/spec/string_filter_spec.rb

@@ -135,4 +135,46 @@ describe "Mutations::StringFilter" do
     assert_equal "red", filtered
     assert_equal nil, errors
   end
+
+  it "converts symbols to strings" do
+    sf = Mutations::StringFilter.new(:strict => false)
+    filtered, errors = sf.filter(:my_sym)
+    assert_equal "my_sym", filtered
+    assert_equal nil, errors
+  end
+
+  it "converts integers to strings" do
+    sf = Mutations::StringFilter.new(:strict => false)
+    filtered, errors = sf.filter(1)
+    assert_equal "1", filtered
+    assert_equal nil, errors
+  end
+
+  it "converts booleans to strings" do
+    sf = Mutations::StringFilter.new(:strict => false)
+    filtered, errors = sf.filter(true)
+    assert_equal "true", filtered
+    assert_equal nil, errors
+  end
+
+  it "disallows symbols" do
+    sf = Mutations::StringFilter.new(:strict => true)
+    filtered, errors = sf.filter(:my_sym)
+    assert_equal :my_sym, filtered
+    assert_equal :string, errors
+  end
+
+  it "disallows integers" do
+    sf = Mutations::StringFilter.new(:strict => true)
+    filtered, errors = sf.filter(1)
+    assert_equal 1, filtered
+    assert_equal :string, errors
+  end
+
+  it "disallows booleans" do
+    sf = Mutations::StringFilter.new(:strict => true)
+    filtered, errors = sf.filter(true)
+    assert_equal true, filtered
+    assert_equal :string, errors
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mutations
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-22 00:00:00.000000000 Z
+date: 2013-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,7 +70,6 @@ files:
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,25 +0,0 @@
-PATH
-  remote: .
-  specs:
-    mutations (0.5.12)
-      activesupport
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activesupport (3.2.8)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    i18n (0.6.1)
-    minitest (4.1.0)
-    multi_json (1.3.6)
-    rake (0.9.2.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport
-  minitest (~> 4.0)
-  mutations!
-  rake