supernova 0.4.18 → 0.6.0

data/Gemfile

@@ -9,10 +9,10 @@ source "http://rubygems.org"
 gem "rsolr"
 gem "will_paginate"
 gem "json"
-gem "i18n"
 gem "activesupport"
 
 group :development do
+  gem "i18n"
   gem 'activerecord', '~>3.0.7', :require => "active_record"
   gem "ruby-debug"
   gem "mysql2", "~> 0.2.7"

data/VERSION

@@ -1 +1 @@
-0.4.18
+0.6.0

data/lib/supernova/collection.rb

@@ -1,4 +1,5 @@
 require "will_paginate"
 
 class Supernova::Collection < WillPaginate::Collection
+  attr_accessor :original_response, :facets
 end

data/lib/supernova/criteria.rb

@@ -69,6 +69,10 @@ class Supernova::Criteria
   def select(*fields)
     merge_filters_array :select, fields
   end
+  
+  def facet_fields(*fields)
+    merge_filters_array :facets, fields
+  end
 
   def conditions(filters)
     merge_filters :conditions, filters

data/lib/supernova/solr_criteria.rb

@@ -27,6 +27,11 @@ class Supernova::SolrCriteria < Supernova::Criteria
     end
     solr_options[:fq] << "type:#{self.clazz}" if self.clazz
     
+    if self.search_options[:facets]
+      solr_options[:facet] = true
+      solr_options["facet.field"] = self.search_options[:facets].compact.map { |field| solr_field_from_field(field) }
+    end
+    
     if self.search_options[:pagination]
       solr_options[:rows] = per_page
       solr_options[:start] = (current_page - 1) * solr_options[:rows]
@@ -142,9 +147,20 @@ class Supernova::SolrCriteria < Supernova::Criteria
     end
   end
   
+  def hashify_facets_from_response(response)
+    if response["facet_counts"] && response["facet_counts"]["facet_fields"]
+      response["facet_counts"]["facet_fields"].inject({}) do |hash, (key, values)|
+        hash[reverse_lookup_solr_field(key)] = Hash[*values]
+        hash
+      end
+    end
+  end
+  
   def execute
     response = Supernova::Solr.connection.post("select", :data => to_params)
     collection = Supernova::Collection.new(current_page, per_page, response["response"]["numFound"])
+    collection.original_response = response
+    collection.facets = hashify_facets_from_response(response)
     collection.replace(build_docs(response["response"]["docs"]))
     collection
   end

data/spec/integration/solr_spec.rb

@@ -240,4 +240,31 @@ describe "Solr" do
       results.first.should == { "id" => "offers/1", "user_id_i" => 1 }
     end
   end
+  
+  describe "#facets" do
+    it "returns the correct facets hash" do
+      # pending "fix me"
+      Supernova::Solr.connection.add(:id => "offers/3", :type => "Offer", :user_id_i => 3, :enabled_b => false, 
+        :text_t => "Hans Müller", :popularity_i => 10, :type => "Offer"
+      )
+      Supernova::Solr.connection.commit
+      new_criteria.facet_fields(:text_t).execute.facets.should == {"text_t"=>{"mintal"=>1, "marek"=>1, "meyer"=>1, "m\303\274ller"=>1, "han"=>2}}
+    end
+  end
+  
+  describe "with mapping" do
+    before(:each) do
+      @clazz = Class.new(Supernova::SolrIndexer)
+      @clazz.has :location, :type => :string
+      @clazz.has :city, :type => :string
+    end
+    
+    it "returns the correct facets" do
+      row1 = { "id" => 1, "location" => "Hamburg", "type" => "Offer" }
+      row2 = { "id" => 2, "location" => "Hamburg", "type" => "Offer" }
+      row3 = { "id" => 3, "location" => "Berlin", "type" => "Offer" }
+      @clazz.new.index_rows([row1, row2, row3])
+      @clazz.facet_fields(:location).execute.facets.should == { :location=>{ "Berlin"=>1, "Hamburg"=>2 } }
+    end
+  end
 end

data/spec/supernova/criteria_spec.rb

@@ -29,7 +29,8 @@ describe "Supernova::Criteria" do
     [:near, "test"],
     [:within, 10],
     [:options, {}],
-    [:without, {}]
+    [:without, {}],
+    [:facet_fields, "name"]
   ].each do |args|
     it "returns the scope itself for #{args.first}" do
       scope.send(*args).should == scope
@@ -43,6 +44,12 @@ describe "Supernova::Criteria" do
     end
   end
   
+  describe "#facet_fields" do
+    it "sets the facets" do
+      scope.facet_fields("title").facet_fields("name", "first_name").search_options[:facets].should == %w(title name first_name)
+    end
+  end
+  
   describe "#order" do
     it "sets the order statement" do
       scope.order("popularity desc").search_options[:order].should == "popularity desc"

data/spec/supernova/solr_criteria_spec.rb

@@ -82,7 +82,6 @@ describe Supernova::SolrCriteria do
       end
     end
     
-    
     it "sets search correct search query" do
       criteria.search("some query").to_params[:q].should == "(some query)"
     end
@@ -104,6 +103,16 @@ describe Supernova::SolrCriteria do
       criteria.select(:user_id).select(:user_id).select(:enabled).to_params[:fl].should == "user_id,enabled,id"
     end
     
+    it "sets the correct facet options when set" do
+      params = criteria.facet_fields(:name).to_params
+      params[:facet].should == true
+    end
+    
+    it "sets all facet fields" do
+      params = criteria.facet_fields(:name).facet_fields(:title).to_params
+      params["facet.field"].should == ["name", "title"]
+    end
+    
     it "uses mapped fields for select" do
       mapping = {
         :user_id => { :type => :integer },
@@ -196,6 +205,10 @@ describe Supernova::SolrCriteria do
       rsolr.stub!(:post).and_return solr_response
     end
     
+    it "sets the original response" do
+      criteria.execute.original_response.should == solr_response
+    end
+    
     it "calls to_params" do
       criteria.should_receive(:to_params).and_return params
       criteria.execute
@@ -240,13 +253,37 @@ describe Supernova::SolrCriteria do
     end
     
     it "calls replace on collection wit returned docs" do
-      col = double("collection")
+      col = double("collection", :original_response= => true, :facets= => true)
       Supernova::Collection.stub!(:new).and_return col
       built_docs = double("built docs")
       criteria.stub!(:build_docs).and_return built_docs
       col.should_receive(:replace).with(built_docs)
       criteria.execute
     end
+    
+    it "sets the correct facets" do
+      rsolr.stub!(:post).and_return facet_response
+      criteria.should_receive(:hashify_facets_from_response).with(facet_response).and_return({ :a => 1 })
+      criteria.execute.facets.should == {:a => 1}
+    end
+  end
+  
+  let(:facet_response) {
+    {
+      "response"=>{"start"=>0, "docs"=>[{"popularity_i"=>10, "enabled_b"=>false, "id"=>"offers/1", "user_id_i"=>1, "text_t"=>"Hans Meyer", "type"=>"Offer", "location_p"=>"47,11"}, {"popularity_i"=>1, "enabled_b"=>true, "id"=>"offers/2", "user_id_i"=>2, "text_t"=>"Marek Mintal", "type"=>"Offer", "location_p"=>"46.9981112912042,11.6587158814378"}], "numFound"=>2}, "facet_counts"=>{"facet_fields"=>{"text_t"=>["han", 1, "marek", 1, "meyer", 1, "mintal", 1]}, "facet_ranges"=>{}, "facet_dates"=>{}, "facet_queries"=>{}}, "responseHeader"=>{"QTime"=>4, "params"=>{"fq"=>"type:Offer", "facet.field"=>"text_t", "facet"=>"true", "q"=>"*:*", "wt"=>"ruby"}, "status"=>0}
+    }
+  }
+  
+  describe "#hashify_facets_from_response" do
+    it "returns nil when nothing found" do
+      criteria.hashify_facets_from_response({}).should == nil
+    end
+    
+    it "returns the correct hash when facets returned" do
+      criteria.hashify_facets_from_response(facet_response).should == {
+        "text_t" => { "han" => 1, "marek" => 1, "meyer" => 1, "mintal" => 1 }
+      }
+    end
   end
   
   describe "#build_docs" do

data/supernova.gemspec

@@ -5,12 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{supernova}
-  s.version = "0.4.18"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tobias Schwab"]
   s.date = %q{2011-08-04}
-  s.default_executable = %q{start_solr}
   s.description = %q{Unified search scopes}
   s.email = %q{tobias.schwab@dynport.de}
   s.executables = ["start_solr"]
@@ -95,7 +94,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/dynport/supernova}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
+  s.rubygems_version = %q{1.7.2}
   s.summary = %q{Unified search scopes}
 
   if s.respond_to? :specification_version then
@@ -105,8 +104,8 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<rsolr>, [">= 0"])
       s.add_runtime_dependency(%q<will_paginate>, [">= 0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_runtime_dependency(%q<i18n>, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<i18n>, [">= 0"])
       s.add_development_dependency(%q<activerecord>, ["~> 3.0.7"])
       s.add_development_dependency(%q<ruby-debug>, [">= 0"])
       s.add_development_dependency(%q<mysql2>, ["~> 0.2.7"])
@@ -122,8 +121,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rsolr>, [">= 0"])
       s.add_dependency(%q<will_paginate>, [">= 0"])
       s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<i18n>, [">= 0"])
       s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
       s.add_dependency(%q<activerecord>, ["~> 3.0.7"])
       s.add_dependency(%q<ruby-debug>, [">= 0"])
       s.add_dependency(%q<mysql2>, ["~> 0.2.7"])
@@ -140,8 +139,8 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rsolr>, [">= 0"])
     s.add_dependency(%q<will_paginate>, [">= 0"])
     s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<i18n>, [">= 0"])
     s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
     s.add_dependency(%q<activerecord>, ["~> 3.0.7"])
     s.add_dependency(%q<ruby-debug>, [">= 0"])
     s.add_dependency(%q<mysql2>, ["~> 0.2.7"])

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: supernova
 version: !ruby/object:Gem::Version 
-  hash: 43
+  hash: 7
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 18
-  version: 0.4.18
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Tobias Schwab
@@ -15,11 +15,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-04 00:00:00 +02:00
-default_executable: start_solr
+date: 2011-08-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -29,11 +27,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rsolr
   version_requirements: *id001
+  name: rsolr
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :runtime
+- !ruby/object:Gem::Dependency 
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -43,11 +41,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: will_paginate
   version_requirements: *id002
+  name: will_paginate
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :runtime
+- !ruby/object:Gem::Dependency 
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -57,11 +55,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: json
   version_requirements: *id003
+  name: json
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :runtime
+- !ruby/object:Gem::Dependency 
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -71,11 +69,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: i18n
   version_requirements: *id004
+  name: activesupport
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :runtime
+- !ruby/object:Gem::Dependency 
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -85,11 +83,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: activesupport
   version_requirements: *id005
+  name: i18n
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -101,11 +99,11 @@ dependencies:
         - 0
         - 7
         version: 3.0.7
-  name: activerecord
   version_requirements: *id006
+  name: activerecord
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -115,11 +113,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: ruby-debug
   version_requirements: *id007
+  name: ruby-debug
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -131,11 +129,11 @@ dependencies:
         - 2
         - 7
         version: 0.2.7
-  name: mysql2
   version_requirements: *id008
+  name: mysql2
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -147,11 +145,11 @@ dependencies:
         - 5
         - 0
         version: 4.5.0
-  name: ZenTest
   version_requirements: *id009
+  name: ZenTest
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -161,11 +159,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: geokit
   version_requirements: *id010
+  name: geokit
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -175,11 +173,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: autotest
   version_requirements: *id011
+  name: autotest
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -189,11 +187,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: autotest-growl
   version_requirements: *id012
+  name: autotest-growl
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -205,11 +203,11 @@ dependencies:
         - 3
         - 0
         version: 2.3.0
-  name: rspec
   version_requirements: *id013
+  name: rspec
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id014 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -221,11 +219,11 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  name: bundler
   version_requirements: *id014
+  name: bundler
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id015 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -237,11 +235,11 @@ dependencies:
         - 6
         - 0
         version: 1.6.0
-  name: jeweler
   version_requirements: *id015
+  name: jeweler
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id016 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -251,9 +249,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rcov
   version_requirements: *id016
+  name: rcov
   prerelease: false
+  type: :development
 description: Unified search scopes
 email: tobias.schwab@dynport.de
 executables: 
@@ -336,7 +335,6 @@ files:
 - spec/supernova/symbol_extensions_spec.rb
 - spec/supernova_spec.rb
 - supernova.gemspec
-has_rdoc: true
 homepage: http://github.com/dynport/supernova
 licenses: 
 - MIT
@@ -366,7 +364,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Unified search scopes