readthis 0.8.1 → 1.0.0

data/spec/readthis/entity_spec.rb

@@ -1,4 +1,4 @@
-require 'readthis/entity'
+require 'readthis'
 require 'json'
 
 RSpec.describe Readthis::Entity do
@@ -7,14 +7,21 @@ RSpec.describe Readthis::Entity do
       string = 'some string'
       entity = Readthis::Entity.new
 
-      expect(entity.dump(string)).to eq(Marshal.dump(string))
+      expect(entity.dump(string)).to include(Marshal.dump(string))
     end
 
     it 'marshals using a custom marshaller' do
       string = 'some string'
       entity = Readthis::Entity.new(marshal: JSON)
 
-      expect(entity.dump(string)).to eq(JSON.dump(string))
+      expect(entity.dump(string)).to include(JSON.dump(string))
+    end
+
+    it 'overrides the marshaller' do
+      string = 'still some string'
+      entity = Readthis::Entity.new
+
+      expect(entity.dump(string, marshal: JSON)).to include(JSON.dump(string))
     end
 
     it 'applies compression when enabled' do
@@ -39,6 +46,22 @@ RSpec.describe Readthis::Entity do
       expect(entity.load(string)).to eq(string)
     end
 
+    it 'overrides the compression threshold' do
+      string = 'a' * 8
+      entity = Readthis::Entity.new(compress: true, threshold: 2)
+      dumped = entity.dump(string)
+
+      expect(entity.dump(string, threshold: 100)).not_to eq(dumped)
+    end
+
+    it 'overrides the compression option' do
+      string = 'a' * 8
+      entity = Readthis::Entity.new(compress: true, threshold: 2)
+      dumped = entity.dump(string)
+
+      expect(entity.dump(string, compress: false)).not_to eq(dumped)
+    end
+
     it 'safely roundtrips nil values' do
       entity = Readthis::Entity.new
 
@@ -49,26 +72,27 @@ RSpec.describe Readthis::Entity do
   describe '#load' do
     it 'unmarshals a value' do
       object = { a: 1, b: '2' }
-      dumped = Marshal.dump(object)
       entity = Readthis::Entity.new
+      dumped = entity.dump(object)
 
       expect(entity.load(dumped)).to eq(object)
     end
 
     it 'uncompresses when compression is enabled' do
       string = 'another one of those huge strings'
-      entity = Readthis::Entity.new(compress: true, threshold: 0)
-      dumped = Marshal.dump(string)
-
-      compressed = entity.compress(dumped)
+      entity = Readthis::Entity.new(compress: true, threshold: 4)
+      dumped = entity.dump(dumped)
 
-      expect(entity.load(compressed)).not_to eq(string)
+      expect(entity.load(dumped)).not_to eq(string)
     end
 
-    it 'does not try to load a nil value' do
-      entity = Readthis::Entity.new
+    it 'uses the dumped value to define load options' do
+      value   = [1, 2, 3]
+      custom  = Readthis::Entity.new(marshal: JSON, compress: true)
+      general = Readthis::Entity.new(marshal: Marshal, compress: false)
+      dumped  = custom.dump(value)
 
-      expect(entity.load(nil)).to be_nil
+      expect(general.load(dumped)).to eq(value)
     end
 
     it 'passes through the value when it fails to marshal' do
@@ -84,4 +108,37 @@ RSpec.describe Readthis::Entity do
       expect { entity.load(dumped) }.not_to raise_error
     end
   end
+
+  describe '#compose' do
+    it 'prepends the string with a formatted marker' do
+      string = 'the quick brown fox'
+      marked = Readthis::Entity.new.compose(string, Marshal, true)
+
+      expect(marked[0]).not_to eq('t')
+    end
+  end
+
+  describe '#decompose' do
+    it 'returns extracted options and values' do
+      string = 'the quick brown fox'
+      entity = Readthis::Entity.new
+      marked = entity.compose(string.dup, JSON, true)
+
+      marshal, compress, value = entity.decompose(marked)
+
+      expect(marshal).to eq(JSON)
+      expect(compress).to eq(true)
+      expect(value).to eq(string)
+    end
+
+    it 'returns the original string without a marker' do
+      string = 'the quick brown fox'
+      entity = Readthis::Entity.new
+      marshal, compress, value = entity.decompose(string)
+
+      expect(marshal).to eq(Marshal)
+      expect(compress).to eq(false)
+      expect(value).to eq(string)
+    end
+  end
 end

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

@@ -0,0 +1,87 @@
+require 'readthis/serializers'
+
+RSpec.describe Readthis::Serializers do
+  CustomSerializer  = Class.new
+  AnotherSerializer = Class.new
+
+  describe '#<<' do
+    it 'appends new serializers' do
+      serializers = Readthis::Serializers.new
+
+      serializers << CustomSerializer
+
+      expect(serializers.marshals).to include(CustomSerializer)
+      expect(serializers.flags).to eq([1, 2, 3, 4])
+    end
+
+    it 'increments flags' do
+      serializers = Readthis::Serializers.new
+      serializers << CustomSerializer
+      serializers << AnotherSerializer
+
+      expect(serializers.flags).to eq((1..5).to_a)
+    end
+
+    it 'prevents more than seven serializers' do
+      serializers = Readthis::Serializers.new
+
+      expect do
+        10.times { serializers << Class.new }
+      end.to raise_error(Readthis::SerializersLimitError)
+    end
+  end
+
+  describe '#assoc' do
+    it 'looks up serializers by module' do
+      serializers = Readthis::Serializers.new
+
+      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
+    it 'inverts the current set of serializers' do
+      serializers = Readthis::Serializers.new
+
+      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
+    it 'does now allow appending after freeze' do
+      serializers = Readthis::Serializers.new
+
+      serializers.freeze!
+
+      expect do
+        serializers << CustomSerializer
+      end.to raise_error(Readthis::SerializersFrozenError)
+    end
+  end
+
+  describe '#reset!' do
+    it 'reverts back to the original set of serializers' do
+      serializers = Readthis::Serializers.new
+
+      serializers << Class.new
+      serializers.reset!
+
+      expect(serializers.serializers.length).to eq(3)
+    end
+  end
+end

data/spec/readthis_spec.rb

@@ -0,0 +1,9 @@
+require 'readthis'
+
+RSpec.describe Readthis do
+  describe '#serializers' do
+    it 'lists currently configured serializers' do
+      expect(Readthis.serializers.marshals).to include(Marshal, JSON)
+    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: 0.8.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2015-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,44 +108,28 @@ 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/compressed.rb
-- benchmarks/driver.rb
-- benchmarks/marshalling.rb
-- benchmarks/memory.rb
-- benchmarks/multi.rb
-- benchmarks/profile.rb
-- bin/rspec
 - lib/active_support/cache/readthis_store.rb
 - lib/readthis.rb
 - lib/readthis/cache.rb
 - lib/readthis/entity.rb
 - lib/readthis/expanders.rb
-- lib/readthis/notifications.rb
 - 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
-- spec/readthis/notifications_spec.rb
 - spec/readthis/passthrough_spec.rb
+- spec/readthis/serializers_spec.rb
+- spec/readthis_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sorentwo/readthis
 licenses:
@@ -153,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Pooled active support compliant caching with redis
@@ -161,6 +159,7 @@ test_files:
 - spec/readthis/cache_spec.rb
 - spec/readthis/entity_spec.rb
 - spec/readthis/expanders_spec.rb
-- spec/readthis/notifications_spec.rb
 - spec/readthis/passthrough_spec.rb
+- spec/readthis/serializers_spec.rb
+- spec/readthis_spec.rb
 - spec/spec_helper.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,114 +0,0 @@
-## 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/pull/13
-[issue-15]: https://github.com/sorentwo/readthis/pull/15
-[issue-16]: https://github.com/sorentwo/readthis/pull/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"
-