progress_tracker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df21ecd837ae3df9bde25bb75176b76b74babba1
+  data.tar.gz: fdc09b64c60c0b47579458b6b665b65584cd0bea
+SHA512:
+  metadata.gz: c21785f5a9253a41c869b221aae9e295b3a524ff2f5e2387d0b1285bad7cd10d4a158dd6c3e46162e6005b35af19c2c5d973963a96f81e737941cf03c7989d3b
+  data.tar.gz: 64c5f45f120e788bbe67ecda28f830d8a4cc0c8c884b934245d35af5e75339d0bc970e4276463df5145d5c8e81d8a26f01bd0013c38a70ab496238149a1aedad

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dan Cheail <dan@undumb.com>
+
+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,83 @@
+# ProgressTracker
+
+ProgressTracker is a very simple API for logging and retreiving the progress of
+a given background task. It lets you track the progress / status of multiple
+objects, and retrieve them as a single set.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'progress_tracker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install progress_tracker
+
+## Usage
+
+Track objects associated with a simple name, or emable the user of a class / id pair
+
+    pt = ProgressTracker.new(:thing)
+    pt = ProgressTracker.new(:billing_cycle, id)
+
+    # Sane Defaults
+    pt = ProgressTracker.new(:foo, 10)
+    pt.to_hash # => { progress: 0, message: "" }
+
+
+Update the progess / messages on the base object
+
+    pt.progress 50
+    pt.message "String"
+    pt.status "BAD"
+
+Or, just chuck anything you want in there
+
+    pt.update progress: 50, message: "Strang.", status: "BAD", herpy: "derpy"
+
+Alternatviely, track seperate, named sub-objects, again with name or class / id pair
+
+    pt.track :cycle
+    pt.track :bill, 10
+    pt.track :bill, 11
+    pt.track :bill, 13
+
+    # update progress percentage
+    pt.cycle.progress 34
+    pt.bill(34).progress 92
+
+    # update status message
+    pt.cycle.message "Message"
+    pt.bill(34).message "Message"
+
+    # or, update them both at the same time
+    pt.cycle.update progress: 14, message: "Message"
+    pt.bill(34).update progress: 14, message: "Message"
+
+Then, in an new context, re-initialise and retreive a complete overview:
+
+    pt = ProgressTracker.new(:billing_cycle, id)
+    pt.to_hash # => {
+      _base: { progress: 19, message: "Message" },
+      cycle: { progress: 19, message: "Message" },
+      bill_10: { progress: 19, message: "Message" },
+      bill_11: { progress: 19, message: "Message" },
+      bill_13: { progress: 19, message: "Message" },
+    }
+
+And easily convert it to JSON as needed:
+
+    pt.to_json
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/progress_tracker/base.rb

@@ -0,0 +1,95 @@
+module ProgressTracker
+  class Base
+
+    # Enable the selection of a Redis connection
+    class << self
+      attr_accessor :redis_connection
+    end
+
+    # And default to using the established global var (yes, I know. Bad.)
+    @redis_connection = $redis
+
+    # Instance-level access to Redis (actually a Redis::Namespace)
+    attr_reader :redis, :base_key
+
+    # All sub-objects tracked with Base#track
+    attr_reader :tracked_object_keys
+
+    # The tracked object that this instance currently refers to
+    attr_accessor :current_tracked_object
+
+    # Just so we've always got values...
+    DEFAULTS = { progress: 0, message: "" }
+
+    def initialize(object_name, object_id = nil)
+      @base_key = _ck(object_name, object_id)
+
+      @redis = ::Redis::Namespace.new(@base_key, redis: ProgressTracker::Base.redis_connection)
+
+      # initialize or fetch our tracked object keys from Redis, ensuring we at least have _base present
+      @tracked_object_keys = Set.new(redis.smembers("tracked-object-keys").map(&:to_sym) << :_base)
+
+      @current_tracked_object = :_base
+    end
+
+    # Build a compound key and store it for future reference
+    def track(object_name, object_id = nil)
+      new_key = _ck(object_name, object_id)
+
+      redis.sadd "tracked-object-keys", new_key
+      tracked_object_keys << new_key
+    end
+
+    # grab all the keys related to this set from redis
+    def to_hash
+      tracked_object_keys.inject({}) do |hash, key|
+        hash.tap do |h|
+          h[key] = DEFAULTS.merge(redis.hgetall(key).symbolize_keys)
+
+          # Make sure :progress is always returned as an integer
+          h[key][:progress] = h[key][:progress].to_i
+        end
+      end
+    end
+
+
+    # If a method is called that matches the name of a tracked object, return
+    # a new instance of self with the @current_tracked_object set
+    # to the correct key
+    def method_missing(meth, *args)
+      meth_key = _ck(meth, args.first)
+
+      if tracked_object_keys.include?(meth_key)
+        self.dup.tap do |t|
+          t.current_tracked_object = meth_key
+        end
+      else
+        raise NoMethodError
+      end
+    end
+
+
+    def update(hsh)
+      redis.hmset current_tracked_object, *hsh.to_a.flatten
+    end
+
+    def progress(value)
+      update progress: value.to_i
+    end
+
+    def message(msg)
+      update message: msg
+    end
+
+    private
+
+    # build a compound key in the format (name_id)
+    def _ck(object_name, object_id = nil)
+      if object_id
+        :"#{object_name}_#{object_id}"
+      else
+        object_name.to_sym
+      end
+    end
+  end
+end

data/lib/progress_tracker/version.rb

@@ -0,0 +1,3 @@
+module ProgressTracker
+  VERSION = "0.0.1"
+end

data/lib/progress_tracker.rb

@@ -0,0 +1,13 @@
+require 'set'
+
+require 'active_support'
+require 'active_support/core_ext/hash/keys'
+
+require 'redis'
+require 'redis/namespace'
+
+require 'progress_tracker/version'
+require 'progress_tracker/base'
+
+module ProgressTracker
+end

data/progress_tracker.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'progress_tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "progress_tracker"
+  spec.version       = ProgressTracker::VERSION
+  spec.authors       = ["Dan Cheail"]
+  spec.email         = ["dan@undumb.com"]
+  spec.description   = %q{A very simple API for logging and retreiving the progress of a given background task using Redis.}
+  spec.summary       = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "activesupport", "~> 4.0.0"
+  spec.add_dependency "redis", "~> 3.0.0"
+  spec.add_dependency "redis-namespace", "~> 1.3.1"
+
+  spec.add_development_dependency "mock_redis"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/progress_tracker_spec.rb

@@ -0,0 +1,116 @@
+Bundler.require(:default, :development)
+
+require 'rspec'
+require 'mock_redis'
+
+require 'progress_tracker'
+
+# FAKE REDIS!
+ProgressTracker::Base.redis_connection = MockRedis.new
+
+shared_examples "a ProgressTracker::Tracker instance" do
+  let(:setter_base) { ProgressTracker::Base.new(:paired_thing) }
+  let(:getter)      { ProgressTracker::Base.new(:paired_thing) }
+
+  it "remembers the current progress" do
+    setter.progress 50
+    expect(_result(getter, :progress, setter.current_tracked_object)).to eql(50)
+  end
+
+  it "ensures that progress is an integer" do
+    setter.progress 50.34
+    expect(_result(getter, :progress, setter.current_tracked_object)).to eql(50)
+  end
+
+  it "remembers the latest message" do
+    msg = "So long, and thanks for all the fish."
+
+    setter.message msg
+    expect(_result(getter, :message, setter.current_tracked_object)).to eql(msg)
+  end
+
+
+  it "remembers several things at once" do
+    things = { progress: 42, message: "Share and enjoy." }
+    setter.update things
+
+    expect(getter.to_hash[setter.current_tracked_object]).to eql(things)
+  end
+
+  it "remembers arbitrary keys / values" do
+    setter.update foo: "bar!"
+    expect(getter.to_hash[setter.current_tracked_object][:foo]).to eql("bar!")
+  end
+end
+
+
+describe ProgressTracker::Base do
+
+  # make sure we're clearing out fake-redis after each test
+  after(:each) do
+    ProgressTracker::Base.redis_connection.flushdb
+  end
+
+  # shortcut for accessing deep hash keys
+  def _result(pt, field, key = :_base)
+    pt.to_hash[key][field]
+  end
+
+  let(:pt) { ProgressTracker::Base.new(:derp) }
+
+  it "must be initialized with at least a simple key" do
+    expect { ProgressTracker::Base.new }.to raise_error
+    expect { ProgressTracker::Base.new(:derp) }.not_to raise_error
+  end
+
+
+  it "can be initialized using a class / id compound key" do
+    expect { ProgressTracker::Base.new(:thing, 100) }.not_to raise_error
+  end
+
+
+  it "returns sane defaults" do
+    expect(pt.to_hash).to eql({ _base: { progress: 0, message: "" } })
+  end
+
+  it "can track mutliple sub-objects" do
+    pt.track :foo
+    pt.track :bar, 100
+
+    expect(pt.to_hash).to have_key(:foo)
+    expect(pt.to_hash).to have_key(:bar_100)
+  end
+
+  # it "ensures that any tracked sub-objects are re-cached when initialising a new tracker" do
+  #   pt.track :foo
+  #   pt.track :bar, 100
+
+  #   pt2 = ProgressTracker::Base.new(pt.base_key)
+
+  #   expect(pt2.to_hash).to have_key(:foo)
+  #   expect(pt2.to_hash).to have_key(:bar_100)
+  # end
+
+  context "when operating on the base object" do
+    it_behaves_like "a ProgressTracker::Tracker instance" do
+      let(:setter) { setter_base }
+    end
+  end
+
+
+  context "when operating on a simple sub-object" do
+    it_behaves_like "a ProgressTracker::Tracker instance" do
+      before(:each) { setter_base.track :derp }
+      let(:setter) { setter_base.derp }
+    end
+  end
+
+  context "when tracking a compound-key sub-object" do
+    it_behaves_like "a ProgressTracker::Tracker instance" do
+      before(:each) { setter_base.track :derp, 100 }
+      let(:setter) { setter_base.derp(100) }
+    end
+  end
+
+  it "can go to json, too!"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: progress_tracker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Cheail
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A very simple API for logging and retreiving the progress of a given
+  background task using Redis.
+email:
+- dan@undumb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/progress_tracker.rb
+- lib/progress_tracker/base.rb
+- lib/progress_tracker/version.rb
+- progress_tracker.gemspec
+- spec/progress_tracker_spec.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.1.4
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/progress_tracker_spec.rb