acts_as_solr_reloaded 1.5.0 → 1.6.0

data/README.rdoc

@@ -5,9 +5,11 @@ This plugin adds full text search capabilities and many other nifty features fro
 * faceting
 * dynamic attributes
 * integration with acts_as_taggable_on
+* integration with will_paginate
 * highlighting
 * geolocation
 * relevance
+* suggest
 
 Watch this screencast for a short demo of the latests features:
 
@@ -55,6 +57,16 @@ If you want to integrate the model with acts_as_taggable_on, just add the option
 
 Please see ActsAsSolr::ActsMethods for a complete info
 
+== PAGINATION
+
+In your controller:
+
+  @search = Product.search "beer", :page => 2, :per_page => 20
+
+And in your view:
+
+  will_paginate @search
+
 == TESTING
 
 To test code that uses acts_as_solr_reloaded you must start a Solr server for the test environment and also start MongoDB.
@@ -82,4 +94,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.6.0

data/config/solr_environment.rb

@@ -2,6 +2,7 @@ ENV['RAILS_ENV']  = (ENV['RAILS_ENV'] || 'development').dup
 # RAILS_ROOT isn't defined yet, so figure it out.
 require "uri"
 require "fileutils"
+require "yaml"
 dir = File.dirname(__FILE__)
 SOLR_PATH = File.expand_path("#{dir}/../solr") unless defined? SOLR_PATH
 

data/generators/dynamic_attributes_migration/templates/migration.rb

@@ -7,9 +7,11 @@ class DynamicAttributesMigration < ActiveRecord::Migration
       t.text :value
       t.timestamps
     end
+    add_index :dynamic_attributes, [:dynamicable_id, :dynamicable_type, :name], :unique => true,  :name => 'da_pk'
   end
 
   def self.down
+    remove_index 'da_pk'
     drop_table :dynamic_attributes
   end
-end
+end

data/lib/acts_as_solr.rb

@@ -21,16 +21,24 @@ require File.dirname(__FILE__) + '/acts_as_solr/lazy_document'
 require File.dirname(__FILE__) + '/acts_as_solr/mongo_mapper'
 
 module ActsAsSolr
+  class Post
+    class << self
+      def config
+        @config ||= YAML::load_file("#{Rails.root}/config/solr.yml")[Rails.env]
+      end
 
-  class Post    
-    def self.execute(request, core = nil)
-      config_file_path = File.join(Rails.root, '/config/solr.yml')
-      config = YAML::load_file(config_file_path)[Rails.env]
-      url = config['url'] + (core.nil? ? '' : "/#{core}")
-      connection = Solr::Connection.new(url,
-                                        :username => config['username'],
-                                        :password => config['password'])
-      connection.send request
+      def credentials
+        @credentials ||= {:username => config['username'], :password => config['password']}
+      end
+
+      def url(core)
+        core.nil? ? config['url'] : "#{config['url']}/#{core}"
+      end
+    
+      def execute(request, core = nil)
+        connection = Solr::Connection.new(url(core), credentials)
+        connection.send request
+      end
     end
   end
 end

data/lib/acts_as_solr/class_methods.rb

@@ -17,7 +17,9 @@ module ActsAsSolr #:nodoc:
     # 
     # ====options:
     # offset:: - The first document to be retrieved (offset)
+    # page:: - The page to be retrieved
     # limit:: - The number of rows per page
+    # per_page:: - Alias for limit
     # order:: - Orders (sort by) the result set using a given criteria:
     #
     #             Book.find_by_solr 'ruby', :order => 'description asc'

data/lib/acts_as_solr/mongo_mapper.rb

@@ -24,4 +24,4 @@ module ActsAsSolr
       end
     end
   end
-end
+end

data/lib/acts_as_solr/parser_methods.rb

@@ -6,7 +6,7 @@ module ActsAsSolr #:nodoc:
     def parse_query(query=nil, options={}, models=nil)
       valid_options = [ :offset, :limit, :facets, :models, :results_format, :order,
                                           :scores, :operator, :include, :lazy, :joins, :select, :core,
-                                          :around, :relevance, :highlight]
+                                          :around, :relevance, :highlight, :page, :per_page]
       query_options = {}
 
       return nil if (query.nil? || query.strip == '')
@@ -14,8 +14,10 @@ module ActsAsSolr #:nodoc:
       raise "Invalid parameters: #{(options.keys - valid_options).join(',')}" unless (options.keys - valid_options).empty?
       begin
         Deprecation.validate_query(options)
-        query_options[:start] = options[:offset]
-        query_options[:rows] = options[:limit]
+        per_page = options[:per_page] || options[:limit] || 30
+        offset = options[:offset] || (((options[:page] || 1).to_i - 1) * per_page) 
+        query_options[:rows] = per_page
+        query_options[:start] = offset
         query_options[:operator] = options[:operator]
 
         query = add_relevance query, options[:relevance]
@@ -121,6 +123,11 @@ module ActsAsSolr #:nodoc:
       }
       results.update(:spellcheck => solr_data.data['spellcheck']) unless solr_data.nil?
       results.update(:facets => {'facet_fields' => []}) if options[:facets]
+      unless solr_data.header['params'].nil?
+        header = solr_data.header
+        results.update :rows => header['params']['rows']
+        results.update :start => header['params']['start']
+      end
       return SearchResults.new(results) if (solr_data.nil? || solr_data.total_hits == 0)
 
       configuration.update(options) if options.is_a?(Hash)

data/lib/acts_as_solr/search_results.rb

@@ -63,10 +63,26 @@ module ActsAsSolr #:nodoc:
         @solr_data[:highlights]
     end
     
+    # Returns a suggested query
     def suggest
       @solr_data[:spellcheck]['suggestions']['collation'].match(/\((.+)\) /)[1]
     end
 
+    # Returns the number of documents per page
+    def per_page
+      @solr_data[:rows].to_i
+    end
+
+    # Returns the number of pages found
+    def total_pages
+      (total / per_page.to_f).ceil
+    end
+
+    # Returns the current page
+    def current_page
+      (@solr_data[:start].to_i / per_page) + 1
+    end
+
     alias docs results
     alias records results
     alias num_found total

data/lib/solr/xml.rb

@@ -18,7 +18,7 @@ begin
   # If we can load rubygems and libxml-ruby...
   require 'rubygems'
   require 'xml/libxml'
-  raise "acts_as_solr requires libxml-ruby 0.7 or greater" unless XML::Node.public_instance_methods.include?("attributes")
+  raise "acts_as_solr requires libxml-ruby 0.7 or greater" unless XML::Node.public_instance_methods.collect{|x| x.to_sym}.include?(:attributes)
 
   # then make a few modifications to XML::Node so it can stand in for REXML::Element
   class XML::Node
@@ -41,4 +41,4 @@ rescue LoadError => e # If we can't load either rubygems or libxml-ruby
   require 'rexml/document'
   Solr::XML::Element = REXML::Element
   
-end
+end

data/test/functional/acts_as_solr_test.rb

@@ -470,4 +470,32 @@ class ActsAsSolrTest < Test::Unit::TestCase
     Document.new(:name => "mapper").save
     assert_equal "mapper", Document.search("mapper").docs.first.name
   end
+
+  def test_total_pages_is_returned_when_limit_specified
+    assert_equal 2, Posting.search("test", :limit => 1).total_pages
+  end
+
+  def test_total_pages_is_returned_when_limit_not_specified
+    assert_equal 1, Posting.search("test").total_pages
+  end
+
+  def test_current_page_is_returned
+    assert_equal 2, Posting.search("test", :limit => 1, :offset => 1).current_page
+  end
+
+  def test_current_page_1_is_returned
+    assert_equal 1, Posting.search("test").current_page
+  end
+
+  def test_current_page_1_is_returned_when_no_records_found
+    assert_equal 1, Posting.search("nothing").current_page
+  end
+
+  def test_page_parameter_is_accepted
+    assert_equal 2, Posting.search("test", :limit => 1, :page => 2).current_page
+  end
+
+  def test_per_page_parameter_is_accepted
+    assert_equal 1, Posting.search("test", :per_page => 1).per_page
+  end
 end

data/test/test_helper.rb

@@ -58,3 +58,13 @@ class Test::Unit::TestCase
     ActsAsSolr::Post.execute(Solr::Request::Delete.new(:query => "type_s:#{table_name.to_s.capitalize.singularize}"))
   end
 end
+
+class Rails
+  def self.root
+    RAILS_ROOT
+  end
+
+  def self.env
+    RAILS_ENV
+  end
+end

data/test/unit/parser_methods_shoulda.rb

@@ -15,6 +15,7 @@ class ParserMethodsTest < Test::Unit::TestCase
         @results.stubs(:max_score).returns 2.1
         @results.stubs(:highlighting).returns []
         @results.stubs(:data).returns({"responseHeader" => {"QTime" => "10.2"}})
+        @results.stubs(:header).returns({})
       end
 
       should "return a SearchResults object" do

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_solr_reloaded
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
   - 1
-  - 5
+  - 6
   - 0
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors: 
 - Diego Carrion
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-19 00:00:00 -03:00
+date: 2011-03-20 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -161,28 +162,32 @@ homepage: http://github.com/dcrec1/acts_as_solr_reloaded
 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"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: This gem adds full text search capabilities and many other nifty features from Apache Solr to any Rails model.