solr_collection 0.1.2 → 0.1.3

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'rake'
+gem 'rspec', '~>2'
+gem 'jeweler'
+gem 'will_paginate'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    rake (0.8.7)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    will_paginate (2.3.14)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rake
+  rspec (~> 2)
+  will_paginate

data/Rakefile

@@ -1,15 +1,16 @@
 task :default => :spec
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new {|t| t.spec_opts = ['--color']}
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--backtrace --color'
+end
 
 begin
-  project_name = 'solr_collection'
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
-    gem.name = project_name
+    gem.name = 'solr_collection'
     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.homepage = "http://github.com/grosser/#{gem.name}"
     gem.authors = ["Michael Grosser"]
     gem.add_dependency "will_paginate"
   end

data/Readme.md

@@ -0,0 +1,27 @@
+ - Wrap acts_as_solr results to behave like WillPaginate (use same helpers!)  
+ - Make arrays behave like solr results (e.g. mock an empty result when solr is down or throws errors)
+
+Usage
+=====
+ - As Rails plugin  `  rails 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.slice(:limit, :offset))
+
+    do_something if results.facets
+    do_something 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']['category_id_facet'] if results.has_facet_fields?
+    puts results.facet_field('category_id_facet')
+
+Author
+======
+[Michael Grosser](http://grosser.it)  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/solr_collection.rb

@@ -3,7 +3,7 @@ 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}]
+  MAPPED_FIELDS = [:facets, :spellcheck, :total_entries]
 
   def initialize(solr_result, options={})
     options = options.dup
@@ -17,21 +17,18 @@ class SolrCollection
 
     #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)
+    MAPPED_FIELDS.each do |field|
+      @solr_data[field] = if options[field]
+        options[field]
+      elsif solr_result.respond_to?(field)
+        solr_result.send(field)
       else
         nil
       end
     end
-    @solr_data[:total_entries] ||= options[:total_entries] || results.size
+
+    # always set a total
+    @solr_data[:total_entries] ||= (results.respond_to?(:total) ? results.total : results.size)
 
     #build will_paginate collection from given options
     options = fill_page_and_per_page(options)
@@ -41,7 +38,7 @@ class SolrCollection
       options[:per_page],
       @solr_data[:total_entries]
     )
-    @subject.replace(results)
+    @subject.replace(results.to_ary)
   end
 
   def has_facet_fields?
@@ -49,6 +46,12 @@ class SolrCollection
     !!(facets and facets['facet_fields'] and not facets['facet_fields'].empty?)
   end
 
+  def facet_field(field)
+    if has_facet_fields? and value = facets['facet_fields'][field]
+      value.empty? ? nil : value
+    end
+  end
+
   private
 
   def fill_page_and_per_page(options)

data/solr_collection.gemspec

@@ -5,18 +5,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{solr_collection}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   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.date = %q{2010-12-08}
   s.email = %q{grosser.michael@gmail.com}
-  s.extra_rdoc_files = [
-    "README.markdown"
-  ]
   s.files = [
-    "README.markdown",
+    "Gemfile",
+     "Gemfile.lock",
      "Rakefile",
+     "Readme.md",
      "VERSION",
      "init.rb",
      "lib/solr_collection.rb",
@@ -27,11 +26,11 @@ Gem::Specification.new do |s|
   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.rubygems_version = %q{1.3.6}
   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"
+    "spec/solr_collection_spec.rb",
+     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/solr_collection_spec.rb

@@ -1,10 +1,15 @@
 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
+  it "behaves like an array when built from solr result" do
+    a = []
+    def a.results; [1, 2, 3];end
+    SolrCollection.new(a)[2].should == 3
+  end
+
+  it "behaves like an array when built from array" do
+    a = [1, 2, 3]
+    SolrCollection.new(a)[2].should == 3
   end
 
   it "behaves like a will_paginate collection" do
@@ -19,22 +24,22 @@ describe SolrCollection do
   end
 
   describe "pages" do
-    it "does not know page" do
-      lambda{ SolrCollection.new([1,2,3]).page }.should raise_error
+    it "does not know non-will-paginate methods" do
+      lambda{ SolrCollection.new([1,2,3], :page => 3).page }.should raise_error
+    end
+
+    it "can set page" do
+      SolrCollection.new([1,2,3], :page=>3).current_page.should == 3
     end
 
     it "knows current_page" do
       SolrCollection.new([1,2,3]).current_page.should == 1
     end
 
-    it "knows per_page" do
+    it "knows default 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
@@ -54,44 +59,57 @@ describe SolrCollection do
     end
   end
 
-  describe "solr fields" do
+  describe "facets" do
     it "knows factes" do
       SolrCollection.new([]).facets.should == nil
     end
 
-    it "knows spellcheck" do
-      SolrCollection.new([]).spellcheck.should == nil
+    it "can set facets via options" do
+      SolrCollection.new([], :facets => [1]).facets.should == [1]
     end
 
-    it "does not know non-solr-method" do
-      lambda{ SolrCollection.new([]).fooo }.should raise_error
+    it "can set facets via collection" do
+      a = []
+      def a.facets; [1]; end
+      SolrCollection.new(a).facets.should == [1]
     end
 
-    it "uses results as subject" do
+    it "prefers facets from options" do
       a = []
-      def a.results; [1,2,3];end
-      SolrCollection.new(a)[2].should == 3
+      def a.facets; [1]; end
+      SolrCollection.new([], :facets => [2]).facets.should == [2]
     end
+  end
 
-    it "knows total_entries" do
-      SolrCollection.new([1,2,3]).total_entries.should == 3
-    end
+  it "knows spellcheck" do
+    SolrCollection.new([]).spellcheck.should == nil
+  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 "does not know non-solr-method" do
+    lambda{ SolrCollection.new([]).fooo }.should raise_error
+  end
 
-    it "can get total_entries from a solr resultset" do
+  describe "total_entries" do
+    it "can get total_entries from a solr result" 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
+    it "can get total_entries from array" do
+      a = [1,2,3]
+      SolrCollection.new(a).total_entries.should == 3
+    end
+
+    it "can get total_entries from self" do
+      a = SolrCollection.new([1,2,3])
+      SolrCollection.new(a).total_entries.should == 3
+    end
+
+    it "prefers total_entries from options" do
       a = []
       def a.total; 22;end
-      SolrCollection.new(a, :total_entries=>33).total_entries.should == 22
+      SolrCollection.new(a, :total_entries=>33).total_entries.should == 33
     end
   end
 
@@ -112,4 +130,22 @@ describe SolrCollection do
       SolrCollection.new(a).has_facet_fields?.should == true
     end
   end
+
+  describe :facet_field do
+    it "gets info from facet_fields" do
+      SolrCollection.new([], :facets => {'facet_fields' => {'x' => {'xx' => 1}}}).facet_field('x').should == {'xx' => 1}
+    end
+
+    it "returns nil when field is empty" do
+      SolrCollection.new([], :facets => {'facet_fields' => {'x' => []}}).facet_field('x').should == nil
+    end
+
+    it "returns nil when field is not found" do
+      SolrCollection.new([], :facets => {'facet_fields' => []}).facet_field('x').should == nil
+    end
+
+    it "returns nil when facets are empty" do
+      SolrCollection.new([]).facet_field('x').should == nil
+    end
+  end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: solr_collection
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Michael Grosser
@@ -9,30 +14,34 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-22 00:00:00 +01:00
+date: 2010-12-08 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 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
+  prerelease: false
+  name: will_paginate
 description: 
 email: grosser.michael@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.markdown
+extra_rdoc_files: []
+
 files: 
-- README.markdown
+- Gemfile
+- Gemfile.lock
 - Rakefile
+- Readme.md
 - VERSION
 - init.rb
 - lib/solr_collection.rb
@@ -52,21 +61,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 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
+- spec/spec_helper.rb

data/README.markdown

@@ -1,29 +0,0 @@
-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...