tickwork 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0f55ef5fd21a2a08cc0a9f43a35c3ff6d419de8
-  data.tar.gz: e524021956050752db8dfe4d493313c5791ed065
+  metadata.gz: 920921d051336381f10e80c3d7241af9d1bd6089
+  data.tar.gz: ea06aed69b17703630a7dfdca5abaf54b9bdf015
 SHA512:
-  metadata.gz: f6bdf37dc8d00f9eaa5c2d193007e90ccb8379003b2179609468811f42c41843b204794d167db3b1a0716d1a54df6be7b548094613e33fadb8478566947d2158
-  data.tar.gz: 8e7abceaab3cf06d8e7424fcf7591f86685d4b02de9644b4baf4b8f037109c83cec1c4e5f54bb6b22083fa64600b97d73305aacd1207efaa7c01b60235cbb3a5
+  metadata.gz: 5098df50b53894be834e88af9a0c303c8a6ea2618a5a8814a373c9f92ecffb4c6e71de097031da046e519c08d9cfb43ef266e82c97c1e203ecdac92133d3dbe3
+  data.tar.gz: a611528f519bf38cc5e063e107c354138b71094a1d7755b062ea4085e1833a3f010a68d988a263ded0ef22a8fed8cfb09b860881618022077c5e9cf4c7a6ca12

data/.gitignore

@@ -4,3 +4,4 @@ tmp
 Gemfile.lock
 *.swo
 *.swp
+*.gem

data/README.md

@@ -245,6 +245,21 @@ If there is no last timestamp, Tickwork starts from now.
 
 This must be larger than your `tick_size`, and probably significantly larger to avoid missing any jobs.
 
+### :data_store
+
+A datastore is required to save the times that jobs last run. This is how Tickwork keeps track of time. This can be anything that implements the following methods:
+
+```ruby
+def read(key)
+end
+def write(key, value)
+end
+```
+
+ActiveSupport::Cache::Store satisfies this, so Rails users can use that. This must be a shared cache to work properly in an environment with multiple servers.
+
+
+
 ### Configuration example
 
 ```ruby

data/lib/tickwork/data_store.rb

@@ -13,16 +13,20 @@ module Tickwork
 
     # Providers should implement
     #
-    # def get(key)
+    # def read(key)
     #
     # end
     # 
-    # def set(key, value)
+    # def write(key, value)
     #
     # end
     #
     # note: keys will be prefixed with '_tickwork_' both for easy identification and also to 
     # help avoid conflicts with the rest of the app
+    #
+    # Keen observers will note that this interface is compatible with ActiveSupport::Cache::Store. So you should
+    # be able to just drop an instance of Store in and be ready to go. Preferably with a cache expiration time
+    # longer than your max_catchup value
 
   end
 end

data/lib/tickwork/event.rb

@@ -21,11 +21,11 @@ module Tickwork
     end
 
     def last
-      @manager.data_store.get(data_store_key)
+      @manager.data_store.read(data_store_key)
     end
 
     def last=(value)
-      @manager.data_store.set(data_store_key, value)
+      @manager.data_store.write(data_store_key, value)
     end
 
     def convert_timezone(t)

data/lib/tickwork/manager.rb

@@ -94,7 +94,7 @@ module Tickwork
       raise NoDataStoreDefined.new if data_store.nil?
       log "Starting clock for #{@events.size} events: [ #{@events.map(&:to_s).join(' ')} ]"
 
-      last = last_t = data_store.get(data_store_key)
+      last = last_t = data_store.read(data_store_key)
       last ||= Time.now.to_i - config[:tick_size] 
       if !config[:max_catchup].nil? && config[:max_catchup] > 0 && last < Time.now.to_i - config[:max_catchup]
         last = Time.now.to_i - config[:max_catchup] - config[:tick_size]
@@ -109,7 +109,7 @@ module Tickwork
         tick_time += config[:tick_size]
         ticks += 1
       end
-      data_store.set(data_store_key, last)
+      data_store.write(data_store_key, last)
       last
     end
 
@@ -129,7 +129,7 @@ module Tickwork
     end
 
     def clear!
-      data_store.set(data_store_key, nil)
+      data_store.write(data_store_key, nil)
     end
 
     def log_error(e)

data/test/data_stores/fake_store.rb

@@ -5,11 +5,11 @@ module Tickwork
       @data_store = {}
     end
 
-    def get(key)
+    def read(key)
       @data_store[key]
     end
 
-    def set(key, value)
+    def write(key, value)
       @data_store[key] = value
     end
 

data/test/manager_test.rb

@@ -399,7 +399,7 @@ end
       config[:max_ticks] = 1
     end
     last = Time.now.to_i - 1000
-    @manager.data_store.set(@manager.data_store_key, last)
+    @manager.data_store.write(@manager.data_store_key, last)
     @manager.expects(:tick).with(last + 1).then.returns
     @manager.run
   end
@@ -410,7 +410,7 @@ end
       config[:max_ticks] = 3
     end
     last = Time.now.to_i - 1000
-    @manager.data_store.set(@manager.data_store_key, last)
+    @manager.data_store.write(@manager.data_store_key, last)
     @manager.expects(:tick).with(last + 1).then.returns
     @manager.expects(:tick).with(last + 2).then.returns
     @manager.expects(:tick).with(last + 3).then.returns
@@ -423,7 +423,7 @@ end
       config[:max_ticks] = 3
     end
     last = Time.now.to_i - 1000
-    @manager.data_store.set(@manager.data_store_key, last)
+    @manager.data_store.write(@manager.data_store_key, last)
     @manager.expects(:tick).with(last + 2).then.returns
     @manager.expects(:tick).with(last + 4).then.returns
     @manager.expects(:tick).with(last + 6).then.returns
@@ -436,7 +436,7 @@ end
       config[:max_ticks] = 3
     end
     last = Time.now.to_i - 1
-    @manager.data_store.set(@manager.data_store_key, last)
+    @manager.data_store.write(@manager.data_store_key, last)
     module Failure
       def tick 
         raise "don't call me"
@@ -452,10 +452,10 @@ end
       config[:max_ticks] = 1
     end
     last = Time.now.to_i - 1000
-    @manager.data_store.set(@manager.data_store_key, last)
+    @manager.data_store.write(@manager.data_store_key, last)
     @manager.expects(:tick).with(last + 10).then.returns
     @manager.run
-    assert_equal (last + 10), @manager.data_store.get(@manager.data_store_key)
+    assert_equal (last + 10), @manager.data_store.read(@manager.data_store_key)
   end
 
   it "should tick from now if no last time" do 
@@ -476,7 +476,7 @@ end
     assert_equal 0, @manager.config[:data_store].size
     @manager.run
     assert_equal 2, @manager.config[:data_store].size
-    assert_equal false, @manager.config[:data_store].get('_tickwork_myjob').nil?
+    assert_equal false, @manager.config[:data_store].read('_tickwork_myjob').nil?
   end
 
   it "should start from max catchup when last is further in the past" do 
@@ -488,7 +488,7 @@ end
 
     @manager.every(1.minute, 'myjob')
     last = Time.now.to_i - 3600
-    @manager.data_store.set(@manager.data_store_key, last)
+    @manager.data_store.write(@manager.data_store_key, last)
     @manager.expects(:tick).with(Time.now.to_i - 1800).then.returns
     @manager.run
   end
@@ -502,7 +502,7 @@ end
 
     @manager.every(1.minute, 'myjob')
     last = Time.now.to_i - 36000
-    @manager.data_store.set(@manager.data_store_key, last)
+    @manager.data_store.write(@manager.data_store_key, last)
     @manager.expects(:tick).with(Time.now.to_i - 36000 + 1).then.returns
     @manager.run
   end
@@ -516,7 +516,7 @@ end
 
     @manager.every(1.minute, 'myjob')
     last = Time.now.to_i - 36000
-    @manager.data_store.set(@manager.data_store_key, last)
+    @manager.data_store.write(@manager.data_store_key, last)
     @manager.expects(:tick).with(Time.now.to_i - 36000 + 1).then.returns
     @manager.run
   end
@@ -527,16 +527,16 @@ end
       config[:max_ticks] = 2
     end
     last = Time.now.to_i - 1000
-    @manager.data_store.set(@manager.data_store_key, last)
+    @manager.data_store.write(@manager.data_store_key, last)
     @manager.expects(:tick).with(last + 10).then.returns
     @manager.expects(:tick).with(last + 20).then.returns
     assert_equal last + 20, @manager.run
   end
 
   it "should clear it's datastore on #clear!" do 
-    @manager.data_store.set(@manager.data_store_key, "10")
+    @manager.data_store.write(@manager.data_store_key, "10")
     @manager.clear!
-    assert_equal nil, @manager.data_store.get(@manager.data_store_key)
+    assert_equal nil, @manager.data_store.read(@manager.data_store_key)
   end
 
   describe 'error_handler' do

data/tickworkwork.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "tickwork"
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.authors = ["John Hinnegan"]
   s.license = 'MIT'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tickwork
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - John Hinnegan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo