mutations 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8bff02ac61eeda799b03898f3e376a661b96396d
-  data.tar.gz: 79b7261aa23b98f03130c7a102643659045bf75e
+SHA256:
+  metadata.gz: f9df957aca8cdb7ad065a71ade7fb1ccf48091e025e73f395822f53dab1de255
+  data.tar.gz: a6a3df2daca41bb6886bc76c75027f28d131c483d69120a10a5b108c79f549c7
 SHA512:
-  metadata.gz: 602de12b62d392455d81710757f7461c40239e0a625dd3908a8f1e9ab16c13d94153c5e60f10cbef833b0c88ee5d103771352e147e33949d70a260a856a1326a
-  data.tar.gz: e379aafc135a683190577f75644f283958092e670bfac3522e1ed4cdfe718cd207183d657b7f95de4600a4e4c6eed6d58834b3835bedb6b9615601d7231b5329
+  metadata.gz: e4ba37c6965c370d1d5cf39a28dcdb1a854e72ca0ad7ae91c5612bce03d2c35e09431eb21ffc4e46ec212d3806a89562517fea37eba2fdfce3683cfae0a0bb21
+  data.tar.gz: 5ed2f4404656a7646dbfb93a69f2bc7008c5182d44e2bb66e3e1ba9a259cd100c56e4849cb6ec5bd923d919db2aee25c2a8d7888862066f15e0b763a28bc67f2

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.8.2
+-----------
+ - Add `:error_key` filter option to allow error messages to be customised. (#115, @mwhatters)
+ - Accept hash inputs that respond to `to_hash`. (#126, @antoniobg)
+
 0.8.1
 -----------
  - Ruby 2.4 support added

data/lib/mutations/command.rb

@@ -56,7 +56,7 @@ module Mutations
     # Instance methods
     def initialize(*args)
       @raw_inputs = args.inject({}.with_indifferent_access) do |h, arg|
-        raise ArgumentError.new("All arguments must be hashes") unless arg.is_a?(Hash)
+        raise ArgumentError.new("All arguments must be hashes") unless arg.respond_to?(:to_hash)
         h.merge!(arg)
       end
 

data/lib/mutations/hash_filter.rb

@@ -79,11 +79,11 @@ module Mutations
       end
 
       # Ensure it's a hash
-      return [data, :hash] unless data.is_a?(Hash)
+      return [data, :hash] unless data.respond_to?(:to_hash)
 
-      # We always want a hash with indiffernet access
+      # We always want a hash with indifferent access
       unless data.is_a?(HashWithIndifferentAccess)
-        data = data.with_indifferent_access
+        data = data.to_hash.with_indifferent_access
       end
 
       errors = ErrorHash.new
@@ -113,16 +113,18 @@ module Mutations
             elsif !is_required && sub_error == :nils && filterer.discard_nils?
               data.delete(key)
             else
-              sub_error = ErrorAtom.new(key, sub_error) if sub_error.is_a?(Symbol)
+              error_key = filterer.options[:error_key] || key
+              sub_error = ErrorAtom.new(error_key, sub_error) if sub_error.is_a?(Symbol)
               errors[key] = sub_error
             end
           end
-          
+
           if !data.has_key?(key)
             if filterer.has_default?
               filtered_data[key] = filterer.default
             elsif is_required
-              errors[key] = ErrorAtom.new(key, :required)
+              error_key = filterer.options[:error_key] || key
+              errors[key] = ErrorAtom.new(error_key, :required)
             end
           end
         end

data/lib/mutations/version.rb

@@ -1,3 +1,3 @@
 module Mutations
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 end

data/spec/command_spec.rb

@@ -59,12 +59,12 @@ describe "Command" do
 
     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")
 
@@ -87,7 +87,7 @@ describe "Command" do
       assert_equal ({:name => "John", :email => "bob@jones.com", :amount => 5}).stringify_keys, outcome.result
     end
 
-    it "shouldn't accept non-hashes" do
+    it "shouldn't accept objects that are not hashes or directly mappable to hashes" do
       assert_raises ArgumentError do
         SimpleCommand.run(nil)
       end
@@ -101,6 +101,19 @@ describe "Command" do
       end
     end
 
+    it 'should accept objects that are conceptually hashes' do
+      class CustomPersonHash
+        def to_hash
+          { 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
+    end
+
     it "should accept nothing at all" do
       SimpleCommand.run # make sure nothing is raised
     end
@@ -168,6 +181,29 @@ describe "Command" do
     end
   end
 
+  describe "CustomErrorKeyCommand" do
+    class CustomErrorKeyCommand < Mutations::Command
+      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
+      outcome = CustomErrorKeyCommand.run
+
+      assert !outcome.success?
+      assert_equal :required, outcome.errors.symbolic[:name]
+      assert_equal "Other Name is required", outcome.errors.message[:name]
+    end
+
+    it "should return the optional error key in the error message if optional" do
+      outcome = CustomErrorKeyCommand.run(email: "foo")
+
+      assert !outcome.success?
+      assert_equal :min_length, outcome.errors.symbolic[:email]
+      assert_equal "Other Email is too short", outcome.errors.message[:email]
+    end
+  end
+
   describe "NestingErrorfulCommand" do
     class NestingErrorfulCommand < Mutations::Command
 

data/spec/hash_filter_spec.rb

@@ -20,6 +20,18 @@ describe "Mutations::HashFilter" do
     assert_equal :hash, errors
   end
 
+  it "allows non-hashes that implement #to_hash" do
+    input = Object.new
+    def input.to_hash
+      {:foo => "bar"}
+    end
+    hf = Mutations::HashFilter.new do
+      string :foo
+    end
+    _filtered, errors = hf.filter(input)
+    assert_equal nil, errors
+  end
+
   it "allows wildcards in hashes" do
     hf = Mutations::HashFilter.new do
       string :*

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mutations
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Jonathan Novak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2018-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Compose your business logic into commands that sanitize and validate input.