session_countdown 0.4.0 → 0.5.0

data/README.rdoc

@@ -5,13 +5,18 @@
 A Ruby on Rails plugin that puts a countdown timer on the session
 object.
 
-  session.countdown_start(30.minutes)
+  session.countdown_start(1.hour)
+  session.countdown_count #=> 3600
   session.countdown_running? # => true
-  session.countdown_expire
+  # 60 minutes pass
+  session.countdown_count #=> 0
   session.countdown_running? # => false
   session.countdown_expired? # => true
   session.countdown_restart
   session.countdown_running? # => true
+  session.countdown_abort
+  session.countdown_running? # => false
+  session.countdown_expired? # => false
 
 === But why?!?
 
@@ -26,7 +31,7 @@ authentication stuff, so why not combine the two?
 == API
 
 
-<i>Note that countdown_expire(), countdown_restart() and
+<i>Note that countdown_abort(), countdown_restart() and
 countdown_count() will throw a NoCountdown exception if called on a
 non-existent countdown timer.</i>
 
@@ -43,7 +48,7 @@ Check if a countdown timer exists and is currently running
 
 Expire early (i.e. logout)
 
-   session.countdown_expire(name = :default)
+   session.countdown_abort(name = :default)
 
 Restart, using the duration supplied to countdown_start
 
@@ -101,7 +106,7 @@ Understanding timer running, expired, and never started
   end
 
   def logout
-    session.countdown_expire
+    session.countdown_abort
     flash[:notice] = "You are now logged out"
     redirect_to :index
   end

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/created.rid

@@ -1 +1 @@
-Fri, 06 Aug 2010 09:30:21 -0400
+Fri, 06 Aug 2010 10:45:22 -0400

data/lib/session_countdown.rb

@@ -39,8 +39,8 @@ module SessionCountdown
 
   ## these methods all require a sanity check for existing countdown
 
-  def _countdown_expire(name = @@default_name)
-    self[get_zero_key(name)] = Time.now
+  def _countdown_abort(name = @@default_name)
+    self[get_zero_key(name)] = nil
   end
 
   def _countdown_restart(name = @@default_name)
@@ -65,7 +65,9 @@ module SessionCountdown
   end
 
   def insist_countdown_exists(name = @@default_name)
-    unless self[get_zero_key(name)]
+    # We use delta_key here because timer might have been nil'd by
+    # aborting, but it still should be restartable.
+    unless self[get_zero_delta_key(name)]
       raise NoCountdown, "no session countdown named '#{name}'"
     end
   end

data/session_countdown.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{session_countdown}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Swope"]

data/test/common/test_controller_test.rb

@@ -21,10 +21,10 @@ class TestControllerTest < ActionController::TestCase
     assert session.countdown_running?
     assert ! session.countdown_expired?
 
-    session.countdown_expire
+    session.countdown_abort
 
     assert ! session.countdown_running?
-    assert session.countdown_expired?
+    assert ! session.countdown_expired?
 
     session.countdown_restart
     assert ! session.countdown_expired?
@@ -45,9 +45,9 @@ class TestControllerTest < ActionController::TestCase
     assert ! session.countdown_expired?
 
     # with countdown expired
-    session.countdown_expire
+    session.countdown_abort
     assert ! session.countdown_running?
-    assert session.countdown_expired?
+    assert ! session.countdown_expired?
 
   end
 
@@ -59,27 +59,27 @@ class TestControllerTest < ActionController::TestCase
     session.countdown_start(1.minute)
     session.countdown_start(1.minute, :admin)
 
-    ## expire default counter
+    ## abort default counter
 
     assert session.countdown_running?
-    session.countdown_expire
+    session.countdown_abort
     assert ! session.countdown_running?
-    assert session.countdown_expired?
+    assert ! session.countdown_expired?
 
-    ## expire admin counter
+    ## abort admin counter
 
     assert session.countdown_running?(:admin)
-    session.countdown_expire(:admin)
+    session.countdown_abort(:admin)
     assert ! session.countdown_running?(:admin)
-    assert session.countdown_expired?(:admin)
+    assert ! session.countdown_expired?(:admin)
 
     ## mixing calls to both timers
 
     session.countdown_start(1.minute)
     assert session.countdown_running?()
     assert ! session.countdown_running?(:admin)
-    session.countdown_expire
-    assert session.countdown_expired?(:admin)
+    session.countdown_abort
+    assert ! session.countdown_expired?(:admin)
     session.countdown_restart(:admin)
     assert session.countdown_running?(:admin)
     assert ! session.countdown_expired?(:admin)
@@ -129,13 +129,13 @@ class TestControllerTest < ActionController::TestCase
     # restart, expire and count require an existing countdown, should
     # throw exception if there isn't one
 
-    assert_raise(NoCountdown) { session.countdown_expire }
+    assert_raise(NoCountdown) { session.countdown_abort }
     assert_raise(NoCountdown) { session.countdown_restart }
     assert_raise(NoCountdown) { session.countdown_count }
 
     ## try with named countdown
 
-    assert_raise(NoCountdown) { session.countdown_expire(:admin) }
+    assert_raise(NoCountdown) { session.countdown_abort(:admin) }
     assert_raise(NoCountdown) { session.countdown_restart(:admin) }
     assert_raise(NoCountdown) { session.countdown_count(:admin) }
 
@@ -163,13 +163,18 @@ class TestControllerTest < ActionController::TestCase
   # copied from README, mostly checking spelling
   test "rdoc example" do
 
-    session.countdown_start(30.minutes)
-    session.countdown_running? # => true
-    session.countdown_expire
-    session.countdown_running? # => false
-    session.countdown_expired? # => true
+    session.countdown_start(1.hour)
+    assert (3599 < session.countdown_count)
+    assert session.countdown_running?
+    Timecop.travel(60.minute)
+    assert_equal 0, session.countdown_count
+    assert ! session.countdown_running?
+    assert session.countdown_expired?
     session.countdown_restart
-    session.countdown_running? # => true
+    assert session.countdown_running?
+    session.countdown_abort
+    assert ! session.countdown_running?
+    assert ! session.countdown_expired?
 
   end
 

data/test/rails2x_root/test/functional/test_controller_test.rb

@@ -21,10 +21,10 @@ class TestControllerTest < ActionController::TestCase
     assert session.countdown_running?
     assert ! session.countdown_expired?
 
-    session.countdown_expire
+    session.countdown_abort
 
     assert ! session.countdown_running?
-    assert session.countdown_expired?
+    assert ! session.countdown_expired?
 
     session.countdown_restart
     assert ! session.countdown_expired?
@@ -45,9 +45,9 @@ class TestControllerTest < ActionController::TestCase
     assert ! session.countdown_expired?
 
     # with countdown expired
-    session.countdown_expire
+    session.countdown_abort
     assert ! session.countdown_running?
-    assert session.countdown_expired?
+    assert ! session.countdown_expired?
 
   end
 
@@ -59,27 +59,27 @@ class TestControllerTest < ActionController::TestCase
     session.countdown_start(1.minute)
     session.countdown_start(1.minute, :admin)
 
-    ## expire default counter
+    ## abort default counter
 
     assert session.countdown_running?
-    session.countdown_expire
+    session.countdown_abort
     assert ! session.countdown_running?
-    assert session.countdown_expired?
+    assert ! session.countdown_expired?
 
-    ## expire admin counter
+    ## abort admin counter
 
     assert session.countdown_running?(:admin)
-    session.countdown_expire(:admin)
+    session.countdown_abort(:admin)
     assert ! session.countdown_running?(:admin)
-    assert session.countdown_expired?(:admin)
+    assert ! session.countdown_expired?(:admin)
 
     ## mixing calls to both timers
 
     session.countdown_start(1.minute)
     assert session.countdown_running?()
     assert ! session.countdown_running?(:admin)
-    session.countdown_expire
-    assert session.countdown_expired?(:admin)
+    session.countdown_abort
+    assert ! session.countdown_expired?(:admin)
     session.countdown_restart(:admin)
     assert session.countdown_running?(:admin)
     assert ! session.countdown_expired?(:admin)
@@ -129,13 +129,13 @@ class TestControllerTest < ActionController::TestCase
     # restart, expire and count require an existing countdown, should
     # throw exception if there isn't one
 
-    assert_raise(NoCountdown) { session.countdown_expire }
+    assert_raise(NoCountdown) { session.countdown_abort }
     assert_raise(NoCountdown) { session.countdown_restart }
     assert_raise(NoCountdown) { session.countdown_count }
 
     ## try with named countdown
 
-    assert_raise(NoCountdown) { session.countdown_expire(:admin) }
+    assert_raise(NoCountdown) { session.countdown_abort(:admin) }
     assert_raise(NoCountdown) { session.countdown_restart(:admin) }
     assert_raise(NoCountdown) { session.countdown_count(:admin) }
 
@@ -163,13 +163,18 @@ class TestControllerTest < ActionController::TestCase
   # copied from README, mostly checking spelling
   test "rdoc example" do
 
-    session.countdown_start(30.minutes)
-    session.countdown_running? # => true
-    session.countdown_expire
-    session.countdown_running? # => false
-    session.countdown_expired? # => true
+    session.countdown_start(1.hour)
+    assert (3599 < session.countdown_count)
+    assert session.countdown_running?
+    Timecop.travel(60.minute)
+    assert_equal 0, session.countdown_count
+    assert ! session.countdown_running?
+    assert session.countdown_expired?
     session.countdown_restart
-    session.countdown_running? # => true
+    assert session.countdown_running?
+    session.countdown_abort
+    assert ! session.countdown_running?
+    assert ! session.countdown_expired?
 
   end
 

data/test/rails3x_root/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/kevin/Development/session_countdown
   specs:
-    session_countdown (0.3.0)
+    session_countdown (0.4.0)
 
 GEM
   remote: http://rubygems.org/

data/test/rails3x_root/test/functional/test_controller_test.rb

@@ -21,10 +21,10 @@ class TestControllerTest < ActionController::TestCase
     assert session.countdown_running?
     assert ! session.countdown_expired?
 
-    session.countdown_expire
+    session.countdown_abort
 
     assert ! session.countdown_running?
-    assert session.countdown_expired?
+    assert ! session.countdown_expired?
 
     session.countdown_restart
     assert ! session.countdown_expired?
@@ -45,9 +45,9 @@ class TestControllerTest < ActionController::TestCase
     assert ! session.countdown_expired?
 
     # with countdown expired
-    session.countdown_expire
+    session.countdown_abort
     assert ! session.countdown_running?
-    assert session.countdown_expired?
+    assert ! session.countdown_expired?
 
   end
 
@@ -59,27 +59,27 @@ class TestControllerTest < ActionController::TestCase
     session.countdown_start(1.minute)
     session.countdown_start(1.minute, :admin)
 
-    ## expire default counter
+    ## abort default counter
 
     assert session.countdown_running?
-    session.countdown_expire
+    session.countdown_abort
     assert ! session.countdown_running?
-    assert session.countdown_expired?
+    assert ! session.countdown_expired?
 
-    ## expire admin counter
+    ## abort admin counter
 
     assert session.countdown_running?(:admin)
-    session.countdown_expire(:admin)
+    session.countdown_abort(:admin)
     assert ! session.countdown_running?(:admin)
-    assert session.countdown_expired?(:admin)
+    assert ! session.countdown_expired?(:admin)
 
     ## mixing calls to both timers
 
     session.countdown_start(1.minute)
     assert session.countdown_running?()
     assert ! session.countdown_running?(:admin)
-    session.countdown_expire
-    assert session.countdown_expired?(:admin)
+    session.countdown_abort
+    assert ! session.countdown_expired?(:admin)
     session.countdown_restart(:admin)
     assert session.countdown_running?(:admin)
     assert ! session.countdown_expired?(:admin)
@@ -129,13 +129,13 @@ class TestControllerTest < ActionController::TestCase
     # restart, expire and count require an existing countdown, should
     # throw exception if there isn't one
 
-    assert_raise(NoCountdown) { session.countdown_expire }
+    assert_raise(NoCountdown) { session.countdown_abort }
     assert_raise(NoCountdown) { session.countdown_restart }
     assert_raise(NoCountdown) { session.countdown_count }
 
     ## try with named countdown
 
-    assert_raise(NoCountdown) { session.countdown_expire(:admin) }
+    assert_raise(NoCountdown) { session.countdown_abort(:admin) }
     assert_raise(NoCountdown) { session.countdown_restart(:admin) }
     assert_raise(NoCountdown) { session.countdown_count(:admin) }
 
@@ -163,13 +163,18 @@ class TestControllerTest < ActionController::TestCase
   # copied from README, mostly checking spelling
   test "rdoc example" do
 
-    session.countdown_start(30.minutes)
-    session.countdown_running? # => true
-    session.countdown_expire
-    session.countdown_running? # => false
-    session.countdown_expired? # => true
+    session.countdown_start(1.hour)
+    assert (3599 < session.countdown_count)
+    assert session.countdown_running?
+    Timecop.travel(60.minute)
+    assert_equal 0, session.countdown_count
+    assert ! session.countdown_running?
+    assert session.countdown_expired?
     session.countdown_restart
-    session.countdown_running? # => true
+    assert session.countdown_running?
+    session.countdown_abort
+    assert ! session.countdown_running?
+    assert ! session.countdown_expired?
 
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: session_countdown
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Kevin Swope