readthis 1.0.0.pre.beta → 1.0.0.pre.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0b93b4402db2eaaff687eb60a40296bb618dd4e
-  data.tar.gz: 81f108e00b2b7dfe0ce92d9209c1160e3cc59a6f
+  metadata.gz: c641f0b14297f5f65cc9e2a36dc525c92e2f4a48
+  data.tar.gz: cf5625a9a3b874f5f715979c615ee0db5c27daad
 SHA512:
-  metadata.gz: d8e81b60017904895db2c2d2666f9f9d2fdad7fa2178c6bbca617abc0d49e5d8934c3128e0f8dba1014c5b30f02d2101fcf3102d2ecee441d5f43f9be9a35282
-  data.tar.gz: 1b8c28d2a8fdcff75d38bc565dceaf14fb442a1d14ca2c547c53e315d5d6eae08f35f96dbf3f97e268f71774ab27eb9afa5faf4266a1f3becf8af7303c92eee9
+  metadata.gz: 3774c714c24caa36cdb07b8ce5b39f1694ed2e9b9b116b2b3c463fc516e2b2bfebf68e1481c5181502fddd76e3690ae3af7bfcf7ef3210c5ae8ca634ad3f16c9
+  data.tar.gz: 274020a823960b9f4b7efdf101d02b3cc6a08074c508a6b32d4c990de0ccacf47571d98a1e74796f2d12d417971c297dffdc81abc1e24b3a770a74c64874810a

data/README.md

@@ -96,28 +96,28 @@ config.cache_store = :readthis_store, {
 }
 ```
 
-### Marshalling
+### Serializing
 
-Readthis uses Ruby's `Marshal` module for dumping and loading all values by
-default. This isn't always the fastest option, and depending on your use case it
-may be desirable to use a faster but less flexible marshaller.
+Readthis uses Ruby's `Marshal` module for serializing all values by default.
+This isn't always the fastest option, and depending on your use case it may be
+desirable to use a faster but less flexible serializer.
 
-By default Readthis knows about 3 different serializers for marshalling:
+By default Readthis knows about 3 different serializers:
 
 * Marshal
 * JSON
 * Passthrough
 
 If all cached data can safely be represented as a string then use the
-pass-through marshaller:
+pass-through serializer:
 
 ```ruby
 Readthis::Cache.new(marshal: Readthis::Passthrough)
 ```
 
-You can introduce up to four additional marshals by configuring `serializers` on
-the Readthis module. For example, if you wanted to use Oj for JSON marshalling,
-it is extremely fast, but supports limited types:
+You can introduce up to four additional serializers by configuring `serializers`
+on the Readthis module. For example, if you wanted to use the extremely fast Oj
+library for JSON serialization:
 
 ```ruby
 Readthis.serializers << Oj

data/lib/active_support/cache/readthis_store.rb

@@ -2,6 +2,6 @@ require 'readthis'
 
 module ActiveSupport
   module Cache
-    ReadthisStore ||= Readthis::Cache
+    ReadthisStore ||= Readthis::Cache # rubocop:disable Style/ConstantName
   end
 end

data/lib/readthis/cache.rb

@@ -7,7 +7,7 @@ require 'connection_pool'
 
 module Readthis
   class Cache
-    attr_reader :entity, :expires_in, :namespace, :options, :pool
+    attr_reader :entity, :options, :pool
 
     # Provide a class level lookup of the proper notifications module.
     # Instrumention is expected to occur within applications that have
@@ -39,9 +39,7 @@ module Readthis
     #   Readthis::Cache.new(compress: true, compression_threshold: 2048)
     #
     def initialize(options = {})
-      @options    = options
-      @expires_in = options.fetch(:expires_in, nil)
-      @namespace  = options.fetch(:namespace, nil)
+      @options = options
 
       @entity = Readthis::Entity.new(
         marshal:   options.fetch(:marshal, Marshal),
@@ -171,7 +169,7 @@ module Readthis
     #   cache.increment('counter', 2) # => 3
     #
     def increment(key, amount = 1, options = {})
-      invoke(:increment, key) do |store|
+      invoke(:increment, key) do |_store|
         alter(key, amount, options)
       end
     end
@@ -192,7 +190,7 @@ module Readthis
     #   cache.decrement('counter', 2) # => 17
     #
     def decrement(key, amount = 1, options = {})
-      invoke(:decrement, key) do |store|
+      invoke(:decrement, key) do |_store|
         alter(key, amount * -1, options)
       end
     end
@@ -271,13 +269,13 @@ module Readthis
       extracted = extract_options!(keys)
       missing   = {}
 
-      invoke(:fetch_multi, keys) do |store|
+      invoke(:fetch_multi, keys) do |_store|
         results.each do |key, value|
-          if value.nil?
-            value = yield(key)
-            missing[key] = value
-            results[key] = value
-          end
+          next unless value.nil?
+
+          value = yield(key)
+          missing[key] = value
+          results[key] = value
         end
       end
 
@@ -354,10 +352,7 @@ module Readthis
     end
 
     def merged_options(options)
-      options = options || {}
-      options[:namespace]  ||= namespace
-      options[:expires_in] ||= expires_in
-      options
+      (options || {}).merge!(@options)
     end
 
     def pool_options(options)

data/lib/readthis/entity.rb

@@ -9,7 +9,6 @@ module Readthis
     }.freeze
 
     COMPRESSED_FLAG = 0x8
-    MARSHAL_FLAG    = 0x3
 
     # Creates a Readthis::Entity with default options. Each option can be
     # overridden later when entities are being dumped.
@@ -105,7 +104,7 @@ module Readthis
       flags = string[0].unpack('C').first
 
       if flags < 16
-        marshal  = serializers.rassoc(flags & MARSHAL_FLAG)
+        marshal  = serializers.rassoc(flags)
         compress = (flags & COMPRESSED_FLAG) != 0
 
         [marshal, compress, string[1..-1]]

data/lib/readthis/expanders.rb

@@ -7,7 +7,7 @@ module Readthis
       when key.is_a?(Array)
         key.flat_map { |elem| expand_key(elem) }.join('/')
       when key.is_a?(Hash)
-        key.sort_by { |key, _| key.to_s }.map { |key, val| "#{key}=#{val}" }.join('/')
+        key.sort_by { |hkey, _| hkey.to_s }.map { |hkey, val| "#{hkey}=#{val}" }.join('/')
       when key.respond_to?(:to_param)
         key.to_param
       else

data/lib/readthis/serializers.rb

@@ -2,8 +2,9 @@ require 'json'
 require 'readthis/passthrough'
 
 module Readthis
-  SerializersFrozenError = Class.new(Exception)
-  SerializersLimitError  = Class.new(Exception)
+  SerializersFrozenError = Class.new(StandardError)
+  SerializersLimitError  = Class.new(StandardError)
+  UnknownSerializerError = Class.new(StandardError)
 
   class Serializers
     BASE_SERIALIZERS = {
@@ -38,9 +39,9 @@ module Readthis
     def <<(serializer)
       case
       when serializers.frozen?
-        raise SerializersFrozenError
+        fail SerializersFrozenError
       when serializers.length > SERIALIZER_LIMIT
-        raise SerializersLimitError
+        fail SerializersLimitError
       else
         @serializers[serializer] = flags.max.succ
         @inverted = @serializers.invert
@@ -63,36 +64,46 @@ module Readthis
       @inverted = @serializers.invert
     end
 
-    # Find a flag by the marshal object.
+    # Find a flag for a serializer object.
     #
     # @param [Object] Look up a flag by object
-    # @return [Number] Corresponding flag for the marshal object
+    # @return [Number] Corresponding flag for the serializer object
+    # @raise [UnknownSerializerError] Indicates that a serializer was
+    #   specified, but hasn't been configured for usage.
     #
     # @example
     #
-    #   serializers.assoc(Marshal) #=> 1
+    #   serializers.assoc(JSON) #=> 1
     #
-    def assoc(marshal)
-      serializers[marshal]
+    def assoc(serializer)
+      flag = serializers[serializer]
+
+      unless flag
+        fail UnknownSerializerError, "'#{serializer}' hasn't been configured"
+      end
+
+      flag
     end
 
-    # Find a marshal object by flag value.
+    # Find a serializer object by flag value.
+    #
+    # @param [Number] Flag to look up the serializer object by
+    # @return [Module] The serializer object
     #
-    # @param [Number] Flag to look up the marshal object by
-    # @return [Module] The marshal object
+    # @example
+    #
+    #   serializers.rassoc(1) #=> Marshal
     #
     def rassoc(flag)
-      inverted[flag]
+      inverted[flag & inverted.length]
     end
 
-    # The current list of marshal objects.
-    #
+    # @private
     def marshals
       serializers.keys
     end
 
-    # The current list of flags.
-    #
+    # @private
     def flags
       serializers.values
     end

data/lib/readthis/version.rb

@@ -1,3 +1,3 @@
 module Readthis
-  VERSION = '1.0.0-beta'
+  VERSION = '1.0.0-rc.1'
 end

data/spec/readthis/cache_spec.rb

@@ -8,18 +8,6 @@ RSpec.describe Readthis::Cache do
   end
 
   describe '#initialize' do
-    it 'accepts and persists a namespace' do
-      cache = Readthis::Cache.new(namespace: 'kash')
-
-      expect(cache.namespace).to eq('kash')
-    end
-
-    it 'accepts and persists an expiration' do
-      cache = Readthis::Cache.new(expires_in: 10)
-
-      expect(cache.expires_in).to eq(10)
-    end
-
     it 'makes options available' do
       cache = Readthis::Cache.new(namespace: 'cache', expires_in: 1)
 
@@ -89,20 +77,20 @@ RSpec.describe Readthis::Cache do
 
     it 'uses globally configured serializers' do
       custom = Class.new do
-        def self.dump(_)
-          'dumped'
+        def self.dump(value)
+          value
         end
 
-        def self.load(_)
-          'dumped'
+        def self.load(value)
+          value
         end
       end
 
       Readthis.serializers << custom
 
-      cache.write('customized', 'overwrite me', marshal: custom)
+      cache.write('customized', 'some value', marshal: custom)
 
-      expect(cache.read('customized')).to include('dumped')
+      expect(cache.read('customized')).to eq('some value')
     end
   end
 
@@ -179,7 +167,7 @@ RSpec.describe Readthis::Cache do
       expect(cache.read_multi('a', 'b', 'c')).to eq(
         'a' => 1,
         'b' => 2,
-        'c' => '3',
+        'c' => '3'
       )
     end
 
@@ -189,7 +177,7 @@ RSpec.describe Readthis::Cache do
 
       expect(cache.read_multi('d', 'e', namespace: 'cache')).to eq(
         'd' => 1,
-        'e' => 2,
+        'e' => 2
       )
     end
 
@@ -208,7 +196,11 @@ RSpec.describe Readthis::Cache do
     end
 
     it 'respects passed options' do
-      cache.write_multi({ 'a' => 1, 'b' => 2 }, namespace: 'multi', expires_in: 1)
+      cache.write_multi(
+        { 'a' => 1, 'b' => 2 },
+        namespace: 'multi',
+        expires_in: 1
+      )
 
       expect(cache.read('a')).to be_nil
       expect(cache.read('a', namespace: 'multi')).to eq(1)
@@ -227,7 +219,7 @@ RSpec.describe Readthis::Cache do
       expect(results).to eq(
         'a' => 1,
         'b' => 'bb',
-        'c' => 3,
+        'c' => 3
       )
 
       expect(cache.read('b')).to eq('bb')

data/spec/readthis/entity_spec.rb

@@ -131,16 +131,6 @@ RSpec.describe Readthis::Entity do
       expect(value).to eq(string)
     end
 
-    it 'can reconstruct longer qualified module names' do
-      string = 'a' * 30
-      entity = Readthis::Entity.new
-      marked = entity.compose(string, Readthis::Passthrough, false)
-
-      marshal, _, _ = entity.decompose(marked)
-
-      expect(marshal).to eq(Readthis::Passthrough)
-    end
-
     it 'returns the original string without a marker' do
       string = 'the quick brown fox'
       entity = Readthis::Entity.new

data/spec/readthis/expanders_spec.rb

@@ -19,7 +19,7 @@ RSpec.describe Readthis::Expanders do
     it 'expands an array of objects' do
       object = double(cache_key: 'gamma')
 
-      expect(expand(['alpha', 'beta'])).to eq('alpha/beta')
+      expect(expand(%w[alpha beta])).to eq('alpha/beta')
       expect(expand([object, object])).to eq('gamma/gamma')
     end
 

data/spec/readthis/serializers_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe Readthis::Serializers do
       serializers << CustomSerializer
 
       expect(serializers.marshals).to include(CustomSerializer)
-      expect(serializers.flags).to eq((1..4).to_a)
+      expect(serializers.flags).to eq([1, 2, 3, 4])
     end
 
     it 'increments flags' do
@@ -25,9 +25,9 @@ RSpec.describe Readthis::Serializers do
     it 'prevents more than seven serializers' do
       serializers = Readthis::Serializers.new
 
-      expect {
+      expect do
         10.times { serializers << Class.new }
-      }.to raise_error(Readthis::SerializersLimitError)
+      end.to raise_error(Readthis::SerializersLimitError)
     end
   end
 
@@ -37,6 +37,14 @@ RSpec.describe Readthis::Serializers do
 
       expect(serializers.assoc(Marshal)).to eq(0x1)
     end
+
+    it 'raises a helpful error when the serializer is unknown' do
+      serializers = Readthis::Serializers.new
+
+      expect do
+        serializers.assoc(CustomSerializer)
+      end.to raise_error(Readthis::UnknownSerializerError)
+    end
   end
 
   describe '#rassoc' do
@@ -45,6 +53,13 @@ RSpec.describe Readthis::Serializers do
 
       expect(serializers.rassoc(1)).to eq(Marshal)
     end
+
+    it 'returns custom serializers' do
+      serializers = Readthis::Serializers.new
+      serializers << CustomSerializer
+
+      expect(serializers.rassoc(4)).to eq(CustomSerializer)
+    end
   end
 
   describe '#freeze!' do
@@ -53,9 +68,9 @@ RSpec.describe Readthis::Serializers do
 
       serializers.freeze!
 
-      expect {
+      expect do
         serializers << CustomSerializer
-      }.to raise_error(Readthis::SerializersFrozenError)
+      end.to raise_error(Readthis::SerializersFrozenError)
     end
   end
 
@@ -66,7 +81,7 @@ RSpec.describe Readthis::Serializers do
       serializers << Class.new
       serializers.reset!
 
-      expect(serializers.marshals.length).to eq(3)
+      expect(serializers.serializers.length).to eq(3)
     end
   end
 end

data/spec/spec_helper.rb

@@ -16,9 +16,7 @@ RSpec.configure do |config|
 
   config.disable_monkey_patching!
 
-  if config.files_to_run.one?
-    config.default_formatter = 'doc'
-  end
+  config.default_formatter = 'doc' if config.files_to_run.one?
 
   config.order = :random
   Kernel.srand config.seed

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readthis
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta
+  version: 1.0.0.pre.rc.1
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -94,33 +94,14 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-description: Pooled active support compliant caching with redis
+description: 
 email:
 - parker@sorentwo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CHANGELOG.md
-- CONTRIBUTING.md
-- Gemfile
-- LICENSE.txt
-- PERFORMANCE.md
 - README.md
-- Rakefile
-- benchmarks/composing.rb
-- benchmarks/compressed.rb
-- benchmarks/driver.rb
-- benchmarks/generic.rb
-- benchmarks/marshalling.rb
-- benchmarks/memory.rb
-- benchmarks/multi.rb
-- benchmarks/parsing.rb
-- benchmarks/profile.rb
-- bin/rspec
 - lib/active_support/cache/readthis_store.rb
 - lib/readthis.rb
 - lib/readthis/cache.rb
@@ -130,7 +111,6 @@ files:
 - lib/readthis/passthrough.rb
 - lib/readthis/serializers.rb
 - lib/readthis/version.rb
-- readthis.gemspec
 - spec/readthis/cache_spec.rb
 - spec/readthis/entity_spec.rb
 - spec/readthis/expanders_spec.rb

data/.gitignore

@@ -1,15 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-TODO

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.travis.yml

@@ -1,15 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.1.0
-  - 2.2.2
-  - ruby-head
-  - rbx-2
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: rbx-2
-services:
-  - redis-server
-script: bin/rspec
-bundler_args: --without benchmarking

data/CHANGELOG.md

@@ -1,135 +0,0 @@
-## v1.0.0-beta
-
-- Breaking: This change is necessary for the consistency and portability of
-  values going forward. All entities are now written with a set of option flags
-  as the initial byte. This flag is later used to determine whether the entity
-  was compressed and what was used to marshal it. There are a number of
-  advantages to this approach, consistency and reliability being the most
-  important. See [readthis#17][pull-17] for additional background.
-- Added: Per-entity options can be passed through to any cache method that
-  writes a value (`write`, `fetch`, etc). For example, this allows certain
-  entities to be cached as JSON while all other entities are cached using
-  Marshal. Thanks to @fabn.
-- Fixed: A hash containing the cache key is passed as the payload for
-  `ActiveSupport::Notifications` instrumentation, rather than the key directly.
-  This moves the implementation in-line with the tests for the code, and
-  prevents errors from being masked when an error occurs inside an instrumented
-  block. [readthis#20][pull-20]. Discovered by @banister and fixed by @workmad3.
-
-[pull-17]: https://github.com/sorentwo/readthis/pull/17
-[pull-20]: https://github.com/sorentwo/readthis/pull/20
-
-## v0.8.1 2015-09-04
-
-- Changed: `Readthis::Cache` now has an accessor for the options that were
-  passed during initialization. This is primarily to support the session store
-  middleware provided by `ActionDispatch`. See [readthis#16][issue-16].
-- Fixed: Caching `nil` values is now possible. Previously the value would be
-  converted into a blank string, causing a Marshal error when loading the data.
-  There is still some non-standard handling of `nil` within `fetch` or
-  `fetch_multi`, where a cached `nil` value will always result in a cache miss.
-  See [readthis#15][issue-15].
-- Fixed: Entity compression was broken, it wouldn't unload data when the
-  compressed size was below the compression limit. Data is now decompressed
-  when it can the value looks to be compressed, falling back to the initial
-  value when decompression fails. See [readthis#13][issue-13] for details.
-
-[issue-13]: https://github.com/sorentwo/readthis/issues/13
-[issue-15]: https://github.com/sorentwo/readthis/issues/15
-[issue-16]: https://github.com/sorentwo/readthis/issues/16
-
-## v0.8.0 2015-08-26
-
-- Breaking: The initializer now takes a single options argument instead of a
-  `url` and `options` separately. This allows the underlying redis client to
-  accept any options, rather than just the driver. For example, it's now
-  possible to use Readthis with sentinel directly through the configuration.
-- Changed: The `hiredis` driver is *no longer the default*. In order to use the
-  vastly faster `hiredis` driver you need to pass it in during construction.
-  See [readthis#9][issue-9] for more discussion.
-
-[issue-9]: https://github.com/sorentwo/readthis/issues/9
-
-## v0.7.0 2015-08-11
-
-- Changed: Entity initialization uses an options hash rather than keyword
-  arguments. This allows flexibility with older Ruby versions (1.9) that aren't
-  officially supported.
-- Changed: There is no longer a hard dependency on `hiredis`, though it is the
-  default. The redis driver can be configured by passing a `driver: :ruby`
-  option through to the constructor.
-
-## v0.6.2 2015-04-28
-
-- Fixed: Set expiration during `write_multi`, primarily effecting `fetch_multi`.
-  This fixes the real issue underlying the change in `v0.6.1`.
-
-## v0.6.1 2015-04-28
-
-- Changed: Expiration values are always cast to an integer before use in write
-  operations. This prevents subtle ActiveSupport bugs where the value would be
-  ignored by `setex`.
-
-## v0.6.0 2015-03-09
-
-- Fixed: Safely handle calling `read_multi` without any keys. [Michael Rykov]
-- Fixed: Pointed `redis-activesupport` at master. Only effected development and
-  testing.
-- Added: A `write_multi` method is no available to bulk set keys and values. It
-  is used by `fetch_multi` internally to ensure that there are at most two Redis
-  calls.
-
-## v0.5.2 2015-01-09
-
-- Fixed: Remove the `pipeline` around `fetch_multi` writing. This will slow down
-  `fetch_multi` in cache miss situations for now. It prevents a difficult to
-  track down exception in multi-threaded situations.
-
-## v0.5.1 2014-12-30
-
-- Fixed: The `clear` method now accepts an argument for compatibility with other
-  caches. The argument is not actually used for anything.
-- Changed: The `delete` method will always return a boolean value rather than an
-  integer.
-- Changed: Avoid multiple instrumentation calls and pool checkouts within
-  `fetch_multi` calls.
-
-## v0.5.0 2014-12-12
-
-- Added: All read and write operations are marshalled to and from storage. This
-  allows hashes, arrays, etc. to be restored instead of always returning a
-  string. Unlike `ActiveSupport::Store::Entity`, no new objects are allocated
-  for each entity, reducing GC and improving performance.
-- Fixed: Increment/Decrement interface was only accepting two params instead of
-  three. Now accepts `amount` as the second parameter.
-- Changed: Increment/Decrement no longer use `incby` and `decby`, as they don't
-  work with marshalled values. This means they are not entirely atomic, so race
-  conditions are possible.
-
-## v0.4.0 2014-12-11
-
-- Added: Force the use of `hiredis` as the adapter. It is dramatically faster,
-  but prevents the project from being used in `jruby`. If we get interest from
-  some `jruby` projects we can soften the requirement.
-- Added: Compression! Adheres to the `ActiveSupport::Store` documentation.
-- Fixed: Gracefully handle `nil` passed as `options` to any cache method.
-
-## v0.3.0 2014-12-01
-
-- Added: Use `to_param` for key expansion, only when available. Makes it
-  possible to extract a key from any object when ActiveSupport is loaded.
-- Added: Expand hashes as cache keys.
-- Changed: Use `mget` for `read_multi`, faster and more synchronous than relying on
-  `pipelined`.
-- Changed: Delimit compound objects with a slash rather than a colon.
-
-## v0.2.0 2014-11-24
-
-- Added: Instrument all caching methods. Will use `ActiveSupport::Notifications`
-  if available, otherwise falls back to a polyfill.
-- Added: Expand objects with a `cache_key` method and arrays of strings or objects into
-  consistent naespaced keys.
-
-## v0.1.0 2014-11-22
-
-- Initial release! Working as a drop in replacement for `redis_store`.

data/CONTRIBUTING.md

@@ -1,14 +0,0 @@
-# Contributing
-
-## Open an Issue
-
-Let us know about bugs. Include your version of Readthis, Ruby, and the
-environment you are using.
-
-## Submit a Pull Request
-
-1. Fork it ( https://github.com/sorentwo/readthis/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request

data/Gemfile

@@ -1,14 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'coveralls', require: false
-
-group :benchmarking do
-  gem 'benchmark-ips'
-  gem 'dalli'
-  gem 'oj'
-  gem 'msgpack'
-  gem 'redis-activesupport'
-  gem 'stackprof'
-end

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 Parker Selbert
-
-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/PERFORMANCE.md

@@ -1,73 +0,0 @@
-Results from the various benchmarks in `./bencharks`. Hardware doesn't matter
-much, as we're simply looking for a comparison against other libraries and prior
-verions.
-
-## Footprint
-
-Footprint compared to `redis-activesupport`:
-
-```
-# Total allocated objects after require
-readthis: 20602
-redis-activesupport: 78630
-```
-
-## Performance
-
-Performance compared to `dalli` and `redis-activesupport`:
-
-```
-Raw Read Multi:
-Calculating -------------------------------------
- readthis:read-multi   358.000  i/100ms
-  redisas:read-multi    94.000  i/100ms
-    dalli:read-multi    99.000  i/100ms
--------------------------------------------------
- readthis:read-multi      3.800k (± 2.3%) i/s -     19.332k
-  redisas:read-multi    962.199  (± 3.6%) i/s -      4.888k
-    dalli:read-multi    995.353  (± 1.1%) i/s -      5.049k
-
-Comparison:
- readthis:read-multi:     3799.8 i/s
-    dalli:read-multi:      995.4 i/s - 3.82x slower
-  redisas:read-multi:      962.2 i/s - 3.95x slower
-
-Raw Fetch Multi:
-Calculating -------------------------------------
-readthis:fetch-multi   336.000  i/100ms
- redisas:fetch-multi    86.000  i/100ms
-   dalli:fetch-multi   102.000  i/100ms
--------------------------------------------------
-readthis:fetch-multi      3.424k (± 2.6%) i/s -     17.136k
- redisas:fetch-multi    874.803  (± 2.7%) i/s -      4.386k
-   dalli:fetch-multi      1.028k (± 1.2%) i/s -      5.202k
-
-Comparison:
-readthis:fetch-multi:     3424.2 i/s
-   dalli:fetch-multi:     1027.7 i/s - 3.33x slower
- redisas:fetch-multi:      874.8 i/s - 3.91x slower
-
-Compressed Writes:
-Calculating -------------------------------------
-      readthis:write   924.000  i/100ms
-         dalli:write   903.000  i/100ms
--------------------------------------------------
-      readthis:write     10.105k (± 4.9%) i/s -     50.820k
-         dalli:write      9.662k (± 1.6%) i/s -     48.762k
-
-Comparison:
-      readthis:write:    10105.3 i/s
-         dalli:write:     9662.4 i/s - 1.05x slower
-
-Compressed Read Multi:
-Calculating -------------------------------------
- readthis:read_multi   325.000  i/100ms
-    dalli:read_multi   100.000  i/100ms
--------------------------------------------------
- readthis:read_multi      3.357k (± 2.3%) i/s -     16.900k
-    dalli:read_multi      1.014k (± 3.1%) i/s -      5.100k
-
-Comparison:
- readthis:read_multi:     3356.5 i/s
-    dalli:read_multi:     1014.1 i/s - 3.31x slower
-```

data/Rakefile

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

data/benchmarks/composing.rb

@@ -1,43 +0,0 @@
-require 'benchmark/ips'
-
-def compose_a(marshal, compress)
-  prefix = ''
-  prefix << 'R|'.freeze
-  prefix << marshal.name.ljust(24)
-  prefix << (compress ? '1'.freeze : '0'.freeze)
-  prefix << 1
-  prefix << '|R'.freeze
-end
-
-def compose_b(marshal, compress)
-  "R|#{marshal.name.ljust(24)}#{compress ? '1'.freeze : '0'.freeze}1|R"
-end
-
-def compose_c(marshal, compress)
-  name = marshal.name.ljust(24)
-  comp = compress ? '1'.freeze : '0'.freeze
-
-  "R|#{name}#{comp}1|R"
-end
-
-SERIALIZER_FLAG = { Marshal => 0x1 }.freeze
-COMPRESSED_FLAG = 0x8
-
-# | 0000 | 0 | 000 |
-# four unused bits, # 1 compression bit, 3 bits for serializer, allow up to 8
-# different marshalers
-def compose_d(marshal, compress)
-  flags  = SERIALIZER_FLAG[marshal]
-  flags |= COMPRESSED_FLAG if compress
-
-  [flags].pack('C')
-end
-
-Benchmark.ips do |x|
-  x.report('a') { compose_a(Marshal, true) }
-  x.report('b') { compose_b(Marshal, true) }
-  x.report('c') { compose_c(Marshal, true) }
-  x.report('d') { compose_d(Marshal, true) }
-
-  x.compare!
-end

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/generic.rb

@@ -1,30 +0,0 @@
-require 'benchmark/ips'
-require 'json'
-require 'readthis'
-
-READTHIS = Readthis::Cache.new(
-  expires_in: 120,
-  marshal: JSON,
-  compress: true
-)
-
-def write_key(key)
-  READTHIS.write(key, key.to_s * 2048)
-end
-
-KEYS = (1..1_000).to_a
-KEYS.each { |key| write_key(key) }
-
-Benchmark.ips do |x|
-  x.report 'readthis:write' do
-    write_key(KEYS.sample)
-  end
-
-  x.report 'readthis:read' do
-    READTHIS.read(KEYS.sample)
-  end
-
-  x.report 'readthis:read_multi' do
-    READTHIS.read(KEYS.sample(30))
-  end
-end

data/benchmarks/marshalling.rb

@@ -1,38 +0,0 @@
-require 'bundler'
-
-Bundler.setup
-
-require 'benchmark/ips'
-require 'json'
-require 'oj'
-require 'msgpack'
-require 'readthis'
-require 'readthis/passthrough'
-
-Readthis.serializers << Oj
-Readthis.serializers << MessagePack
-
-readthis_oj      = Readthis::Cache.new(marshal: Oj)
-readthis_msgpack = Readthis::Cache.new(marshal: MessagePack)
-readthis_json    = Readthis::Cache.new(marshal: JSON)
-readthis_ruby    = Readthis::Cache.new(marshal: Marshal)
-
-HASH = ('a'..'z').each_with_object({}) { |key, memo| memo[key] = key }
-
-Benchmark.ips do |x|
-  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('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,60 +0,0 @@
-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/parsing.rb

@@ -1,42 +0,0 @@
-require 'benchmark/ips'
-
-def parse_a(string)
-  marshal  = string[2, 12].strip
-  compress = string[15] == '1'.freeze
-
-  [Kernel.const_get(marshal), compress, string[18..-1]]
-end
-
-def parse_b(marked)
-  prefix = marked[0, 32].scrub('*'.freeze)[/R\|(.*)\|R/, 1]
-  offset = prefix.size + 4
-
-  marshal, c_name, _ = prefix.split(' '.freeze)
-
-  compress = c_name == 'true'.freeze
-
-  [Kernel.const_get(marshal), compress, marked[offset..-1]]
-end
-
-SERIALIZERS     = { Marshal => 0x1 }.freeze
-DESERIALIZERS   = SERIALIZERS.invert.freeze
-COMPRESSED_FLAG = 0x8
-MARSHAL_FLAG    = 0x3
-BINARY_FLAG     = [SERIALIZERS[Marshal] | COMPRESSED_FLAG].pack('C')
-
-def parse_c(binary_string)
-  flags = binary_string[0].unpack('C').first
-
-  [DESERIALIZERS[flags & MARSHAL_FLAG], flags & COMPRESSED_FLAG, binary_string[1..-1]]
-end
-
-STR = 'R|Marshal      0|Rafdlkadfjadfj asdlkfjasdlfkj asdlfkjdasflkjadsflkjadslkjfadslkjfasdlkjfadlskjf laksdjflkajsdflkjadsflkadjsfladskjf laksjflakdjfalsdkjfadlskjf laksdjflkajdsflk j'
-STR2 = BINARY_FLAG << 'Rafdlkadfjadfj asdlkfjasdlfkj asdlfkjdasflkjadsflkjadslkjfadslkjfasdlkjfadlskjf laksdjflkajsdflkjadsflkadjsfladskjf laksjflakdjfalsdkjfadlskjf laksdjflkajdsflk j'
-
-Benchmark.ips do |x|
-  x.report('a') { parse_a(STR) }
-  x.report('b') { parse_b(STR) }
-  x.report('c') { parse_c(STR2) }
-
-  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
-
-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/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