search_and_resque 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ad86e4b35d185b5d25a7396261908351e938021
+  data.tar.gz: 3f50eb245144bb3a970d116797af9058633a363f
+SHA512:
+  metadata.gz: fb86cffcdd4bd64c86a25d1785077fd82d4b35e04283d4323008b18d3d7960951a1a437a237a4f3a896dfe8c33cc17def5b6be3010b426c7f093f6fdf774f123
+  data.tar.gz: 8811816945c72859930ae4a043ca0fc510ad3887a43c642894480365182ea4b01ab2bab7ea078b64389a2beda8fa8d6c08c8184a6ded94e82285849926825e9c

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in search_and_resque.gemspec
+gemspec
+
+gem 'activerecord'
+gem 'chewy'
+gem 'resque'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Peter Woo
+
+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,54 @@
+# SearchAndResque
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+    gem 'chewy'
+    gem 'search_and_resque'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install search_and_resque
+
+## Usage
+
+```ruby
+class Film < ActiveRecord::Base
+  # Create after_save, after_destroy callbacks
+  search_and_resque :films
+end
+
+class Document < ActiveRecord::Base
+  # Create after_save, after_destroy callbacks, only run when document text has changed
+  search_and_resque :documents, :if => ->{ contents_changed? }
+end
+
+class MyIndex < Chewy::Index
+  define_type Film do
+    field :title
+  end
+  
+  define_type Document do
+    field :contents
+  end
+end
+```
+
+Calling `search_and_resque` in a Rails model sets up `after_save`/`after_destroy` callbacks, which will enqueue Resque jobs to update (or delete from) the index.
+
+## Configuration
+
+`SearchAndResque.index_name` must be set by the environment, as well as `SearchAndResque::Queue.queue` (the queue name).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/search_and_resque/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/search_and_resque.rb

@@ -0,0 +1,42 @@
+require "search_and_resque/version"
+require "search_and_resque/callbacks"
+require "search_and_resque/queue"
+require "search_and_resque/chewy_extensions"
+
+module SearchAndResque
+  extend ActiveSupport::Concern
+
+  @queue = SearchAndResque::Queue
+
+  def self.queue=(queue)
+    @queue = queue
+  end
+
+  def self.queue
+    @queue
+  end
+
+  def self.index_name=(name)
+    @index_name = "#{name}"
+  end
+
+  def self.index_name
+    @index_name
+  end
+
+  module ClassMethods
+    def search_and_resque(type_name, options={})
+      unless included_modules.include?(SearchAndResque::Callbacks)
+        options[:if] ||= ->{ true }
+        define_method(:should_update_elastic_search?, &options[:if])
+
+        @elastic_search_type = "#{type_name}"
+
+        include SearchAndResque::Callbacks
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, SearchAndResque
+Chewy::Type.send :include, SearchAndResque::ChewyExtensions::ChewyType

data/lib/search_and_resque/callbacks.rb

@@ -0,0 +1,69 @@
+module SearchAndResque
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        attr_accessor :elastic_search_type
+      end
+      after_save :enqueue_elastic_search_update
+      after_destroy :enqueue_elastic_search_delete
+    end
+
+    module ClassMethods
+      def enqueue_elastic_search_update(ids)
+        ids = Array(ids).map{ |x| x.is_a?(ActiveRecord::Base) ? x.id : x }
+        SearchAndResque.queue.enqueue_update(elastic_search_type, ids)
+      end
+
+      def enqueue_elastic_search_delete(ids)
+        ids = Array(ids).map{ |x| x.is_a?(ActiveRecord::Base) ? x.id : x }
+        SearchAndResque.queue.enqueue_delete(elastic_search_type, ids)
+      end
+    end
+
+    def enqueue_elastic_search_update
+      self.class.enqueue_elastic_search_update(id) if should_update_elastic_search?
+    end
+
+    def enqueue_elastic_search_delete
+      self.class.enqueue_elastic_search_delete(id)
+    end
+
+    # e.g.
+    #     Model.will_update_all(@records) do
+    #       ...
+    #       @records.update_all(...)
+    #       ...
+    #     end
+    def will_update_all(ids)
+      begin
+        skip_callback(:save, :after, :enqueue_elastic_search_update)
+        transaction do
+          yield if block_given?
+          enqueue_elastic_search_update(ids) unless ids.empty?
+        end
+      ensure
+        set_callback(:save, :after, :enqueue_elastic_search_update)
+      end
+    end
+    
+    # e.g.
+    #     Model.will_delete_all(@records) do
+    #       ...
+    #       @records.delete_all
+    #       ...
+    #     end
+    def will_delete_all(ids)
+      begin
+        skip_callback(:destroy, :after, :enqueue_elastic_search_delete)
+        transaction do
+          yield if block_given?
+          enqueue_elastic_search_delete(ids) unless ids.empty?
+        end
+      ensure
+        set_callback(:destroy, :after, :enqueue_elastic_search_delete)
+      end
+    end
+  end
+end

data/lib/search_and_resque/chewy_extensions.rb

@@ -0,0 +1,13 @@
+module SearchAndResque
+  module ChewyExtensions
+    module ChewyType
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def delete!(ids)
+          filter(:term => {:_id => ids}).delete_all
+        end
+      end
+    end
+  end
+end

data/lib/search_and_resque/queue.rb

@@ -0,0 +1,25 @@
+module SearchAndResque
+  class Queue
+    class << self
+      attr_accessor :queue
+    end
+
+    def self.perform(index_name, type_name, action, ids)
+      index = Chewy::Index.subclasses.find{ |ind| ind.index_name == index_name }
+      type = index.types.find{ |t| t.type_name == type_name }
+      type.send(action, ids)
+    end
+
+    def self.enqueue_update(type_name, ids)
+      unless ids.empty?
+        Resque.enqueue(self, SearchAndResque.index_name, type_name, :import!, ids)
+      end
+    end
+    
+    def self.enqueue_delete(type_name, ids)
+      unless ids.empty?
+        Resque.enqueue(self, SearchAndResque.index_name, type_name, :delete!, ids)
+      end
+    end
+  end
+end

data/lib/search_and_resque/version.rb

@@ -0,0 +1,3 @@
+module SearchAndResque
+  VERSION = "0.1.0"
+end

data/search_and_resque.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'search_and_resque/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "search_and_resque"
+  spec.version       = SearchAndResque::VERSION
+  spec.authors       = ["Peter Woo"]
+  spec.email         = ["petersnowdonwoo@gmail.com"]
+  spec.summary       = %q{Resque integration for Chewy}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/test/search_and_resque_test.rb

@@ -0,0 +1,94 @@
+require 'active_record'
+
+test_framework = if ActiveRecord::VERSION::STRING >= "4.1"
+  require 'minitest/autorun'
+  MiniTest::Test
+else
+  require 'test/unit'
+  Test::Unit::TestCase
+end
+
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+require 'chewy'
+require 'resque'
+require 'search_and_resque'
+
+def connect!
+  ActiveRecord::Base.establish_connection :adapter => 'sqlite3', database: ':memory:'
+end
+
+def setup!
+  connect!
+  ActiveRecord::Base.connection.execute 'CREATE TABLE books (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME, title STRING)'
+  ActiveRecord::Base.connection.execute 'CREATE TABLE films (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME, title STRING, director STRING)'
+end
+
+setup!
+
+class Book < ActiveRecord::Base
+  search_and_resque :books
+end
+
+class Film < ActiveRecord::Base
+  search_and_resque :films, :if => ->{ title_changed? }
+end
+
+class SearchAndResqueTestIndex < Chewy::Index
+  define_type Book, :name => 'books' do
+    field :title
+  end
+
+  define_type Film, :name => 'films' do
+    field :title
+    field :director
+  end
+end
+
+Chewy.configuration = {
+  host: 'localhost:9200'
+}
+
+SearchAndResque.index_name = 'search_and_resque_test'
+SearchAndResque::Queue.queue = :search_and_resque_test_queue
+
+Resque.inline = true
+
+
+class SearchAndResqueTest < test_framework
+  def setup
+    SearchAndResqueTestIndex.purge
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.execute "DELETE FROM #{table}"
+    end
+  end
+
+  def test_index_update_on_create_and_destroy
+    book = Book.create
+    assert_equal 1, SearchAndResqueTestIndex::Books.filter(:ids => {:values => [book.id]}).total_count
+
+    book.destroy
+    assert_equal 0, SearchAndResqueTestIndex::Books.filter(:ids => {:values => [book.id]}).total_count
+  end
+
+  def test_index_update_on_save
+    book = Book.create(:title => 'one')
+
+    book.update_attributes(:title => 'two')
+    assert_equal 'two', SearchAndResqueTestIndex::Books.filter(:ids => {:values => [book.id]}).first.title
+  end
+
+  def test_failing_conditional_index_update
+    film = Film.create(:title => 'one', :director => 'two')
+
+    film.update_attributes(:director => 'three')
+    assert_equal 'two', SearchAndResqueTestIndex::Films.filter(:ids => {:values => [film.id]}).first.director
+  end
+
+  def test_succeeding_conditional_index_update
+    film = Film.create(:title => 'one', :director => 'two')
+
+    film.update_attributes(:title => 'three', :director => 'four')
+    assert_equal 'four', SearchAndResqueTestIndex::Films.filter(:ids => {:values => [film.id]}).first.director
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: search_and_resque
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Woo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: 
+email:
+- petersnowdonwoo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/search_and_resque.rb
+- lib/search_and_resque/callbacks.rb
+- lib/search_and_resque/chewy_extensions.rb
+- lib/search_and_resque/queue.rb
+- lib/search_and_resque/version.rb
+- search_and_resque.gemspec
+- test/search_and_resque_test.rb
+homepage: ''
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Resque integration for Chewy
+test_files:
+- test/search_and_resque_test.rb