Merge pull request #9 from rdok/develop

Develop

.busted

@@ -1,5 +1,6 @@
 return {
  _all = {
- helper = 'tests/bootstrap.lua'
+ helper = 'tests/bootstrap.lua',
+ ROOT = {'tests'},
  }
 }

.travis.yml

@@ -8,4 +8,4 @@ before_install:
 
 script:
  - sudo chmod +x docker/busted/entry-point.sh
- - docker-compose run --rm busted  tests -v
+ - docker-compose run --rm busted -v

src/Command.lua

@@ -9,7 +9,7 @@ Command = {
  return Pomodoro.new()
  end
 
- return HelpPage.new()
+ return HelpPage.print()
  end
 }
 

src/HelpPage.lua

@@ -1,6 +1,5 @@
 HelpPage = {
-
- new = function()
+ print = function()
  -- Not using loop due to lua not guarantying any iteration order
  -- TODO: find package offering this functionality when this table becomes
  -- hard to maintain
@@ -11,3 +10,4 @@ HelpPage = {
  CHAT_SYSTEM.AddMessage(CHAT_SYSTEM, '> stop Stop the current Pomodoro.')
  end
 }
+

src/Listener.lua

@@ -7,5 +7,4 @@ Listener = {
  dispatch = function()
  d(os.date("%d.%m.%Y %H:%M:%S"))
  end
-}
-
+}

src/Pomodoro.lua

@@ -1,10 +1,28 @@
 Pomodoro = {
+ duration = 1500, -- Seconds = 25 minutes
  new = function()
- pomodoro = {}
- pomodoro.startedAt = os.time()
+ local pomodoro = Pomodoro
+ pomodoro.createdAt = os.time()
+ pomodoro.completedAt = nil
+
  CHAT_SYSTEM.AddMessage(CHAT_SYSTEM, 'Pomodoro started.')
 
  return pomodoro
- end
-}
+ end,
+
+ ping = function(self)
+ if (self.completedAt ~= nil) then
+ error("Error: Attempting to re-check finished Pomodoro. \nPlease report this at https://git.io/fjO3p")
+ end
+
+ local time = os.time()
+ local currentDuration = time - self.createdAt
 
+ if (currentDuration >= Pomodoro.duration) then
+ self.completedAt = time
+ CHAT_SYSTEM.AddMessage(CHAT_SYSTEM, 'Pomodoro finished.')
+ end
+
+ return pomodoro
+ end,
+}

tests/Acceptance/HelpPomodoro_spec.lua

@@ -1,12 +1,12 @@
 describe("Help Page:", function()
- -- See https://github.com/rdok/eso-pomodoro/issues/3
+ -- https://github.com/rdok/eso-pomodoro/issues/3
 
  it("A player may request the command's help page", function()
  -- Given I am acting as a player
- local player = require('Player')
+ require('Player')
 
  -- When I request the help page
- player:callHelpPage()
+ Player:callHelpPage()
 
  -- Then i should see in the chat window a line from the help page
  assert.chat_window_contains('Usage: pomodoro COMMAND')

tests/Acceptance/StartPomodoro_spec.lua

@@ -1,12 +1,12 @@
 describe("Start pomodoro:", function()
- -- See https://github.com/rdok/eso-pomodoro/issues/3
+ -- https://github.com/rdok/eso-pomodoro/issues/7
 
  it("a player may start a pomodoro", function()
  -- Given I am acting as a player
- local player = require('Player')
+ require('Player')
 
  -- When I start a new pomodoro
- player:callStartPomodoro()
+ Player:callStartPomodoro()
 
  -- Then i should see in the chat window message about the new pomodoro
  assert.chat_window_contains('Pomodoro started.')

tests/Acceptance/StopPomodoro_spec.lua

@@ -0,0 +1,17 @@
+describe("Stop pomodoro:", function()
+
+ pending("a player may stop a pomodoro", function()
+ -- Given I am acting as a player
+ require('Player')
+
+ -- And I have started a pomodoro
+ Player.callStartPomodoro()
+
+ -- When I stop the pomodoro
+ Player.callStopPomodoro()
+
+ -- Then i should see in the chat window message about the new pomodoro
+ assert.chat_window_contains('Pomodoro stopped.')
+ end)
+
+end)

tests/Unit/Command_spec.lua

@@ -5,20 +5,20 @@ describe("Command", function()
  end)
 
  it("may initialize the help page", function()
- spy.on(HelpPage, "new")
+ spy.on(HelpPage, "print")
  Command.call()
- assert.spy(HelpPage.new).was_called()
+ assert.spy(HelpPage.print).was_called()
  end)
 
  it("may initialize the help page with 'help' argument", function()
- spy.on(HelpPage, "new")
+ spy.on(HelpPage, "print")
  Command.call('help')
- assert.spy(HelpPage.new).was_called()
+ assert.spy(HelpPage.print).was_called()
  end)
 
  it("may initialize a new pomodoro with 'start' argument", function()
  spy.on(Pomodoro, "new")
  Command.call('start')
- assert.spy(Pomodoro.new).was_called()
+ assert.stub(Pomodoro.new).was_called()
  end)
 end)

tests/Unit/HelpPage_spec.lua

@@ -10,7 +10,7 @@ describe("HelpPage", function()
 
  it("should print the help page to the chat system upon initialization", function()
  spy.on(CHAT_SYSTEM, "AddMessage")
- HelpPage.new()
+ HelpPage.print()
  for section, description in pairs(helpMessages) do
  assert.spy(CHAT_SYSTEM.AddMessage).was_called_with(CHAT_SYSTEM, description)
  end

tests/Unit/Pomodoro_spec.lua

@@ -8,11 +8,35 @@ describe("Pomodoro", function()
  end)
 
  it("should store the time the pomodoro started", function()
- local pomodoro = Pomodoro.new()
- assert.is_valid_time(pomodoro.startedAt)
+ local pomodoro = Pomodoro:new()
+ assert.is_valid_time(pomodoro.createdAt)
  end)
 
- --it("should error if pomodoro hasn't started", function()
- -- pending("should error if pomodoro hasn't started")
- --end)
+ it("should print message when pomodoro is completed.", function()
+ local pomodoro = Pomodoro:new()
+ pomodoro.createdAt = os.time() - 1500
+
+ spy.on(CHAT_SYSTEM, "AddMessage")
+ pomodoro:ping()
+ assert.spy(CHAT_SYSTEM.AddMessage)
+ .was_called_with(CHAT_SYSTEM, 'Pomodoro finished.')
+ end)
+
+ it("should not print completion message if pomodoro hasn't finished.", function()
+ local pomodoro = Pomodoro:new()
+ pomodoro.createdAt = os.time() - 1499
+
+ spy.on(CHAT_SYSTEM, "AddMessage")
+ pomodoro:ping()
+ assert.spy(CHAT_SYSTEM.AddMessage).was.not_called()
+ end)
+
+ it("should error when pomodoro has already been completed", function()
+ local pomodoro = Pomodoro:new()
+ pomodoro.completedAt = os.time()
+
+ assert.has_error(function()
+ pomodoro:ping()
+ end, "Error: Attempting to re-check finished Pomodoro. \nPlease report this at https://git.io/fjO3p")
+ end)
 end)

tests/_support/Assertions/ChatWindowAssertion.lua

@@ -3,7 +3,7 @@ local say = require("say")
 
 -- Consider instance of table a table that has the same functions key names
 local function chat_window_contains(state, arguments)
- if not type(arguments[1]) == "table" or #arguments ~= 1 then
+ if #arguments ~= 1 or not type(arguments[1]) == "string" then
  return false
  end
 

tests/_support/Player.lua

@@ -1,12 +1,14 @@
 -- Mock player. That is, the eso engine acting in behalf of the user.
-local Player = {}
+Player = {
+ callHelpPage = function()
+ Command.call()
+ end,
 
-function Player:callHelpPage()
- Command.call()
-end
+ callStartPomodoro = function()
+  Command.call('start')
+ end,
 
-function Player:callStartPomodoro()
- Command.call('start')
-end
-
-return Player
+ callStopPomodoro = function()
+ Command.call('start')
+ end,
+}