mutations 0.5.12 → 0.6.0

data/{.travis → .travis.yml}

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

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+0.6.0
+-----------
+
+- Add pluggable filters.
+- Add ruby 1.8.7 support [#19]
+- Add a date filter: ```date :start_date``` (/via @eliank and @geronimo)
+- ```Mutations.cache_constants = false``` if you want to work in Rails dev mode which redefines constants. [#23]
+
 0.5.12
 -----------
 
@@ -15,8 +23,8 @@
 - Model filters should lazily resolve their classes so that mocks can be used (@edwinv)
 - Filtered inputs should be included in the Outcome
 - Fix typos (@frodsan)
- 
+
 0.5.10 and earlier
 -----------
 
-- Initial versions
+- Initial versions

data/Gemfile

@@ -1,5 +1,8 @@
 source 'http://rubygems.org'
 gemspec
 
-gem 'minitest', '~> 4.0'
-gem 'activesupport'
+gem 'activesupport'
+
+group :test do
+  gem 'minitest', '~> 4.0'
+end

data/README.md

@@ -1,6 +1,7 @@
 # Mutations
 
 [![Build Status](https://travis-ci.org/cypriss/mutations.png)](https://travis-ci.org/cypriss/mutations)
+[![Code Climate](https://codeclimate.com/github/cypriss/mutations.png)](https://codeclimate.com/github/cypriss/mutations)
 
 Compose your business logic into commands that sanitize and validate input. Write safe, reusable, and maintainable code for Ruby and Rails apps.
 

data/TODO

@@ -1,6 +1,6 @@
  - Document default behavior discarding of nils for optional params
  - document string.discard_empty
- 
+
  - protected parameters:
      optional do
        boolean :skip_confirmation, protected: true
@@ -10,5 +10,3 @@
      But this would not:
      params = {user: current_user, skip_confirmation: true}
      User::ChangeEmail.run!(params)
-
-

data/lib/mutations.rb

@@ -1,16 +1,19 @@
 require 'active_support'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/string/inflections'
+require 'date'
 
 require 'mutations/version'
 require 'mutations/exception'
 require 'mutations/errors'
 require 'mutations/input_filter'
+require 'mutations/additional_filter'
 require 'mutations/string_filter'
 require 'mutations/integer_filter'
 require 'mutations/float_filter'
 require 'mutations/boolean_filter'
 require 'mutations/duck_filter'
+require 'mutations/date_filter'
 require 'mutations/file_filter'
 require 'mutations/model_filter'
 require 'mutations/array_filter'
@@ -27,5 +30,15 @@ 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
   end
-end
+end
+
+Mutations.cache_constants = true

data/lib/mutations/additional_filter.rb

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

data/lib/mutations/array_filter.rb

@@ -1,9 +1,16 @@
 module Mutations
   class ArrayFilter < InputFilter
+    def self.register_additional_filter(type_class, type_name)
+      define_method(type_name) do | *args |
+        options = args[0] || {}
+        @element_filter = type_class.new(options)
+      end
+    end
+
     @default_options = {
-      nils: false,            # true allows an explicit nil to be valid. Overrides any other options
-      class: nil,             # A constant or string indicates that each element of the array needs to be one of these classes
-      arrayize: false         # true will convert "hi" to ["hi"]. "" converts to []
+      :nils => false,            # true allows an explicit nil to be valid. Overrides any other options
+      :class => nil,             # A constant or string indicates that each element of the array needs to be one of these classes
+      :arrayize => false         # true will convert "hi" to ["hi"]. "" converts to []
     }
 
     def initialize(name, opts = {}, &block)
@@ -19,35 +26,10 @@ module Mutations
       raise ArgumentError.new("Can't supply both a class and a filter") if @element_filter && self.options[:class]
     end
 
-    def string(options = {})
-      @element_filter = StringFilter.new(options)
-    end
-
-    def integer(options = {})
-      @element_filter = IntegerFilter.new(options)
-    end
-
-    def float(options = {})
-      @element_filter = FloatFilter.new(options)
-    end
-
-    def boolean(options = {})
-      @element_filter = BooleanFilter.new(options)
-    end
-    
-    def duck(options = {})
-      @element_filter = DuckFilter.new(options)
-    end
-    
-    def file(options = {})
-      @element_filter = FileFilter.new(options)
-    end
-
     def hash(options = {}, &block)
       @element_filter = HashFilter.new(options, &block)
     end
 
-    # Advanced types
     def model(name, options = {})
       @element_filter = ModelFilter.new(name.to_sym, options)
     end
@@ -74,7 +56,7 @@ module Mutations
         found_error = false
         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)
+          el_error = ErrorAtom.new(@name, el_error, :index => i) if el_error.is_a?(Symbol)
 
           errors << el_error
           found_error = true if el_error
@@ -110,4 +92,4 @@ module Mutations
       [data, nil]
     end
   end
-end
+end

data/lib/mutations/boolean_filter.rb

@@ -1,7 +1,7 @@
 module Mutations
-  class BooleanFilter < InputFilter
+  class BooleanFilter < AdditionalFilter
     @default_options = {
-      nils: false   # true allows an explicit nil to be valid. Overrides any other options
+      :nils => false   # true allows an explicit nil to be valid. Overrides any other options
     }
 
     BOOL_MAP = {"true" => true, "1" => true, "false" => false, "0" => false}
@@ -30,4 +30,4 @@ module Mutations
       end
     end
   end
-end
+end

data/lib/mutations/command.rb

@@ -55,11 +55,11 @@ module Mutations
 
     # Instance methods
     def initialize(*args)
-      @raw_inputs = args.each_with_object({}.with_indifferent_access) do |arg, h|
+      @raw_inputs = args.inject({}.with_indifferent_access) do |h, arg|
         raise ArgumentError.new("All arguments must be hashes") unless arg.is_a?(Hash)
         h.merge!(arg)
       end
-      
+
       @inputs, @errors = self.input_filters.filter(@raw_inputs)
     end
 
@@ -110,11 +110,12 @@ module Mutations
 
       @errors ||= ErrorHash.new
       @errors.tap do |errs|
-        *path, last = key.to_s.split(".")
+        path = key.to_s.split(".")
+        last = path.pop
         inner = path.inject(errs) do |cut_errors,part|
           cur_errors[part.to_sym] ||= ErrorHash.new
         end
-        inner[last] = ErrorAtom.new(key, kind, message: message)
+        inner[last] = ErrorAtom.new(key, kind, :message => message)
       end
     end
 

data/lib/mutations/date_filter.rb

@@ -0,0 +1,52 @@
+module Mutations
+  class DateFilter < AdditionalFilter
+    @default_options = {
+      :nils => false,       # true allows an explicit nil to be valid. Overrides any other options
+      :format => nil,       # If nil, Date.parse will be used for coercsion. If something like "%Y-%m-%d", Date.strptime is used
+      :after => nil,        # A date object, representing the minimum date allowed, inclusive
+      :before => nil        # A date object, representing the maximum date allowed, inclusive
+    }
+
+    def filter(data)
+      # Handle nil case
+      if data.nil?
+        return [nil, nil] if options[:nils]
+        return [nil, :nils]
+      end
+
+      if data.is_a?(Date) # Date and DateTime
+        actual_date = data
+      elsif data.is_a?(String)
+        begin
+          actual_date = if options[:format]
+            Date.strptime(data, options[:format])
+          else
+            Date.parse(data)
+          end
+        rescue ArgumentError
+          return [nil, :date]
+        end
+      elsif data.respond_to?(:to_date)  # Time
+        actual_date = data.to_date
+      else
+        return [nil, :date]
+      end
+      
+      # Ok, its a valid date, check if it falls within the range
+      if options[:after]
+        if actual_date <= options[:after]
+          return [nil, :after]
+        end
+      end
+
+      if options[:before]
+        if actual_date >= options[:before]
+          return [nil, :before]
+        end
+      end
+
+      # We win, it's valid!
+      [actual_date, nil]
+    end
+  end
+end

data/lib/mutations/duck_filter.rb

@@ -1,8 +1,8 @@
 module Mutations
-  class DuckFilter < InputFilter
+  class DuckFilter < AdditionalFilter
     @default_options = {
-      nils: false,       # true allows an explicit nil to be valid. Overrides any other options
-      methods: nil       # The object needs to respond to each of the symbols in this array.
+      :nils => false,       # true allows an explicit nil to be valid. Overrides any other options
+      :methods => nil       # The object needs to respond to each of the symbols in this array.
     }
 
     def filter(data)
@@ -22,4 +22,4 @@ module Mutations
       [data, nil]
     end
   end
-end
+end

data/lib/mutations/errors.rb

@@ -6,33 +6,38 @@ module Mutations
     MESSAGES = Hash.new("is invalid").tap do |h|
       h.merge!(
         # General
-        nils: "can't be nil",
-        required: "is required",
+        :nils => "can't be nil",
+        :required => "is required",
 
         # Datatypes
-        string: "isn't a string",
-        integer: "isn't an integer",
-        boolean: "isn't a boolean",
-        hash: "isn't a hash",
-        array: "isn't an array",
-        model: "isn't the right class",
+        :string => "isn't a string",
+        :integer => "isn't an integer",
+        :boolean => "isn't a boolean",
+        :hash => "isn't a hash",
+        :array => "isn't an array",
+        :model => "isn't the right class",
+
+        # Date
+        :date => "date doesn't exist",
+        :before => "isn't before given date",
+        :after => "isn't after given date",
 
         # String
-        empty: "can't be blank",
-        max_length: "is too long",
-        min_length: "is too short",
-        matches: "isn't in the right format",
-        in: "isn't an option",
+        :empty => "can't be blank",
+        :max_length => "is too long",
+        :min_length => "is too short",
+        :matches => "isn't in the right format",
+        :in => "isn't an option",
 
         # Array
-        class: "isn't the right class",
+        :class => "isn't the right class",
 
         # Integer
-        min: "is too small",
-        max: "is too big",
+        :min => "is too small",
+        :max => "is too big",
 
         # Model
-        new_records: "isn't a saved model"
+        :new_records => "isn't a saved model"
       )
     end
 
@@ -49,7 +54,6 @@ module Mutations
     end
   end
 
-
   class ErrorAtom
 
     # NOTE: in the future, could also pass in:
@@ -70,7 +74,7 @@ module Mutations
     end
 
     def message
-      @message ||= Mutations.error_message_creator.message(@key, @symbol, index: @index)
+      @message ||= Mutations.error_message_creator.message(@key, @symbol, :index => @index)
     end
 
     def message_list
@@ -152,4 +156,4 @@ module Mutations
       compact.map {|e| e.message_list }.flatten
     end
   end
-end
+end

data/lib/mutations/exception.rb

@@ -10,4 +10,4 @@ module Mutations
       "#{self.errors.message_list.join('; ')}"
     end
   end
-end
+end

data/lib/mutations/file_filter.rb

@@ -1,9 +1,9 @@
 module Mutations
-  class FileFilter < InputFilter
+  class FileFilter < AdditionalFilter
     @default_options = {
-      nils: false,       # true allows an explicit nil to be valid. Overrides any other options
-      upload: false,     # if true, also checks the file is has original_filename and content_type methods.
-      size: nil          # An integer value like 1_000_000 limits the size of the file to 1M bytes
+      :nils => false,       # true allows an explicit nil to be valid. Overrides any other options
+      :upload => false,     # if true, also checks the file is has original_filename and content_type methods.
+      :size => nil          # An integer value like 1_000_000 limits the size of the file to 1M bytes
     }
 
     def filter(data)
@@ -20,13 +20,13 @@ module Mutations
       methods.each do |method|
         return [data, :file] unless data.respond_to?(method)
       end
-      
+
       if options[:size].is_a?(Fixnum)
-        return [data, :size] if data.size > options[:size] 
+        return [data, :size] if data.size > options[:size]
       end
 
       # We win, it's valid!
       [data, nil]
     end
   end
-end
+end

data/lib/mutations/float_filter.rb

@@ -1,9 +1,9 @@
 module Mutations
-  class FloatFilter < InputFilter
+  class FloatFilter < AdditionalFilter
     @default_options = {
-      nils: false,       # true allows an explicit nil to be valid. Overrides any other options
-      min: nil,          # lowest value, inclusive
-      max: nil           # highest value, inclusive
+      :nils => false,       # true allows an explicit nil to be valid. Overrides any other options
+      :min => nil,          # lowest value, inclusive
+      :max => nil           # highest value, inclusive
     }
 
     def filter(data)
@@ -32,4 +32,4 @@ module Mutations
       [data, nil]
     end
   end
-end
+end