async_cache 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 500e9448eef871f617a1d0a131fd3838c231058d
-  data.tar.gz: 3f09a314542ea93102d65d96e6417f25374483d0
+  metadata.gz: f27471956b05c3bb40ca9741a98a95134308fc84
+  data.tar.gz: 0cc68507dc421ff154b487d1db2fa2db56f4dc07
 SHA512:
-  metadata.gz: e174c76425afb575ace71b4902b6b7fcb6acc9d2b096fc4955e0a0c88c738c4441e83529d274243dd40d2360c5f265bc69e267c4773558e2587a5849311da30a
-  data.tar.gz: 51e30ffe8cb929710185ee2624e6a957a33b33338a3724f317414597bf75786f7b96944abf02a3878212fd7daa85137b3cbe39f58ed2d56e3e8b73ba5f637bab
+  metadata.gz: edacd1a9fff44a91e2791d8bcf27b9511bd2d9806d475637d93a874d51c715a11d48959138c8509d91f6a9b4f4de8b35cab6827821a61bdcc96478fd8c244df4
+  data.tar.gz: 88a1777e3e4e4bca3fcc51695c670e5160f1380da356ae9417e49c36aa02877b0663f6679243cf8c26623b3f4e3e5f0b92ec2c8566533c0664825b635fea35c6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    async_cache (1.0.2)
+    async_cache (1.1.0)
       sourcify (~> 0.5.0)
 
 GEM

data/lib/async_cache.rb

@@ -21,3 +21,4 @@ end
 require 'async_cache/version'
 require 'async_cache/store'
 require 'async_cache/workers/base'
+require 'async_cache/railtie' if defined?(Rails)

data/lib/async_cache/railtie.rb

@@ -0,0 +1,11 @@
+module AsyncCache
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      %w[clear].each do |name|
+        file = File.join(File.dirname(__FILE__), "tasks/#{name}.rake")
+
+        load file
+      end
+    end
+  end
+end

data/lib/async_cache/store.rb

@@ -2,6 +2,11 @@ module AsyncCache
   class Store
     attr_accessor :backend, :worker_klass
 
+    # Global index of store instances
+    def self.stores
+      @stores ||= []
+    end
+
     # @param [Hash] opts Initialization options
     # @option opts [Object] :backend The backend that it will read/write
     #   entries to/from
@@ -19,6 +24,9 @@ module AsyncCache
         end
 
       @backend = opts[:backend] || AsyncCache.backend
+
+      # Register ourselves in the array of known store instances
+      self.class.stores << self
     end
 
     # @param [String] locator The constant locator for the entry in the cache
@@ -66,6 +74,10 @@ module AsyncCache
       end
     end
 
+    def clear
+      @worker_klass.clear
+    end
+
     def determine_strategy(has_cached_data:, needs_regen:, synchronous_regen:)
       case
       when !has_cached_data
@@ -111,6 +123,18 @@ module AsyncCache
       )
     end
 
+    def inspect
+      pointer_format  = '0x%014x'
+      pointer         = Kernel.sprintf pointer_format, self.object_id * 2
+      backend_pointer = Kernel.sprintf pointer_format, @backend.object_id * 2
+
+      '#<' + [
+        "#{self.class.name}:#{pointer} ",
+        "@worker_klass=#{@worker_klass.name}, ",
+        "@backend=#<#{@backend.class.name}:#{backend_pointer}>"
+      ].join('') + '>'
+    end
+
     private
 
       # Ensures the arguments are primitives.

data/lib/async_cache/tasks/clear.rake

@@ -0,0 +1,16 @@
+namespace :async_cache do
+  prereqs =
+    if defined?(Rails)
+      [:environment]
+    else
+      []
+    end
+
+  desc 'Clear the worker queues'
+  task :clear => prereqs do
+    AsyncCache::Store.stores.each do |store|
+      store.clear
+      puts "Cleared #{store.inspect}"
+    end
+  end
+end

data/lib/async_cache/version.rb

@@ -1,3 +1,3 @@
 module AsyncCache
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

data/lib/async_cache/workers/active_job.rb

@@ -11,6 +11,10 @@ module AsyncCache
         true
       end
 
+      def self.clear
+        raise NotImplementedError, 'ActiveJob does not support clearing queues'
+      end
+
       def self.enqueue_async_job(key:, version:, expires_in:, block:, arguments:)
         self.perform_later key, version, expires_in, arguments, block
       end

data/lib/async_cache/workers/base.rb

@@ -23,6 +23,11 @@ module AsyncCache
         raise NotImplementedError
       end
 
+      # Clear the active jobs from this worker's queue.
+      def self.clear
+        raise NotImplementedError
+      end
+
       # Public interface for enqueuing jobs. This is what is called by
       # {AsyncCache::Store}.
       def self.enqueue_async_job(key:, version:, expires_in:, block:, arguments:)

data/lib/async_cache/workers/sidekiq.rb

@@ -13,22 +13,32 @@ module AsyncCache
       # Use the Sidekiq API to see if there are worker processes available to
       # handle the async cache jobs queue.
       def self.has_workers?
-        target_queue = self.sidekiq_options['queue'].to_s
-
         processes = Sidekiq::ProcessSet.new.to_a
         queues_being_processed = processes.flat_map { |p| p['queues'] }
 
-        if queues_being_processed.include? target_queue
+        if queues_being_processed.include? sidekiq_queue
           true
         else
           false
         end
       end
 
+      def self.clear
+        queue = Sidekiq::Queue.new sidekiq_queue
+
+        queue.clear
+      end
+
       def self.enqueue_async_job(key:, version:, expires_in:, block:, arguments:)
         self.perform_async key, version, expires_in, arguments, block
       end
 
+      private
+
+        def self.sidekiq_queue
+          self.sidekiq_options['queue'].to_s
+        end
+
     end # class SidekiqWorker
   end
 end

data/spec/railtie_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe AsyncCache do
+  context 'Railtie' do
+    class Application < Rails::Application
+    end
+
+    before(:all) do
+      app = Application.new
+      app.load_tasks
+    end
+
+    it 'adds the async_cache:* tasks' do
+      expect(Rake::Task.task_defined?('async_cache:clear')).to eq true
+    end
+  end
+end

data/spec/tasks_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe AsyncCache do
+  context 'tasks' do
+    before(:all) do
+      require 'rake'
+      Rake.application.clear
+      Rake.application.add_import File.join(File.dirname(__FILE__), '../lib/async_cache/tasks/clear.rake')
+      Rake.application.load_imports
+    end
+
+    before(:each) do
+      # Reset the array of known store instances
+      AsyncCache::Store.instance_eval { @stores = [] }
+    end
+
+    describe ':clear' do
+      it 'clears with worker queues' do
+        store = AsyncCache::Store.new backend: Rails.cache, worker: :sidekiq
+
+        queue_double = double 'Sidekiq::Queue'
+        allow(Sidekiq::Queue).to receive(:new).and_return(queue_double)
+
+        expect(queue_double).to receive(:clear)
+
+        Rake.application['async_cache:clear'].execute
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Adam Derewecki
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sourcify
@@ -185,7 +185,9 @@ files:
 - async_cache.gemspec
 - examples/examples_controller.rb
 - lib/async_cache.rb
+- lib/async_cache/railtie.rb
 - lib/async_cache/store.rb
+- lib/async_cache/tasks/clear.rake
 - lib/async_cache/version.rb
 - lib/async_cache/workers/active_job.rb
 - lib/async_cache/workers/base.rb
@@ -195,8 +197,10 @@ files:
 - spec/integration/support/run_all.rb
 - spec/integration/support/sinatra.rb
 - spec/integration/support/version.txt
+- spec/railtie_spec.rb
 - spec/spec_helper.rb
 - spec/store_spec.rb
+- spec/tasks_spec.rb
 - spec/workers/active_job_spec.rb
 - spec/workers/base_spec.rb
 - spec/workers/sidekiq_spec.rb