Added mach.any. Closes #18.

Author: ryanplusplus

README.md

@@ -57,6 +57,16 @@ mocked_object.foo:should_be_called():when(function()
 end)
 ```
 
+## Ignoring Arguments
+
+```lua
+local mach = require 'mach'
+
+local f = mach.mock_function('f')
+
+f:should_be_called_with_any_arguments():when(function() f('any', 'args', 'are', 'fine') end)
+```
+
 ## Returning Values
 
 ```lua
@@ -104,7 +114,7 @@ local mach = require 'mach'
 
 local f = mach.mock_function('f')
 
-f:mayBeCalled():when(function() end)
+f:may_be_called():when(function() end)
 ```
 
 ## Optional Ordering
@@ -180,7 +190,20 @@ f:should_be_called_with(mach.match({ 1, 2, 3 }, custom_matcher)):
   end)
 ```
 
-## Ignoring Other calls
+## Matching Any Single Argument
+
+```lua
+local mach = require 'mach'
+
+local f = mach.mockFunction();
+
+f:should_be_called_with(mach.any, 42):
+  when(function()
+    f({ 'whatever' }, 42)
+  end)
+```
+
+## Ignoring Other Calls
 
 ```javascript
 local mach = require 'mach'

rockspecs/mach-git-0.rockspec

@@ -25,5 +25,6 @@ build = {
     ['mach.format_arguments'] = 'mach/format_arguments.lua',
     ['mach.deep_compare_matcher'] = 'mach/deep_compare_matcher.lua',
     ['mach.match'] = 'mach/match.lua',
+    ['mach.any'] = 'mach/any.lua',
   }
 }

spec/mach_spec.lua

@@ -671,4 +671,18 @@ describe('The mach library', function()
       end)
     end)
   end)
+
+  it('should match any argument with mach.any', function()
+    f:should_be_called_with(mach.any, 2, 3):when(function()
+      f({ a = 11, b = 22 }, 2, 3)
+    end)
+  end)
+
+  it('should match other arguments when mach.any is used for an argument', function()
+    should_fail(function()
+      f:should_be_called_with(mach.any, 2, 3):when(function()
+        f(false, 2, 4)
+      end)
+    end)
+  end)
 end)

src/mach.lua

@@ -6,6 +6,8 @@ local mach_match = require 'mach.match'
 
 local mach = {}
 
+mach.any = require 'mach.any'
+
 function unexpected_call(m, name, args)
   unexpected_call_error(name, args, {}, {}, 2)
 end

src/mach/CompletedCall.lua

@@ -1,13 +1,10 @@
+local format_arguments = require 'mach.format_arguments'
+
 local completed_call = {}
 completed_call.__index = completed_call
 
 completed_call.__tostring = function(self)
-  local arg_strings = {}
-  for _, arg in ipairs(self._args) do
-    table.insert(arg_strings, tostring(arg))
-  end
-
-  return self._name .. '(' .. table.concat(arg_strings, ', ') .. ')'
+  return self._name .. format_arguments(self._args)
 end
 
 local function create(name, args)

src/mach/ExpectedCall.lua

@@ -1,15 +1,12 @@
 local mach_match = require 'mach.match'
+local mach_any = require 'mach.any'
+local format_arguments = require 'mach.format_arguments'
 
 local expected_call = {}
 expected_call.__index = expected_call
 
 expected_call.__tostring = function(self)
-  local arg_strings = {}
-  for _, arg in ipairs(self._args) do
-    table.insert(arg_strings, tostring(arg))
-  end
-
-  local s = self._f._name .. '(' .. table.concat(arg_strings, ', ') .. ')'
+  local s = self._f._name .. format_arguments(self._args)
 
   if not self._required then
     s = s .. ' (optional)'
@@ -41,10 +38,10 @@ function expected_call:args_match(args)
   if self._ignore_args then return true end
   if #self._args ~= #args then return false end
 
-  for k in ipairs(self._args) do
-    if getmetatable(self._args[k]) == mach_match then
-      if not self._args[k].matcher(self._args[k].value, args[k]) then return false end
-    elseif self._args[k] ~= args[k] then
+  for i = 1, self._args.n do
+    if getmetatable(self._args[i]) == mach_match then
+      if not self._args[i].matcher(self._args[i].value, args[i]) then return false end
+    elseif self._args[i] ~= mach_any and self._args[i] ~= args[i] then
       return false
     end
   end

src/mach/any.lua

@@ -0,0 +1 @@
+return {}

src/mach/format_arguments.lua

@@ -1,7 +1,7 @@
 return function(args)
   local arg_strings = {}
-  for _, arg in ipairs(args) do
-    table.insert(arg_strings, tostring(arg))
+  for i = 1, args.n do
+    table.insert(arg_strings, tostring(args[i]))
   end
 
   return '(' .. table.concat(arg_strings, ', ') .. ')'