workling_delta_indexer 0.1.2

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/workling"]
+	path = vendor/workling
+	url = git://github.com/purzelrakete/workling.git

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dan Pickett
+
+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.rdoc

@@ -0,0 +1,30 @@
+= workling_delta_indexer
+
+Use workling to manage your delta indexing with <a href="http://freelancing-gods.com/">Pat Allan's</a> <a href="http://github.com/freelancing-god/thinking-sphinx/tree/master">Thinking Sphinx</a>
+
+== How to Use
+
+Install the gem
+
+  gem install dpickett-workling_delta_indexer
+
+Add the gem to your list of required gems in config/environment.rb
+
+  config.gem "dpickett-workling_delta_indexer", 
+    :lib => "workling_delta_indexer"
+
+Use WorklingDelta::Indexer as your Delta handler
+
+  define_index do
+    <index details>
+
+    set_property :delta => WorklingDelta::Indexer
+  end
+
+== Documentation
+
+View the documentation at http://rdoc.info/projects/dpickett/workling_delta_indexer
+
+== Copyright
+
+Copyright (c) 2009 Dan Pickett. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "workling_delta_indexer"
+    gem.summary = %Q{workling delta indexing for thinking sphinx}
+    gem.email = "dpickett@enlightsolutions.com"
+    gem.homepage = "http://github.com/dpickett/workling_delta_indexer"
+    gem.authors = ["Dan Pickett"]
+    gem.add_dependency "freelancing-god-thinking-sphinx", ">= 1.1.5"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'workling_delta_indexer'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*', "LICENSE")
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require "YARD"
+  YARD::Rake::YardocTask.new do |t|
+  end
+rescue LoadError
+
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 2
+:major: 0

data/lib/workling_delta/indexer.rb

@@ -0,0 +1,19 @@
+module WorklingDelta
+  # This is the class that that should be wired to your index configuration
+  # @example definition in an index
+  #   define_index do |index|
+  #     set_property :delta => WorklingDelta::Indexer
+  #   end
+  class Indexer < ThinkingSphinx::Deltas::DefaultDelta
+    # Creates the worker that performs the delta indexing
+    # @param model the class of that triggered the delta
+    # @param instance the instance that changed (if applicable)
+    # @return [Boolean] should always return true
+    def do_index(model, instance = nil)
+      doc_id = instance ? instance.sphinx_document_id : nil
+      WorklingDelta::Worker.async_index(:index_name => delta_index_name(model), :document_id => doc_id)
+    
+      true
+    end
+  end
+end

data/lib/workling_delta/worker.rb

@@ -0,0 +1,15 @@
+# The Worker that actually performs the delta indexing
+# This class performs the indexing asyncronously for Workling configurations
+class WorklingDelta::Worker < Workling::Base
+  #perform the index
+  #@option options [String] :index_name the name of the index to run the delta job on
+  #@option options [Integer, nil] :document_id the sphinx document id of the object that needs to be flagged as deleted
+  def index(options = {})
+    ThinkingSphinx::Deltas::DeltaJob.new(options[:index_name]).perform
+    
+    if options[:document_id]
+      ThinkingSphinx::Deltas::FlagAsDeletedJob.new(options[:index_name], 
+        options[:document_id]).perform
+    end
+  end
+end

data/lib/workling_delta_indexer.rb

@@ -0,0 +1,7 @@
+gem "freelancing-god-thinking-sphinx"
+
+require "thinking_sphinx"
+
+require File.join(File.dirname(__FILE__), "workling_delta", "indexer")
+require File.join(File.dirname(__FILE__), "workling_delta", "worker")
+

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'test/unit'
+
+require 'shoulda'
+require 'rr'
+require 'active_support'
+require 'active_support/core_ext'
+
+RAILS_ENV = "test"
+RAILS_DEFAULT_LOGGER = "/dev/null"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'vendor'))
+
+require "workling/lib/workling/discovery"
+require "workling/lib/workling/base"
+require 'workling_delta_indexer'
+
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit
+end

data/test/workling_delta/indexer_test.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), "..", "test_helper")
+
+class WorklingDelta::IndexerTest < Test::Unit::TestCase
+    context "an indexer" do
+    should "spawn a worker with the delta index name when an index is triggered" do
+      mock(WorklingDelta::Worker).async_index(:index_name => "test_model_delta", :document_id => nil)
+
+      WorklingDelta::Indexer.new(ThinkingSphinx::Index.new(TestModel), {}).do_index(TestModel)
+    end
+  end
+
+end
+
+class TestModel < ActiveRecord::Base
+  define_index do
+    indexes :id
+  end
+end
+
+

data/test/workling_delta/worker_test.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), "..", "test_helper")
+
+class WorklingDelta::WorkerTest < Test::Unit::TestCase
+  context "a worker" do
+    setup do
+      @index_name = "the_delta_index"
+      @document_id = 1
+
+      @job = mock(Object)
+      mock(ThinkingSphinx::Deltas::DeltaJob).new(@index_name) { @job }
+      @job.perform
+    end
+
+    context "that doesn't receive a document id" do
+      
+      should "perform a TS delta job with the index name" do
+        invoke_worker(:index_name => @index_name)
+      end
+
+      should "not perform a flag as deleted job if I don't pass a document id" do
+        dont_allow(ThinkingSphinx::Deltas::FlagAsDeletedJob).new(
+         anything, anything)
+        
+        invoke_worker(:index_name => @index_name)
+      end
+
+    end
+
+    context "that receives a document id" do
+      should "trigger a flag as deleted job if I pass a document id" do
+        delete_job = mock(Object)
+        mock(ThinkingSphinx::Deltas::FlagAsDeletedJob).new(
+          @index_name, @document_id) { delete_job }
+        delete_job.perform
+
+        invoke_worker(:index_name => @index_name, :document_id => @document_id)
+      end
+    end
+    
+  end
+
+  private
+  def invoke_worker(options = {})
+    WorklingDelta::Worker.new.index(options)
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: workling_delta_indexer
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Dan Pickett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-26 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: freelancing-god-thinking-sphinx
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.5
+    version: 
+description: 
+email: dpickett@enlightsolutions.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- .gitmodules
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/workling_delta/indexer.rb
+- lib/workling_delta/worker.rb
+- lib/workling_delta_indexer.rb
+- test/test_helper.rb
+- test/workling_delta/indexer_test.rb
+- test/workling_delta/worker_test.rb
+has_rdoc: true
+homepage: http://github.com/dpickett/workling_delta_indexer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: workling delta indexing for thinking sphinx
+test_files: 
+- test/test_helper.rb
+- test/workling_delta/indexer_test.rb
+- test/workling_delta/worker_test.rb