tick_tacker 0.1.2 → 0.1.3

data/examples/cowntdown.rb

@@ -0,0 +1,26 @@
+$: << "../lib"
+require 'tick_tacker'
+
+class Cowntdown
+  def initialize
+    @timer = TickTacker::Timer.new.with :total_time => 5.seconds
+    @timer.add_observer self
+    Thread.new {
+      @timer.start
+    }
+    6.times do
+      do_nothing
+    end
+  end
+
+  def do_nothing
+    puts "this is the cowntdown doing another things, nothing to be more precisely."
+    sleep(1)
+  end
+
+  def update(options)
+    puts "time remaining: #{options[:time_remaining]}"
+  end
+end
+
+Cowntdown.new

data/examples/cowntdown_respawn.rb

@@ -0,0 +1,42 @@
+$: << "../lib"
+require 'tick_tacker'
+
+class Cowntdown
+  def timer
+    @timer = TickTacker::Timer.new.with :total_time => 5.seconds
+    @timer.add_observer self
+  end
+
+  def update(options)
+    @time_remaining = options[:time_remaining]
+    @respawn = true if options[:time_remaining] == 0
+  end
+
+  def forever
+    timer
+    @timer.add_observer self
+    Thread.new {
+      @timer.start
+    }
+    while true
+      puts "."
+      puts "remaining: #{@time_remaining}"
+      sleep(0.3)
+      if @respawn
+        @respawn = false
+        respawn
+      end
+    end
+  end
+
+  def respawn
+    @timer.stop
+    timer
+    puts "respawning..."
+    Thread.new {
+      @timer.start
+    }
+  end
+end
+
+Cowntdown.new.forever

data/lib/tick_tacker/ticker.rb

@@ -1,7 +1,18 @@
 module TickTacker
   class Ticker
+    attr_accessor :interval
+
     def initialize
       @can_run = true
+      with :interval => 1.second
+    end
+
+    def with(options={})
+      default = {:interval => 1.second}
+      config = default.merge(options)
+      @interval = config[:interval]
+      repeat_every(@interval) { yield } if block_given?
+      self
     end
 
     def time_block 
@@ -10,7 +21,7 @@ module TickTacker
       Time.now - start_time 
     end 
 
-    def repeat_every(seconds) 
+    def repeat_every(seconds)
       while @can_run do 
         time_spent = time_block { yield } # To handle -ve sleep interaval 
         sleep(seconds - time_spent) if time_spent < seconds 
@@ -20,5 +31,9 @@ module TickTacker
     def stop
       @can_run = false
     end
+
+    def repeat
+      repeat_every(@interval) { yield }
+    end
   end
 end

data/lib/tick_tacker/timer.rb

@@ -4,39 +4,47 @@ module TickTacker
   class Timer
     include Observable
 
-    attr_reader :total_minutes, :ticker_time
+    attr_reader :total_time
     attr_accessor :elapsed_time
 
-    def initialize(options = {:with => 25.minutes})
-      @total_minutes = options[:with]
-      @ticker_time = 1.second
-      @ticker = Ticker.new
+    def initialize
+      with(:total_time => 25.minutes)
+    end
+
+    def with(options)
+      default = {:ticker => Ticker.new}
+      config = default.merge(options)
+      @ticker = config[:ticker]
+      @ticker_time = @ticker.interval
+      @total_time = config[:total_time]
+      self
     end
 
     def notify
-      time_remaining = total_minutes - elapsed_time
+      time_remaining = total_time - elapsed_time
       notification_options = {:time_remaining => time_remaining}
       notify_observers(notification_options)
     end
 
     def update_time_elapsed(time)
       @elapsed_time += time
-      if @elapsed_time >= @total_minutes
+      if @elapsed_time >= @total_time
         @ticker.stop
       end
     end
 
-    def update(options)
+    def update(options = {})
       @elapsed_time ||= 0
-      options[:time_elapsed] = 1 if options[:time_elapsed].nil?
-      update_time_elapsed(options[:time_elapsed])
+      default = {:time_elapsed => @ticker.interval}
+      config = default.merge(options)
+      update_time_elapsed(config[:time_elapsed])
       changed
       notify
     end
 
     def start
-      @ticker.repeat_every 1.second do 
-        self.update({})
+      @ticker.repeat do
+        self.update
       end
     end
 

data/lib/tick_tacker/version.rb

@@ -1,3 +1,3 @@
 module TickTacker
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/spec/tick_tacker/ticker_spec.rb

@@ -1,9 +1,61 @@
 require 'spec_helper'
 
+def loop_number
+  2
+end
+
 module TickTacker
   describe Ticker do
-    it 'should test ticker' do
-      pending
+    let(:ticker) { Ticker.new }
+    let(:ticker_execute) do
+      start = Time.now
+      x = 0;
+      ticker.with :interval => 1.second do 
+        ticker.stop if x == loop_number-1
+        x += 1
+      end
+      elapsed = Time.now - start
+      {:counter => x, :elapsed => elapsed.round}
+    end
+
+    it "should starts with default interval of 1.second" do
+      ticker.interval.should == 1.second
     end
+
+    describe "execution loop" do
+      it "execute #{loop_number} times in #{loop_number} seconds if the interval is of 1 second" do
+        result = ticker_execute
+        result[:elapsed].should == loop_number
+      end
+    end
+
+    describe "#with" do
+      it "returns a default ticker" do
+        ticker = Ticker.new.with
+        ticker.should be_a Ticker
+      end
+    end
+
+    describe '#stop' do
+      it 'stops Ticker loops' do
+        result = ticker_execute
+        result[:counter].should == loop_number
+      end
+    end
+
+    describe "#repeat" do
+      it "starts loop with default interval" do
+        ticker = Ticker.new
+        x = 0
+        start = Time.now
+        ticker.repeat do 
+          ticker.stop if x == loop_number-1
+          x += 1
+        end
+        elapsed = Time.now - start
+        elapsed.round.should == loop_number
+      end
+    end
+
   end
 end

data/spec/tick_tacker/timer_spec.rb

@@ -1,29 +1,30 @@
 require 'spec_helper'
 
+def tick
+  2
+end
+
 module TickTacker
   describe Timer do
-    let(:timer) { Timer.new :with => 15.minutes }
+    let(:ticker) { Ticker.new.with :interval => 1.second }
+    let(:timer) { Timer.new.with(:ticker => ticker, :total_time => 15.minutes) }
     let(:observer) { double('TimerObserver').as_null_object }
 
     it 'should be configured with 25 minutes by default' do
-      Timer.new.total_minutes.should == 25.minutes
-    end
-
-    it 'should have a default ticker configured with 1.second' do
-      timer.ticker_time.should == 1.second
+      Timer.new.total_time.should == 25.minutes
     end
 
     it 'should receive a number of minutes as parameter to configure a count down' do
-      timer.total_minutes.should == 15.minutes
+      timer.total_time.should == 15.minutes
     end
 
-    it 'should reduce by one second the remaining time when receives an update' do
+    it 'should reduce by 1.second the remaining time when receives an update' do
       timer.update :elapsed_time => 1.second
       timer.elapsed_time.should == 1.second
     end
 
     it 'should notify the observer about the second elapsed' do
-      timer = Timer.new :with => 1.minutes
+      timer = Timer.new.with :total_time => 1.minute
       timer.add_observer observer
       observer.should_receive(:update).with({:time_remaining => 59.seconds}).once
       timer.update :elapsed_time => 1.second
@@ -37,5 +38,23 @@ module TickTacker
         timer.update :elapsed_time => 1.second
       end
     end
+
+    describe "#start" do
+      it "calls Ticker#repeat" do
+        tickr = double("Ticker").as_null_object
+        t = Timer.new.with :ticker => tickr
+        tickr.should_receive(:repeat).once
+        t.start
+      end
+    end
+
+    describe "#stop" do
+      it "stops the ticker" do
+        tickr = double("Ticker").as_null_object
+        t = Timer.new.with :ticker => tickr
+        tickr.should_receive(:stop).once
+        t.stop
+      end
+    end
   end
 end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: tick_tacker
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
+  prerelease: 
+  version: 0.1.3
 platform: ruby
 authors: 
 - Ricardo Valeriano
@@ -32,6 +28,8 @@ files:
 - Gemfile
 - Gemfile.lock
 - Rakefile
+- examples/cowntdown.rb
+- examples/cowntdown_respawn.rb
 - lib/tick_tacker.rb
 - lib/tick_tacker/ticker.rb
 - lib/tick_tacker/timer.rb
@@ -54,21 +52,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: tick_tacker
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A timer wich accepts subscribers and use a ticker