mutations 0.9.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60a9dcaccc2cded1876539ff36b62111b6bfdcec887494265fe4fa510c360ad5
-  data.tar.gz: 7a2bd2aacb4f8b9296e7f4a638fe42a1034ee8736a24a31d811580a87e4ecbe7
+  metadata.gz: e8910273a1df86a4c215e9b4878698f4c74f88b1756f7df8145b116ebeff92e2
+  data.tar.gz: 8f8e311fe7f030469ba62e473e5bc63f45af913640e670b19d7255f8ed5f20f8
 SHA512:
-  metadata.gz: 756a1dd30f3affd27ef111ebfbdf066e3e056767f6a08a7b69f8c39831f977bb9ee96b82e2f729cc02d4f6bffa2ea04f8ad8e405b9b6855f7a3bc06a20a4039a
-  data.tar.gz: b18adcdba20934dda3555cb3b72d90e23cd81612e152991338dd750f2d4bbd57ced91037b9900c4d42f8d6090cf4fe662ca0e91c3dba64692a5d0f0e3f46cae3
+  metadata.gz: fc69d3c607ee357701a72293b9233d652017d3e9b65c3d7b59dc3c4290fafda020189e769c8dc70fbf32645e3141225f5395d05f91c9dda63f4ce10d09e5e1a3
+  data.tar.gz: 2e3f1114e8aaee8a264a68aa4ef90cca33bf14d5629d8b71864c238749b77c02a61d2e1651990b27e3d808e1e3808b90c2c107380a52df0988da7ed8b5b90a9c

data/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        ruby-version:
+          - 2.1
+          - 2.2
+          - 2.3
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - '3.0'
+          - 3.1
+          - 3.2
+          - 3.3
+          - 3.4
+          - 4.0
+          - jruby
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - run: bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+0.9.2
+-----------
+ - Optimize control char stripping (#167, @byroot)
+
+0.9.1
+-----------
+ - Treat blank strings as nil when `strip` and `empty_is_nil` options are set (#148, @saverio-kantox)
+ - Don't use full key in nested error messages (#149, @eugeneius)
+ - Don't remove unknown characters in string filter (#150, @eugeneius)
+
 0.9.0
 -----------
  - Retain `_id` suffix in error keys (#129, @khalilovcmd)

data/Gemfile

@@ -1,8 +1,2 @@
 source 'http://rubygems.org'
 gemspec
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'psych'
-  gem 'rubinius-developer_tools'
-end

data/README.md

@@ -1,6 +1,6 @@
 # Mutations
 
-[![Build Status](https://travis-ci.org/cypriss/mutations.svg)](https://travis-ci.org/cypriss/mutations)
+[![Build Status](https://travis-ci.org/cypriss/mutations.svg?branch=master)](https://travis-ci.org/cypriss/mutations)
 [![Code Climate](https://codeclimate.com/github/cypriss/mutations.svg)](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/Rakefile

@@ -2,7 +2,6 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 Rake::TestTask.new(:test) do |test|
   test.libs << "spec"
-  # test.warning = true # Wow that outputs a lot of shit
   test.pattern = "spec/**/*_spec.rb"
 end
 

data/lib/mutations/array_filter.rb

@@ -1,8 +1,7 @@
 module Mutations
   class ArrayFilter < InputFilter
     def self.register_additional_filter(type_class, type_name)
-      define_method(type_name) do | *args, &block |
-        options = args[0] || {}
+      define_method(type_name) do |options = {}, &block|
         @element_filter = type_class.new(options, &block)
       end
     end

data/lib/mutations/command.rb

@@ -119,7 +119,7 @@ module Mutations
         inner = path.inject(errs) do |cur_errors,part|
           cur_errors[part.to_sym] ||= ErrorHash.new
         end
-        inner[last] = ErrorAtom.new(key, kind, :message => message)
+        inner[last] = ErrorAtom.new(last.to_sym, kind, :message => message)
       end
     end
 

data/lib/mutations/date_filter.rb

@@ -9,10 +9,6 @@ module Mutations
     }
 
     def filter(data)
-      if options[:empty_is_nil] && data == ""
-        data = nil
-      end
-
       # Handle nil case
       if data.nil?
         return [nil, nil] if options[:nils]
@@ -20,7 +16,13 @@ module Mutations
       end
 
       # Now check if it's empty:
-      return [data, :empty] if "" == data
+      if data == ""
+        if options[:empty_is_nil]
+          return [nil, (:nils unless options[:nils])]
+        else
+          return [data, :empty]
+        end
+      end
 
       if data.is_a?(Date) # Date and DateTime
         actual_date = data

data/lib/mutations/hash_filter.rb

@@ -1,10 +1,7 @@
 module Mutations
   class HashFilter < InputFilter
     def self.register_additional_filter(type_class, type_name)
-      define_method(type_name) do | *args, &block |
-        name = args[0]
-        options = args[1] || {}
-
+      define_method(type_name) do |name, options = {}, &block|
         @current_inputs[name.to_sym] = type_class.new(options, &block)
       end
     end

data/lib/mutations/integer_filter.rb

@@ -9,11 +9,6 @@ module Mutations
     }
 
     def filter(data)
-
-      if options[:empty_is_nil] && data == ""
-        data = nil
-      end
-
       # Handle nil case
       if data.nil?
         return [nil, nil] if options[:nils]
@@ -21,7 +16,13 @@ module Mutations
       end
 
       # Now check if it's empty:
-      return [data, :empty] if data == ""
+      if data == ""
+        if options[:empty_is_nil]
+          return [nil, (:nils unless options[:nils])]
+        else
+          return [data, :empty]
+        end
+      end
 
       # Ensure it's the correct data type (Integer)
       if !data.is_a?(Integer)

data/lib/mutations/string_filter.rb

@@ -11,14 +11,13 @@ module Mutations
       :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.
-      :allow_control_characters => false    # false removes unprintable characters from the string
+      :allow_control_characters => false    # false removes control characters from the string
     }
 
-    def filter(data)
-      if options[:empty_is_nil] && data == ""
-        data = nil
-      end
+    CONTROL_CHARS = ((0..31).map(&:chr) - ["\r", "\n", "\t"]).join.freeze
+    REPLACE = (" " * CONTROL_CHARS.bytesize).freeze
 
+    def filter(data)
       # Handle nil case
       if data.nil?
         return [nil, nil] if options[:nils]
@@ -31,15 +30,17 @@ module Mutations
       # Now ensure it's a string:
       return [data, :string] unless data.is_a?(String)
 
-      # At this point, data is a string. Now remove unprintable characters from the string:
-      data = data.gsub(/[^[:print:]\t\r\n]+/, ' ') unless options[:allow_control_characters]
+      # At this point, data is a string. Now remove control characters from the string:
+      data = data.tr_s(CONTROL_CHARS, REPLACE) unless options[:allow_control_characters]
 
       # Transform it using strip:
       data = data.strip if options[:strip]
 
       # Now check if it's blank:
       if data == ""
-        if options[:empty]
+        if options[:empty_is_nil]
+          return [nil, (:nils unless options[:nils])]
+        elsif options[:empty]
           return [data, nil]
         else
           return [data, :empty]

data/lib/mutations/version.rb

@@ -1,3 +1,3 @@
 module Mutations
-  VERSION = "0.9.0"
+  VERSION = "0.9.2"
 end

data/mutations.gemspec

@@ -14,6 +14,6 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
 
   s.add_dependency "activesupport"
-  s.add_development_dependency 'minitest', '~> 4'
+  s.add_development_dependency 'minitest'
   s.add_development_dependency 'rake'
 end

data/spec/additional_filter_spec.rb

@@ -39,7 +39,7 @@ describe "Mutations::AdditionalFilter" do
     it "should recognize additional filters" do
       outcome = TestCommandUsingAdditionalFilters.run(:first_name => "John", :last_name => "Doe")
       assert outcome.success?
-      assert_equal nil, outcome.errors
+      assert_nil outcome.errors
     end
 
     class TestCommandUsingAdditionalFiltersInHashes < Mutations::Command
@@ -60,7 +60,7 @@ describe "Mutations::AdditionalFilter" do
       )
 
       assert outcome.success?
-      assert_equal nil, outcome.errors
+      assert_nil outcome.errors
     end
 
     class TestCommandUsingAdditionalFiltersInArrays < Mutations::Command
@@ -81,7 +81,7 @@ describe "Mutations::AdditionalFilter" do
       )
 
       assert outcome.success?
-      assert_equal nil, outcome.errors
+      assert_nil outcome.errors
     end
 
     module Mutations

data/spec/array_filter_spec.rb

@@ -9,7 +9,7 @@ describe "Mutations::ArrayFilter" do
     f = Mutations::ArrayFilter.new(:arr)
     filtered, errors = f.filter([1])
     assert_equal [1], filtered
-    assert_equal nil, errors
+    assert_nil errors
   end
 
   it "considers non-arrays to be invalid" do
@@ -23,7 +23,7 @@ describe "Mutations::ArrayFilter" do
   it "considers nil to be invalid" do
     f = Mutations::ArrayFilter.new(:arr, :nils => false)
     filtered, errors = f.filter(nil)
-    assert_equal nil, filtered
+    assert_nil filtered
     assert_equal :nils, errors
   end
 
@@ -31,20 +31,20 @@ describe "Mutations::ArrayFilter" do
     f = Mutations::ArrayFilter.new(:arr, :nils => true)
     _filtered, errors = f.filter(nil)
     _filtered, errors = f.filter(nil)
-    assert_equal nil, errors
+    assert_nil errors
   end
 
   it "lets you specify a class, and has valid elements" do
     f = Mutations::ArrayFilter.new(:arr, :class => Integer)
     filtered, errors = f.filter([1,2,3])
-    assert_equal nil, errors
+    assert_nil errors
     assert_equal [1,2,3], filtered
   end
 
   it "lets you specify a class as a string, and has valid elements" do
     f = Mutations::ArrayFilter.new(:arr, :class => 'Integer')
     filtered, errors = f.filter([1,2,3])
-    assert_equal nil, errors
+    assert_nil errors
     assert_equal [1,2,3], filtered
   end
 
@@ -125,7 +125,7 @@ describe "Mutations::ArrayFilter" do
 
     filtered, errors = f.filter([true, false, "1"])
     assert_equal [true, false, true], filtered
-    assert_equal nil, errors
+    assert_nil errors
   end
 
   it "lets you pass model in arrays" do
@@ -133,7 +133,7 @@ describe "Mutations::ArrayFilter" do
 
     filtered, errors = f.filter(["hey"])
     assert_equal ["hey"], filtered
-    assert_equal nil, errors
+    assert_nil errors
   end
 
   it "lets you pass hashes in arrays" do
@@ -153,9 +153,9 @@ describe "Mutations::ArrayFilter" do
     filtered, errors = f.filter([{:foo => "f", :bar => 3, :baz => true}, {:foo => "f", :bar => 3}, {:foo => "f"}])
     assert_equal [{:foo=>"f", :bar=>3, :baz=>true}, {:foo=>"f", :bar=>3}, {:foo=>"f"}], filtered
 
-    assert_equal nil, errors[0]
-    assert_equal nil, errors[1]
-    assert_equal ({"bar"=>:required}), errors[2].symbolic
+    assert_nil errors[0]
+    assert_nil errors[1]
+    assert_equal({"bar"=>:required}, errors[2].symbolic)
   end
 
   it "lets you pass arrays of arrays" do
@@ -167,7 +167,7 @@ describe "Mutations::ArrayFilter" do
 
     filtered, errors = f.filter([["h", "e"], ["l"], [], ["lo"]])
     assert_equal filtered, [["h", "e"], ["l"], [], ["lo"]]
-    assert_equal nil, errors
+    assert_nil errors
   end
 
   it "handles errors for arrays of arrays" do
@@ -189,14 +189,14 @@ describe "Mutations::ArrayFilter" do
     end
     filtered, errors = f.filter([1, "2", "three", "4", 5, [6]])
     assert_equal [1,2,4,5], filtered
-    assert_equal nil, errors
+    assert_nil errors
   end
 
   it "considers long arrays to be valid" do
     f = Mutations::ArrayFilter.new(:arr, :min_length => 2)
     filtered, errors = f.filter([1, 2])
     assert_equal [1, 2], filtered
-    assert_equal nil, errors
+    assert_nil errors
   end
 
   it "considers short arrays to be invalid" do
@@ -210,7 +210,7 @@ describe "Mutations::ArrayFilter" do
     f = Mutations::ArrayFilter.new(:arr, :max_length => 20)
     filtered, errors = f.filter([1])
     assert_equal [1], filtered
-    assert_equal nil, errors
+    assert_nil errors
   end
   
   it "sets a max_length for the array of 2 with 5 as invalid" do
@@ -224,12 +224,12 @@ describe "Mutations::ArrayFilter" do
     was = Mutations.cache_constants?
     Mutations.cache_constants = true
 
-    f = Mutations::ArrayFilter.new(:simple_models, class: "SimpleModel")
+    f = Mutations::ArrayFilter.new(:simple_models, :class => "SimpleModel")
 
     m = SimpleModel.new
     filtered, errors = f.filter([m])
     assert_equal [m], filtered
-    assert_equal nil, errors
+    assert_nil errors
 
     Object.send(:remove_const, 'SimpleModel')
     class SimpleModel; end
@@ -246,12 +246,12 @@ describe "Mutations::ArrayFilter" do
     was = Mutations.cache_constants?
     Mutations.cache_constants = false
 
-    f = Mutations::ArrayFilter.new(:simple_models, class: "SimpleModel")
+    f = Mutations::ArrayFilter.new(:simple_models, :class => "SimpleModel")
 
     m = SimpleModel.new
     filtered, errors = f.filter([m])
     assert_equal [m], filtered
-    assert_equal nil, errors
+    assert_nil errors
 
     Object.send(:remove_const, 'SimpleModel')
     class SimpleModel; end
@@ -259,7 +259,7 @@ describe "Mutations::ArrayFilter" do
     m = SimpleModel.new
     filtered, errors = f.filter([m])
     assert_equal [m], filtered
-    assert_equal nil, errors
+    assert_nil errors
 
     Mutations.cache_constants = was
   end

data/spec/boolean_filter_spec.rb

@@ -6,11 +6,11 @@ describe "Mutations::BooleanFilter" do
     f = Mutations::BooleanFilter.new
     filtered, errors = f.filter(true)
     assert_equal true, filtered
-    assert_equal nil, errors
+    assert_nil errors
 
     filtered, errors = f.filter(false)
     assert_equal false, filtered
-    assert_equal nil, errors
+    assert_nil errors
   end
 
   it "considers non-booleans to be invalid" do
@@ -24,15 +24,15 @@ describe "Mutations::BooleanFilter" do
   it "considers nil to be invalid" do
     f = Mutations::BooleanFilter.new(:nils => false)
     filtered, errors = f.filter(nil)
-    assert_equal nil, filtered
+    assert_nil filtered
     assert_equal :nils, errors
   end
 
   it "considers nil to be valid" do
     f = Mutations::BooleanFilter.new(:nils => true)
     filtered, errors = f.filter(nil)
-    assert_equal nil, filtered
-    assert_equal nil, errors
+    assert_nil filtered
+    assert_nil errors
   end
 
   it "considers certain strings to be valid booleans" do
@@ -40,7 +40,7 @@ describe "Mutations::BooleanFilter" do
     [["true", true], ["TRUE", true], ["TrUe", true], ["1", true], ["false", false], ["FALSE", false], ["FalSe", false], ["0", false], [0, false], [1, true]].each do |(str, v)|
       filtered, errors = f.filter(str)
       assert_equal v, filtered
-      assert_equal nil, errors
+      assert_nil errors
     end
   end
   

data/spec/command_spec.rb

@@ -8,16 +8,16 @@ describe "Command" do
       outcome = SimpleCommand.run(:name => "John", :email => "john@gmail.com", :amount => 5)
 
       assert outcome.success?
-      assert_equal ({:name => "John", :email => "john@gmail.com", :amount => 5}).stringify_keys, outcome.result
-      assert_equal nil, outcome.errors
+      assert_equal({:name => "John", :email => "john@gmail.com", :amount => 5}.stringify_keys, outcome.result)
+      assert_nil outcome.errors
     end
 
     it "should filter out spurious params" do
       outcome = SimpleCommand.run(:name => "John", :email => "john@gmail.com", :amount => 5, :buggers => true)
 
       assert outcome.success?
-      assert_equal ({:name => "John", :email => "john@gmail.com", :amount => 5}).stringify_keys, outcome.result
-      assert_equal nil, outcome.errors
+      assert_equal({:name => "John", :email => "john@gmail.com", :amount => 5}.stringify_keys, outcome.result)
+      assert_nil outcome.errors
     end
 
     it "should discover errors in inputs" do
@@ -29,7 +29,7 @@ describe "Command" do
 
     it "shouldn't throw an exception with run!" do
       result = SimpleCommand.run!(:name => "John", :email => "john@gmail.com", :amount => 5)
-      assert_equal ({:name => "John", :email => "john@gmail.com", :amount => 5}).stringify_keys, result
+      assert_equal({:name => "John", :email => "john@gmail.com", :amount => 5}.stringify_keys, result)
     end
 
     it "should throw an exception with run!" do
@@ -70,21 +70,21 @@ describe "Command" do
 
       assert !outcome.success?
       assert_equal :max_length, outcome.errors.symbolic[:name]
-      assert_equal nil, outcome.errors.symbolic[:email]
+      assert_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})
 
       assert outcome.success?
-      assert_equal ({:name => "John", :email => "bob@jones.com", :amount => 5}).stringify_keys, outcome.result
+      assert_equal({:name => "John", :email => "bob@jones.com", :amount => 5}.stringify_keys, outcome.result)
     end
 
     it "should merge hashes indifferently" do
       outcome = SimpleCommand.run({:name => "John", :email => "john@gmail.com"}, {"email" => "bob@jones.com", "amount" => 5})
 
       assert outcome.success?
-      assert_equal ({:name => "John", :email => "bob@jones.com", :amount => 5}).stringify_keys, outcome.result
+      assert_equal({:name => "John", :email => "bob@jones.com", :amount => 5}.stringify_keys, outcome.result)
     end
 
     it "shouldn't accept objects that are not hashes or directly mappable to hashes" do
@@ -104,14 +104,14 @@ describe "Command" do
     it 'should accept objects that are conceptually hashes' do
       class CustomPersonHash
         def to_hash
-          { name: 'John', email: 'john@example.com' }
+          { :name => 'John', :email => 'john@example.com' }
         end
       end
 
       outcome = SimpleCommand.run(CustomPersonHash.new)
 
       assert outcome.success?
-      assert_equal ({ name: "John", email: "john@example.com" }).stringify_keys, outcome.result
+      assert_equal({ :name => "John", :email => "john@example.com" }.stringify_keys, outcome.result)
     end
 
     it "should accept nothing at all" do
@@ -120,7 +120,7 @@ describe "Command" do
 
     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
+      assert_equal({:name => "John", :email => "john@gmail.com", :amount => 5}.stringify_keys, outcome.inputs)
     end
   end
 
@@ -137,7 +137,7 @@ describe "Command" do
 
     it "should define getter methods on params" do
       mutation = EigenCommand.run(:name => "John", :email => "john@gmail.com")
-      assert_equal ({:name => "John", :email => "john@gmail.com"}), mutation.result
+      assert_equal({:name => "John", :email => "john@gmail.com"}, mutation.result)
     end
   end
 
@@ -155,7 +155,7 @@ describe "Command" do
 
     it "should define setter methods on params" do
       mutation = MutatatedCommand.run(:name => "John", :email => "john@gmail.com")
-      assert_equal ({:name => "bob", :email => "bob@jones.com"}), mutation.result
+      assert_equal({:name => "bob", :email => "bob@jones.com"}, mutation.result)
     end
   end
 
@@ -183,8 +183,8 @@ describe "Command" do
 
   describe "CustomErrorKeyCommand" do
     class CustomErrorKeyCommand < Mutations::Command
-      required { string :name, error_key: :other_name }
-      optional { string :email, min_length: 4, error_key: :other_email }
+      required { string :name, :error_key => :other_name }
+      optional { string :email, :min_length => 4, :error_key => :other_email }
     end
 
     it "should return the optional error key in the error message if required" do
@@ -196,7 +196,7 @@ describe "Command" do
     end
 
     it "should return the optional error key in the error message if optional" do
-      outcome = CustomErrorKeyCommand.run(email: "foo")
+      outcome = CustomErrorKeyCommand.run(:email => "foo")
 
       assert !outcome.success?
       assert_equal :min_length, outcome.errors.symbolic[:email]
@@ -223,6 +223,7 @@ describe "Command" do
       assert !outcome.success?
       assert_nil outcome.result
       assert_equal :is_a_bob, outcome.errors[:people].symbolic[:bob]
+      assert_equal "Bob is invalid", outcome.errors[:people].message[:bob]
     end
   end