stacks 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzVhYWZlNDQ4ZGRlOGVlNDM3ZmU1NWU0ZmMzZTMyMDVjOTk4ZTNkYg==
+  data.tar.gz: !binary |-
+    ZmFmNmYyZDRmMTM5YjU1NDAxZWFiNzY1MzdlNzlkMzU3Yjc2YjYyMA==
+SHA512:
+  metadata.gz: !binary |-
+    Yzg2ZmI5MDVkYTIxYmIwZTRkYzk3MGU1OTFjODY4NmExMTI5ZWNhOTU0MmVh
+    MDAwYjgzNzM5YjZkZWZhODAzMDA3YTk5N2Q0OGNiMmU1MThiNzQwYjhjNjYx
+    Y2RhYzczMzA2ZjUyNGU0YTViNGUzNDA2ZmVjN2NjZjYzMzczYjA=
+  data.tar.gz: !binary |-
+    YWY0NTJiN2ZkNTJhMDhkNzc2YTZmZWQyMzEyZDRmZTNjNGI3ZjNkMjlmYWEx
+    YzFiMjk0M2IwMWM3NmMxNGZlOTc3NWY3NTE4ZWQ0YjgyODUwMjk5MWZlMmUw
+    ZTc5Mzk1NzQ5ZTY2YjE3MWU1MmZiNjdjNTNkZDdmMDA4MDZhM2U=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+stacks

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+gem 'activerecord'
+
+group :development do
+  gem 'mock_redis', '~> 0.10.0'
+  gem 'simplecov', '~> 0.8.2'
+  gem 'sqlite3', '~> 1.3.8'
+  gem 'jeweler', '~> 1.8.4'
+  gem 'rdoc', '~> 3.12'
+  gem 'rspec', '~> 2.8.0'
+  gem 'pry', '~> 0.9.12.4'
+end

data/Gemfile.lock

@@ -0,0 +1,85 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.18)
+      activesupport (= 2.3.18)
+    activesupport (2.3.18)
+    addressable (2.3.5)
+    builder (3.2.2)
+    coderay (1.1.0)
+    diff-lcs (1.1.3)
+    docile (1.1.1)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    method_source (0.8.2)
+    mock_redis (0.10.0)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.4.7)
+    sqlite3 (1.3.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  jeweler (~> 1.8.4)
+  mock_redis (~> 0.10.0)
+  pry (~> 0.9.12.4)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  simplecov (~> 0.8.2)
+  sqlite3 (~> 1.3.8)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 David Huie
+
+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,8 @@
+# stacks
+
+Fancy redis-backed caches.
+
+## Copyright
+
+Copyright (c) 2013 NationBuilder. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "stacks"
+  gem.homepage = "http://github.com/3dna/stacks"
+  gem.license = "MIT"
+  gem.summary = 'Fancy redis-backed caches'
+  gem.description = 'Fancy redis-backed caches'
+  gem.email = "david@nationbuilder.com"
+  gem.authors = ["David Huie"]
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/stacks.rb

@@ -0,0 +1,48 @@
+require 'digest/sha2'
+require 'active_record'
+require 'set'
+
+class Stacks
+
+  class << self
+    attr_accessor(:extra_prefix,
+                  :redis,
+                  :redis_prefix,
+                  :key_separator,
+                  :model_listening_caches,
+                  :deactivate,
+                  :restrict)
+  end
+
+  self.redis_prefix = 'stacks'
+  self.key_separator = ':'
+
+  module Backends; end
+  module Items; end
+
+  class NoValueException < Exception; end
+
+  def self.bust_all_caches
+    keys = redis.keys("#{redis_prefix}*")
+
+    redis.pipelined do
+      keys.each { |key| redis.del(key) }
+    end
+  end
+
+end
+
+require 'stacks/backends/backend'
+require 'stacks/backends/key_value_backend'
+require 'stacks/backends/namespaced_backend'
+require 'stacks/items/column_dependent_block'
+require 'stacks/items/method_call'
+require 'stacks/items/proc'
+require 'stacks/items/timestamp'
+require 'stacks/cache'
+require 'stacks/method_cache'
+require 'stacks/column_dependent_cache'
+require 'stacks/report_cache'
+require 'stacks/model_extensions'
+
+Stacks.model_listening_caches = [Stacks::ColumnDependentCache]

data/lib/stacks/backends/backend.rb

@@ -0,0 +1,38 @@
+module Stacks::Backends::Backend
+
+  def prefix_keys
+    keys = [Stacks.redis_prefix, backend_key]
+    keys << Stacks.extra_prefix.call if Stacks.extra_prefix
+    keys
+  end
+
+  def prefix_key
+    prefix_keys.join(Stacks::key_separator)
+  end
+
+  def suffix_key(item)
+    item.key
+  end
+
+  def key(item)
+    [prefix_key, suffix_key(item)].join(Stacks::key_separator)
+  end
+
+  def fill(item, ttl)
+    value = set(item)
+    expire(item, ttl)
+    value
+  end
+
+  def get_or_set(item, ttl)
+    begin
+      value = get(item)
+      return value
+    rescue Stacks::NoValueException
+
+    end
+
+    fill(item, ttl)
+  end
+
+end

data/lib/stacks/backends/key_value_backend.rb

@@ -0,0 +1,29 @@
+class Stacks::Backends::KeyValueBackend
+
+  include Stacks::Backends::Backend
+
+  def backend_key
+    "kv"
+  end
+
+  def get(item)
+    potential_value = Stacks.redis.get(key(item))
+    raise Stacks::NoValueException unless potential_value
+    Marshal.load(potential_value) if potential_value
+  end
+
+  def set(item)
+    value = item.value
+    Stacks.redis.set(key(item), Marshal.dump(value))
+    value
+  end
+
+  def del(item)
+    Stacks.redis.del(key(item))
+  end
+
+  def expire(item, ttl)
+    Stacks.redis.expire(key(item), ttl)
+  end
+
+end

data/lib/stacks/backends/namespaced_backend.rb

@@ -0,0 +1,47 @@
+class Stacks::Backends::NamespacedBackend
+
+  include Stacks::Backends::Backend
+
+  attr_accessor :namespace
+
+  def backend_key
+    "n"
+  end
+
+  def prefix_keys
+    super << @namespace
+  end
+
+  def get(item)
+    potential_value = Stacks.redis.hget(prefix_key, suffix_key(item))
+    raise Stacks::NoValueException unless potential_value
+    return Marshal.load(potential_value) if potential_value
+  end
+
+  def set(item)
+    value = item.value
+    Stacks.redis.hset(prefix_key, suffix_key(item), Marshal.dump(value))
+    value
+  end
+
+  def expire(item, ttl)
+    Stacks.redis.expire(prefix_key, ttl)
+  end
+
+  def clear_cache
+    Stacks.redis.del(prefix_key)
+  end
+
+  def keys
+    Stacks.redis.hkeys(prefix_key)
+  end
+
+  def del_key(key)
+    Stacks.redis.hdel(prefix_key, key)
+  end
+
+  def del(item)
+    del_key(suffix_key(item))
+  end
+
+end

data/lib/stacks/cache.rb

@@ -0,0 +1,13 @@
+module Stacks::Cache
+
+  def get_value(item, backend, ttl)
+    return item.value if Stacks.deactivate
+
+    if Stacks.restrict
+      return item.value unless Stacks.restrict.call
+    end
+
+    backend.get_or_set(item, ttl)
+  end
+
+end

data/lib/stacks/column_dependent_cache.rb

@@ -0,0 +1,98 @@
+class Stacks::ColumnDependentCache
+
+  extend Stacks::Cache
+
+  class << self
+    attr_accessor :default_ttl, :cache_filling_job
+  end
+
+  # Expire everything after one week
+  self.default_ttl = 60*60*24*7
+
+  class InvalidModel < Exception; end
+
+  def self.validate_model(model)
+    raise InvalidModel.new(model.to_s) unless model < ActiveRecord::Base
+  end
+
+  def self.get_backend(model)
+    backend = Stacks::Backends::NamespacedBackend.new
+    backend.namespace = model.to_s
+    backend
+  end
+
+  def self.defined_blocks
+    @defined_caches ||= {}
+  end
+
+  def self.fillable_block_keys
+    @fillable_block_keys ||= Hash.new { |h, k| h[k] = {} }
+  end
+
+  def self.get_block_value(identifier)
+    item = defined_blocks[identifier]
+    backend = get_backend(item.model)
+
+    get_value(item, backend, default_ttl)
+  end
+
+  def self.define_block(model, columns, identifier, &block)
+    item = get_item(model, columns, identifier, block)
+    defined_blocks[identifier] = item
+    fillable_block_keys[model][item.key] = item
+  end
+
+  def self.make_fill_decision(model, key)
+    if cache_filling_job
+      cache_filling_job.call(model, key)
+    else
+      fill_block(model, key)
+    end
+  end
+
+  def self.fill_block(model, key)
+    item = fillable_block_keys[model][key]
+    backend = get_backend(item.model)
+    backend.fill(item, default_ttl)
+  end
+
+  def self.get_item(model, columns, identifier, block)
+    validate_model(model)
+    columns = [columns] unless columns.is_a?(Array)
+    Stacks::Items::ColumnDependentBlock.new(model, columns, identifier, block)
+  end
+
+  def self.cached(model, columns, identifier, &block)
+    backend = get_backend(model)
+    item = get_item(model, columns, identifier, block)
+
+    get_value(item, backend, default_ttl)
+  end
+
+  def self.bust_cache(model, columns)
+    backend = get_backend(model)
+    columns = columns.map { |c| c.to_s }
+
+    fill_keys = Set.new
+    del_keys = Set.new
+
+    backend.keys.each do |key|
+      potential_columns = Stacks::Items::ColumnDependentBlock.key_to_columns(key)
+
+      columns.each do |column|
+        if potential_columns.include?(column)
+          if fillable_block_keys[model].keys.include?(key)
+            fill_keys << [model, key]
+            next
+          end
+
+          del_keys << key
+        end
+      end
+    end
+
+    fill_keys.each { |model, key| make_fill_decision(model, key) }
+    del_keys.each { |key| backend.del_key(key) }
+  end
+
+end