solr_collection 0.1.2

data/README.markdown

@@ -0,0 +1,29 @@
+SolrCollection is a wrapper for acts_as_solr results sets that behaves/feels like will_paginate collection
+
+ - no need to separate results from facets / spellcheck information
+ - all pages can use the same pagination helpers
+ - simple to mock an empty result when solr is down or throws errors
+
+Usage
+=====
+ - As Rails plugin  `  script/plugin install git://github.com/grosser/solr_collection.git  `
+ - As gem `  sudo gem install solr_collection  `
+
+Example:
+    options = {:limit=>10, :offset=>100, :facets=>{....}, .... }
+    results = MyModel.find_by_solr("abc", options) rescue []
+    results = SolrCollection.new(results, options)
+
+    do_something if results.facets
+    something_else if results.total_entries > results.size #more pages ?
+    will_paginate(results)
+
+Other features:
+    #facet fields can be nil or [] or {} -> use has_facet_fields? to check
+    puts results.facets['facet_fields']['categories'] if results.has_facet_fields?
+
+Author
+======
+[Michael Grosser](http://pragmatig.wordpress.com)  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/Rakefile

@@ -0,0 +1,20 @@
+task :default => :spec
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new {|t| t.spec_opts = ['--color']}
+
+begin
+  project_name = 'solr_collection'
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = project_name
+    gem.summary = "Wrapper for solr results sets then behaves/feels like will_paginate collection"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{project_name}"
+    gem.authors = ["Michael Grosser"]
+    gem.add_dependency "will_paginate"
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/init.rb

@@ -0,0 +1,2 @@
+#This file is only needed when used as Rails plugin
+require 'solr_collection'

data/lib/solr_collection.rb

@@ -0,0 +1,74 @@
+require 'will_paginate/collection'
+
+#Proxy that delegates all calls to contained subject
+# except solr related methods in MAPPED_FIELDS
+class SolrCollection
+  MAPPED_FIELDS = [:facets, :spellcheck, {:total=>:total_entries}]
+
+  def initialize(solr_result, options={})
+    options = options.dup
+
+    #solr result has results in an array called results
+    results = if solr_result.respond_to?(:results)
+      solr_result.results
+    else
+      solr_result
+    end
+
+    #get fields from solr_result or set them to nil
+    @solr_data = {}
+    MAPPED_FIELDS.each do |fields|
+      if fields.is_a? Hash
+        solr_field = fields.keys.first
+        collection_field = fields.values.first
+      else
+        solr_field = collection_field = fields
+      end
+
+      @solr_data[collection_field] = if solr_result.respond_to?(solr_field)
+        solr_result.send(solr_field)
+      else
+        nil
+      end
+    end
+    @solr_data[:total_entries] ||= options[:total_entries] || results.size
+
+    #build will_paginate collection from given options
+    options = fill_page_and_per_page(options)
+
+    @subject = WillPaginate::Collection.new(
+      options[:page],
+      options[:per_page],
+      @solr_data[:total_entries]
+    )
+    @subject.replace(results)
+  end
+
+  def has_facet_fields?
+    # can be a array, when empty reults where returned
+    !!(facets and facets['facet_fields'] and not facets['facet_fields'].empty?)
+  end
+
+  private
+
+  def fill_page_and_per_page(options)
+    options[:per_page] ||= options[:limit] || 10
+    if options[:page].to_s.empty?
+      options[:page] = if options[:offset]
+        (options[:offset] / options[:per_page]) + 1
+      else
+        1
+      end
+    end
+    options
+  end
+  
+  def method_missing(method, *args, &block)
+    method = method.to_sym
+    if @solr_data.key? method
+      @solr_data[method]
+    else
+      @subject.send(method, *args, &block)
+    end
+  end
+end

data/solr_collection.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{solr_collection}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2009-11-22}
+  s.email = %q{grosser.michael@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/solr_collection.rb",
+     "solr_collection.gemspec",
+     "spec/solr_collection_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/grosser/solr_collection}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Wrapper for solr results sets then behaves/feels like will_paginate collection}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/solr_collection_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<will_paginate>, [">= 0"])
+    else
+      s.add_dependency(%q<will_paginate>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<will_paginate>, [">= 0"])
+  end
+end
+

data/spec/solr_collection_spec.rb

@@ -0,0 +1,115 @@
+require 'spec/spec_helper'
+
+describe SolrCollection do
+  it "behaves like an array" do
+    s = SolrCollection.new([1,2,3])
+    s.size.should == 3
+    s[1].should == 2
+  end
+
+  it "behaves like a will_paginate collection" do
+    s = SolrCollection.new([1,2,3], :page=>1, :per_page=>2, :total_entries=>20)
+    s.total_pages.should == 10
+  end
+  
+  it "does not modify options" do
+    a = {:per_page=>2, :offset=>2}
+    SolrCollection.new([1], a).current_page.should == 2
+    a.should == {:per_page=>2, :offset=>2}
+  end
+
+  describe "pages" do
+    it "does not know page" do
+      lambda{ SolrCollection.new([1,2,3]).page }.should raise_error
+    end
+
+    it "knows current_page" do
+      SolrCollection.new([1,2,3]).current_page.should == 1
+    end
+
+    it "knows per_page" do
+      SolrCollection.new([1,2,3]).per_page.should == 10
+    end
+
+     it "can set page" do
+      SolrCollection.new([1,2,3], :page=>3).current_page.should == 3
+    end
+
+    it "can set per_page" do
+      SolrCollection.new([1,2,3], :per_page=>3).per_page.should == 3
+    end
+  end
+
+  describe "limit and offset" do
+    it "uses per_page when per_page and limit are given" do
+      SolrCollection.new([1], :per_page=>2, :limit=>20, :offset=>10).current_page.should == 6
+    end
+
+    it "understands limit/offset" do
+      SolrCollection.new([1], :limit=>2, :offset=>10).current_page.should == 6
+    end
+
+    it "understands per_page/offset" do
+      SolrCollection.new([1], :per_page=>2, :offset=>2).current_page.should == 2
+    end
+  end
+
+  describe "solr fields" do
+    it "knows factes" do
+      SolrCollection.new([]).facets.should == nil
+    end
+
+    it "knows spellcheck" do
+      SolrCollection.new([]).spellcheck.should == nil
+    end
+
+    it "does not know non-solr-method" do
+      lambda{ SolrCollection.new([]).fooo }.should raise_error
+    end
+
+    it "uses results as subject" do
+      a = []
+      def a.results; [1,2,3];end
+      SolrCollection.new(a)[2].should == 3
+    end
+
+    it "knows total_entries" do
+      SolrCollection.new([1,2,3]).total_entries.should == 3
+    end
+
+    it "can get total_entries from an array" do
+      a = [1,2,3]
+      SolrCollection.new(a, :per_page=>2).total_pages.should == 2
+    end
+
+    it "can get total_entries from a solr resultset" do
+      a = []
+      def a.total; 22;end
+      SolrCollection.new(a).total_entries.should == 22
+    end
+
+    it "does not overwrite total from solr resultset with given total_entries" do
+      a = []
+      def a.total; 22;end
+      SolrCollection.new(a, :total_entries=>33).total_entries.should == 22
+    end
+  end
+
+  describe :has_facet_fields do
+    it "is false when facets are nil" do
+      SolrCollection.new([]).has_facet_fields?.should == false
+    end
+
+    it "is false when facet_fieldss are an empty array" do
+      a = []
+      def a.facets; {'facet_fields'=>[]}; end
+      SolrCollection.new(a).has_facet_fields?.should == false
+    end
+
+    it "is true when it is a filled hash" do
+      a = []
+      def a.facets; {'facet_fields'=>{'x'=>'y'}}; end
+      SolrCollection.new(a).has_facet_fields?.should == true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# ---- requirements
+require 'rubygems'
+$LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
+require File.expand_path("../init", File.dirname(__FILE__))

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: solr_collection
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: will_paginate
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- lib/solr_collection.rb
+- solr_collection.gemspec
+- spec/solr_collection_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/grosser/solr_collection
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Wrapper for solr results sets then behaves/feels like will_paginate collection
+test_files: 
+- spec/spec_helper.rb
+- spec/solr_collection_spec.rb