ts-datetime-delta 1.0.2 → 1.0.3

data/README.textile

@@ -4,16 +4,20 @@ h2. Installation
 
 You'll need Thinking Sphinx 1.3.0 or later.
 
-<pre><code>gem install ts-datetime-delta --source http://gemcutter.org</code></pre>
+<pre><code>gem install ts-datetime-delta</code></pre>
 
-In your @environment.rb@ file, with the rest of your gem dependencies:
+In your Gemfile, you can use it like so:
+
+<pre><code>gem 'ts-datetime-delta', '~> 1.0.2',
+  :require => 'thinking_sphinx/deltas/datetime_delta'</code></pre>
+
+Or if you're still on Rails 2, then put this in your @environment.rb@ file with the rest of your gem dependencies:
 
 <pre><code>config.gem 'ts-datetime-delta',
   :lib     => 'thinking_sphinx/deltas/datetime_delta'
-  :version => '>= 1.0.0',
-  :source  => 'http://gemcutter.org'</code></pre>
+  :version => '>= 1.0.0'</code></pre>
 
-And add the following line to the bottom of your @Rakefile@:
+No matter which version of Rails, you'll need to add the following line to the bottom of your @Rakefile@:
 
 <pre><code>require 'thinking_sphinx/deltas/datetime_delta/tasks'</code></pre>
 
@@ -23,7 +27,7 @@ For the indexes you want to use this delta approach, make sure you set that up i
 
 <pre><code>define_index do
   # ...
-  
+
   set_property :delta => :datetime
 end</code></pre>
 
@@ -45,6 +49,11 @@ The shorthand version is:
 
 <pre><code>rake ts:in:delta</code></pre>
 
+h2. Contributors
+
+* "W. Andrew Loe III":http://andrewloe.com/ - Environment variable for disabling merging.
+* "Kirill Maximov":http://kirblog.idetalk.com - Handling nil timestamp column values for toggled checks.
+
 h2. Copyright
 
-Copyright (c) 2009 Pat Allan, and released under an MIT Licence.
+Copyright (c) 2009-2012 Pat Allan, and released under an MIT Licence.

data/lib/thinking_sphinx/deltas/datetime_delta.rb

@@ -1,121 +1,139 @@
 # Datetime Deltas for Thinking Sphinx
-# 
+#
 # This documentation is aimed at those reading the code. If you're looking for
 # a guide to Thinking Sphinx and/or deltas, I recommend you start with the
 # Thinking Sphinx site instead - or the README for this library at the very
 # least.
-# 
+#
 # @author Patrick Allan
 # @see http://ts.freelancing-gods.com Thinking Sphinx
-# 
+#
 class ThinkingSphinx::Deltas::DatetimeDelta < ThinkingSphinx::Deltas::DefaultDelta
   attr_accessor :column, :threshold
-  
+
+  def self.index
+    ThinkingSphinx.context.indexed_models.collect { |model|
+      model.constantize
+    }.select { |model|
+      model.define_indexes
+      model.delta_indexed_by_sphinx?
+    }.each do |model|
+      model.sphinx_indexes.select { |index|
+        index.delta? && index.delta_object.respond_to?(:delayed_index)
+      }.each { |index|
+        index.delta_object.delayed_index(index.model)
+      }
+    end
+  end
+
   # Initialises the Delta object for the given index and settings. All handled
   # by Thinking Sphinx, so you shouldn't need to call this method yourself in
   # general day-to-day situations.
-  # 
+  #
   # @example
   #   ThinkingSphinx::Deltas::DatetimeDelta.new index,
   #     :delta_column => :updated_at,
   #     :threshold    => 1.day
-  # 
+  #
   # @param [ThinkingSphinx::Index] index the index using this delta object
   # @param [Hash] options a hash of options for the index
   # @option options [Symbol] :delta_column (:updated_at) The column to use for
   #   tracking when a record has changed. Default to :updated_at.
   # @option options [Integer] :threshold (1.day) The window of time to store
   #   changes for, in seconds. Defaults to one day.
-  # 
+  #
   def initialize(index, options = {})
     @index      = index
     @column     = options.delete(:delta_column) || :updated_at
     @threshold  = options.delete(:threshold)    || 1.day
   end
-  
+
   # Does absolutely nothing, beyond returning true. Thinking Sphinx expects
   # this method, though, and we don't want to use the inherited behaviour from
   # DefaultDelta.
-  # 
+  #
   # All the real indexing logic is done by the delayed_index method.
-  # 
+  #
   # @param [Class] model the ActiveRecord model to index.
   # @param [ActiveRecord::Base] instance the instance of the given model that
   #   has changed. Optional.
   # @return [Boolean] true
   # @see #delayed_index
-  # 
+  #
   def index(model, instance = nil)
     # do nothing
     true
   end
-  
+
   # Processes the delta index for the given model, and then merges the relevant
   # core and delta indexes together. By default, the output of these indexer
   # commands are printed to stdout. If you'd rather it didn't, set
   # ThinkingSphinx.suppress_delta_output to true.
-  # 
+  #
   # @param [Class] model the ActiveRecord model to index
   # @return [Boolean] true
-  # 
+  #
   def delayed_index(model)
     config = ThinkingSphinx::Configuration.instance
     rotate = ThinkingSphinx.sphinx_running? ? " --rotate" : ""
-    
+
     output = `#{config.bin_path}#{config.indexer_binary_name} --config #{config.config_file}#{rotate} #{model.delta_index_names.join(' ')}`
-    
+
+
     model.sphinx_indexes.select(&:delta?).each do |index|
       output += `#{config.bin_path}#{config.indexer_binary_name} --config #{config.config_file}#{rotate} --merge #{index.core_name} #{index.delta_name} --merge-dst-range sphinx_deleted 0 0`
-    end
+    end unless ENV['DISABLE_MERGE'] == 'true'
+
     puts output unless ThinkingSphinx.suppress_delta_output?
-    
+
     true
   end
-  
+
   # Toggles the given instance to be flagged as part of the next delta indexing.
   # For datetime deltas, this means do nothing at all.
-  # 
+  #
   # @param [ActiveRecord::Base] instance the instance to be toggled
-  # 
+  #
   def toggle(instance)
     # do nothing
   end
-  
+
   # Report whether a given instance is considered toggled (part of the next
   # delta process). For datetime deltas, this is true if the delta column
   # (updated_at by default) has a value within the threshold. Otherwise, false
   # is returned.
-  # 
+  #
   # @param [ActiveRecord::Base] instance the instance to check
   # @return [Boolean] True if within the threshold window, otherwise false.
-  # 
+  #
   def toggled(instance)
-    instance.send(@column) > @threshold.ago
+    res = instance.send(@column)
+    res && (res > @threshold.ago)
   end
-  
+
   # Returns the SQL query that resets the model data after a normal index. For
   # datetime deltas, nothing needs to be done, so this method returns nil.
-  # 
+  #
   # @param [Class] model The ActiveRecord model that is requesting the query
   # @return [NilClass] Always nil
-  # 
+  #
   def reset_query(model)
     nil
   end
-  
+
   # A SQL condition (as part of the WHERE clause) that limits the result set to
   # just the delta data, or all data, depending on whether the toggled argument
-  # is true or not. For datetime deltas, the former value is a check on the 
+  # is true or not. For datetime deltas, the former value is a check on the
   # delta column being within the threshold. In the latter's case, no condition
   # is needed, so nil is returned.
-  # 
+  #
   # @param [Class] model The ActiveRecord model to generate the SQL condition
   #   for.
   # @param [Boolean] toggled Whether the query should request delta documents or
   #   all documents.
   # @return [String, NilClass] The SQL condition if the toggled version is
   #   requested, otherwise nil.
-  # 
+  #
   def clause(model, toggled)
     if toggled
       "#{model.quoted_table_name}.#{model.connection.quote_column_name(@column.to_s)}" +

data/lib/thinking_sphinx/deltas/datetime_delta/tasks.rb

@@ -1,26 +1,15 @@
 namespace :thinking_sphinx do
   namespace :index do
-    desc "Index Thinking Sphinx datetime delta indexes"
+    desc "Index Thinking Sphinx datetime delta indices"
     task :delta => :app_env do
-      ThinkingSphinx.context.indexed_models.collect { |model|
-        model.constantize
-      }.select { |model|
-        model.define_indexes
-        model.delta_indexed_by_sphinx?
-      }.each do |model|
-        model.sphinx_indexes.select { |index|
-          index.delta? && index.delta_object.respond_to?(:delayed_index)
-        }.each { |index|
-          index.delta_object.delayed_index(index.model)
-        }
-      end
+      ThinkingSphinx::Deltas::DatetimeDelta.index
     end
   end
 end
 
 namespace :ts do
   namespace :in do
-    desc "Index Thinking Sphinx datetime delta indexes"
+    desc "Index Thinking Sphinx datetime delta indices"
     task :delta => "thinking_sphinx:index:delta"
   end
 end

data/spec/spec_helper.rb

@@ -1,12 +1,13 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'rubygems'
-require 'spec'
-require 'spec/autorun'
+require 'rspec'
 
-require "thinking_sphinx"
+require 'active_support'
+require 'active_support/time'
+require 'thinking_sphinx'
 require 'thinking_sphinx/deltas/datetime_delta'
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   #
 end

data/spec/thinking_sphinx/deltas/datetime_delta_spec.rb

@@ -1,4 +1,4 @@
-require 'spec/spec_helper'
+require './spec/spec_helper'
 
 describe ThinkingSphinx::Deltas::DatetimeDelta do
   before :each do
@@ -6,32 +6,34 @@ describe ThinkingSphinx::Deltas::DatetimeDelta do
       stub('index'), {}
     )
   end
-  
+
   describe '#index' do
     it "should do nothing to the model" do
       @datetime_delta.index(stub('model'))
     end
-    
+
     it "should do nothing to the instance, if provided" do
       @datetime_delta.index(stub('model'), stub('instance'))
     end
-    
+
     it "should make no system calls" do
       @datetime_delta.stub! :`      => true
       @datetime_delta.stub! :system => true
-      
+
       @datetime_delta.should_not_receive(:`)
       @datetime_delta.should_not_receive(:system)
-      
+
       @datetime_delta.index(stub('model'), stub('instance'))
     end
-    
+
     it "should return true" do
       @datetime_delta.index(stub('model')).should be_true
     end
   end
-  
+
   describe '#delayed_index' do
+    let(:root) { File.expand_path File.dirname(__FILE__) + '/../../..' }
+
     before :each do
       @index = stub('index',
         :delta?     => true,
@@ -44,92 +46,100 @@ describe ThinkingSphinx::Deltas::DatetimeDelta do
         :delta_index_names      => ['foo_delta'],
         :sphinx_indexes         => [@index]
       )
-      
+
       ThinkingSphinx.suppress_delta_output = false
-      
+
       @datetime_delta.stub! :`    => ""
       @datetime_delta.stub! :puts => nil
     end
-    
+
     it "should process the delta index for the given model" do
       @datetime_delta.should_receive(:`).
-        with('indexer --config /config/development.sphinx.conf foo_delta')
-      
+        with("indexer --config /config/development.sphinx.conf foo_delta")
+
       @datetime_delta.delayed_index(@model)
     end
-    
+
     it "should merge the core and delta indexes for the given model" do
-      @datetime_delta.should_receive(:`).with('indexer --config /config/development.sphinx.conf --merge foo_core foo_delta --merge-dst-range sphinx_deleted 0 0')
-      
+      @datetime_delta.should_receive(:`).with("indexer --config /config/development.sphinx.conf --merge foo_core foo_delta --merge-dst-range sphinx_deleted 0 0")
+
       @datetime_delta.delayed_index(@model)
     end
-    
+
     it "should include --rotate if Sphinx is running" do
       ThinkingSphinx.stub!(:sphinx_running? => true)
       @datetime_delta.should_receive(:`) do |command|
         command.should match(/\s--rotate\s/)
+        'output'
       end
-      
+
       @datetime_delta.delayed_index(@model)
     end
-    
+
     it "should output the details by default" do
       @datetime_delta.should_receive(:puts)
-      
+
       @datetime_delta.delayed_index(@model)
     end
-    
+
     it "should hide the details if suppressing delta output" do
       ThinkingSphinx.suppress_delta_output = true
       @datetime_delta.should_not_receive(:puts)
-      
+
       @datetime_delta.delayed_index(@model)
     end
   end
-  
+
   describe '#toggle' do
     it "should do nothing to the instance" do
       @datetime_delta.toggle(stub('instance'))
     end
   end
-  
+
   describe '#toggled' do
     it "should return true if the column value is more recent than the threshold" do
       instance = stub('instance', :updated_at => 20.minutes.ago)
       @datetime_delta.threshold = 30.minutes
-      
+
       @datetime_delta.toggled(instance).should be_true
     end
-    
+
     it "should return false if the column value is older than the threshold" do
       instance = stub('instance', :updated_at => 30.minutes.ago)
       @datetime_delta.threshold = 20.minutes
-      
+
+      @datetime_delta.toggled(instance).should be_false
+    end
+
+    it "should return false if the column value is null" do
+      instance = stub('instance', :updated_at => nil)
+      @datetime_delta.threshold = 20.minutes
+
       @datetime_delta.toggled(instance).should be_false
     end
   end
-  
+
   describe '#reset_query' do
     it "should be nil" do
       @datetime_delta.reset_query(@model).should be_nil
     end
   end
-  
+
   describe '#clause' do
     before :each do
       @model = stub('model', :connection => stub('connection'))
       @model.stub!(:quoted_table_name => '`foo`')
       @model.connection.stub!(:quote_column_name => '`updated_at`')
-      
+
       @datetime_delta.stub!(
         :adapter => stub('adapter', :time_difference => 'time_difference')
       )
     end
-    
+
     it "should return nil if not for the toggled results" do
       @datetime_delta.clause(@model, false).should be_nil
     end
-    
+
     it "should return only records within the threshold" do
       @datetime_delta.clause(@model, true).
         should == '`foo`.`updated_at` > time_difference'

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ts-datetime-delta
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  hash: 17
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Pat Allan
@@ -9,49 +15,68 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-03 00:00:00 +11:00
-default_executable: 
+date: 2012-06-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thinking-sphinx
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 3
+        - 8
         version: 1.3.8
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
         version: 1.2.9
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: cucumber
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id004
 description: Manage delta indexes via datetime columns for Thinking Sphinx
 email: pat@freelancing-gods.com
 executables: []
@@ -66,44 +91,59 @@ files:
 - README.textile
 - lib/thinking_sphinx/deltas/datetime_delta.rb
 - lib/thinking_sphinx/deltas/datetime_delta/tasks.rb
-has_rdoc: true
+- features/step_definitions/common_steps.rb
+- features/step_definitions/datetime_delta_steps.rb
+- features/support/db/fixtures/thetas.rb
+- features/support/db/migrations/create_thetas.rb
+- features/support/env.rb
+- features/support/models/theta.rb
+- features/datetime_deltas.feature
+- features/support/database.example.yml
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/thinking_sphinx/deltas/datetime_delta_spec.rb
 homepage: http://github.com/freelancing-god/ts-datetime-delta
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Thinking Sphinx - Datetime Deltas
 test_files: 
-- features/datetime_deltas.feature
 - features/step_definitions/common_steps.rb
 - features/step_definitions/datetime_delta_steps.rb
-- features/support/database.example.yml
-- features/support/database.yml
 - features/support/db/fixtures/thetas.rb
 - features/support/db/migrations/create_thetas.rb
 - features/support/env.rb
 - features/support/models/theta.rb
+- features/datetime_deltas.feature
+- features/support/database.example.yml
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/thinking_sphinx/deltas/datetime_delta_spec.rb

data/features/support/database.yml

@@ -1,5 +0,0 @@
-username: thinking_sphinx
-host: localhost
-password: thinking_sphinx
-pool: 1
-min_messages: warning