elastic_searchable 1.1.4 → 1.2.0

data/.rvmrc

@@ -1,4 +1 @@
-rvm use ree-1.8.7-2011.03@rails3
-
-# use rails2 gemset for testing as well
-#ree-1.8.7-2011.03@rails2
+rvm use ree-1.8.7-2011.03@elastic_searchable --create

data/README.md

@@ -33,6 +33,10 @@ gem 'elastic_searchable'
 # (optional) customize elasticsearch host
 # default is localhost:9200
 ElasticSearchable.base_uri = 'server:9200'
+
+# (optional) customize elasticsearch paginator
+# default is ElasticSearchable::Pagination::WillPaginate
+ElasticSearchable::Paginator.handler = ElasticSearchable::Pagination::Kaminari
 ```
 
 ## Contributing

data/elastic_searchable.gemspec

@@ -8,22 +8,21 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Ryan Sonnek"]
   s.email       = ["ryan@codecrate.com"]
-  s.homepage    = %q{http://github.com/wireframe/elastic_searchable}
+  s.homepage    = %q{http://github.com/socialcast/elastic_searchable}
   s.summary     = %q{elastic search for activerecord}
   s.description = %q{integrate the elastic search engine with rails}
 
   s.rubyforge_project = "elastic_searchable"
-  
+
   s.add_runtime_dependency(%q<activerecord>, [">= 3.0.5"])
-  s.add_runtime_dependency(%q<will_paginate>, [">= 3.0.pre2"])
   s.add_runtime_dependency(%q<httparty>, ["~> 0.6.0"])
   s.add_runtime_dependency(%q<backgrounded>, ["~> 0.7.0"])
+  s.add_runtime_dependency(%q<multi_json>, ["~> 1.0.0"])
+  s.add_development_dependency(%q<rake>, ["0.9.2"])
+  s.add_development_dependency(%q<sqlite3-ruby>, ["~> 1.3.2"])
+  s.add_development_dependency(%q<pry>, ["0.9.6.2"])
   s.add_development_dependency(%q<shoulda>, [">= 0"])
   s.add_development_dependency(%q<mocha>, [">= 0"])
-  s.add_development_dependency(%q<bundler>, [">= 0"])
-  s.add_development_dependency(%q<rcov>, [">= 0"])
-  s.add_development_dependency(%q<sqlite3-ruby>, ["~> 1.3.2"])
-  s.add_development_dependency(%q<ruby-debug>, [">= 0"])
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/elastic_searchable.rb

@@ -1,4 +1,5 @@
 require 'httparty'
+require 'multi_json'
 require 'logger'
 require 'elastic_searchable/active_record_extensions'
 
@@ -25,7 +26,7 @@ module ElasticSearchable
     # encapsulate encoding hash into json string
     # support Yajl encoder if installed
     def encode_json(options = {})
-      defined?(Yajl) ? Yajl::Encoder.encode(options) : ActiveSupport::JSON.encode(options)
+      MultiJson.encode options
     end
     # perform a request to the elasticsearch server
     # configuration:
@@ -33,7 +34,7 @@ module ElasticSearchable
     # ElasticSearchable.debug_output outputs all http traffic to console
     def request(method, url, options = {})
       options.merge! :headers => {'Content-Type' => 'application/json'}
-      options.merge! :body => ElasticSearchable.encode_json(options[:json_body]) if options[:json_body]
+      options.merge! :body => ElasticSearchable.encode_json(options.delete(:json_body)) if options[:json_body]
 
       response = self.send(method, url, options)
       logger.debug "elasticsearch request: #{method} #{url} #{"took #{response['took']}ms" if response['took']}"

data/lib/elastic_searchable/active_record_extensions.rb

@@ -3,6 +3,7 @@ require 'backgrounded'
 require 'elastic_searchable/queries'
 require 'elastic_searchable/callbacks'
 require 'elastic_searchable/index'
+require 'elastic_searchable/paginator'
 
 module ElasticSearchable
   module ActiveRecordExtensions
@@ -11,7 +12,7 @@ module ElasticSearchable
     # :type (optional) configue type to store data in.  default to model table name
     # :index_options (optional) configure index properties (ex: tokenizer)
     # :mapping (optional) configure field properties for this model (ex: skip analyzer for field)
-    # :if (optional) reference symbol/proc condition to only index when condition is true 
+    # :if (optional) reference symbol/proc condition to only index when condition is true
     # :unless (optional) reference symbol/proc condition to skip indexing when condition is true
     # :json (optional) configure the json document to be indexed (see http://api.rubyonrails.org/classes/ActiveModel/Serializers/JSON.html#method-i-as_json for available options)
     #

data/lib/elastic_searchable/index.rb

@@ -1,5 +1,3 @@
-require 'will_paginate'
-
 module ElasticSearchable
   module Indexing
     module ClassMethods
@@ -68,13 +66,13 @@ module ElasticSearchable
       # TODO: move this to AREL relation to remove the options scope param
       def reindex(options = {})
         self.update_index_mapping
-        options.reverse_merge! :page => 1, :per_page => 1000, :total_entries => 1
+        options.reverse_merge! :page => 1, :per_page => 1000
         scope = options.delete(:scope) || self
-
-        records = scope.paginate(options)
+        page = options[:page]
+        per_page = options[:per_page]
+        records = scope.limit(per_page).offset(per_page * (page -1)).all
         while records.any? do
-          ElasticSearchable.logger.debug "reindexing batch ##{records.current_page}..."
-
+          ElasticSearchable.logger.debug "reindexing batch ##{page}..."
           actions = []
           records.each do |record|
             next unless record.should_index?
@@ -89,12 +87,12 @@ module ElasticSearchable
           begin
             ElasticSearchable.request(:put, '/_bulk', :body => "\n#{actions.join("\n")}\n") if actions.any?
           rescue ElasticError => e
-            ElasticSearchable.logger.warn "Error indexing batch ##{options[:page]}: #{e.message}"
+            ElasticSearchable.logger.warn "Error indexing batch ##{page}: #{e.message}"
             ElasticSearchable.logger.warn e
           end
 
-          options.merge! :page => (records.current_page + 1)
-          records = scope.paginate(options)
+          page += 1
+          records = scope.limit(per_page).offset(per_page* (page-1)).all
         end
       end
 
@@ -109,7 +107,7 @@ module ElasticSearchable
 
     module InstanceMethods
       # reindex the object in elasticsearch
-      # fires after_index callbacks after operation is complete 
+      # fires after_index callbacks after operation is complete
       # see http://www.elasticsearch.org/guide/reference/api/index_.html
       def reindex(lifecycle = nil)
         query = {}

data/lib/elastic_searchable/pagination/kaminari.rb

@@ -0,0 +1,37 @@
+module ElasticSearchable
+  module Pagination
+    class Kaminari < ::ElasticSearchable::Paginator
+      attr_accessor :page, :limit_value, :total_entries, :total_pages
+
+      def initialize(results, page, per_page, total = nil)
+        self.page          = page
+        self.limit_value   = per_page
+        self.total_entries = total if total
+        self.replace results
+      end
+
+      alias :current_page :page
+      alias :per_page     :limit_value
+
+      # total item numbers of the original array
+      def total_count
+        total_entries
+      end
+
+      # Total number of pages
+      def num_pages
+        (total_count.to_f / per_page).ceil
+      end
+
+      # First page of the collection ?
+      def first_page?
+        current_page == 1
+      end
+
+      # Last page of the collection?
+      def last_page?
+        current_page >= num_pages
+      end
+    end
+  end
+end

data/lib/elastic_searchable/pagination/will_paginate.rb

@@ -0,0 +1,44 @@
+module ElasticSearchable
+  module Pagination
+    class WillPaginate < ::ElasticSearchable::Paginator
+      attr_reader :current_page, :per_page, :total_entries, :total_pages
+
+      def initialize(results, page, per_page, total = nil)
+        @current_page = page.to_i
+        raise InvalidPage.new(page, @current_page) if @current_page < 1
+        @per_page = per_page.to_i
+        raise ArgumentError, "`per_page` setting cannot be less than 1 (#{@per_page} given)" if @per_page < 1
+
+        self.total_entries = total if total
+        self.replace results
+      end
+
+      def self.create(page, per_page, total = nil)
+        pager = new(page, per_page, total)
+        yield pager
+        pager
+      end
+
+      def out_of_bounds?
+        current_page > total_pages
+      end
+
+      def offset
+        (current_page - 1) * per_page
+      end
+
+      def previous_page
+        current_page > 1 ? (current_page - 1) : nil
+      end
+
+      def next_page
+        current_page < total_pages ? (current_page + 1) : nil
+      end
+
+      def total_entries=(number)
+        @total_entries = number.to_i
+        @total_pages   = (@total_entries / per_page.to_f).ceil
+      end
+    end
+  end
+end

data/lib/elastic_searchable/paginator.rb

@@ -0,0 +1,41 @@
+
+module ElasticSearchable
+  class Paginator < Array
+    class << self
+      def handler
+        @handler ||= ElasticSearchable::Pagination::WillPaginate
+      end
+
+      def handler=(handler)
+        @handler = handler
+      end
+    end
+
+    # This is a magic wrapper for the original Array#replace method. It serves
+    # for populating the paginated collection after initialization.
+    #
+    # Why magic? Because it tries to guess the total number of entries judging
+    # by the size of given array. If it is shorter than +per_page+ limit, then we
+    # know we're on the last page. This trick is very useful for avoiding
+    # unnecessary hits to the database to do the counting after we fetched the
+    # data for the current page.
+    #
+    # However, after using +replace+ you should always test the value of
+    # +total_entries+ and set it to a proper value if it's +nil+. See the example
+    # in +create+.
+    def replace(array)
+      result = super
+
+      # The collection is shorter then page limit? Rejoice, because
+      # then we know that we are on the last page!
+      if total_entries.nil? and length < per_page and (current_page == 1 or length > 0)
+        self.total_entries = offset + length
+      end
+
+      result
+    end
+  end
+end
+
+require 'elastic_searchable/pagination/kaminari'
+require 'elastic_searchable/pagination/will_paginate'

data/lib/elastic_searchable/queries.rb

@@ -1,9 +1,11 @@
-require 'will_paginate/collection'
-
 module ElasticSearchable
   module Queries
     PER_PAGE_DEFAULT = 20
 
+    def per_page
+      PER_PAGE_DEFAULT
+    end
+
     # search returns a will_paginate collection of ActiveRecord objects for the search results
     # supported options:
     # :page - page of results to search for
@@ -38,9 +40,7 @@ module ElasticSearchable
       ids = hits['hits'].collect {|h| h['_id'].to_i }
       results = self.find(ids).sort_by {|result| ids.index(result.id) }
 
-      page = WillPaginate::Collection.new(page, options[:size], hits['total'])
-      page.replace results
-      page
+      ElasticSearchable::Paginator.handler.new(results, page, options[:size], hits['total'])
     end
 
     private

data/lib/elastic_searchable/version.rb

@@ -1,4 +1,4 @@
 module ElasticSearchable
-  VERSION = '1.1.4'
+  VERSION = '1.2.0'
 end
 

data/test/helper.rb

@@ -10,7 +10,7 @@ end
 require 'test/unit'
 require 'shoulda'
 require 'mocha'
-require 'ruby-debug'
+require 'pry'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/setup_database.rb

@@ -37,12 +37,3 @@ ActiveRecord::Schema.define(:version => 1) do
     t.belongs_to :parent
   end
 end
-
-if WillPaginate.respond_to?(:enable_activerecord)
-  puts 'configuring will_paginate v2.x'
-  WillPaginate.enable_activerecord
-else
-  puts 'configuring will_paginate v3.x'
-  require 'will_paginate/finders/active_record'
-  WillPaginate::Finders::ActiveRecord.enable!
-end

data/test/test_elastic_searchable.rb

@@ -4,7 +4,7 @@ class TestElasticSearchable < Test::Unit::TestCase
   def setup
     delete_index
   end
-  ElasticSearchable.debug_output
+  # ElasticSearchable.debug_output
   SINGLE_NODE_CLUSTER_CONFIG = {'number_of_replicas' => 0, 'number_of_shards' => 1}
 
   context 'non elastic activerecord class' do
@@ -194,7 +194,7 @@ class TestElasticSearchable < Test::Unit::TestCase
         assert_nil @results.next_page
       end
     end
-    
+
     context 'searching for results using a query Hash' do
       setup do
         @results = Post.search({
@@ -244,7 +244,7 @@ class TestElasticSearchable < Test::Unit::TestCase
         assert_equal @first_post, @results.last
       end
     end
-    
+
     context 'advanced sort options' do
       setup do
         @results = Post.search 'foo', :sort => [{:id => 'desc'}]
@@ -294,7 +294,7 @@ class TestElasticSearchable < Test::Unit::TestCase
       'number_of_shards' => 1,
       "analysis.analyzer.default.tokenizer" => 'standard',
       "analysis.analyzer.default.filter" => ["standard", "lowercase", 'porterStem']},
-    :mapping => {:properties => {:name => {:type => :string, :index => :not_analyzed}}}
+    :mapping => {:properties => {:name => {:type => 'string', :index => 'not_analyzed'}}}
   end
   context 'activerecord class with :index_options and :mapping' do
     context 'creating index' do
@@ -302,7 +302,7 @@ class TestElasticSearchable < Test::Unit::TestCase
         User.create_index
       end
       should 'have used custom index_options' do
-        @status = ElasticSearchable.request :get, '/elastic_searchable/_status'
+        @status = ElasticSearchable.request :get, '/elastic_searchable/_settings'
         expected = {
           "index.number_of_replicas" => "0",
           "index.number_of_shards" => "1",
@@ -311,18 +311,16 @@ class TestElasticSearchable < Test::Unit::TestCase
           "index.analysis.analyzer.default.filter.1" => "lowercase",
           "index.analysis.analyzer.default.filter.2" => "porterStem"
         }
-        assert_equal expected, @status['indices']['elastic_searchable']['settings'], @status.inspect
+        assert_equal expected, @status['elastic_searchable']['settings'], @status.inspect
       end
       should 'have set mapping' do
         @status = ElasticSearchable.request :get, '/elastic_searchable/users/_mapping'
         expected = {
-          "users"=> {
-            "properties"=> {
-              "name"=> {"type"=>"string", "index"=>"not_analyzed"}
-            }
+          "properties"=> {
+            "name"=> {"type"=>"string", "index"=>"not_analyzed"}
           }
         }
-        assert_equal expected, @status['elastic_searchable'], @status.inspect
+        assert_equal expected, @status['users'], @status.inspect
       end
     end
   end
@@ -427,8 +425,25 @@ class TestElasticSearchable < Test::Unit::TestCase
       @second = MaxPageSizeClass.create! :name => 'foo two'
       MaxPageSizeClass.refresh_index
     end
-    context 'MaxPageSizeClass.search with default options' do
+    context 'MaxPageSizeClass.search with default options and WillPaginate' do
+      setup do
+        ElasticSearchable::Paginator.handler = ElasticSearchable::Pagination::WillPaginate
+        @results = MaxPageSizeClass.search 'foo'
+      end
+      should 'have one per page' do
+        assert_equal 1, @results.per_page
+      end
+      should 'return one instance' do
+        assert_equal 1, @results.length
+      end
+      should 'have second page' do
+        assert_equal 2, @results.total_entries
+      end
+    end
+
+    context 'MaxPageSizeClass.search with default options and Kaminari' do
       setup do
+        ElasticSearchable::Paginator.handler = ElasticSearchable::Pagination::Kaminari
         @results = MaxPageSizeClass.search 'foo'
       end
       should 'have one per page' do
@@ -440,6 +455,9 @@ class TestElasticSearchable < Test::Unit::TestCase
       should 'have second page' do
         assert_equal 2, @results.total_entries
       end
+      should 'have a total of 2 pages' do
+        assert_equal 2, @results.num_pages
+      end
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: elastic_searchable
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 31
   prerelease: 
   segments: 
   - 1
-  - 1
-  - 4
-  version: 1.1.4
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Ryan Sonnek
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-04 00:00:00 Z
+date: 2011-10-20 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -34,98 +35,104 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: will_paginate
+  name: httparty
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1923831917
+        hash: 7
         segments: 
-        - 3
         - 0
-        - pre
-        - 2
-        version: 3.0.pre2
+        - 6
+        - 0
+        version: 0.6.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: httparty
+  name: backgrounded
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
         - 0
-        - 6
+        - 7
         - 0
-        version: 0.6.0
+        version: 0.7.0
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: backgrounded
+  name: multi_json
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 23
         segments: 
+        - 1
         - 0
-        - 7
         - 0
-        version: 0.7.0
+        version: 1.0.0
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: rake
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 63
         segments: 
         - 0
-        version: "0"
+        - 9
+        - 2
+        version: 0.9.2
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: mocha
+  name: sqlite3-ruby
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 31
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 3
+        - 2
+        version: 1.3.2
   type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: pry
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 27
         segments: 
         - 0
-        version: "0"
+        - 9
+        - 6
+        - 2
+        version: 0.9.6.2
   type: :development
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: rcov
+  name: shoulda
   prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
@@ -139,25 +146,9 @@ dependencies:
   type: :development
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  name: sqlite3-ruby
+  name: mocha
   prerelease: false
   requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 3
-        - 2
-        version: 1.3.2
-  type: :development
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: ruby-debug
-  prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -167,7 +158,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id010
+  version_requirements: *id009
 description: integrate the elastic search engine with rails
 email: 
 - ryan@codecrate.com
@@ -191,13 +182,17 @@ files:
 - lib/elastic_searchable/active_record_extensions.rb
 - lib/elastic_searchable/callbacks.rb
 - lib/elastic_searchable/index.rb
+- lib/elastic_searchable/pagination/kaminari.rb
+- lib/elastic_searchable/pagination/will_paginate.rb
+- lib/elastic_searchable/paginator.rb
 - lib/elastic_searchable/queries.rb
 - lib/elastic_searchable/version.rb
 - test/database.yml
 - test/helper.rb
 - test/setup_database.rb
 - test/test_elastic_searchable.rb
-homepage: http://github.com/wireframe/elastic_searchable
+has_rdoc: true
+homepage: http://github.com/socialcast/elastic_searchable
 licenses: []
 
 post_install_message: 
@@ -226,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: elastic_searchable
-rubygems_version: 1.7.2
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: elastic search for activerecord