supernova 0.3.6 → 0.3.8

data/VERSION

@@ -1 +1 @@
-0.3.6
+0.3.8

data/lib/supernova/solr_criteria.rb

@@ -103,8 +103,9 @@ class Supernova::SolrCriteria < Supernova::Criteria
     doc
   end
   
+  # called in build doc, all hashes have strings as keys!!!
   def convert_doc_attributes(hash)
-    hash.inject({}) do |ret, (key, value)|
+    converted_hash = hash.inject({}) do |ret, (key, value)|
       if key == "id"
         ret["id"] = value.to_s.split("/").last
       else
@@ -112,6 +113,18 @@ class Supernova::SolrCriteria < Supernova::Criteria
       end
       ret
     end
+    self.select_fields.each do |select_field|
+      converted_hash[select_field.to_s] = nil if !converted_hash.has_key?(select_field.to_s)
+    end
+    converted_hash
+  end
+  
+  def select_fields
+    if self.search_options[:select].present?
+      self.search_options[:select]
+    else
+      self.search_options[:named_scope_class].respond_to?(:select_fields) ? self.search_options[:named_scope_class].select_fields : []
+    end
   end
   
   def set_first_responding_attribute(doc, solr_key, value)

data/lib/supernova/solr_indexer.rb

@@ -11,6 +11,12 @@ class Supernova::SolrIndexer
       @field_definitions ||= {}
     end
     
+    def select_fields
+      field_definitions.map do |key, attributes|
+        attributes[:virtual] != true ? key : nil
+      end.compact
+    end
+    
     def has(key, attributes)
       field_definitions[key] = attributes.is_a?(Hash) ? attributes : { :type => attributes }
     end

data/spec/supernova/solr_criteria_spec.rb

@@ -255,29 +255,42 @@ describe Supernova::SolrCriteria do
   end
   
   describe "#build_doc" do
+    class OfferIndex < Supernova::SolrIndexer
+      has :enabled, :type => :boolean
+      has :popularity, :type => :integer
+      has :is_deleted, :type => :boolean, :virtual => true
+      clazz Offer
+    end
+    
+    
     { "Offer" => Offer, "Host" => Host }.each do |type, clazz|
       it "returns the #{clazz} for #{type.inspect}" do
         criteria.build_doc("type" => type).should be_an_instance_of(clazz)
       end
     end
     
-    { :popularity => 10, :enabled => false, :id => 1 }.each do |key, value|
-      it "sets #{key} to #{value}" do
-        doc = criteria.build_doc("type" => "Offer", "some_other" => "Test", "id" => "offers/1", "enabled" => false, "popularity" => 10)
-        doc.send(key).should == value
-      end
+    it "calls convert_doc_attributes" do
+      row = { "type" => "Offer", "id" => "offers/1" }
+      criteria.should_receive(:convert_doc_attributes).with(row).and_return row
+      criteria.build_doc(row)
     end
     
-    it "updates the attributes hash when defined" do
-      atts = { "type" => "Offer", "some_other" => "Test", "id" => "offers/1", "enabled" => false, "popularity" => 10 }
-      doc = criteria.build_doc(atts)
-      doc.instance_variable_get("@attributes").should == { "popularity" => 10, "enabled" => false, "id" => "1", "some_other" => "Test"}
-    end
-    
-    it "returns a Hash when type does not response to " do
+    it "returns the original hash when no type given" do
       type = double("type")
+      row = { "id" => "offers/1", "type" => type }
       type.should_receive(:respond_to?).with(:constantize).and_return false
-      criteria.build_doc("type" => type).should be_an_instance_of(Hash)
+      criteria.should_not_receive(:convert_doc_attributes)
+      criteria.build_doc(row).should == row
+    end
+    
+    it "assigns the attributes returned from convert_doc_attributes to attributes when instance variable exists" do
+      str = String.new
+      str.instance_variable_set("@attributes", {})
+      atts = { :title => "Hello" }
+      row = { "type" => "Offer" }
+      criteria.should_receive(:convert_doc_attributes).with(row).and_return atts
+      doc = criteria.build_doc(row)
+      doc.instance_variable_get("@attributes").should == atts
     end
     
     it "sets the original solr_doc" do
@@ -293,25 +306,69 @@ describe Supernova::SolrCriteria do
       criteria.build_doc(docs.first).should_not be_a_new_record
     end
     
-    it "uses attribute_mapping when defined" do
+    it "returns an offer and sets all given parameters" do
       criteria.attribute_mapping(:enabled => { :type => :boolean }, :popularity => { :type => :integer })
       doc = criteria.build_doc("type" => "Offer", "id" => "offers/1", "enabled_b" => true, "popularity_i" => 10)
       doc.should be_an_instance_of(Offer)
       doc.popularity.should == 10
     end
     
+    it "sets selected parameters even when nil" do
+      doc = criteria.select(:enabled, :popularity).build_doc("type" => "Offer", "id" => "offers/1")
+      doc.enabled.should be_nil
+      doc.popularity.should be_nil
+    end
+    
+    it "it sets parameters to nil when no select given and not present" do
+      doc = OfferIndex.search_scope.build_doc("type" => "Offer", "id" => "offers/1")
+      doc.should be_an_instance_of(Offer)
+      doc.popularity.should be_nil
+    end
+    
+    it "does not set virtual parameters to nil" do
+      OfferIndex.search_scope.build_doc("type" => "Offer", "id" => "offers/1").attributes.should_not have_key(:is_deleted)
+      OfferIndex.search_scope.build_doc("type" => "Offer", "id" => "offers/1").attributes.should_not have_key("is_deleted")
+    end
+  end
+  
+  describe "#select_fields" do
+    it "returns the fields from search_options when defined" do
+      criteria.select(:enabled).select_fields.should == [:enabled]
+    end
+    
+    it "returns the select_fields from named_search_scope when assigned and responding to" do
+      fields = double("fields")
+      nsc = double("scope", :select_fields => fields)
+      criteria.named_scope_class(nsc)
+      criteria.select_fields.should == fields
+    end
+    
+    it "returns an empty array by default" do
+      criteria.select_fields.should be_empty
+    end
+  end
+  
+  describe "#convert_doc_attributes" do
+    { "popularity" => 10, "enabled" => false, "id" => "1" }.each do |key, value|
+      it "sets #{key} to #{value}" do
+        criteria.convert_doc_attributes("type" => "Offer", "some_other" => "Test", "id" => "offers/1", "enabled" => false, "popularity" => 10)[key].should == value
+      end
+    end
+    
+    { "popularity" => 10, "enabled" => true, "id" => "1" }.each do |field, value|
+      it "uses sets #{field} to #{value}" do
+        criteria.attribute_mapping(:enabled => { :type => :boolean }, :popularity => { :type => :integer })
+        criteria.convert_doc_attributes("type" => "Offer", "id" => "offers/1", "enabled_b" => true, "popularity_i" => 10)[field].should == value
+      end
+    end
+  
+    
     class MongoOffer
       attr_accessor :id
     end
     
     it "would also work with mongoid ids" do
-      criteria.build_doc("type" => "MongoOffer", "id" => "offers/4df08c30f3b0a72e7c227a55").id.should == "4df08c30f3b0a72e7c227a55"
-    end
-    
-    it "uses OpenStruct when type is not given" do
-      doc = criteria.build_doc("id" => "offers/4df08c30f3b0a72e7c227a55")
-      doc.should be_an_instance_of(Hash)
-      doc["id"].should == "offers/4df08c30f3b0a72e7c227a55"
+      criteria.convert_doc_attributes("type" => "MongoOffer", "id" => "offers/4df08c30f3b0a72e7c227a55")["id"].should == "4df08c30f3b0a72e7c227a55"
     end
   end
   

data/spec/supernova/solr_indexer_spec.rb

@@ -406,6 +406,22 @@ describe Supernova::SolrIndexer do
     end
   end
   
+  describe "SolrIndexer.select_fields" do
+    it "returns the keys of the field definitions" do
+      Supernova::SolrIndexer.should_receive(:field_definitions).and_return(
+        { :title => { :type => :string }, :popularity => { :type => :integer } }
+      )
+      Supernova::SolrIndexer.select_fields.map(&:to_s).sort.should == %w(popularity title)
+    end
+    
+    it "does not include virtual attributes" do
+      Supernova::SolrIndexer.should_receive(:field_definitions).and_return(
+        { :title => { :type => :string }, :popularity => { :type => :integer }, :is_deleted => { :virtual => true, :type => :integer } }
+      )
+      Supernova::SolrIndexer.select_fields.map(&:to_s).sort.should == %w(popularity title)
+    end
+  end
+  
   describe "#method_missing" do
     it "returns a new supernova criteria" do
       indexer_clazz.where(:a => 1).should be_an_instance_of(Supernova::SolrCriteria)

data/supernova.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{supernova}
-  s.version = "0.3.6"
+  s.version = "0.3.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tobias Schwab"]
-  s.date = %q{2011-06-13}
+  s.date = %q{2011-06-15}
   s.description = %q{Unified search scopes}
   s.email = %q{tobias.schwab@dynport.de}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: supernova
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 3
   prerelease: 
   segments: 
   - 0
   - 3
-  - 6
-  version: 0.3.6
+  - 8
+  version: 0.3.8
 platform: ruby
 authors: 
 - Tobias Schwab
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-13 00:00:00 Z
+date: 2011-06-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement