goalkeeper 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 131ffcb82da5ac820f63710b94d5139cf249bc9d
-  data.tar.gz: d0ccd33c05701a7b3c5bb669008eb5bea1eedf32
+  metadata.gz: c2218b1dbfd25948dd08869e05472cf1e5b12947
+  data.tar.gz: 56e2989786f574f8424b8d5674d85f5cbc2a9f2c
 SHA512:
-  metadata.gz: ced9ac47bf52311689d02ded1b17c59067c9bd55906de495f53a4c3a59cf7242b8b3dce7f0eafb662326c6c8c3ab050d5377718dad07d95c221704fc4e2953d3
-  data.tar.gz: 928f802e2557c64bb046e9eec2769e66c9d4f075d34fc6b8b202111cd7b703693dfa4ac44e2bea08966ab2af33bc543e2a8172c0de9f397e5a60a84c761fc332
+  metadata.gz: 48d3cfa5ad03262197bcaadca3d008568bb7228896e8f0453f5425e4e05fa163c4ece7bcbe9873bb4fb74ca4a58464c52e78b3f03905b844fe788c15da1a680f
+  data.tar.gz: f3a7a95b5dee458012e67b7958df75e03c805f0c7368e39777dfb8ac24543451531b316c5fed981290a7b79b953427c647e635acb0c74284c6ee4a04366766c6

data/CHANGES.md

@@ -0,0 +1,4 @@
+# 0.3.2
+
+* Enhancement
+  * `Goal.new` auto joins multiple arguments into a single label

data/README.md

@@ -1,11 +1,58 @@
 # Goalkeeper
 
-Goalkeeper is a simple system for tracking if system wide requirements have been met. It is a TODO list for your application.
+Goalkeeper is a simple library for tracking if, and when, a Goal has
+been met.  A Set of goals can be combined to check if all of them
+have been completed.
 
-An example usage would be validating if each customer was sent a daily report.
+This could be used as a checklist for process completion.
 
+### Examples
 
-##### Installation
+Check if your application ran its daily backup
+
+```ruby
+# send the report and mark the report as sent
+def backup
+  # ... backup code ...
+  Goalkeeper.met!("backup:#{Date.today}")
+end
+
+# elsewhere warn if any customer has not had a report sent
+def did_backup_today?
+  Goalkeeper.met?("backup:#{Date.today}")
+end
+```
+
+Wait for a Set of Goals to be met before starting another.
+```ruby
+# The email can't be sent until the 'prices' and 'awards' are downloaded
+def email_report
+  set = Goalkeeper::Set.new.
+    add("prices:#{Date.today}").
+    add("awards:#{Date.today}")
+
+  if set.met?
+    log.info "Downloads completed by #{set.met_at}"
+    deliver
+  else
+    log.info "#{set.unmet.map(&:label).join(', ')} have not been downloaded"
+    retry_later
+  end
+end
+
+# elsewhere the code to get the data and mark it complete
+def download_prices
+  # ... download code ...
+  Goalkeeper.met!('prices:#{Date.today}')
+end
+
+def download_awards
+  # ... download code ...
+  Goalkeeper.met!('awards:#{Date.today}')
+end
+```
+
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -21,9 +68,131 @@ Or install it yourself as:
 
     $ gem install goalkeeper
 
-## Usage
+### Usage
+
+Its goes likes this...
+
+You might never need to reference the Goal class.  Most everything can be done via Goalkeeper and Goalkeeper::Set.
+
+```ruby
+Goalkeeper.met? "label" #=> false
+Goalkeeper.met! "label" #=> <Goalkeeper::Goal>
+Goalkeeper.met? "label" #=> true
+```
+
+But lets have a granular example.  Lets ensure we wakeup New Years Day 2020.
+The Goal will be named 'wakeup:2020-01-01'
+
+```ruby
+g = Goalkeeper::Goal.new('wakeup:2020-01-01')
+g.met? #=> false
+```
+
+Time flies... it is New Years Day 2020.
+
+```ruby
+g.met! # or Goalkeeper.met!('wakeup:2020-01-01')
+g.met? #=> true
+g.met_at #=> 2020-01-01 05:01:31 -0500
+```
+
+Now if our application checks our goal, it will be met.
+
+```ruby
+Goalkeeper.met?('wakeup:2020-01-01') #=> true
+# or
+Goalkeeper::Goal.new('wakeup:2020-01-01').met? #=> true
+```
+
+Note: Once a Goal is 'met' the 'met\_at' timestamp will not change, unless
+'clear!' is called.
+
+We are probably only interested in this goal being complete for a limited
+time, so it will expire and be removed from Redis.
+
+```ruby
+g.ttl #=> 86400 (1 day)
+```
+
+If you need to reference the Redis key
+
+```ruby
+g.key #=> Goalkeeper:wakeup:2020-01-01
+```
+
+Finally deleting the Goal is simple
+
+```ruby
+g.clear!
+g.met? #=> false
+```
+
+#### Sets
+
+Perhaps you have a series of Goals you want to track, and see if they all have been met, or not.
+
+```ruby
+set = Goalkeeper::Set.new
+set.add('goal1').add('goal2')
+set.met? #=> false
+```
+
+Lets have 1 goal met:
+
+```ruby
+Goalkeeper.met!('goal1')
+```
+
+But our set is not met yet
+
+```ruby
+set.met? #=> false
+```
+
+See which goals are met, or unmet
+
+```ruby
+set.met #=> [#<Goalkeeper::Goal @label="goal1">]
+set.unmet #=> [#<Goalkeeper::Goal @label="goal2">]
+```
+
+Lets complete our set.
+
+```ruby
+Goalkeeper.met!('goal1')
+set.met? #=> true
+```
+
+See the time the final goal was met
+
+```ruby
+set.met_at #=> 2015-01-01 08:02:15 -0500
+```
+
+#### Customization
+
+Customize the redis client by setting it in your application
+
+```ruby
+Goalkeeper.redis = your_redis_client
+```
+
+Each record has a default expiration of 24 hours, but this can be modified.
+
+```ruby
+Goalkeeper.expiration = number_of_seconds
+```
+
+Redis keys are stored under the default namespace of "Goalkeeper:". The
+namespace can be configured:
+
+```ruby
+Goalkeeper.namespace = string
+```
+
+## API
 
-### Goal
+#### Goal
 | method     | description                                                | example                                  |
 | --------   | ------                                                     | -----                                    |
 | new(label) | Creates a new Goal with the unique label                   | `g = Goal.new('process')`                |
@@ -35,15 +204,13 @@ Or install it yourself as:
 | clear!     | Deletes the `met` record.  Goal is now unmet.              | `g.clear!`                               |
 
 
-### Set
+#### Set
 | method     | description                                                             | example                                  |
 | --------   | ------                                                                  | -----                                    |
 | new        | creates an empty set of goals.                                          | `s = set.new`                            |
 | add(label) | Adds a new Goal the Set. _chainable_                                    | `s.add('process.a').add('process.b')`    |
 | met?       | Returns true if _all_ the Set's Goals have been met.                    | `s.met? #=> false`                       |
-| met!       | Calls `met!` on all Goals.                                              | `s.met! #=> Time.now`                    |
 | met\_at    | Returns the most recent met_at for the Set's Goals. Nil if no Goal met. | `s.met_at #=> 2015-02-09 22:24:07 -0500` |
-| clear!     | Calls `clear!` on all Goals.                                            | `s.clear!`                               |
 | met        | Returns a new Set with all Goals which have been met.                   | `s.met #=> Set(...)`                     |
 | unmet      | Returns a new Set with all Goals which have not been met.               | `s.unmet` #=> Set(...)                   |
 
@@ -51,6 +218,7 @@ Or install it yourself as:
 | method        | description                          | example |
 | --------      | ------                               | -----   |
 | ::met!(label) | Creates a new Goal and marks it met. | `Goalkeeper.met!('process') #=> <Goalkeepr::Goal>`
+| ::met?(label) | Checks if the label has been met or not | `Goalkeeper.met?('process') #=> true`
 
 ## Contributing
 

data/lib/goalkeeper/goal.rb

@@ -9,10 +9,10 @@ module Goalkeeper
     # the TTL value for the Redis record.  Defalts to Goalkeeper.expiration
     attr_reader :expiration
 
-    # +label+ is a unique string to identify this Goal.
+    # +label+ is a unique string to identify this Goal. If multiple args are passed they are joined and seperated by ':'
     # +expiration+ number secconds. This can be set to override the gobal expiration.
-    def initialize(label, expiration: Goalkeeper.expiration)
-      @label = label
+    def initialize(*label, expiration: Goalkeeper.expiration)
+      @label = label.join(":")
       @expiration = expiration
     end
 

data/lib/goalkeeper/version.rb

@@ -1,3 +1,3 @@
 module Goalkeeper
-  VERSION = "0.3.0"
+  VERSION = "0.3.2"
 end

data/test/goalkeeper/goal_test.rb

@@ -11,6 +11,18 @@ describe Goalkeeper::Goal do
     assert_equal "test", goal.label
   end
 
+  describe "label" do
+    it "can be a string" do
+      g = Goalkeeper::Goal.new("a_string")
+      assert_equal 'a_string', g.label
+    end
+
+    it "will join multiple args into a string seperated by ':'" do
+      g = Goalkeeper::Goal.new("a", :b, Object)
+      assert_equal 'a:b:Object', g.label
+    end
+  end
+
   it "has a namespaced key" do
     assert_equal "Goalkeeper:test", goal.key
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goalkeeper
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - John Weir
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -61,6 +61,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGES.md
 - Gemfile
 - LICENSE
 - README.md