sunspot_kaminari_support 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sunspot_kaminari_support.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrey Rozhkovsky
+
+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/README.md

@@ -0,0 +1,37 @@
+# SunspotKaminariSupport
+
+Add methods required for Kaminari helper methods (ex:
+helper.paginate(result))
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sunspot_kaminari_support'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sunspot_kaminari_support
+
+## Usage
+
+Gem includes module with helper method into Sunspot::Search::AbstractSearch.
+So now you are able to use solr results in kaminari helpers:
+
+    @result = Post.solr_search{}
+    paginate(@result)          # This would output several pagination links such as « First ‹ Prev ... 2 3 4 5 6 7 8 9 10 ... Next › Last »
+    page_entries_info(@result) # This renders a helpful message with numbers of displayed vs. total entries.
+
+See [kaminari](https://github.com/amatsuda/kaminari) page for detailed explanation of these helpers usage
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sunspot_kaminari_support.rb

@@ -0,0 +1,80 @@
+require "sunspot_kaminari_support/version"
+
+module SunspotKaminariSupport
+  # Returns:
+  #   => Current page number
+  #
+  def current_page
+    query.page
+  end
+
+  # Returns:
+  #   => Total number of pages
+  #
+  def total_pages
+    (total.to_f / query.per_page).ceil
+  end
+
+  # Returns:
+  #    => Number of records displayed per page
+  #
+  def limit_value
+    query.per_page || Kaminari.config.default_per_page
+  end
+
+
+  # Returns:
+  #    => true if result is blank
+  #
+  def empty?
+    total == 0
+  end
+
+  # Returns:
+  #    => true if there are any results
+  def any?
+    total > 0
+  end
+
+  # Changes page query param
+  def page(new_page)
+    query.paginate(new_page, nil)
+    self
+  end
+
+  # Returns:
+  #   => true if current_page is last or bigger
+  def last_page?
+    current_page >= total_pages
+  end
+
+  # Returns:
+  #   => true if current_page equals 1
+  def first_page?
+    current_page == 1
+  end
+
+  # Methods for page_entries_info helper
+  #
+
+  # Returns:
+  #   => Total number of records before current page
+  #
+  def offset_value
+    query.per_page * (query.page - 1)
+  end
+
+
+  # Returns:
+  #   => Total number of records found
+  #
+  def total_count
+    total
+  end
+end
+
+if defined?(Sunspot)
+  Sunspot::Search::AbstractSearch.send(:include, SunspotKaminariSupport)
+else
+  puts "[SunspotKaminariSupport] WARNING: Sunspot not found"
+end

data/lib/sunspot_kaminari_support/version.rb

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

data/spec/lib/sunspot_kaminari_support_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+describe SunspotKaminariSupport do
+  subject {SunspotStub.new(:query => query, :total => total)}
+  let(:query) {double('query')}
+  let(:total) {nil}
+  it "#current_page delegates to query" do
+    query.should_receive :page
+    subject.current_page
+  end
+  context "#total_pages" do
+    it "uses query.per_page" do
+      query.should_receive(:per_page).and_return(3)
+      subject.total_pages
+    end
+    it "returns correct number" do
+      query.stub(:per_page => 3)
+      expect(subject.total_pages).to eq(2)
+    end
+  end
+  context '#limit_value' do
+    it "returns per_page" do
+      query.should_receive(:per_page).and_return(3)
+      expect(subject.limit_value).to eq(3)
+    end
+  end
+  context '#empty?' do
+    it "returns true when total eq 0" do
+      subject.stub(:total => 0)
+      expect(subject.empty?).to be_true
+    end
+    it "returns false when total > 0" do
+      subject.stub(:total => 1)
+      expect(subject.empty?).to be_false
+    end
+  end
+
+  context '#any?' do
+    it "returns false when total eq 0" do
+      subject.stub(:total => 0)
+      expect(subject.any?).to be_false
+    end
+    it "returns true when total > 0" do
+      subject.stub(:total => 1)
+      expect(subject.any?).to be_true
+    end
+  end
+
+  context '#last_page?' do
+    it "returns true when current_page is last" do
+      subject.stub(:total_pages => 1)
+      query.stub(:page => 1)
+      expect(subject.last_page?).to be_true
+    end
+    it "returns false when current page isn't last" do
+      subject.stub(:total_pages => 2)
+      query.stub(:page => 1)
+      expect(subject.last_page?).to be_false
+    end
+  end
+
+  context '#offset_value' do
+    it "returns numbre of records before current page" do
+      query.stub(:per_page => 3, :page => 2)
+      expect(subject.offset_value).to eq(3)
+    end
+  end
+
+  context '#total_count' do
+    it "returns total" do
+      subject.should_receive(:total).and_return(6)
+      expect(subject.total_count).to eq 6
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require "pry"
+require File.expand_path('../../lib/sunspot_kaminari_support', __FILE__)
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+class SunspotStub
+  include SunspotKaminariSupport
+  attr_reader :query, :total
+  def initialize(options = {})
+    @query = options[:query]
+    @total = options[:total] || 5
+  end
+end

data/sunspot_kaminari_support.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sunspot_kaminari_support/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sunspot_kaminari_support"
+  gem.version       = SunspotKaminariSupport::VERSION
+  gem.authors       = ["Andrey Rozhkovsky"]
+  gem.email         = ["a.rozhkovsky@kandasoft.com"]
+  gem.description   = %q{Adds methods required for kaminari helpers in views to sunspot result}
+  gem.summary       = %q{Includes module with methods required for kaminari helpers in views to sunspot result}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "pry"
+  gem.add_runtime_dependency 'sunspot'
+  gem.add_runtime_dependency 'sunspot_rails'
+  gem.add_runtime_dependency 'kaminari', '>= 0.14.0'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: sunspot_kaminari_support
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrey Rozhkovsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pry
+  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
+  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'
+- !ruby/object:Gem::Dependency
+  name: sunspot_rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Adds methods required for kaminari helpers in views to sunspot result
+email:
+- a.rozhkovsky@kandasoft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sunspot_kaminari_support.rb
+- lib/sunspot_kaminari_support/version.rb
+- spec/lib/sunspot_kaminari_support_spec.rb
+- spec/spec_helper.rb
+- sunspot_kaminari_support.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.25
+signing_key: 
+specification_version: 3
+summary: Includes module with methods required for kaminari helpers in views to sunspot
+  result
+test_files:
+- spec/lib/sunspot_kaminari_support_spec.rb
+- spec/spec_helper.rb