red_trend 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2012 Brendon Murphy
+
+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,48 @@
+# RedTrend
+
+Store your trend data in redis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'red_trend'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install red_trend
+
+## Usage
+
+```ruby
+require 'red_trend'
+
+red_trend = RedTrend.new(:prefix => "project:9")
+red_trend.record("post_views", 42)
+red_trend.record("post_views", 53)
+red_trend.record("post_views", 53)
+red_trend.top("post_views") # => ["53", "42"]
+```
+
+TODO add configuration examples here
+
+## How it works
+
+TODO
+
+## Todos
+
+Rip ActiveSupport entirely if possible; otherwise narrow the inclusion.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create your specs and feature code
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+

data/lib/red_trend/version.rb

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

data/lib/red_trend.rb

@@ -0,0 +1,132 @@
+require 'redis'
+require "red_trend/version"
+require 'active_support/all'
+
+class RedTrend
+  CYCLE_UNITS = {
+    :minute => 60,
+    :hour  => 3600,
+    :day => 86400
+  }.freeze
+
+  class << self
+    attr_writer :redis
+
+    def redis
+      @redis ||= Redis.new
+    end
+  end
+
+  attr_reader :options
+
+  def initialize(options = {})
+    @options = options
+    unless CYCLE_UNITS.include?(cycle_unit)
+      raise ArgumentError, "cycle unit must be in #{CYCLE_UNITS.keys}"
+    end
+  end
+
+  # How many cycles we'll persist data for
+  def cycles_count
+    @options.fetch(:cycles_count, 3)
+  end
+
+  def cycle_length
+    CYCLE_UNITS[cycle_unit]
+  end
+
+  # The length of 1 cycle
+  def cycle_unit
+    @options.fetch(:cycle_unit, :hour)
+  end
+
+  # The interval length of each cycle, probably
+  # days for production
+  def cycle_interval
+    cycle_length * cycles_count
+  end
+
+  def current_cycle
+    method = case cycle_unit
+             when :minute then :min
+             when :hour then :hour
+             when :day then :yday
+             end
+
+    time = @time || Time.now
+    (time.send(method) % cycles_count) + 1
+  end
+
+  def cycle_positions
+    1.upto(cycles_count - 1).inject([current_cycle]) do |n_cycles, offset|
+      n = current_cycle - offset
+      n = n + cycles_count if n < 1
+      n_cycles << n
+    end
+  end
+
+  # Increment the leaderboard score for the object on
+  # the sorted set for the current cycle.  Make the key
+  # volitile so that it doesn't persist past the number
+  # of cycles.  Store the union score set after each
+  # new score
+  def record(key, member)
+    @time = Time.now
+
+    n_key = make_key(key, current_cycle)
+
+    zcard = redis.zcard(n_key)
+
+    redis.multi do
+      redis.zincrby n_key, 1, member
+      # FIXME I'm not certain the second redis.ttl is working in the multi
+      if zcard < 1 || redis.ttl(n_key) == -1
+        redis.expire n_key, calculate_expire_seconds
+      end
+      unionize_sets(key)
+    end
+
+    @time = nil
+
+    true
+  end
+
+  # Returns top scoring ids for the current interval
+  def top(key, limit = 10)
+    redis.zrevrange make_key(key), 0, limit - 1
+  end
+
+  def weight_offset
+    ("%0.1f" % (1 / cycles_count.to_f)).to_f
+  end
+
+  def cycle_weights
+    cycles_count.times.inject([]) do |weights, n|
+      weights << 1 - n * weight_offset
+    end
+  end
+
+  private
+
+  def make_key(*args)
+    key_parts = [options[:prefix]]
+    key_parts.concat Array(args)
+    key_parts.compact.join(":")
+  end
+
+  def redis
+    self.class.redis
+  end
+
+  # The time in seconds which the current cycle key should expire in
+  def calculate_expire_seconds
+    ((@time.to_f / cycle_length).floor * cycle_length + cycle_interval) - @time.to_i
+  end
+
+  # Take the scores from all current cycle sets and store
+  # them as a union
+  def unionize_sets(key)
+    keys = cycle_positions.collect { |n| make_key(key, n) }
+    redis.zunionstore(make_key(key), keys, :weights => cycle_weights)
+  end
+end

data/red_trend.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/red_trend/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Brendon Murphy"]
+  gem.email         = ["xternal1+github@gmail.com"]
+  gem.description   = %q{Store your trend data in redis}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "red_trend"
+  gem.require_paths = ["lib"]
+  gem.version       = RedTrend::VERSION
+
+  gem.add_dependency "redis"
+  gem.add_dependency "active_support"
+  gem.add_dependency "i18n"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "integration_test_redis"
+  gem.add_development_dependency "timecop"
+end

data/spec/red_trend_spec.rb

@@ -0,0 +1,275 @@
+require 'spec_helper'
+
+describe RedTrend, "redis connection config at the class level" do
+  let(:redis) { stub }
+
+  it "can instantiate a default localhost redis instance" do
+    RedTrend.redis = nil
+    Redis.should_receive(:new).with().and_return(redis)
+    RedTrend.redis.should == redis
+  end
+
+  it "can be overrided with a redis connection" do
+    RedTrend.redis = redis
+    RedTrend.redis.should == redis
+  end
+end
+
+describe RedTrend, "defaults" do
+  subject { RedTrend.new }
+
+  it "cycles_count to 3" do
+    subject.cycles_count.should == 3
+  end
+
+  it "cycle_unit to :hour" do
+    subject.cycle_unit.should == :hour
+  end
+
+  it "cycle_length to 3 hours" do
+    subject.cycle_interval.to_i.should == 3 * 60 * 60
+  end
+end
+
+describe RedTrend, "overriding defaults" do
+  subject { RedTrend.new(:cycles_count => 2, :cycle_unit => :minute) }
+
+  it "allows setting the cycles_count" do
+    subject.cycles_count.should == 2
+  end
+
+  it "allows setting the cycle_length" do
+    subject.cycle_length.should == 60
+  end
+
+  it "accepts the cycle_length of :minute, :hour, or :day" do
+    [:minute, :hour, :day].each do |unit|
+      lambda {
+        RedTrend.new(:cycle_length => unit)
+      }.should_not raise_error
+    end
+  end
+
+  it "raises an argument error for an unknown cycle length" do
+    lambda {
+      RedTrend.new(:cycle_unit => :foobar)
+    }.should raise_error(ArgumentError)
+  end
+end
+
+describe RedTrend, "cycle interval" do
+  context "for a cycle_count of 2 and cycle_unit of :minute" do
+    it "is 120" do
+      subject = RedTrend.new(:cycles_count => 2, :cycle_unit => :minute)
+      subject.cycle_interval.should == 120
+    end
+  end
+
+  context "for a cycle_count of 4 and cycle_length of 1 day" do
+    it "is 345600" do
+      subject = RedTrend.new(:cycles_count => 4, :cycle_unit => :day)
+      subject.cycle_interval.should == 345600
+    end
+  end
+end
+
+describe RedTrend, "getting the current cycle" do
+  before do
+    Timecop.freeze("2012-07-30 18:00:00 -0700")
+  end
+
+  context "for a default RedTrend" do
+    subject { RedTrend.new }
+
+    it "cycles from 1 through 3 on intervals based on the hour" do
+      subject.current_cycle.should == 1
+      Timecop.travel(3600)
+      subject.current_cycle.should == 2
+      Timecop.travel(3600)
+      subject.current_cycle.should == 3
+      Timecop.travel(3600)
+      subject.current_cycle.should == 1
+    end
+
+    it "cycles from 2, 3, 1 on intervals based on the hour" do
+      Timecop.freeze("2012-07-30 19:00:00 -0700")
+      subject.current_cycle.should == 2
+      Timecop.travel(3600)
+      subject.current_cycle.should == 3
+      Timecop.travel(3600)
+      subject.current_cycle.should == 1
+      Timecop.travel(3600)
+      subject.current_cycle.should == 2
+    end
+
+    it "behaves when the time does not fall on the boundary" do
+      subject.current_cycle.should == 1
+      Timecop.travel(1800)
+      subject.current_cycle.should == 1
+      Timecop.travel(1800)
+      subject.current_cycle.should == 2
+    end
+  end
+
+  context "for a RedTrend of 4 cycles of 60 seconds" do
+    subject { RedTrend.new(:cycles_count => 4, :cycle_unit => :minute) }
+
+    it "cycles from 1 through 4 on intervals based on the minute" do
+      subject.current_cycle.should == 1
+      Timecop.travel(60)
+      subject.current_cycle.should == 2
+      Timecop.travel(60)
+      subject.current_cycle.should == 3
+      Timecop.travel(60)
+      subject.current_cycle.should == 4
+      Timecop.travel(60)
+      subject.current_cycle.should == 1
+    end
+  end
+
+  context "for a RedTrend of 2 cycles of 1 day" do
+    subject { RedTrend.new(:cycles_count => 2, :cycle_unit => :day) }
+
+    it "cycles from 1 through 2 on intervals based on the day" do
+      subject.current_cycle.should == 1
+      Timecop.travel(86400)
+      subject.current_cycle.should == 2
+      Timecop.travel(86400)
+      subject.current_cycle.should == 1
+    end
+  end
+
+  context "for a RedTrend of 3 cycles of 1 day starting with Dec 31" do
+    subject { RedTrend.new(:cycles_count => 3, :cycle_unit => :day) }
+
+    it "cycles from 1 through 2 on intervals based on the day" do
+      Timecop.freeze("2012-12-31 18:00:00 -0700")
+      subject.current_cycle.should == 1
+      Timecop.travel(86400)
+      subject.current_cycle.should == 2
+      Timecop.travel(86400)
+      subject.current_cycle.should == 3
+      Timecop.travel(86400)
+      subject.current_cycle.should == 1
+    end
+  end
+end
+
+describe RedTrend, "getting an array of cycle numbers" do
+  subject { RedTrend.new :cycles_count => 4 }
+
+  before do
+    Timecop.freeze("2012-07-30 18:00:00 -0700")
+  end
+
+  it "starts with the current cycle to the last cycle and wraps back around" do
+    subject.cycle_positions.should == [3, 2, 1, 4]
+  end
+end
+
+describe RedTrend, "recording" do
+  subject { RedTrend.new }
+  let(:redis) { IntegrationTestRedis.client }
+
+  before do
+    Timecop.freeze("2012-07-30 18:00:00 -0700")
+  end
+
+  it "increments the score for the member at the current zset key" do
+    subject.record("foobar", 42)
+    redis.zscore("foobar:1", "42").should == 1
+    subject.record("foobar", 42)
+    redis.zscore("foobar:1", "42").should == 2
+  end
+
+  it "prefixes the key if the prefix option was set" do
+    subject.options[:prefix] = "fizz:buzz"
+    subject.record("foobar", 42)
+    redis.zscore("fizz:buzz:foobar:1", "42").should == 1
+  end
+
+  it "sets the zset to expire when the cycle wraps back around to it" do
+    subject.record("foobar", 42)
+    redis.ttl("foobar:1").should == 10800
+
+    Timecop.travel(1800)
+    subject.record("foobar", 42)
+    redis.ttl("foobar:1").should == 10800
+
+    Timecop.travel(1800)
+    subject.record("foobar", 42)
+    redis.ttl("foobar:2").should == 10800
+  end
+
+  it "creates a union set from the current zsets" do
+    redis.exists("foobar").should be_false
+    subject.record("foobar", 42)
+    redis.exists("foobar").should be_true
+  end
+end
+
+describe RedTrend, "storing a union off all cycles" do
+  subject { RedTrend.new }
+  let(:redis) { IntegrationTestRedis.client }
+
+  before do
+    Timecop.freeze("2012-07-30 18:00:00 -0700")
+
+    # Cycle 1
+    subject.record("foobar", 1)
+    Timecop.travel(1800)
+    subject.record("foobar", 2)
+
+    # Cycle 2
+    Timecop.travel(1800)
+    subject.record("foobar", 3)
+
+    # Cycle 3
+    Timecop.travel(3600)
+    subject.record("foobar", 4)
+
+    # Cycle 1
+    Timecop.travel(3600)
+    subject.record("foobar", 5)
+
+    # Cycle 2
+    Timecop.travel(3600)
+    subject.record("foobar", 1)
+  end
+
+  it "unionizes the data from all the available cycles" do
+    redis.zrange("foobar", 0, -1).should =~ %w[1 2 3 4 5]
+  end
+
+  it "weights the unionization to prefer newer data" do
+    redis.zrevrangebyscore("foobar", '+inf', '-inf').should == %w[1 3 5 2 4]
+  end
+
+  it "builds a weight offset by dividing 1 by the cycles count and rounding to 1/10 precision" do
+    subject.weight_offset.should == 0.3
+    subject.options[:cycles_count] = 4
+    subject.weight_offset.should == 0.2
+  end
+
+  it "uses the weight offset to build decreasing weights by subtracting multiples of the offset" do
+    redis.zrevrangebyscore("foobar", '+inf', '-inf', :with_scores => true).map(&:last).should == [1.7, 1, 0.7, 0.7, 0.4]
+  end
+end
+
+describe RedTrend, "getting the current top ids" do
+  subject { RedTrend.new }
+
+  before do
+    1.upto(11) do |n|
+      n.times { subject.record("foobar", n) }
+    end
+  end
+
+  it "returns the top 10 zrevrange of the union set" do
+    subject.top("foobar").should == %w[11 10 9 8 7 6 5 4 3 2]
+  end
+
+  it "can be given an optional limit" do
+    subject.top("foobar", 3).should == %w[11 10 9]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rspec'
+require 'timecop'
+
+require File.expand_path("../../lib/red_trend", __FILE__)
+
+require "integration_test_redis"
+IntegrationTestRedis.start
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.before(:each) do
+    RedTrend.redis = IntegrationTestRedis.client
+    IntegrationTestRedis.client.flushdb
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: red_trend
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &2164433440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164433440
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: &2164433000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164433000
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &2164432580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164432580
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2164657580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164657580
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2164657120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164657120
+- !ruby/object:Gem::Dependency
+  name: integration_test_redis
+  requirement: &2164656140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164656140
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &2164655580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164655580
+description: Store your trend data in redis
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/red_trend.rb
+- lib/red_trend/version.rb
+- red_trend.gemspec
+- spec/red_trend_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3032661298513805062
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3032661298513805062
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Store your trend data in redis
+test_files:
+- spec/red_trend_spec.rb
+- spec/spec_helper.rb