sparkplug 2.0.0 → 2.1.0

data/.gitignore

@@ -4,4 +4,5 @@ coverage
 rdoc
 pkg
 test/data
-demos/simple/public/sparks/*
+dump.rdb
+demos/**/public/sparks/*

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.1.0

data/demos/redis/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/demos/redis/lib/redis_demo/handler.rb

@@ -0,0 +1,27 @@
+module RedisDemo
+  class Handler < Sparkplug::Handlers::AbstractData
+    attr_reader :list
+
+    def initialize(list)
+      @list = list
+    end
+
+    def data_path=(v)
+      v.sub!(/^\//, '')
+      @data_path = v
+      @plug      = @list.find(@data_path)
+    end
+
+    def exists?
+      @plug.exists?
+    end
+
+    def updated_at
+      @plug.updated_at
+    end
+
+    def fetch
+      yield @plug.datapoints
+    end
+  end
+end

data/demos/redis/lib/redis_demo/spark_list.rb

@@ -0,0 +1,111 @@
+module RedisDemo
+  # Persists sparkline data to Redis.  Data is pushed and popped from a Redis list.
+  class SparkList
+    attr_reader :redis, :plug_list
+    attr_accessor :prefix, :limit
+
+    # SparkList options
+    #   :prefix => 'plug'
+    #   :limit  => 50
+    #   :redis  => {} # passed to Redis
+    def initialize(options = {})
+      @prefix    = options[:prefix] || 'plug'
+      @limit     = options[:limit]  || 50
+      @index_key = "#{@prefix}:index"
+      @redis     = Redis.new(options[:redis] || {})
+      @plug_list = PlugList.new(self)
+    end
+
+    def find(name)
+      Plug.new(self, name)
+    end
+  end
+
+  class PlugList
+    def initialize(list)
+      @list     = list
+      @redis    = @list.redis
+      @list_key = "#{@prefix}:sparkplug:list"
+    end
+
+    def add(plug)
+      @redis.sadd @list_key, plug.name
+      @redis.sort @list_key, :order => "ALPHA"
+    end
+
+    def delete(plug)
+      @redis.srem @list_key, plug.name
+    end
+
+    def all
+      @redis.smembers(@list_key)
+    end
+  end
+
+  # represents a list of datapoints
+  class Plug
+    attr_reader :name
+
+    def initialize(list, name)
+      @list  = list
+      @redis = @list.redis
+      @name  = name
+      @name_key = @updated_key = nil
+    end
+
+    def add(value)
+      points = count
+      @redis.rpush(name_key, value.to_i)
+      if points.zero?
+        @list.plug_list.add(self)
+      end
+      excess = points + 1 - @list.limit
+      if excess > 0
+        excess.times { @redis.lpop(name_key) }
+      end
+      self.updated_at = Time.now.utc
+    end
+
+    def datapoints
+      @redis.lrange(name_key, 0, @list.limit-1).map! { |p| p.to_i }
+    end
+
+    def updated_at
+      value = @redis.get(updated_key)
+      value.nil? ? Time.now.utc : Time.parse(value)
+    end
+
+    def updated_at=(v)
+      @redis.set(updated_key, v.to_s)
+    end
+
+    def delete
+      @list.plug_list.delete(self)
+      @redis.delete(name_key)
+      @redis.delete(updated_key)
+    end
+
+    def exists?
+      count > 0
+    end
+
+    def count
+      @redis.llen(name_key)
+    end
+
+    def name_key
+      @name_key ||= plug_name(@name)
+    end
+
+    def updated_key
+      @updated_key ||= plug_name(@name, :updated)
+    end
+
+    # convert a simple plug name to a full plug name
+    def plug_name(plug, *extras)
+      s = "#{@list.prefix}:#{plug}"
+      extras.each { |e| s << ':' << e.to_s }
+      s
+    end
+  end
+end

data/demos/redis/sparkplug_redis.rb

@@ -0,0 +1,74 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..', 'lib')
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+require 'rubygems'
+require 'sinatra'
+require 'redis'
+require 'time'
+
+require 'sparkplug'
+require 'redis_demo/spark_list'
+require 'redis_demo/handler'
+
+config = 
+  if ENV['CONFIG']
+    if File.exist?(ENV['CONFIG'])
+      require 'yaml'
+      YAML.load_file(ENV['CONFIG'])
+    else
+      puts "Config file #{ENV['CONFIG'].inspect} not found."
+      {}
+    end
+  else
+    {}
+  end
+
+$redis_list = RedisDemo::SparkList.new(config)
+$handler    = RedisDemo::Handler.new($redis_list)
+pub_dir     = File.expand_path(File.join(File.dirname(__FILE__), 'public'))
+use Sparkplug, :prefix => 'sparks',
+  :handler => $handler,
+  :cacher  => Sparkplug::Cachers::Filesystem.new(File.join(pub_dir, 'sparks'))
+
+get '/' do
+  @plug_list = $redis_list.plug_list
+  erb :show
+end
+
+post '/modify' do
+  case params[:commit]
+    when /delete/i
+      $redis_list.find(params[:plug]).delete
+      redirect '/'
+    else
+      plug = $redis_list.find(params[:plug])
+      plug.add(params[:value])
+      redirect "/#{params[:plug]}"
+  end
+end
+
+post '/:plug/:value' do
+  plug = $redis_list.find(params[:plug])
+  plug.add(params[:value])
+  'ok'
+end
+
+get '/:plug.json' do
+  plug = $redis_list.find(params[:plug])
+  "[#{plug.datapoints * ","}]"
+end
+
+get '/:plug' do
+  @plug_list = $redis_list.plug_list
+  @plug      = $redis_list.find(params[:plug])
+  erb :show
+end
+
+delete '/:plug' do
+  plug = $redis_list.find(params[:plug])
+  plug.delete
+  'deleted'
+end
+
+def h(s)
+  Rack::Utils.escape(s)
+end

data/demos/redis/test/redis_demo_test.rb

@@ -0,0 +1,93 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack'
+require 'rack/test'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
+require 'sparkplug_redis'
+
+$redis_list.redis.flushall
+$redis_list.prefix = 'test'
+$redis_list.limit  = 5
+sake  = $redis_list.find('sake')
+unagi = $redis_list.find('unagi')
+sake.add 1
+sake.add 2
+sake.add 3
+unagi.add 1
+
+class RedisDemoTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Sinatra::Application
+  end
+
+  def test_root_url
+    get '/'
+    assert last_response.ok?
+  end
+
+  def test_adding_a_datapoint_for_new_plug
+    get '/koi.json'
+    assert_equal '[]', last_response.body
+
+    post '/koi/5'
+    assert last_response.ok?
+
+    get '/koi.json'
+    assert_equal '[5]', last_response.body
+  end
+
+  def test_datapoint_limit
+    10.times do |i|
+      post "/shiira/#{i + 5}"
+    end
+    get "/shiira.json"
+    assert_equal "[10,11,12,13,14]", last_response.body
+  end
+
+  def test_fetching_csv_data_for_existing_slug
+    get '/sake.json'
+    assert_equal '[1,2,3]', last_response.body
+  end
+
+  def test_deletes_plug
+    get '/unagi.json'
+    assert_equal '[1]', last_response.body
+
+    delete '/unagi'
+
+    get '/unagi.json'
+    assert_equal '[]', last_response.body
+  end
+end
+
+class RedisDemoPlugTest < Test::Unit::TestCase
+  def test_plug_list_stores_existing_plugs
+    assert  $redis_list.plug_list.all.include?('sake')
+    assert !$redis_list.plug_list.all.include?('flounder')
+  end
+
+  def test_adding_plug_adds_to_datapoint
+    assert !$redis_list.plug_list.all.include?('tamago')
+    $redis_list.find('tamago').add 5
+    assert  $redis_list.plug_list.all.include?('tamago')
+  end
+
+  def test_removing_plug_clears_from_datapoint
+    $redis_list.find('tamago').add 5
+    assert  $redis_list.plug_list.all.include?('tamago')
+    $redis_list.find('tamago').delete
+    assert !$redis_list.plug_list.all.include?('tamago')
+  end
+
+  def test_adding_datapoint_sets_updated_at
+    plug = $redis_list.find('shiira')
+    plug.add 1
+    date = plug.updated_at
+    sleep 1
+    plug.add 5
+    assert_not_equal date, plug.updated_at
+  end
+end

data/demos/redis/views/show.erb

@@ -0,0 +1,35 @@
+<html>
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8">
+    <title>Sparkplug - Ruby Rack module for generating sparkline graphs on the fly</title>
+    <style type="text/css" media="screen">
+h1, div, p {
+  font-family: verdana;
+}
+    </style>
+  </head>
+  <body>
+    <h1>Sparkplug Redis Demo<% if @plug %>: <%=h @plug.name %><% end %></h1>
+    <% if @plug %>
+    <div>
+      <img src="/sparks/<%= @plug.name %>.png" />
+    </div>
+    <p>(if you can see this, the rack module works!)</p>
+    <% end %>
+
+    <p><strong>Existing:</strong> <%= @plug_list.all.map { |name| %(<a href="/#{h(name)}">#{h(name)}</a>) }.join(", ") %></p>
+    <% if @plug %>
+    <p><a href="/">Back</a></p>
+    <% end %>
+    <form action="/modify" method="post">
+      <div>
+        <label>Name: <input type="text" name="plug" value="<%= @plug.name if @plug %>" /></label><br />
+        <label>Value: <input type="text" name="value" value="" size="5" /></label><br />
+        <input type="submit" name="commit" value="Save">
+        <% if @plug %>
+        <input type="submit" name="commit" value="Delete">
+        <% end %>
+      </div>
+    </form>
+  </body>
+</html>

data/demos/simple/sparkplug_demo.rb

@@ -3,8 +3,6 @@ require 'rubygems'
 require 'sinatra'
 
 require 'sparkplug'
-require 'sparkplug/handlers/csv_data'
-require 'sparkplug/cachers/filesystem'
 
 pub_dir = File.expand_path(File.join(File.dirname(__FILE__), 'public'))
 use Sparkplug, :prefix => 'sparks',

data/lib/sparkplug.rb

@@ -3,6 +3,18 @@ require 'spark_pr'
 # Render sparkline graphs dynamically from datapoints in a matching CSV file 
 # (or anything that there is a Handler for).
 class Sparkplug
+  module Cachers
+    autoload :Abstract,   'sparkplug/cachers/abstract'
+    autoload :Filesystem, 'sparkplug/cachers/filesystem'
+    autoload :Memory,     'sparkplug/cachers/memory'
+  end
+
+  module Handlers
+    autoload :AbstractData, 'sparkplug/handlers/abstract_data'
+    autoload :CsvData,      'sparkplug/handlers/csv_data'
+    autoload :StubbedData,  'sparkplug/handlers/stubbed_data'
+  end
+
   DEFAULT_SPARK_OPTIONS = {:has_min => true, :has_max => true, :height => 40, :step => 10}
 
   # Options:

data/lib/sparkplug/cachers/abstract.rb

@@ -1,4 +1,3 @@
-require 'sparkplug'
 require 'time'
 
 class Sparkplug

data/lib/sparkplug/cachers/filesystem.rb

@@ -1,4 +1,3 @@
-require 'sparkplug/cachers/abstract'
 require 'fileutils'
 
 class Sparkplug

data/lib/sparkplug/cachers/memory.rb

@@ -1,4 +1,3 @@
-require 'sparkplug/cachers/abstract'
 require 'fileutils'
 
 class Sparkplug

data/lib/sparkplug/handlers/abstract_data.rb

@@ -1,5 +1,3 @@
-require 'sparkplug'
-
 class Sparkplug
   module Handlers
     # Abstract class for retrieving the data and determining whether the cache

data/lib/sparkplug/handlers/csv_data.rb

@@ -1,5 +1,3 @@
-require 'sparkplug/handlers/abstract_data'
-
 module Sparkplug::Handlers
   # Reads sparkline data from CSV files.  Only the first line of numbers are 
   # read.  Requests for "/sparks/stats.csv" will pass a data_path of "stats.csv"

data/lib/sparkplug/handlers/stubbed_data.rb

@@ -1,5 +1,3 @@
-require 'sparkplug/handlers/abstract_data'
-
 module Sparkplug::Handlers
   # Allows you to stub sparkline data in a global hash.  Requests for 
   # "/sparks/stats.csv" will pass a data_path of "stats.csv"

data/sparkplug.gemspec

@@ -1,12 +1,15 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{sparkplug}
-  s.version = "2.0.0"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["rick"]
-  s.date = %q{2009-11-01}
+  s.date = %q{2009-12-29}
   s.email = %q{technoweenie@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -19,6 +22,14 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "demos/redis/Rakefile",
+     "demos/redis/lib/redis_demo/handler.rb",
+     "demos/redis/lib/redis_demo/spark_list.rb",
+     "demos/redis/public/sparks/foo.png",
+     "demos/redis/public/sparks/technoweenie.png",
+     "demos/redis/sparkplug_redis.rb",
+     "demos/redis/test/redis_demo_test.rb",
+     "demos/redis/views/show.erb",
      "demos/simple/public/temps/portland/2007.csv",
      "demos/simple/sparkplug_demo.rb",
      "demos/simple/views/readme.erb",
@@ -36,7 +47,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/technoweenie/sparkplug}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Rack module that dynamically generates sparkline graphs from a set of numbers.}
   s.test_files = [
     "test/sparkplug_test.rb"
@@ -52,3 +63,4 @@ Gem::Specification.new do |s|
   else
   end
 end
+

data/test/sparkplug_test.rb

@@ -6,10 +6,6 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rack'
 require 'rack/test'
 require 'sparkplug'
-require 'sparkplug/handlers/stubbed_data'
-require 'sparkplug/handlers/csv_data'
-require 'sparkplug/cachers/filesystem'
-require 'sparkplug/cachers/memory'
 
 class SparkplugTest < Test::Unit::TestCase
   include Rack::Test::Methods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sparkplug
 version: !ruby/object:Gem::Version 
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors: 
 - rick
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-01 00:00:00 -07:00
+date: 2009-12-29 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +29,14 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- demos/redis/Rakefile
+- demos/redis/lib/redis_demo/handler.rb
+- demos/redis/lib/redis_demo/spark_list.rb
+- demos/redis/public/sparks/foo.png
+- demos/redis/public/sparks/technoweenie.png
+- demos/redis/sparkplug_redis.rb
+- demos/redis/test/redis_demo_test.rb
+- demos/redis/views/show.erb
 - demos/simple/public/temps/portland/2007.csv
 - demos/simple/sparkplug_demo.rb
 - demos/simple/views/readme.erb
@@ -66,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Rack module that dynamically generates sparkline graphs from a set of numbers.