Updated to conform to olivine labs' style guide

Author: ryanplusplus

README.md

@@ -8,9 +8,9 @@ Simple mocking framework for Lua inspired by CppUMock and designed for readabili
 ```lua
 mach = require 'mach'
 
-local f = mach.mockFunction()
+local f = mach.mock_function()
 
-mach(f):shouldBeCalled():
+mach(f):should_be_called():
 when(function() f() end)
 ```
 
@@ -20,9 +20,9 @@ when(function() f() end)
 mach = require 'mach'
 
 local o = {}
-o.m = mach.mockMethod()
+o.m = mach.mach_method()
 
-mach(m):shouldBeCalled():
+mach(m):should_be_called():
 when(function() o:m() end)
 ```
 
@@ -31,42 +31,42 @@ when(function() o:m() end)
 ```lua
 mach = require 'mach'
 
-local someTable = {
+local some_table = {
   foo = function() end,
   bar = function() end
 }
 
-mockedTable = mach.mockTable(someTable)
+mocked_table = mach.mockTable(some_table)
 
-mach(mockedTable.foo):shouldBeCalled():
-when(function() mockedTable.foo() end)
+mach(mocked_table.foo):should_be_called():
+when(function() mocked_table.foo() end)
 ```
 
 ## Mocking an Object
 
 ```lua
 mach = require 'mach'
 
-local someObject = {}
-function someObject:foo() end
-function someObject:bar() end
+local some_object = {}
+function some_object:foo() end
+function some_object:bar() end
 
-mockedObject = mach.mockObject(someObject)
+mocked_object = mach.mock_object(some_object)
 
-mach(mockedObject.foo):shouldBeCalled():
-when(function() mockedObject:foo() end)
+mach(mocked_object.foo):should_be_called():
+when(function() mocked_object:foo() end)
 ```
 
 ## Multiple Expectations
 
 ```lua
 mach = require 'mach'
 
-local f1 = mach.mockFunction()
-local f2 = mach.mockFunction()
+local f1 = mach.mock_function()
+local f2 = mach.mock_function()
 
-mach(f1):shouldBeCalled():
-andAlso(mach(f2):shouldBeCalled()):
+mach(f1):should_be_called():
+and_also(mach(f2):should_be_called()):
 when(function() f1(); f2() end)
 ```
 
@@ -75,7 +75,7 @@ when(function() f1(); f2() end)
 ```lua
 mach = require 'mach'
 
-local f = mach.mockFunction()
+local f = mach.mock_function()
 
 mach(f):mayBeCalled():
 when(function() end)
@@ -86,21 +86,21 @@ when(function() end)
 ```lua
 mach = require 'mach'
 
-local f = mach.mockFunction()
+local f = mach.mock_function()
 
--- Use andAlso when order is important
-mach(f):shouldBeCalledWith(1):
-andThen(mach(f):shouldBeCalledWith(2)):
+-- Use and_also when order is important
+mach(f):should_be_calledWith(1):
+andThen(mach(f):should_be_calledWith(2)):
 when(function()
   f(2) -- Error, out of order call
   f(1)
 end)
 
--- Use andAlso when order is unimportant
-mach(f):shouldBeCalledWith(1):
-andAlso(mach(f):shouldBeCalledWith(2)):
+-- Use and_also when order is unimportant
+mach(f):should_be_calledWith(1):
+and_also(mach(f):should_be_calledWith(2)):
 when(function()
-  f(2) -- No error, order is not fixed when 'andAlso' is used
+  f(2) -- No error, order is not fixed when 'and_also' is used
   f(1)
 end)
 ```
@@ -110,12 +110,12 @@ end)
 ```lua
 mach = require 'mach'
 
-local f = mach.mockFunction()
+local f = mach.mock_function()
 
-mach(f):shouldBeCalledWith(1):
-andAlso(mach(f):shouldBeCalledWith(2)):
-andThen(mach(f):shouldBeCalledWith(3)):
-andAlso(mach(f):shouldBeCalledWith(4)):
+mach(f):should_be_calledWith(1):
+and_also(mach(f):should_be_calledWith(2)):
+andThen(mach(f):should_be_calledWith(3)):
+and_also(mach(f):should_be_calledWith(4)):
 when(function()
   f(2)
   f(1)
@@ -129,24 +129,24 @@ end)
 ```lua
 mach = require 'mach'
 
-local m1 = mach.mockFunction()
-local m2 = mach.mockFunction()
+local m1 = mach.mock_function()
+local m2 = mach.mock_function()
 
-function somethingShouldHappen()
-  return mach(m1):shouldBeCalled()
+function something_should_happen()
+  return mach(m1):should_be_called()
 end
 
-function anotherThingShouldHappen()
-  return mach(m2):shouldBeCalledWith(1, 2, 3)
+function another_thing_should_happen()
+  return mach(m2):should_be_calledWith(1, 2, 3)
 end
 
-function theCodeUnderTestRuns()
+function the_code_under_test_runs()
   m1()
   m2(1, 2, 3)
 end
 
 -- Actual test:
-somethingShouldHappen():
-andAlso(anotherThingShouldHappen()):
-when(theCodeUnderTestRuns)
+something_should_happen():
+and_also(another_thing_should_happen()):
+when(the_code_under_test_runs)
 ```