goalkeeper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e12557dafed1d9031a7a11e69d2c4acd39665cf8
+  data.tar.gz: 87d0150ba4b4b3c6f72d6577308f3dbbb60d30b3
+SHA512:
+  metadata.gz: 5053c93b993f256c6b91000713ed079058a0b1179cd6ca58e0aeefb5e6ec8dd69188ba091ed8bb5e23f1dd8fdede9e72ba348e01c408a9066521da81e08c5fa0
+  data.tar.gz: 2eafd8b2593bd2f4ce935089fceb606f2ee954a412d771558ce349f5a00c56aebfe7d92f2d7d1d0036326ec13ed6862ffba10a91004dad9d0ad9d20310ddc747

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in goalkeeper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 John Weir
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# Goalkeeper
+
+Goalkeeper is a simple system for tracking if system wide requirements have been met. It is a TODO list for your application.
+
+An example usage would be validating if each customer was sent a daily report.
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'goalkeeper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install goalkeeper
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/jweir/goalkeeper/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end
+

data/goalkeeper.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'goalkeeper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "goalkeeper"
+  spec.version       = Goalkeeper::VERSION
+  spec.authors       = ["John Weir"]
+  spec.email         = ["john@smokinggun.com"]
+  spec.summary       = %q{A Todo App for your application.}
+  spec.description   = %q{Goalkeeper is a system for validation that specific goals have been met by an application.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redis", "~> 3"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/goalkeeper.rb

@@ -0,0 +1,98 @@
+require "goalkeeper/version"
+require 'forwardable'
+require 'redis'
+
+class Goalkeeper
+
+  # Creates a persistent Goal market with the given label.
+  def self.met!(label)
+    Goal.new(label).met!
+  end
+
+  class List
+    extend Forwardable
+    def_delegators :@list, :size, :[]
+
+    def initialize
+      @list = []
+    end
+
+    # Creates a new Goal.
+    # see Goal#new for usage
+    def add(label, ref: nil)
+      @list.push(Goal.new(label, ref: ref))
+      self
+    end
+
+    def met?
+      unmet.empty?
+    end
+
+    def unmet
+      @list.select {|g| ! g.met?}
+    end
+
+    def met
+      @list.select {|g| g.met?}
+    end
+  end
+
+  class Goal
+    attr_reader :label
+    attr_reader :ref
+
+    # +label+ is a unique string to identify this demand.
+    # There is no checking if it is truly unique.
+    #
+    # +ref+ is an optional reference to any object.  This
+    # would be used by the end user's application.
+    def initialize(label, ref: nil)
+      @label = label
+      @ref = ref
+    end
+
+    def met!
+      Store.write(self.label)
+      self
+    end
+
+    def met?
+      ! Store.read(self.label).nil?
+    end
+  end
+
+  class Store
+    EXPIRATION = 60 * 60 * 24 # 1 day
+
+    def self.write(label)
+      nl = ns(label)
+      client.set nl, Time.now
+      client.expire nl, EXPIRATION
+    end
+
+    def self.read(label)
+      nl = ns(label)
+      client.get nl
+    end
+
+    def self.remove(label)
+      nl = ns(label)
+      client.del nl
+    end
+
+    protected
+
+    def self.ns(label)
+      namespace + ":"+ label
+    end
+
+    def self.namespace
+      "Goalkeeper"
+    end
+
+    def self.client
+      @client ||= Redis.new
+    end
+
+  end
+end

data/lib/goalkeeper/version.rb

@@ -0,0 +1,3 @@
+class Goalkeeper
+  VERSION = "0.0.1"
+end

data/test/goalkeeper_test.rb

@@ -0,0 +1,102 @@
+require 'test_helper'
+
+# API
+# Goal.configure
+# Goal.met label, ttl
+# Goal::List.new
+#   .add
+#   .met
+#   .unmet
+#   .met?
+#
+#   configure
+#     redis client
+#     namespace
+#
+# Goal -> score, completed, met
+#
+# was a Goal met?
+# when was it met?
+describe Goalkeeper do
+
+  describe Goalkeeper::List do
+    before do
+      @goals = Goalkeeper::List.new
+    end
+
+    describe "#add" do
+      it "create a Goal" do
+        @goals.add("a:1")
+        assert_equal 1, @goals.size
+        assert_equal "a:1", @goals[0].label
+      end
+
+      it "accepts an optional reference object" do
+        o = Object.new
+        @goals.add("a:1", ref: o)
+        assert_equal o, @goals[0].ref
+      end
+
+      it "should return itself (so it is chainable)" do
+        assert_equal @goals, @goals.add("a:1")
+      end
+    end
+
+    describe "#met" do
+      it "returns all Goals which have been met"
+    end
+
+    describe "#unmet" do
+      it "returns all Goals which have not been met"
+    end
+
+    describe "#met?" do
+      it "is true when all Goals have been met"
+    end
+  end
+
+  describe "met!" do
+    it "should create a Goal for the given label" do
+      assert Goalkeeper.met!("x:1")
+    end
+
+    it "has a default ttl expiration"
+    it "takes an optional at: timestamp" 
+    it "takes an optional ttl for expiration" 
+  end
+
+  describe "namespace" do
+  end
+
+  describe "configuation" do
+    # allow setting the redis client
+  end
+end
+
+describe "Integration" do
+  before do
+    puts "fix this!"
+    Redis.new.flushdb
+  end
+
+  it "works like this" do
+    Goalkeeper.met! "x"
+
+    d = Goalkeeper::List
+      .new
+      .add("x")
+      .add("y")
+
+    assert_equal false, d.met?
+
+    assert_equal ["y"], d.unmet.map(&:label)
+    assert_equal ["x"], d.met.map(&:label)
+
+    Goalkeeper.met! "y"
+
+    assert_equal true, d.met?
+
+    assert_equal ["x","y"], d.met.map(&:label)
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/unit'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require './lib/goalkeeper'

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: goalkeeper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Weir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Goalkeeper is a system for validation that specific goals have been met
+  by an application.
+email:
+- john@smokinggun.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- goalkeeper.gemspec
+- lib/goalkeeper.rb
+- lib/goalkeeper/version.rb
+- test/goalkeeper_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Todo App for your application.
+test_files:
+- test/goalkeeper_test.rb
+- test/test_helper.rb