sunspot_association 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.bundle/
+log/*.log
+pkg/
+tmp/
+spec/sunspot_association.sqlite3

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+ - 1.9.2
+ - 1.9.3
+ - ruby-head

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem 'rake'
+
+gemspec
+
+group :development do
+  gem 'rspec'
+  gem 'shoulda-matchers'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rb-fsevent'
+  gem 'with_model'
+end

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    sunspot_association (0.0.1)
+      activerecord (~> 3.0)
+      sunspot_solr
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
+    builder (3.0.4)
+    coderay (1.0.9)
+    diff-lcs (1.1.3)
+    guard (1.6.2)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      terminal-table (>= 1.4.3)
+      thor (>= 0.14.6)
+    guard-rspec (2.4.0)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    i18n (0.6.1)
+    listen (0.7.2)
+    lumberjack (1.0.2)
+    metaclass (0.0.1)
+    method_source (0.8.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.2)
+    nokogiri (1.5.6)
+    pr_geohash (1.0.0)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.0.4)
+    rb-fsevent (0.9.3)
+    rsolr (1.0.8)
+      builder (>= 2.1.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
+    slop (3.4.4)
+    sqlite3 (1.3.7)
+    sunspot (1.3.3)
+      pr_geohash (~> 1.0)
+      rsolr (~> 1.0.7)
+    sunspot_rails (1.3.3)
+      nokogiri
+      sunspot (= 1.3.3)
+    sunspot_solr (2.0.0)
+    sunspot_test (0.4.0)
+      sunspot_rails (>= 1.2.1)
+    terminal-table (1.4.5)
+    thor (0.18.1)
+    tzinfo (0.3.37)
+    with_model (0.3.1)
+      activerecord (>= 2.3.5, < 4.0.0)
+      rspec (~> 2.11)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  guard
+  guard-rspec
+  rake
+  rb-fsevent
+  rspec
+  shoulda-matchers
+  sqlite3
+  sunspot_association!
+  sunspot_test
+  with_model

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+end
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,74 @@
+# sunspot_association [![Build Status](https://secure.travis-ci.org/Arjeno/sunspot_association.png?branch=master)](http://travis-ci.org/Arjeno/sunspot_association)
+
+Automatically reindex ActiveRecord associations using Sunspot.
+
+## Usage
+
+Add to your Gemfile:
+
+```ruby
+gem 'sunspot_association'
+```
+
+Add to your model:
+
+```ruby
+class Company < ActiveRecord::Base
+  sunspot_associate :orders, :fields => :name
+end
+```
+
+## Example
+
+```ruby
+class User < ActiveRecord::Base
+  belongs_to :company
+
+  searchable do
+    text :company_name { company.try(:name) }
+  end
+end
+
+class Order < ActiveRecord::Base
+  belongs_to :company
+
+  searchable do
+    text :company_name { company.try(:name) }
+  end
+end
+
+class Company < ActiveRecord::Base
+  has_many :orders
+  has_many :users
+
+  sunspot_associate :orders, :users
+
+  # Or only track changes for the name field
+  # => sunspot_associate :orders, :users, :fields => :name
+end
+```
+
+## License
+
+Copyright (c) 2013 Arjen Oosterkamp
+
+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/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/sunspot_association/version.rb

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

data/lib/sunspot_association.rb

@@ -0,0 +1,118 @@
+require 'active_record'
+require 'sunspot_association/version'
+
+module SunspotAssociation
+  module Model
+
+    extend ActiveSupport::Concern
+
+    included do
+
+      ## Attributes
+
+      cattr_accessor :sunspot_association_configuration
+      cattr_accessor :sunspot_association_callbacks
+
+    end
+
+    module ClassMethods
+
+      def sunspot_associate?
+        self.sunspot_association_configuration != {}
+      end
+
+      # Reindex associations when a model changes
+      #
+      # Options:
+      #
+      # :fields
+      # => Field(s) to watch for changes
+      #
+      # :on_create
+      # => Specifies if it should reindex associations when a record is created
+      #
+      # Examples:
+      #
+      # => sunspot_associate :orders, :fields => :name
+      # => sunspot_associate :orders, :users, :fields => [:name, :phone], :on_create => true
+      #
+      def sunspot_associate(*args)
+        options = args.extract_options!
+        fields  = options.delete(:fields)
+
+        self.sunspot_association_configuration ||= {}
+
+        args.each do |object|
+          default = { :fields => [] }
+          config  = self.sunspot_association_configuration[object] || default
+
+          # Fields
+          config[:fields] += Array(fields)
+          config[:fields].compact!
+          config[:fields].uniq!
+
+          config.merge!(options)
+
+          self.sunspot_association_configuration[object] = config
+        end
+
+        sunspot_association_callbacks!
+      end
+
+      def sunspot_association_callbacks!
+        return true if self.sunspot_association_callbacks == true
+
+        after_create  Proc.new { |o| o.reindex_sunspot_associations!(:create) }
+        after_update  Proc.new { |o| o.reindex_sunspot_associations!(:update) }
+        after_destroy Proc.new { |o| o.reindex_sunspot_associations!(:destroy) }
+
+        self.sunspot_association_callbacks = true
+      end
+
+      def reset_sunspot_associations!
+        self.sunspot_association_configuration = {}
+        self.sunspot_association_callbacks = false
+      end
+
+    end
+
+    # Main callback method, checks if it should reindex an association
+    def reindex_sunspot_associations!(event)
+      self.class.sunspot_association_configuration.each do |object, config|
+        case event
+        when :create
+          reindex_sunspot_association!(object) if config[:on_create]
+        when :update
+          reindex_sunspot_association!(object) if reindex_sunspot_association?(object)
+        when :destroy
+          reindex_sunspot_association!(object)
+        end
+      end
+    end
+
+    # Checks if an association should be reindexed
+    # => reindex_sunspot_association?(:orders) => true
+    def reindex_sunspot_association?(object)
+      if (config = (self.class.sunspot_association_configuration || {})[object]).present?
+        if config[:fields].present?
+          return ! (changed & (config[:fields] || []).map(&:to_s)).empty?
+        else
+          return changed.any?
+        end
+      end
+
+      false
+    end
+
+    # Reindexes an association using Sunspot.index
+    def reindex_sunspot_association!(object)
+      return false unless self.class.sunspot_associate?
+      return false unless self.respond_to?(object)
+
+      Sunspot.index self.send(object)
+    end
+
+  end
+end
+
+ActiveRecord::Base.send(:include, SunspotAssociation::Model)

data/lib/tasks/sunspot_association_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sunspot_association do
+#   # Task goes here
+# end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'active_record'
+require 'sunspot_association'
+require 'shoulda/matchers'
+require 'with_model'
+require 'sunspot_test/rspec'
+
+RSpec.configure do |config|
+  config.extend WithModel
+end
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3",
+                                        :database => File.dirname(__FILE__) + "/sunspot_association.sqlite3")

data/spec/sunspot_association_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+
+describe SunspotAssociation do
+
+  with_model :User do
+    table do |t|
+      t.belongs_to :company
+      t.string :name
+      t.timestamps
+    end
+
+    model do
+      belongs_to :company
+    end
+  end
+
+  with_model :Order do
+    table do |t|
+      t.belongs_to :company
+      t.string :number
+      t.timestamps
+    end
+
+    model do
+      belongs_to :company
+    end
+  end
+
+  with_model :Company do
+    table do |t|
+      t.string :name
+      t.string :number
+      t.timestamps
+    end
+
+    model do
+      has_many :orders
+      has_many :users
+      sunspot_associate :orders
+    end
+  end
+
+  let(:company) { Company.create({ :name => 'Company name', :number => '1' }) }
+  let(:order) { Order.create({ :number => '1', :company => company }) }
+  let(:user) { User.create({ :name => 'John Doe', :company => company }) }
+
+  before(:each) do
+    Company.sunspot_associate :orders, :fields => :name
+    Company.sunspot_associate :users, :on_create => true
+  end
+
+  after(:each) do
+    Company.reset_sunspot_associations!
+  end
+
+  describe :sunspot_association_configuration do
+
+    it do
+      Company.sunspot_association_configuration.should == {
+        :orders => { :fields => [:name] },
+        :users  => { :fields => [], :on_create => true }
+      }
+    end
+
+    context 'with multiple objects' do
+
+      before(:each) do
+        Company.sunspot_associate :orders, :users, :fields => :name, :on_create => true
+      end
+
+      it do
+        Company.sunspot_association_configuration.should == {
+          :orders => { :fields => [:name], :on_create => true },
+          :users  => { :fields => [:name], :on_create => true },
+        }
+      end
+
+    end
+
+  end
+
+  describe :reindex_sunspot_association? do
+
+    subject { company }
+
+    context 'without changes' do
+
+      it { company.reindex_sunspot_association?(:orders).should be_false }
+      it { company.reindex_sunspot_association?(:users).should be_false }
+
+    end
+
+    context 'with changes' do
+
+      before(:each) { company.name = 'Name change' }
+
+      it { company.reindex_sunspot_association?(:orders).should be_true }
+      it { company.reindex_sunspot_association?(:users).should be_true }
+
+    end
+
+    context 'with any change' do
+
+      before(:each) { company.number = '5' }
+
+      it { company.reindex_sunspot_association?(:orders).should be_false }
+      it { company.reindex_sunspot_association?(:users).should be_true }
+
+    end
+
+  end
+
+  describe :callbacks do
+
+    context :after_create do
+
+      let(:company) { Company.new }
+      after(:each) { company.save }
+
+      it do
+        company.should_not_receive(:reindex_sunspot_association!).with(:orders)
+        company.should_receive(:reindex_sunspot_association!).with(:users)
+      end
+
+    end
+
+    context :after_update do
+
+      context 'with tracked change' do
+
+        after(:each) { company.update_attributes({ :name => 'name change' }) }
+
+        it do
+          company.should_receive(:reindex_sunspot_association!).with(:orders)
+          company.should_receive(:reindex_sunspot_association!).with(:users)
+        end
+
+      end
+
+      context 'with untracked change' do
+
+        after(:each) { company.update_attributes({ :number => '5' }) }
+
+        it do
+          company.should_not_receive(:reindex_sunspot_association!).with(:orders)
+          company.should_receive(:reindex_sunspot_association!).with(:users)
+        end
+
+      end
+
+    end
+
+    context :after_destroy do
+
+      after(:each) { company.destroy }
+
+      it do
+        company.should_receive(:reindex_sunspot_association!).with(:orders)
+        company.should_receive(:reindex_sunspot_association!).with(:users)
+      end
+
+    end
+
+  end
+
+end

data/sunspot_association.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "sunspot_association/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "sunspot_association"
+  s.version     = SunspotAssociation::VERSION
+  s.authors     = ["Arjen Oosterkamp"]
+  s.email       = ["mail@arjen.me"]
+  s.homepage    = ""
+  s.summary     = %q{Automatically reindex ActiveRecord associations using Sunspot}
+  s.description = %q{Automatically reindex ActiveRecord associations using Sunspot}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec", "~> 2.3"
+
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "sunspot_test"
+
+  s.add_dependency "activerecord", "~> 3.0"
+  s.add_dependency "sunspot_solr"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: sunspot_association
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Arjen Oosterkamp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sunspot_test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sunspot_solr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automatically reindex ActiveRecord associations using Sunspot
+email:
+- mail@arjen.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/sunspot_association.rb
+- lib/sunspot_association/version.rb
+- lib/tasks/sunspot_association_tasks.rake
+- spec/spec_helper.rb
+- spec/sunspot_association_spec.rb
+- sunspot_association.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Automatically reindex ActiveRecord associations using Sunspot
+test_files:
+- spec/spec_helper.rb
+- spec/sunspot_association_spec.rb
+has_rdoc: