cache_reduce 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22c4d6f4018a2ace22fb44c20f93130d2ce67c88
+  data.tar.gz: 5dfbd810aced627db4b1897abbf155f07419166b
+SHA512:
+  metadata.gz: c8e89c4c2c759111988ca57328477e7b5139200d4115769dc5e7286aa61f51bfff326bbf0c3e299a5a3a17b9d94c2dc3301b55d3d9a5ef50fa3dea87918b5f32
+  data.tar.gz: 2ee7f24160e00e21ccf47e5b47aae36a872ae5ed16f907ed6758256f2fc41bcf1c4902bf5a1d8ba89e13a96f096c7cab1bf12e060ad860b9646a0000de0dd29a

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Kane
+
+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,147 @@
+# CacheReduce
+
+A simple, powerful pattern for caching data
+
+:warning: Work in progress - interface not finalized
+
+## How It Works
+
+1. Cache step - data is cached in small buckets by time
+  - Break time range into small buckets
+  - Read values from cache
+  - Caclulate missing values
+  - Cache new values, except the current period
+
+2. Reduce step - group buckets and reduce
+
+Since the current period is always calculated, CacheReduce provides real-time results.
+
+## Examples
+
+### Searches
+
+```ruby
+class SearchesCount
+  include CacheReduce::Magic
+
+  def value(time_range)
+    Search.where(created_at: time_range).count
+  end
+end
+```
+
+Count all searches
+
+```ruby
+SearchesCount.all(time_range: time_range)
+```
+
+Count searches by day
+
+```ruby
+SearchesCount.by_day(time_range: time_range)
+```
+
+### New Users
+
+Use the preload method for faster cache warming.
+
+```ruby
+class NewUsersCount
+  include CacheReduce::Magic
+
+  def preload(time_range)
+    @users = User.group_by_hour(:created_at, range: time_range).count
+  end
+
+  def value(time_range)
+    @users[time_range.first]
+  end
+end
+```
+
+And:
+
+```ruby
+NewUsersCount.all(time_range: time_range)
+NewUsersCount.by_day(time_range: time_range)
+```
+
+### Visitors
+
+Reduce ids instead of numbers - great for creating funnels
+
+```ruby
+class VisitorIds
+  include CacheReduce::Magic
+
+  def value(time_range)
+    Visit.where(created_at: time_range).uniq.pluck(:user_id)
+  end
+
+  def reduce(values)
+    values.flatten
+  end
+end
+```
+
+### Events
+
+Pass your own arguments
+
+```ruby
+class EventCount
+  include CacheReduce::Magic
+
+  def initialize(name)
+    @name = name
+  end
+
+  def key
+    ["event", @name]
+  end
+
+  def value(time_range)
+    Ahoy::Event.where(name: @name, time: time_range).count
+  end
+
+end
+```
+
+### Reducers
+
+Built-in methods
+
+- all
+- by_day
+- by_hour
+
+Built-in operations
+
+- sum
+- flatten
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'cache_reduce'
+```
+
+## TODO
+
+- more reducer methods - `by_week`, `by_month`, etc.
+- custom cache period, not just hours
+- more data stores
+- better interface
+- better readme
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/cache_reduce/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/cache_reduce/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

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

data/cache_reduce.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cache_reduce/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cache_reduce"
+  spec.version       = CacheReduce::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+  spec.summary       = %q{A simple, powerful pattern for caching data}
+  spec.description   = %q{A simple, powerful pattern for caching data}
+  spec.homepage      = "https://github.com/ankane/cache_reduce"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/cache_reduce.rb

@@ -0,0 +1,122 @@
+require "cache_reduce/version"
+
+module CacheReduce
+  module Magic
+
+    def all(options = {})
+      reduce(fetch(options).values)
+    end
+
+    def by_day(options = {})
+      result = fetch(options)
+      time_range = result.keys.first..result.keys.last
+      days = [time_range.first.beginning_of_day]
+      while day = days.last + 1.day and time_range.cover?(day)
+        days << day
+      end
+      grouped = result.group_by{|k, v| k.beginning_of_day }
+
+      final = {}
+      days.each do |day|
+        final[day] = reduce((grouped[day] || []).map(&:last))
+      end
+      final
+    end
+
+    def by_hour(options = {})
+      fetch(options)
+    end
+
+    protected
+
+    def preload(time_range)
+    end
+
+    def value(time_range)
+      raise "Must define value"
+    end
+
+    def reduce(values)
+      values.sum
+    end
+
+    def key
+      self.class.name.underscore
+    end
+
+    def cache_store
+      @cache_store ||= CacheStore.new
+    end
+
+    def fetch(options = {})
+      time_range = options[:time_range]
+
+      hours = [time_range.first.beginning_of_hour]
+      while hour = hours.last + 1.hour and time_range.cover?(hour)
+        hours << hour
+      end
+
+      # TODO handle advanced objects as keys
+      key = self.key
+      key = key.join("/") if key.is_a?(Array)
+      keys = hours.map{|h| [key, "hour", h.to_i].join("/") }
+      values = options[:fresh] ? {} : cache_store.read(keys)
+
+      # TODO smarter groups
+      range_start = nil
+      hours.each_with_index do |hour, i|
+        value = values[keys[i]]
+        if !value
+          range_start = hour
+          break
+        end
+      end
+
+      preload(range_start...hours.last + 1.hour)
+
+      result = {}
+      hours.each_with_index do |hour, i|
+        key = keys[i]
+        result[hour] =
+          if values[key]
+            values[key]
+          else
+            v = value(hour...hour + 1.hour)
+            if hour.end_of_hour < Time.now
+              cache_store.write(key, v)
+            end
+            v
+          end
+      end
+
+      result
+    end
+
+  end
+
+  class CacheStore
+
+    # TODO update interface
+    # key, period, hours
+    def read(keys)
+      # puts "READ: #{keys}"
+      values = {}
+      redis.mget(*keys).each_with_index do |value, i|
+        key = keys[i]
+        value = redis.get(key)
+        values[key] = value ? JSON.parse("[" + value + "]")[0] : nil
+      end
+      values
+    end
+
+    def write(key, value)
+      # puts "WRITE: #{key} #{value}"
+      redis.set(key, value.to_json)
+    end
+
+    def redis
+      @redis ||= Redis.new
+    end
+
+  end
+end

data/lib/cache_reduce/version.rb

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

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: cache_reduce
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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 simple, powerful pattern for caching data
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cache_reduce.gemspec
+- lib/cache_reduce.rb
+- lib/cache_reduce/version.rb
+homepage: https://github.com/ankane/cache_reduce
+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 simple, powerful pattern for caching data
+test_files: []