readthis 1.0.0.pre.rc.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c641f0b14297f5f65cc9e2a36dc525c92e2f4a48
-  data.tar.gz: cf5625a9a3b874f5f715979c615ee0db5c27daad
+  metadata.gz: 985ab4cb70b6ff45de0b279fe4d3ca90690cb206
+  data.tar.gz: d3c0519b74366c12278dc2a554d0a33c2914e7ac
 SHA512:
-  metadata.gz: 3774c714c24caa36cdb07b8ce5b39f1694ed2e9b9b116b2b3c463fc516e2b2bfebf68e1481c5181502fddd76e3690ae3af7bfcf7ef3210c5ae8ca634ad3f16c9
-  data.tar.gz: 274020a823960b9f4b7efdf101d02b3cc6a08074c508a6b32d4c990de0ccacf47571d98a1e74796f2d12d417971c297dffdc81abc1e24b3a770a74c64874810a
+  metadata.gz: e0cec4bef654487ed5f99c46f27d05572993a823239d1993b6e0b534f0b699f170c773ef191cddf468e1b05936c588d23ac6716ddf7659c89a86710306f13c5b
+  data.tar.gz: 5f8ac666204946a58135953c5e4b23d64a12f412019d578b28c8b8b1a7c351c1004775c0470a812038b12d2577b87eec5df8a4e09f628e5fbb1bed3fc008517a

data/README.md

@@ -52,7 +52,11 @@ cache = Readthis::Cache.new(
 )
 ```
 
+You can also specify `host`, `port`, `db` or any other valid Redis options. For
+more details about connection options see in [redis gem documentation][redisrb]
+
 [store]: http://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html
+[redisrb]: https://github.com/redis/redis-rb#getting-started
 
 ### Instances & Databases
 

data/lib/readthis/cache.rb

@@ -1,24 +1,19 @@
 require 'readthis/entity'
 require 'readthis/expanders'
-require 'readthis/notifications'
 require 'readthis/passthrough'
 require 'redis'
 require 'connection_pool'
 
 module Readthis
   class Cache
-    attr_reader :entity, :options, :pool
+    attr_reader :entity, :notifications, :options, :pool
 
     # Provide a class level lookup of the proper notifications module.
     # Instrumention is expected to occur within applications that have
     # ActiveSupport::Notifications available, but needs to work even when it
     # isn't.
     def self.notifications
-      if defined?(ActiveSupport::Notifications)
-        ActiveSupport::Notifications
-      else
-        Readthis::Notifications
-      end
+      ActiveSupport::Notifications if defined?(ActiveSupport::Notifications)
     end
 
     # Creates a new Readthis::Cache object with the given options.
@@ -334,11 +329,15 @@ module Readthis
       delta
     end
 
-    def instrument(operation, key)
-      name    = "cache_#{operation}.active_support"
-      payload = { key: key }
+    def instrument(name, key)
+      if self.class.notifications
+        name    = "cache_#{name}.active_support"
+        payload = { key: key, name: name }
 
-      self.class.notifications.instrument(name, payload) { yield(payload) }
+        self.class.notifications.instrument(name, payload) { yield(payload) }
+      else
+        yield
+      end
     end
 
     def invoke(operation, key, &block)

data/lib/readthis/version.rb

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

data/spec/readthis/cache_spec.rb

@@ -291,4 +291,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readthis
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-28 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
@@ -107,14 +121,12 @@ files:
 - 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
 - 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
@@ -134,9 +146,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1
@@ -147,7 +159,6 @@ 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

data/lib/readthis/notifications.rb

@@ -1,7 +0,0 @@
-module Readthis
-  module Notifications
-    def self.instrument(_name, payload)
-      yield(payload)
-    end
-  end
-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