sunspot_mongo 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c76e7526946c4e71396d8e9be616809e2cf0641c
-  data.tar.gz: 8a95498eadd27dae4388aa7f9b29a96144e3df77
+  metadata.gz: 0b69f799044bedbdd34c2e51e95ea5b7de468da6
+  data.tar.gz: 4dde9885c91e575ace88a47e92b543046ea75b0c
 SHA512:
-  metadata.gz: 6f1f22f005de41f9724c181d4806e96a4fee285a756c511c061f5ee9b90778ef2b3875eb08ae4182db364ac22916873352ad325bb8451e4025325fba2e6b45e9
-  data.tar.gz: b15f31a49fc636d6d2cb61b05f94cf4f1ba15eb5b157431fc5ed59d1d8a077b45747102e4e814b8e22ba8b2bfb3bf1ee171f14a4368815083d40ade566f55f5b
+  metadata.gz: d81247aaf38e4dbe82cd1f7606b4365d8e290d165a1296c315234d04018d6b39073ec946fdddc0e81f4a4fb4f7a2dd30b6a584eb4665ebc70e3747e03a25817c
+  data.tar.gz: 95a1f3a371d16bcb577f407ef32a363c37ee6819c9d784db5ab970f1d3181eab06a94f7cc8f6c48781a41cdb443e10488565482cd8ad7d428dcfb771151934f1

data/.rubocop_todo.yml

@@ -1,5 +1,6 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-01-27 17:13:18 -0500 using RuboCop version 0.28.0.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-08-28 12:21:38 -0400 using RuboCop version 0.33.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -9,7 +10,7 @@
 Metrics/AbcSize:
   Max: 20
 
-# Offense count: 10
+# Offense count: 9
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 124
@@ -19,10 +20,12 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 15
 
-# Offense count: 8
+# Offense count: 10
 Style/Documentation:
-  Enabled: false
-
-# Offense count: 2
-Style/RegexpLiteral:
-  MaxSlashes: 0
+  Exclude:
+    - 'lib/sunspot/mongo.rb'
+    - 'lib/sunspot/mongo/railtie.rb'
+    - 'lib/sunspot/mongo/version.rb'
+    - 'spec/support/models/mongo_mapper.rb'
+    - 'spec/support/models/mongoid.rb'
+    - 'spec/support/rails.rb'

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+#### 1.2.0 (2015/08/28)
+
+* [#9](https://github.com/derekharmel/sunspot_mongo/pull/9): Changed `DataAccessor` to fix support for eager loading of associations - [@cec](https://github.com/cec).
+* [#9](https://github.com/derekharmel/sunspot_mongo/pull/9): Changed `rake sunspot:mongo:reindex` to support namespaced models - [@cec](https://github.com/cec).
+* [#9](https://github.com/derekharmel/sunspot_mongo/pull/9): Renamed `rake sunspot:mongo:reindex` to `sunspot:reindex`, overriding Sunspot's original task - [@cec](https://github.com/cec).
+* [#9](https://github.com/derekharmel/sunspot_mongo/pull/9): Added UPGRADING - [@cec](https://github.com/cec).
+
 #### 1.1.0 (2015/01/27)
 
 * Changed `DataAccessor#load_all` to use the `.find` method for MongoMapper and Mongoid for loading a group of documents - [@derekharmel](https://github.com/derekharmel).

data/README.md

@@ -35,6 +35,10 @@ rails g sunspot_rails:install
 rake sunspot:solr:start
 ```
 
+## Upgrading
+
+When upgrading to a new version, don't forget to check [UPGRADING](UPGRADING.md) for notes about breaking changes.
+
 ## Usage
 
 Add the following to your model (assuming you have a string field named "content"):
@@ -64,7 +68,7 @@ If you are using Rails, objects are automatically indexed to Solr as a part of t
 If you make a change to the object's "schema" (code in the searchable block), you must reindex all objects so the changes are reflected in Solr. Run:
 
 ```
-bundle exec rake sunspot:mongo:reindex
+bundle exec rake sunspot:reindex
 ```
 
 ## More info

data/UPGRADING.md

@@ -0,0 +1,8 @@
+Upgrading SunspotMongo
+======================
+
+### Upgrading to >= 1.2.0
+
+The Rake task `sunspot:mongo:reindex` has been renamed to `sunspot:reindex` and now overrides the original Rake task from Sunspot.
+
+See [#9](https://github.com/derekhamel/sunspot_mongo/pull/9) for more information.

data/lib/sunspot/mongo.rb

@@ -18,12 +18,25 @@ module Sunspot
     end
 
     class DataAccessor < Sunspot::Adapters::DataAccessor
+      attr_accessor :include
+
+      # inspired by how Sunspot does this for ActiveRecord
+      def initialize(clazz)
+        super(clazz)
+        @inherited_attributes = [:include]
+      end
+
       def load(id)
-        @clazz.find(id)
+        scope.find(id)
       end
 
       def load_all(ids)
-        @clazz.find(ids)
+        scope.find(ids)
+      end
+
+      def scope
+        sc = @clazz.respond_to?(:criteria) ? @clazz.criteria : @clazz
+        @include ? sc.includes(@include) : sc
       end
     end
   end

data/lib/sunspot/mongo/tasks.rb

@@ -1,20 +1,21 @@
+# Delete reindex task registered by sunspot_rails
+tasks = Rake.application.instance_variable_get '@tasks'
+tasks.delete 'sunspot:reindex'
+
 namespace :sunspot do
-  namespace :mongo do
-    desc "Reindex all models that include Sunspot::Mongo and are located in your application's models directory."
-    task :reindex, [:models] => :environment do |_t, args|
-      sunspot_models = if args[:models]
-                         args[:models].split('+').map(&:constantize)
-                       else
-                         all_files = Dir.glob(Rails.root.join('app', 'models', '**', '*.rb'))
-                         all_models = all_files.map { |path| File.basename(path, '.rb').camelize.constantize }
-                         all_models.select { |m| m.include?(Sunspot::Mongo) && m.searchable? }
-                       end
+  desc "Reindex all models that include Sunspot::Mongo and are located in your application's models directory."
+  task :reindex, [:models] => :environment do |_t, args|
+    sunspot_models = if args[:models]
+                       args[:models].split('+').map(&:constantize)
+                     else
+                       Rails.application.eager_load!
+                       Sunspot.searchable # when a model calls searchable, it registers itself to Sunspot
+                     end
 
-      sunspot_models.each do |model|
-        puts "reindexing #{model}"
-        model.all.each(&:index)
-        Sunspot.commit
-      end
+    sunspot_models.each do |model|
+      puts "reindexing #{model}"
+      model.all.each(&:index)
+      Sunspot.commit
     end
   end
 end

data/lib/sunspot/mongo/version.rb

@@ -1,5 +1,5 @@
 module Sunspot
   module Mongo
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'rails'
 require 'sunspot_mongo'
+require 'support/rails'
 
 ENV['MONGOID_VERSION'] = '4' unless ENV['MONGOID_VERSION'] || ENV['MONGO_MAPPER_VERSION']
 
@@ -17,7 +18,7 @@ require 'shared_examples'
 def setup_servers_and_connections
   FileUtils.mkdir_p '/tmp/sunspot_mongo_test/'
 
-  @solr_pid  = fork { `sunspot-solr start --log-file=solr.log --data-directory=data --log-level=INFO --port=8900` }
+  @solr_pid = fork { `sunspot-solr start --log-file=solr.log --data-directory=data --log-level=INFO --port=8900` }
   sleep 5
 
   if ENV['MONGOID_VERSION']

data/spec/sunspot_mongo_spec.rb

@@ -19,6 +19,20 @@ describe 'Sunspot::Mongo' do
   if ENV['MONGOID_VERSION']
     describe MongoidTestDocument do
       it_behaves_like 'a mongo document'
+      it 'eager-loads associations specified through :include option' do
+        test_doc = MongoidTestDocument.create title: 'So much foo, so little bar.'
+        test_tag = MongoidTestDocumentTag.create name: 'A tag'
+        test_doc.tags << test_tag
+        test_doc.save
+        test_doc.index!
+
+        search = MongoidTestDocument.solr_search(include: :tags) do
+          fulltext 'foo'
+        end
+        expect(search.hits.length).to eql 1
+        expect(search.results.first).to eql test_doc
+        expect(search.results.first.tags).to match [test_tag]
+      end
     end
     describe 'test documents with options' do
       it 'should set sunspot_options' do

data/spec/support/models/mongoid.rb

@@ -4,7 +4,18 @@ class MongoidTestDocument
 
   field :title
 
+  has_and_belongs_to_many :tags, class_name: 'MongoidTestDocumentTag'
+
   searchable do
     text :title
   end
 end
+
+class MongoidTestDocumentTag
+  include Mongoid::Document
+  include Sunspot::Mongo
+
+  field :name
+
+  has_and_belongs_to_many :documents, class_name: 'MongoidTestDocument'
+end

data/spec/support/rails.rb

@@ -0,0 +1,5 @@
+module Rails
+  def self.root
+    Dir.pwd
+  end
+end

data/sunspot_mongo.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/derekharmel/sunspot_mongo'
   s.summary     = 'Sunspot support for Mongo Mapper and Mongoid.'
   s.description = 'Sunspot support for Mongo Mapper and Mongoid.'
+  s.license     = 'MIT'
 
   s.rubyforge_project = 'sunspot_mongo'
 
@@ -25,5 +26,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'guard'
   s.add_development_dependency 'guard-rspec'
   s.add_development_dependency 'sunspot_solr', '2.0.0'
-  s.add_development_dependency 'rubocop', '0.28.0'
+  s.add_development_dependency 'rubocop', '0.33.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sunspot_mongo
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Brian Alexander
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sunspot_rails
@@ -101,14 +101,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: 0.33.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: 0.33.0
 description: Sunspot support for Mongo Mapper and Mongoid.
 email:
 - balexand@gmail.com
@@ -129,6 +129,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- UPGRADING.md
 - lib/sunspot/mongo.rb
 - lib/sunspot/mongo/railtie.rb
 - lib/sunspot/mongo/tasks.rb
@@ -139,9 +140,11 @@ files:
 - spec/sunspot_mongo_spec.rb
 - spec/support/models/mongo_mapper.rb
 - spec/support/models/mongoid.rb
+- spec/support/rails.rb
 - sunspot_mongo.gemspec
 homepage: https://github.com/derekharmel/sunspot_mongo
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -169,3 +172,4 @@ test_files:
 - spec/sunspot_mongo_spec.rb
 - spec/support/models/mongo_mapper.rb
 - spec/support/models/mongoid.rb
+- spec/support/rails.rb