mutations 0.5.4 → 0.5.9

data/Gemfile.lock

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

data/TODO

@@ -0,0 +1,2 @@
+ - Document default behavior discarding of nils for optional params
+ - document string.discard_empty

data/lib/mutations.rb

@@ -8,6 +8,7 @@ require 'mutations/errors'
 require 'mutations/input_filter'
 require 'mutations/string_filter'
 require 'mutations/integer_filter'
+require 'mutations/float_filter'
 require 'mutations/boolean_filter'
 require 'mutations/model_filter'
 require 'mutations/array_filter'
@@ -20,7 +21,7 @@ module Mutations
     def error_message_creator
       @error_message_creator ||= DefaultErrorMessageCreator.new
     end
-    
+
     def error_message_creator=(creator)
       @error_message_creator = creator
     end

data/lib/mutations/errors.rb

@@ -87,7 +87,7 @@ module Mutations
   #     state: ErrorAtom(:in)
   #   }
   # }
-  class ErrorHash < HashWithIndifferentAccess
+  class ErrorHash < Hash
 
     # Returns a nested HashWithIndifferentAccess where the values are symbols.  Eg:
     # {

data/lib/mutations/float_filter.rb

@@ -0,0 +1,36 @@
+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
+    }
+
+    def filter(data)
+
+      # Handle nil case
+      if data.nil?
+        return [nil, nil] if options[:nils]
+        return [nil, :nils]
+      end
+
+      # Ensure it's the correct data type (Float)
+      if !data.is_a?(Float)
+        if data.is_a?(String) && data =~ /^[-+]?\d*\.?\d+/
+          data = data.to_f
+        elsif data.is_a?(Fixnum)
+          data = data.to_f
+        else
+          return [data, :float]
+        end
+      end
+
+      return [data, :min] if options[:min] && data < options[:min]
+      return [data, :max] if options[:max] && data > options[:max]
+
+      # We win, it's valid!
+      [data, nil]
+    end
+  end
+end

data/lib/mutations/hash_filter.rb

@@ -108,6 +108,11 @@ module Mutations
           end
           
           data_element = data[key]
+          
+          # 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 == ""
+          
           default_used = false
           if !data.has_key?(key) && filterer.has_default?
             data_element = filterer.default
@@ -134,6 +139,11 @@ module Mutations
         
         filtered_keys.each do |key|
           data_element = data[key]
+          
+          # First, discard optional nils/empty params
+          next if data.has_key?(key) && wildcard_filterer.discard_nils? && data_element.nil?
+          next if data.has_key?(key) && wildcard_filterer.discard_empty? && data_element == ""
+          
           sub_data, sub_error = wildcard_filterer.filter(data_element)
           if sub_error.nil?
             filtered_data[key] = sub_data

data/lib/mutations/input_filter.rb

@@ -19,11 +19,20 @@ module Mutations
     end
     
     def has_default?
-      self.options.has_key?(:default)
+      options.has_key?(:default)
     end
     
     def default
-      self.options[:default]
+      options[:default]
+    end
+    
+    # Only relevant for optional params
+    def discard_nils?
+      !options[:nils]
+    end
+    
+    def discard_empty?
+      options[:discard_empty]
     end
   end
 end

data/lib/mutations/string_filter.rb

@@ -1,14 +1,15 @@
 module Mutations
   class StringFilter < InputFilter
     @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
-      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
-      max_length: nil,   # Can be a number like 10, meaning that at most 10 codepoints are permitted
-      matches: nil,      # Can be a regexp
-      in: nil            # Can be an array like %w(red blue green)
+      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
+      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
+      max_length: nil,      # Can be a number like 10, meaning that at most 10 codepoints are permitted
+      matches: nil,         # Can be a regexp
+      in: nil,              # Can be an array like %w(red blue green)
+      discard_empty: false  # If the param is optional, discard_empty: true drops empty fields.
     }
     
     def filter(data)

data/lib/mutations/version.rb

@@ -1,3 +1,3 @@
 module Mutations
-  VERSION = "0.5.4"
+  VERSION = "0.5.9"
 end

data/spec/float_filter_spec.rb

@@ -0,0 +1,97 @@
+require_relative 'spec_helper'
+
+describe "Mutations::FloatFilter" do
+
+  it "allows floats" do
+    f = Mutations::FloatFilter.new
+    filtered, errors = f.filter(3.1415926)
+    assert_equal 3.1415926, filtered
+    assert_equal nil, errors
+  end
+
+  it "allows strings that start with a digit" do
+    f = Mutations::FloatFilter.new
+    filtered, errors = f.filter("3")
+    assert_equal 3.0, filtered
+    assert_equal nil, errors
+  end
+
+  it "allows string representation of float" do
+    f = Mutations::FloatFilter.new
+    filtered, errors = f.filter("3.14")
+    assert_equal 3.14, filtered
+    assert_equal nil, errors
+  end
+
+  it "allows string representation of float without a number before dot" do
+    f = Mutations::FloatFilter.new
+    filtered, errors = f.filter(".14")
+    assert_equal 0.14, filtered
+    assert_equal nil, errors
+  end
+
+  it "allows negative strings" do
+    f = Mutations::FloatFilter.new
+    filtered, errors = f.filter("-.14")
+    assert_equal -0.14, filtered
+    assert_equal nil, errors
+  end
+
+  it "allows strings with a positive sign" do
+    f = Mutations::FloatFilter.new
+    filtered, errors = f.filter("+.14")
+    assert_equal 0.14, filtered
+    assert_equal nil, errors
+  end
+
+  it "doesnt't allow other strings, nor does it allow random objects or symbols" do
+    f = Mutations::FloatFilter.new
+    ["zero","a1", {}, [], Object.new, :d].each do |thing|
+      filtered, errors = f.filter(thing)
+      assert_equal :float, errors
+    end
+  end
+
+  it "considers nil to be invalid" do
+    f = Mutations::FloatFilter.new(nils: false)
+    filtered, errors = f.filter(nil)
+    assert_equal nil, filtered
+    assert_equal :nils, errors
+  end
+
+  it "considers nil to be valid" do
+    f = Mutations::FloatFilter.new(nils: true)
+    filtered, errors = f.filter(nil)
+    assert_equal nil, filtered
+    assert_equal nil, errors
+  end
+
+  it "considers low numbers invalid" do
+    f = Mutations::FloatFilter.new(min: 10)
+    filtered, errors = f.filter(3)
+    assert_equal 3, filtered
+    assert_equal :min, errors
+  end
+
+  it "considers low numbers valid" do
+    f = Mutations::FloatFilter.new(min: 10)
+    filtered, errors = f.filter(31)
+    assert_equal 31, filtered
+    assert_equal nil, errors
+  end
+
+  it "considers high numbers invalid" do
+    f = Mutations::FloatFilter.new(max: 10)
+    filtered, errors = f.filter(31)
+    assert_equal 31, filtered
+    assert_equal :max, errors
+  end
+
+  it "considers high numbers vaild" do
+    f = Mutations::FloatFilter.new(max: 10)
+    filtered, errors = f.filter(3)
+    assert_equal 3, filtered
+    assert_equal nil, errors
+  end
+
+end

data/spec/hash_filter_spec.rb

@@ -32,8 +32,8 @@ describe "Mutations::HashFilter" do
     hf = Mutations::HashFilter.new do
       string :*
     end
-    filtered, errors = hf.filter(foo: nil)
-    assert_equal ({"foo" => :nils}), errors.symbolic
+    filtered, errors = hf.filter(foo: [])
+    assert_equal ({"foo" => :string}), errors.symbolic
   end
   
   it "allows a mix of specific keys and then wildcards" do
@@ -46,4 +46,107 @@ describe "Mutations::HashFilter" do
     assert_equal nil, errors
   end
   
+  it "doesn't allow a mix of specific keys and then wildcards -- should raise errors appropriately" do
+    hf = Mutations::HashFilter.new do
+      string :foo
+      integer :*
+    end
+    filtered, errors = hf.filter(foo: "bar", baz: "poopin")
+    assert_equal ({"baz" => :integer}), errors.symbolic
+  end
+  
+  describe "optional params and nils" do
+    it "bar is optional -- it works if not passed" do
+      hf = Mutations::HashFilter.new do
+        required do
+          string :foo
+        end
+        optional do
+          string :bar
+        end
+      end
+      
+      filtered, errors = hf.filter(foo: "bar")
+      assert_equal ({"foo" => "bar"}), filtered
+      assert_equal nil, errors
+    end
+    
+    it "bar is optional -- it works if nil is passed" do
+      hf = Mutations::HashFilter.new do
+        required do
+          string :foo
+        end
+        optional do
+          string :bar
+        end
+      end
+      
+      filtered, errors = hf.filter(foo: "bar", bar: nil)
+      assert_equal ({"foo" => "bar"}), filtered
+      assert_equal nil, errors
+    end
+    
+    it "bar is optional -- it works if nil is passed and nils are allowed" do
+      hf = Mutations::HashFilter.new do
+        required do
+          string :foo
+        end
+        optional do
+          string :bar, nils: true
+        end
+      end
+      
+      filtered, errors = hf.filter(foo: "bar", bar: nil)
+      assert_equal ({"foo" => "bar", "bar" => nil}), filtered
+      assert_equal nil, errors
+    end
+  end
+  
+  describe "optional params and empty values" do
+    it "bar is optional -- discards empty" do
+      hf = Mutations::HashFilter.new do
+        required do
+          string :foo
+        end
+        optional do
+          string :bar, discard_empty: true
+        end
+      end
+      
+      filtered, errors = hf.filter(foo: "bar", bar: "")
+      assert_equal ({"foo" => "bar"}), filtered
+      assert_equal nil, errors
+    end
+    
+    it "bar is optional -- errors if discard_empty is false and value is blank" do
+      hf = Mutations::HashFilter.new do
+        required do
+          string :foo
+        end
+        optional do
+          string :bar, discard_empty: false
+        end
+      end
+      
+      filtered, errors = hf.filter(foo: "bar", bar: "")
+      assert_equal ({"bar" => :empty}), errors.symbolic
+    end
+    
+    it "bar is optional -- discards empty -- now with wildcards" do
+      hf = Mutations::HashFilter.new do
+        required do
+          string :foo
+        end
+        optional do
+          string :*, discard_empty: true
+        end
+      end
+      
+      filtered, errors = hf.filter(foo: "bar", bar: "")
+      assert_equal ({"foo" => "bar"}), filtered
+      assert_equal nil, errors
+    end
+  end
+  
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mutations
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-22 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -73,12 +73,14 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- TODO
 - lib/mutations.rb
 - lib/mutations/array_filter.rb
 - lib/mutations/boolean_filter.rb
 - lib/mutations/command.rb
 - lib/mutations/errors.rb
 - lib/mutations/exception.rb
+- lib/mutations/float_filter.rb
 - lib/mutations/hash_filter.rb
 - lib/mutations/input_filter.rb
 - lib/mutations/integer_filter.rb
@@ -92,6 +94,7 @@ files:
 - spec/command_spec.rb
 - spec/default_spec.rb
 - spec/errors_spec.rb
+- spec/float_filter_spec.rb
 - spec/hash_filter_spec.rb
 - spec/inheritance_spec.rb
 - spec/integer_filter_spec.rb