readthis 0.8.1 → 1.2.1

data/spec/readthis/cache_spec.rb

@@ -1,4 +1,4 @@
-require 'readthis/cache'
+require 'readthis'
 
 RSpec.describe Readthis::Cache do
   let(:cache) { Readthis::Cache.new }
@@ -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)
 
@@ -60,11 +48,16 @@ RSpec.describe Readthis::Cache do
     end
 
     it 'uses a custom expiration' do
-      cache.write('some-key', 'some-value', expires_in: 1)
+      cache = Readthis::Cache.new(namespace: 'cache', expires_in: 86_400)
+
+      cache.write('some-key', 'some-value')
+      cache.write('other-key', 'other-value', expires_in: 1)
 
       expect(cache.read('some-key')).not_to be_nil
+      expect(cache.read('other-key')).not_to be_nil
       sleep 1.01
-      expect(cache.read('some-key')).to be_nil
+      expect(cache.read('some-key')).not_to be_nil
+      expect(cache.read('other-key')).to be_nil
     end
 
     it 'expands non-string keys' do
@@ -82,19 +75,52 @@ RSpec.describe Readthis::Cache do
     end
   end
 
+  describe 'serializers' do
+    after do
+      Readthis.serializers.reset!
+    end
+
+    it 'uses globally configured serializers' do
+      custom = Class.new do
+        def self.dump(value)
+          value
+        end
+
+        def self.load(value)
+          value
+        end
+      end
+
+      Readthis.serializers << custom
+
+      cache.write('customized', 'some value', marshal: custom)
+
+      expect(cache.read('customized')).to eq('some value')
+    end
+  end
+
   describe 'compression' do
-    it 'round trips entries when compression is enabled' do
+    it 'roundtrips entries when compression is enabled' do
       com_cache = Readthis::Cache.new(compress: true, compression_threshold: 8)
       raw_cache = Readthis::Cache.new
       value = 'enough text that it should be compressed'
 
       com_cache.write('compressed', value)
 
-      expect(raw_cache.read('compressed')).not_to eq(value)
       expect(com_cache.read('compressed')).to eq(value)
+      expect(raw_cache.read('compressed')).to eq(value)
+    end
+
+    it 'roundtrips entries with option overrides' do
+      cache = Readthis::Cache.new(compress: false)
+      value = 'enough text that it should be compressed'
+
+      cache.write('comp-round', value, marshal: JSON, compress: true, threshold: 8)
+
+      expect(cache.read('comp-round')).to eq(value)
     end
 
-    it 'round trips bulk entries when compression is enabled' do
+    it 'roundtrips bulk entries when compression is enabled' do
       cache = Readthis::Cache.new(compress: true, compression_threshold: 8)
       value = 'also enough text to compress'
 
@@ -135,6 +161,21 @@ RSpec.describe Readthis::Cache do
 
       expect(cache.read('short-key')).to eq('other stuff')
     end
+
+    it 'gets an existing value when `options` are passed as nil' do
+      cache.write('great-key', 'great')
+      expect(cache.fetch('great-key', nil)).to eq('great')
+    end
+
+    it 'serves computed content when the cache is down and tolerance is enabled' do
+      Readthis.fault_tolerant = true
+
+      allow(cache.pool).to receive(:with).and_raise(Redis::CannotConnectError)
+
+      computed = cache.fetch('error-key') { 'computed' }
+
+      expect(computed).to eq('computed')
+    end
   end
 
   describe '#read_multi' do
@@ -146,7 +187,7 @@ RSpec.describe Readthis::Cache do
       expect(cache.read_multi('a', 'b', 'c')).to eq(
         'a' => 1,
         'b' => 2,
-        'c' => '3',
+        'c' => '3'
       )
     end
 
@@ -156,7 +197,7 @@ RSpec.describe Readthis::Cache do
 
       expect(cache.read_multi('d', 'e', namespace: 'cache')).to eq(
         'd' => 1,
-        'e' => 2,
+        'e' => 2
       )
     end
 
@@ -175,7 +216,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)
@@ -194,7 +239,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')
@@ -266,4 +311,27 @@ RSpec.describe Readthis::Cache do
       expect(cache.decrement('unknown')).to eq(-1)
     end
   end
+
+  describe 'instrumentation' do
+    it 'instruments cache invokations' do
+      require 'active_support/notifications'
+
+      notes  = ActiveSupport::Notifications
+      cache  = Readthis::Cache.new
+      events = []
+
+      notes.subscribe(/cache_*/) do |*args|
+        events << ActiveSupport::Notifications::Event.new(*args)
+      end
+
+      cache.write('a', 'a')
+      cache.read('a')
+
+      expect(events.length).to eq(2)
+      expect(events.map(&:name)).to eq(%w[
+        cache_write.active_support
+        cache_read.active_support
+      ])
+    end
+  end
 end

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,21 @@
+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
+
+  describe '#fault_tolerant?' do
+    it 'defaults to being false' do
+      expect(Readthis).not_to be_fault_tolerant
+    end
+
+    it 'can be enabled' do
+      Readthis.fault_tolerant = true
+
+      expect(Readthis).to be_fault_tolerant
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -16,10 +16,12 @@ 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
+
+  config.before do
+    Readthis.reset!
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readthis
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2016-04-06 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,29 @@ 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/errors.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 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Pooled active support compliant caching with redis
@@ -161,6 +160,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