readthis 0.8.1 → 1.0.0

data/benchmarks/compressed.rb

@@ -1,74 +0,0 @@
-require 'bundler'
-
-Bundler.setup
-
-require 'benchmark/ips'
-require 'dalli'
-require 'active_support'
-require 'active_support/cache/dalli_store'
-require 'readthis'
-
-dalli = ActiveSupport::Cache::DalliStore.new(
-  'localhost',
-  pool_size: 5,
-  compressed: true,
-  compression_threshold: 8
-)
-
-readthis  = Readthis::Cache.new(
-  pool_size: 5,
-  compressed: true,
-  compression_threshold: 128
-)
-
-KEY  = 'key'
-TEXT = <<-TEXT
-  An abstract cache store class. There are multiple cache store implementations, each having its own additional features. See the classes under the ActiveSupport::Cache module, e.g. ActiveSupport::Cache::MemCacheStore. MemCacheStore is currently the most popular cache store for large production websites.
-  Some implementations may not support all methods beyond the basic cache methods of fetch, write, read, exist?, and delete.
-  ActiveSupport::Cache::Store can store any serializable Ruby object.
-  cache = ActiveSupport::Cache::MemoryStore.new
-  cache.read('city')   # => nil
-  cache.write('city', "Duckburgh")
-  cache.read('city')   # => "Duckburgh"
-  Keys are always translated into Strings and are case sensitive. When an object is specified as a key and has a cache_key method defined, this method will be called to define the key. Otherwise, the to_param method will be called. Hashes and Arrays can also be used as keys. The elements will be delimited by slashes, and the elements within a Hash will be sorted by key so they are consistent.
-  cache.read('city') == cache.read(:city)   # => true
-  Nil values can be cached.
-  If your cache is on a shared infrastructure, you can define a namespace for your cache entries. If a namespace is defined, it will be prefixed on to every key. The namespace can be either a static value or a Proc. If it is a Proc, it will be invoked when each key is evaluated so that you can use application logic to invalidate keys.
-  cache.namespace = -> { @last_mod_time }  # Set the namespace to a variable
-  @last_mod_time = Time.now  # Invalidate the entire cache by changing namespace
-  Caches can also store values in a compressed format to save space and reduce time spent sending data. Since there is overhead, values must be large enough to warrant compression. To turn on compression either pass compress: true in the initializer or as an option to fetch or write. To specify the threshold at which to compress values, set the :compress_threshold option. The default threshold is 16K.
-TEXT
-
-puts 'Compressed Write/Read:'
-Benchmark.ips do |x|
-  x.report 'readthis:write/read' do
-    readthis.write(KEY, TEXT)
-    readthis.read(KEY)
-  end
-
-  x.report 'dalli:write/read' do
-    dalli.write(KEY, TEXT)
-    dalli.read(KEY)
-  end
-
-  x.compare!
-end
-
-puts 'Compressed Read Multi:'
-MULTI_KEY = (1..30).to_a
-MULTI_KEY.each do |key|
-  readthis.write(key, TEXT)
-  dalli.write(key, TEXT)
-end
-
-Benchmark.ips do |x|
-  x.report 'readthis:read_multi' do
-    readthis.read_multi(*MULTI_KEY)
-  end
-
-  x.report 'dalli:read_multi' do
-    dalli.read_multi(*MULTI_KEY)
-  end
-
-  x.compare!
-end

data/benchmarks/driver.rb

@@ -1,18 +0,0 @@
-require 'bundler'
-
-Bundler.setup
-
-require 'benchmark/ips'
-require 'readthis'
-
-native  = Readthis::Cache.new(redis: { driver: :ruby }, expires_in: 60)
-hiredis = Readthis::Cache.new(redis: { driver: :hiredis }, expires_in: 60)
-
-('a'..'z').each { |key| native.write(key, key * 1024) }
-
-Benchmark.ips do |x|
-  x.report('native:read-multi')  { native.read_multi(*('a'..'z')) }
-  x.report('hiredis:read-multi') { hiredis.read_multi(*('a'..'z')) }
-
-  x.compare!
-end

data/benchmarks/marshalling.rb

@@ -1,40 +0,0 @@
-require 'bundler'
-
-Bundler.setup
-
-require 'benchmark/ips'
-require 'json'
-require 'oj'
-require 'msgpack'
-require 'readthis'
-require 'readthis/passthrough'
-
-OPTIONS = { compressed: false }
-
-readthis_pass    = Readthis::Cache.new(OPTIONS.merge(marshal: Readthis::Passthrough))
-readthis_oj      = Readthis::Cache.new(OPTIONS.merge(marshal: Oj))
-readthis_msgpack = Readthis::Cache.new(OPTIONS.merge(marshal: MessagePack))
-readthis_json    = Readthis::Cache.new(OPTIONS.merge(marshal: JSON))
-readthis_ruby    = Readthis::Cache.new(OPTIONS.merge(marshal: Marshal))
-
-HASH = ('a'..'z').each_with_object({}) { |key, memo| memo[key] = key }
-
-Benchmark.ips do |x|
-  x.report('pass:hash:dump')    { readthis_pass.write('pass',       HASH) }
-  x.report('oj:hash:dump')      { readthis_oj.write('oj',           HASH) }
-  x.report('json:hash:dump')    { readthis_json.write('json',       HASH) }
-  x.report('msgpack:hash:dump') { readthis_msgpack.write('msgpack', HASH) }
-  x.report('ruby:hash:dump')    { readthis_ruby.write('ruby',       HASH) }
-
-  x.compare!
-end
-
-Benchmark.ips do |x|
-  x.report('pass:hash:load')    { readthis_pass.read('pass') }
-  x.report('oj:hash:load')      { readthis_oj.read('oj') }
-  x.report('json:hash:load')    { readthis_json.read('json') }
-  x.report('msgpack:hash:load') { readthis_msgpack.read('msgpack') }
-  x.report('ruby:hash:load')    { readthis_ruby.read('ruby') }
-
-  x.compare!
-end

data/benchmarks/memory.rb

@@ -1,11 +0,0 @@
-require 'bundler'; Bundler.setup
-a = GC.stat(:total_allocated_objects)
-
-require 'readthis'
-b = GC.stat(:total_allocated_objects)
-
-require 'redis-activesupport'
-c = GC.stat(:total_allocated_objects)
-
-puts "readthis: #{b - a}"
-puts "redis-activesupport: #{c - b}"

data/benchmarks/multi.rb

@@ -1,64 +0,0 @@
-require 'bundler'
-
-Bundler.setup
-
-require 'benchmark/ips'
-require 'dalli'
-require 'redis-activesupport'
-require 'active_support/cache/memory_store'
-require 'active_support/cache/dalli_store'
-require 'readthis'
-
-memory   = ActiveSupport::Cache::MemoryStore.new(expires_in: 60, namespace: 'mm')
-dalli    = ActiveSupport::Cache::DalliStore.new('localhost', namespace: 'da', pool_size: 5, expires_in: 60)
-redisas  = ActiveSupport::Cache::RedisStore.new('redis://localhost:6379/11/ra', expires_in: 60)
-readthis = Readthis::Cache.new(namespace: 'rd', expires_in: 60)
-
-('a'..'z').each do |key|
-  value = key * 1024
-
-  memory.write(key, value)
-  dalli.write(key, value)
-  readthis.write(key, value)
-  redisas.write(key, value)
-end
-
-Benchmark.ips do |x|
-  x.report 'memory:read-multi' do
-    memory.read_multi(*('a'..'z'))
-  end
-
-  x.report 'readthis:read-multi' do
-    readthis.read_multi(*('a'..'z'))
-  end
-
-  x.report 'redisas:read-multi' do
-    redisas.read_multi(*('a'..'z'))
-  end
-
-  x.report 'dalli:read-multi' do
-    dalli.read_multi(*('a'..'z'))
-  end
-
-  x.compare!
-end
-
-Benchmark.ips do |x|
-  x.report 'memory:fetch-multi' do
-    memory.fetch_multi(*('a'..'z')) { |_| 'missing' }
-  end
-
-  x.report 'readthis:fetch-multi' do
-    readthis.fetch_multi(*('a'..'z')) { |_| 'missing' }
-  end
-
-  x.report 'redisas:fetch-multi' do
-    redisas.fetch_multi(*('a'..'z')) { |_| 'missing' }
-  end
-
-  x.report 'dalli:fetch-multi' do
-    dalli.fetch_multi(*('a'..'z')) { |_| 'missing' }
-  end
-
-  x.compare!
-end

data/benchmarks/profile.rb

@@ -1,20 +0,0 @@
-require 'bundler'
-
-Bundler.setup
-
-require 'fileutils'
-require 'stackprof'
-require 'readthis'
-
-readthis = Readthis::Cache.new('redis://localhost:6379/11')
-
-FileUtils.mkdir_p('tmp')
-readthis.clear
-
-('a'..'z').each { |key| readthis.write(key, key * 1024) }
-
-StackProf.run(mode: :object, interval: 500, out: "tmp/stackprof-object.dump") do
-  1000.times do
-    readthis.read_multi(*('a'..'z'))
-  end
-end

data/bin/rspec

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'rspec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('rspec-core', 'rspec')

data/lib/readthis/notifications.rb

@@ -1,7 +0,0 @@
-module Readthis
-  module Notifications
-    def self.instrument(_name, payload)
-      yield(payload)
-    end
-  end
-end

data/readthis.gemspec

@@ -1,27 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'readthis/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'readthis'
-  spec.version       = Readthis::VERSION
-  spec.authors       = ['Parker Selbert']
-  spec.email         = ['parker@sorentwo.com']
-  spec.summary       = 'Pooled active support compliant caching with redis'
-  spec.description   = 'Pooled active support compliant caching with redis'
-  spec.homepage      = 'https://github.com/sorentwo/readthis'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(%r{^(spec)/})
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'redis',           '~> 3.0'
-  spec.add_dependency 'connection_pool', '~> 2.1'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'hiredis', '~> 0.5'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec',   '~> 3.1'
-end

data/spec/readthis/notifications_spec.rb

@@ -1,15 +0,0 @@
-require 'readthis/notifications'
-
-RSpec.describe Readthis::Notifications do
-  describe '#instrument' do
-    it 'yields the provided block' do
-      inner = double(:inner)
-
-      expect(inner).to receive(:call)
-
-      Readthis::Notifications.instrument('operation', key: 'key') do
-        inner.call
-      end
-    end
-  end
-end