chewy_kiqqer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a364d1e2c036ad050b57aa91e61a72ee3319191e
+  data.tar.gz: 9cefa2b4bdf0e56a55c6c5b532374c4735aabd24
+SHA512:
+  metadata.gz: 765a041ec58e3f32c1a853f686320cf5fb2d681c608f966a7781bad2c6894e67fad3b39c0bdc9009982f293aabda00e0aa460b38d5533a067a34da2c81a4d782
+  data.tar.gz: 9df08fe3e7e40a4d275782fb7739aff7d0e01168b39af27f9f9408854ac66e2755e8efd3a1f1d5946e07940240ced3187788869f06475036f1026ddfb3832cf8

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chewy_kiqqer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel Hahn
+
+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/README.md

@@ -0,0 +1,39 @@
+# ChewyKiqqer
+
+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.
+
+Unlike the standard update_index mechnism it will **always** use the record's index for updates (at this time at least). If you need to do bulk updates, just use chewy's built-in mechanisms.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'chewy_kiqqer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chewy_kiqqer
+
+## Usage
+
+Just add the module and set it up:
+
+    class User < ActiveRecord::Base
+      include ChewyKiqqer::Mixin
+      
+      async_update_index 'users#user'
+    end
+
+You can also include the mixin into ActiveRecord::Base in an initializer if it should be generally available.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/chewy_kiqqer.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chewy_kiqqer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chewy_kiqqer"
+  spec.version       = ChewyKiqqer::VERSION
+  spec.authors       = ["Daniel Hahn"]
+  spec.email         = ["dha@betterplace.org"]
+  spec.description   = %q{Sidekiq integration for chewy and sidekiq}
+  spec.summary       = %q{Small helper gem that allows you to automatically run all chewy index updates in sidekiq}
+  spec.homepage      = ""
+  spec.license       = "Apache V2"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'sidekiq'
+  spec.add_dependency 'chewy'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "kaminari"
+  spec.add_development_dependency "rspec"
+end

data/lib/chewy_kiqqer.rb

@@ -0,0 +1,3 @@
+require "chewy_kiqqer/version"
+require "chewy_kiqqer/mixin"
+require "chewy_kiqqer/worker"

data/lib/chewy_kiqqer/mixin.rb

@@ -0,0 +1,24 @@
+require 'active_support/concern'
+
+module ChewyKiqqer
+  module Mixin
+
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      attr_reader :index_name
+
+      def async_update_index(index_name)
+        @index_name = index_name
+        after_save    :queue_job
+        after_destroy :queue_job
+      end
+
+    end
+
+    def queue_job
+      ChewyKiqqer::Worker.perform_async(self.class.index_name, id)
+    end
+  end
+end

data/lib/chewy_kiqqer/version.rb

@@ -0,0 +1,3 @@
+module ChewyKiqqer
+  VERSION = "0.0.1"
+end

data/lib/chewy_kiqqer/worker.rb

@@ -0,0 +1,7 @@
+require 'sidekiq'
+
+module ChewyKiqqer
+  class Worker
+    include Sidekiq::Worker
+  end
+end

data/spec/mixin_spec.rb

@@ -0,0 +1,39 @@
+require 'chewy_kiqqer'
+
+class Gummi
+  include ChewyKiqqer::Mixin
+
+  def self.after_save(*args) ; end
+  def self.after_destroy(*args) ; end
+  def id ; 17 ; end
+
+end
+
+describe ChewyKiqqer::Mixin do
+
+  context 'class methods' do
+    it 'installs the hooks' do
+      Gummi.should_receive(:after_save).with(:queue_job)
+      Gummi.should_receive(:after_destroy).with(:queue_job)
+      Gummi.async_update_index('xxx')
+    end
+
+    it 'knows the index_name' do
+      Gummi.async_update_index('bar#foo')
+      Gummi.index_name.should eq 'bar#foo'
+    end
+  end
+
+  context '#queue_job' do
+
+    let(:record) { Gummi.new }
+
+    it 'queues the job' do
+      Gummi.async_update_index 'foo#bar'
+      ChewyKiqqer::Worker.should_receive(:perform_async).with('foo#bar', 17)
+      record.queue_job
+    end
+
+  end
+
+end

data/spec/workder.spec.rb

@@ -0,0 +1,15 @@
+require 'chewy_kiqqer'
+
+desribe ChewyKiqqer::Worker do
+
+  let(:worker) { ChewyKiqqer::Worker.new }
+
+  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)
+
+    worker.perform('foo#bar', index)
+  end
+
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: chewy_kiqqer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Hahn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: chewy
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- chewy_kiqqer.gemspec
+- lib/chewy_kiqqer.rb
+- lib/chewy_kiqqer/mixin.rb
+- lib/chewy_kiqqer/version.rb
+- lib/chewy_kiqqer/worker.rb
+- spec/mixin_spec.rb
+- spec/workder.spec.rb
+homepage: ''
+licenses:
+- Apache V2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Small helper gem that allows you to automatically run all chewy index updates
+  in sidekiq
+test_files:
+- spec/mixin_spec.rb
+- spec/workder.spec.rb