chewy_kiqqer 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb3f4ba0613a2a7aaf26d0420b24b04b71e4e7d8
-  data.tar.gz: eb448452aea67e4fd1cdc10abd2994730b9313e0
+  metadata.gz: 18f4132a1ead16bf52fdad2c82b2e2ad915847f8
+  data.tar.gz: d7c229850a348c5218eb79bbf7c60bb1a3da2671
 SHA512:
-  metadata.gz: cc1e952e7d5563ba29a3c66062dd3b60b530b97e6a0bd0823b21f480ab21e2dc1028d0890c3940dbb198e234ef5e492d05b394c369564a99170599a39c3495e5
-  data.tar.gz: 58781a4e0677d625b432a733b46cd741f6ba9fd647d6d72350c0aca3824563d62c2e8a3249f8eec2acfdc34fa85d0b660266f43e86ca2513609d6e5e75ab3207
+  metadata.gz: 5b49b9869ccd87ae8c504d79fec9968465787a69ca00f2a17b38d26f3622de6e3d8be9c66853fe8775c605e07de1021bf592ddab5b4baaab507dd3ab7c1b5db5
+  data.tar.gz: d7cd065b06dfb7060cfea6eea902f37078f5dcb2db8644007d052cbc68359331cab904c9c5f8f92147d4058c6750291b756d92eeb423c4b74289d316185dc94c

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.2
+addons:
+  code_climate:
+    repo_token: dadcc13fd018e8813c5052a604bec42110d8f4c0931414639973cb94e5e150cb

data/README.md

@@ -1,5 +1,9 @@
 # ChewyKiqqer
 
+[![Build Status](https://travis-ci.org/averell23/chewy_kiqqer.svg?branch=master)](https://travis-ci.org/averell23/chewy_kiqqer)
+[![Code Climate](https://codeclimate.com/github/averell23/chewy_kiqqer.png)](https://codeclimate.com/github/averell23/chewy_kiqqer)
+[![Test Coverage](https://codeclimate.com/github/averell23/chewy_kiqqer/coverage.png)](https://codeclimate.com/github/averell23/chewy_kiqqer)
+
 This is an alternative udpate/callback mechanism for [Chewy](https://github.com/toptal/chewy). It queues the updates as [Sidekiq](https://github.com/mperham/sidekiq) jobs.
 
 You can pass backrefs like with the standard chewy mechanism, but the job itself will always receive an array of ids.
@@ -45,6 +49,8 @@ which will be indexed. The default is to use the current record.
     # Pass a proc. It will be called with the current record to get the backref
     ... backref: -> (rec) { |rec| rec.do_something }
 
+## Update handling
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 
+task default: :spec
+
 RSpec::Core::RakeTask.new(:spec)
 
 Bundler.require

data/chewy_kiqqer.gemspec

@@ -20,9 +20,12 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'sidekiq'
   spec.add_dependency 'chewy'
+  spec.add_dependency 'sidekiq-lock'
+  spec.add_dependency 'activesupport', '>= 3.2.0'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "kaminari"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "codeclimate-test-reporter"
 end

data/lib/chewy_kiqqer.rb

@@ -1,4 +1,12 @@
+require 'active_support/notifications'
+require 'active_support/log_subscriber'
+
 require "chewy_kiqqer/version"
 require "chewy_kiqqer/mixin"
 require "chewy_kiqqer/worker"
 require "chewy_kiqqer/index"
+require "chewy_kiqqer/logger"
+require "chewy_kiqqer/log_subscriber"
+
+
+ChewyKiqqer::LogSubscriber.attach_to 'chewy_kiqqer'

data/lib/chewy_kiqqer/log_subscriber.rb

@@ -0,0 +1,19 @@
+module ChewyKiqqer
+
+  class LogSubscriber < ActiveSupport::LogSubscriber
+
+    def perform(event)
+      info "ChewyKiqqer performed on #{event.payload[:index_name]} with ids #{event.payload[:ids]} - duration #{event.duration}"
+    end
+
+    def queue_jobs(event)
+      debug "ChewyKiqqer queued jobs from #{event.payload[:class]} #{event.payload[:id]}"
+    end
+
+    def logger
+      ChewyKiqqer.logger
+    end
+
+  end
+
+end

data/lib/chewy_kiqqer/logger.rb

@@ -0,0 +1,13 @@
+require 'logger'
+
+module ChewyKiqqer
+
+  def self.logger
+    @logger
+  end
+
+  def self.logger=(value)
+    @logger = value
+  end
+
+end

data/lib/chewy_kiqqer/mixin.rb

@@ -35,8 +35,10 @@ module ChewyKiqqer
     end
 
     def queue_chewy_jobs
-      self.class.indexers or return
-      self.class.indexers.each { |idx| idx.enqueue(self) }
+      ActiveSupport::Notifications.instrument('queue_jobs.chewy_kiqqer', class: self.class.name, id: self.id) do
+        self.class.indexers or return
+        self.class.indexers.each { |idx| idx.enqueue(self) }
+      end
     end
   end
 end

data/lib/chewy_kiqqer/version.rb

@@ -1,3 +1,3 @@
 module ChewyKiqqer
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/lib/chewy_kiqqer/worker.rb

@@ -1,11 +1,27 @@
 require 'sidekiq'
+require 'sidekiq-lock'
 
 module ChewyKiqqer
   class Worker
+
+    class LockError < StandardError ; end
+
     include Sidekiq::Worker
+    include Sidekiq::Lock::Worker
+
+    sidekiq_options lock: {
+      timeout: 3000,
+      name:    ->(index_name, ids) { "lock:chewy_kiqqer:#{ids}-#{[ids].flatten.sort.join('-')}" }
+    }
+
 
     def perform(index_name, ids)
-      Chewy.derive_type(index_name).import ids
+      lock.acquire! or raise LockError
+      ActiveSupport::Notifications.instrument('perform.chewy_kiqqer', index_name: index_name, ids: ids) do
+        Chewy.derive_type(index_name).import ids
+      end
+    ensure
+      lock.release!
     end
   end
 end

data/spec/index_spec.rb

@@ -1,4 +1,4 @@
-require 'chewy_kiqqer'
+require 'spec_helper'
 
 describe ChewyKiqqer::Index do
 
@@ -7,30 +7,30 @@ describe ChewyKiqqer::Index do
     it 'defaults to the corresponding object' do
       object = Object.new
       idx = ChewyKiqqer::Index.new
-      idx.backref(object).should eq object
+      expect(idx.backref(object)).to eq object
     end
 
     it 'can run a random method' do
       object = double(foobar: :backref)
       idx = ChewyKiqqer::Index.new(backref: :foobar)
-      idx.backref(object).should eq :backref
+      expect(idx.backref(object)).to eq :backref
     end
 
     it 'can use a proc' do
       object = double(foobar: :my_backref)
       idx = ChewyKiqqer::Index.new(backref: -> (r) { r.foobar })
-      idx.backref(object).should eq :my_backref
+      expect(idx.backref(object)).to eq :my_backref
     end
 
     context 'turning backrefs into ids' do
       let(:idx) { ChewyKiqqer::Index.new }
 
       it 'uses the ids of the objects' do
-        idx.backref_ids([double(id: 3), double(id: 6)]).should eq [3, 6]
+        expect(idx.backref_ids([double(id: 3), double(id: 6)])).to eq [3, 6]
       end
 
       it 'turns everything else into ints' do
-        idx.backref_ids([3, '6']).should eq [3, 6]
+        expect(idx.backref_ids([3, '6'])).to eq [3, 6]
       end
 
     end
@@ -41,7 +41,7 @@ describe ChewyKiqqer::Index do
         idx = ChewyKiqqer::Index.new index: 'foo#bar',
                                      queue: 'hello'
 
-        Sidekiq::Client.should_receive(:push)
+        expect(Sidekiq::Client).to receive(:push)
                        .with('queue' => 'hello',
                              'class' => ChewyKiqqer::Worker,
                              'args' => ['foo#bar', [24]])
@@ -53,7 +53,7 @@ describe ChewyKiqqer::Index do
         ChewyKiqqer.default_queue = :my_default
         idx = ChewyKiqqer::Index.new index: 'foo#bar'
 
-        Sidekiq::Client.should_receive(:push)
+        expect(Sidekiq::Client).to receive(:push)
                        .with('queue' => :my_default,
                              'class' => ChewyKiqqer::Worker,
                              'args' => ['foo#bar', [24]])

data/spec/log_subscriber_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe ChewyKiqqer::LogSubscriber do
+
+  let(:subscriber) { ChewyKiqqer::LogSubscriber.new }
+  let(:logger) { Logger.new(nil) }
+
+  it 'logs a perform with the default logger' do
+    expect {
+      subscriber.perform(double(payload: { index_name: 'foo', ids: [1,2] }, duration: 0.2))
+    }.to_not raise_error
+  end
+
+  it 'logs a perform event' do
+    allow(subscriber).to receive(:logger).and_return(logger)
+    expect(logger).to receive(:info)
+    expect {
+      subscriber.perform(double(payload: { index_name: 'foo', ids: [1,2] }, duration: 0.2))
+    }.to_not raise_error
+  end
+
+  it 'log a queue_jobs event' do
+    allow(subscriber).to receive(:logger).and_return(logger)
+    expect(logger).to receive(:debug)
+    expect {
+      subscriber.queue_jobs(double(payload: { class: 'Huha', id: 123 }))
+    }.to_not raise_error
+  end
+
+end

data/spec/logger_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe '#logger' do
+
+
+  after(:each) { ChewyKiqqer.logger = nil }
+
+  it 'can be set from the outside' do
+    ChewyKiqqer.logger = :nolog
+    expect(ChewyKiqqer.logger).to eq(:nolog)
+  end
+
+
+end

data/spec/mixin_spec.rb

@@ -1,10 +1,12 @@
-require 'chewy_kiqqer'
+require 'spec_helper'
 
 class Gummi
   include ChewyKiqqer::Mixin
 
   def self.after_commit(*args) ; end
 
+  def id ; 17 ; end
+
 end
 
 describe ChewyKiqqer::Mixin do
@@ -14,22 +16,22 @@ describe ChewyKiqqer::Mixin do
   context '#update_index' do
 
     it 'installs the hooks if nothing was installed yet' do
-      Gummi.should_receive(:install_chewy_hooks)
+      expect(Gummi).to receive(:install_chewy_hooks)
       Gummi.async_update_index(index: 'xxx')
     end
 
     it 'does not install the hooks twice' do
-      Gummi.should_receive(:install_chewy_hooks).once
+      expect(Gummi).to receive(:install_chewy_hooks).once
       Gummi.async_update_index(index: 'xxx')
       Gummi.async_update_index(index: 'xxx')
     end
 
     it 'installs the indexer' do
-      ChewyKiqqer::Index.should_receive(:new)
+      expect(ChewyKiqqer::Index).to receive(:new)
                         .with(index: 'some#thing', queue: :medium, backref: :foobar)
                         .and_return(:idx)
       Gummi.async_update_index(index: 'some#thing', queue: :medium, backref: :foobar)
-      Gummi.indexers.should eq [:idx]
+      expect(Gummi.indexers).to eq [:idx]
     end
 
   end
@@ -37,7 +39,7 @@ describe ChewyKiqqer::Mixin do
   context '#install hooks' do
 
     it 'installs the hooks' do
-      Gummi.should_receive(:after_commit).with(:queue_chewy_jobs)
+      expect(Gummi).to receive(:after_commit).with(:queue_chewy_jobs)
       Gummi.install_chewy_hooks
     end
 
@@ -49,8 +51,8 @@ describe ChewyKiqqer::Mixin do
 
     it 'queues the job' do
       idx = double
-      idx.should_receive(:enqueue).with(record)
-      Gummi.stub(indexers: [idx])
+      expect(idx).to receive(:enqueue).with(record)
+      allow(Gummi).to receive(:indexers).and_return([idx])
       record.queue_chewy_jobs
     end
 

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'chewy_kiqqer'
+require 'chewy'

data/spec/worker_spec.rb

@@ -1,16 +1,25 @@
-require 'chewy_kiqqer'
-require 'chewy'
+require 'spec_helper'
 
 describe ChewyKiqqer::Worker do
 
   let(:worker) { ChewyKiqqer::Worker.new }
+  let(:lock) { double(acquire!: true, release!: true) }
+
+  before(:each) { allow(worker).to receive(:lock).and_return(lock) }
 
   it 'calls the indexing with chewy' do
     index = double
-    Chewy.should_receive(:derive_type).with('foo#bar').and_return(index)
-    index.should_receive(:import).with([17])
+    expect(Chewy).to receive(:derive_type).with('foo#bar').and_return(index)
+    expect(index).to receive(:import).with([17])
 
     worker.perform('foo#bar', [17])
   end
 
+  it 'raises a lock error if the lock cannot be acquired' do
+    allow(lock).to receive(:acquire!).and_return(false)
+    expect {
+      worker.perform('foo#bar', [17])
+    }.to raise_error(ChewyKiqqer::Worker::LockError)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chewy_kiqqer
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Hahn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -38,6 +38,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq-lock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +122,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Sidekiq integration for chewy and sidekiq
 email:
 - dha@betterplace.org
@@ -102,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -109,11 +152,16 @@ files:
 - chewy_kiqqer.gemspec
 - lib/chewy_kiqqer.rb
 - lib/chewy_kiqqer/index.rb
+- lib/chewy_kiqqer/log_subscriber.rb
+- lib/chewy_kiqqer/logger.rb
 - lib/chewy_kiqqer/mixin.rb
 - lib/chewy_kiqqer/version.rb
 - lib/chewy_kiqqer/worker.rb
 - spec/index_spec.rb
+- spec/log_subscriber_spec.rb
+- spec/logger_spec.rb
 - spec/mixin_spec.rb
+- spec/spec_helper.rb
 - spec/worker_spec.rb
 homepage: ''
 licenses:
@@ -135,12 +183,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Small helper gem that allows you to automatically run all chewy index updates
   in sidekiq
 test_files:
 - spec/index_spec.rb
+- spec/log_subscriber_spec.rb
+- spec/logger_spec.rb
 - spec/mixin_spec.rb
+- spec/spec_helper.rb
 - spec/worker_spec.rb