picky-client 0.0.3 → 0.0.4

data/lib/picky-client/convenience.rb

@@ -8,6 +8,14 @@ module Picky
     def empty?
       allocations.empty?
     end
+    # The rendered results or AR instances if you
+    # have populated the results.
+    #
+    def entries limit = 20
+      entries = []
+      allocations.each { |allocation| allocation[5].each { |id| break if entries.size > limit; entries << id } }
+      entries
+    end
     # Returns the topmost limit results.
     #
     def ids limit = 20
@@ -32,6 +40,50 @@ module Picky
     def total
       @total || @total = self[:total]
     end
-
+    
+    # Populating the results.
+    #
+    # Give it an AR class and options for the find and it
+    # will yield each found result for you to render.
+    #
+    # If you don't pass it a block, it will just use the AR results.
+    #
+    def populate_with klass, amount = 20, options = {}, &block
+      the_ids = ids amount
+      
+      objects = klass.find the_ids, options
+      
+      # Put together a mapping.
+      #
+      mapped_entries = objects.inject({}) do |mapped, entry|
+        mapped[entry.id] = entry if entry
+        mapped
+      end
+      
+      # Preserves the order
+      #
+      objects = the_ids.map { |id| mapped_entries[id] }
+      
+      objects.collect! &block if block_given?
+      
+      replace_ids_with objects
+      clear_ids
+      
+      objects
+    end
+    
+    # The ids need to come in the order which the ids were returned by the ids method.
+    #
+    def replace_ids_with entries
+      i = 0
+      self.allocations.each do |allocation|
+        allocation[5] = allocation[4].map do |_|
+          e = entries[i]
+          i += 1
+          e
+        end
+      end
+    end
+    
   end
 end

data/lib/picky-client/engine.rb

@@ -87,7 +87,11 @@ end
 
 # Extend hash with to_query method.
 #
-require 'active_support/core_ext/object/to_query'
+begin
+  require 'active_support/core_ext/object/to_query'
+rescue LoadError
+  
+end
 class Hash
   def to_query namespace = nil
     collect do |key, value|

data/lib/picky-client/helper.rb

@@ -0,0 +1,58 @@
+module Picky
+
+  # This class provides a few view helpers.
+  #
+  class Helper
+    
+    @@localized_interface = lambda { |options|
+      search_button_text = options[:button]     || 'search'
+      no_results         = options[:no_results] || 'Sorry, no results found!'
+      more_allocations   = options[:more]       || 'more'
+<<-HTML
+<div id="picky">
+  <div class="dashboard empty">
+    <div class="feedback">
+      <div class="status"></div>
+      <input type="text" autocorrect="off" class="query"/>
+      <div class="reset" title="clear"></div>
+    </div>
+    <input type="button" class="search_button" value="#{search_button_text}">
+  </div>
+  <ol class="results"></ol>
+  <div class="no_results">#{no_results}</div>
+  <div class="allocations">
+    <ol class="shown"></ol>
+    <ol class="more">#{more_allocations}</ol>
+    <ol class="hidden"></ol>
+  </div>
+</div>
+HTML
+    }
+    
+    # Returns a standard search interface for easy starting.
+    #
+    # ... aka scaffolding ;)
+    #
+    # Options:
+    #  * button: The search button text.
+    #  * no_results: The text shown when there are no results.
+    #  * more: The text shown when there are more than X results.
+    #
+    # Usage, in Views:
+    #
+    #   = Picky::Helper.interface :button => 'Go go go!'
+    #
+    #
+    def self.interface options = {}
+      @@localized_interface[options].gsub!(/[\n]/, '').squeeze! ' '
+    end
+    
+    # Returns a cached version if you always use a single language.
+    #
+    def self.cached_interface options = {}
+      @interface ||= interface.freeze
+    end
+    
+  end
+  
+end

data/lib/picky-client.rb

@@ -4,7 +4,8 @@ require 'rubygems'
 
 require 'active_support'
 
-this = File.dirname __FILE__
-require File.join(this, '/picky-client/engine')
-require File.join(this, '/picky-client/serializer')
-require File.join(this, '/picky-client/convenience')
+dir = File.dirname __FILE__
+require File.expand_path('picky-client/engine', dir)
+require File.expand_path('picky-client/serializer', dir)
+require File.expand_path('picky-client/convenience', dir)
+require File.expand_path('picky-client/helper', dir)

data/spec/picky-client/convenience_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe Picky::Convenience do
 
@@ -12,21 +12,60 @@ describe Picky::Convenience do
       :duration => 0.12345
     }.extend Picky::Convenience
   end
-
-  # describe 'replace_ids_with' do
-  #   before(:each) do
-  #     @results = Search::Results.new [
-  #         [nil, nil, nil, [1,2,3,4,5,6,7,8]],
-  #         [nil, nil, nil, [9,10,11,12,13,14,15,16]],
-  #         [nil, nil, nil, [17,18,19,20,21,22,23]]
-  #       ], [], nil, 123, true, true, 0.123, 1234
-  #   end
-  #   it 'should replace the ids' do
-  #     new_ids = (11..31).to_a # +10
-  #     @results.replace_ids_with new_ids
-  #     @results.ids.should == (11..31).to_a
-  #   end
-  # end
+  
+  describe "populate_with" do
+    before(:each) do
+      @results = {
+          :allocations => [[nil, nil, nil, nil, [1,2,3,4,5,6,7,8]],
+                           [nil, nil, nil, nil, [9,10,11,12,13,14,15,16]],
+                           [nil, nil, nil, nil, [17,18,19,20,21,22,23]]
+                          ],
+           :offset => 123,
+           :duration => 0.123,
+           :count => 1234
+         }.extend Picky::Convenience
+      
+      class ARClass
+        attr_reader :id
+        def initialize id
+          @id = id
+        end
+        def self.find ids, options = {}
+          ids.map { |id| new(id) }
+        end
+        def == other
+          self.id == other.id
+        end
+      end
+    end
+    it "should populate correctly even without a block" do
+      @results.populate_with ARClass
+      @results.entries.should == (1..21).map { |id| ARClass.new(id) }
+    end
+    it "should populate correctly with a render block" do
+      @results.populate_with(ARClass) { |ar_instance| ar_instance.id.to_s }
+      @results.entries.should == (1..21).map { |id| id.to_s } # "rendering" using to_s
+    end
+  end
+  
+  describe 'replace_ids_with' do
+    before(:each) do
+      @results = {
+          :allocations => [[nil, nil, nil, nil, [1,2,3,4,5,6,7,8]],
+                           [nil, nil, nil, nil, [9,10,11,12,13,14,15,16]],
+                           [nil, nil, nil, nil, [17,18,19,20,21,22,23]]
+                          ],
+           :offset => 123,
+           :duration => 0.123,
+           :count => 1234
+         }.extend Picky::Convenience
+    end
+    it 'should populate with the entries' do
+      new_ids = (11..31).to_a # +10
+      @results.replace_ids_with new_ids
+      @results.entries.should == (11..31).to_a
+    end
+  end
 
   describe 'clear_ids' do
     it 'should clear all ids' do

data/spec/picky-client/engine_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe Picky::Client do
   

data/spec/picky-client/helper_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Picky::Helper do
+  
+  describe "cached_interface" do
+    it "should return good html" do
+      Picky::Helper.cached_interface.should == Picky::Helper.interface
+    end
+    it "should return the cached interface" do
+      Picky::Helper.cached_interface.object_id.should == Picky::Helper.cached_interface.object_id
+    end
+    it "should be frozen" do
+      Picky::Helper.cached_interface.should be_frozen
+    end
+  end
+  
+  describe "interface" do
+    it "should return good html" do
+      Picky::Helper.interface.should == "<div id=\"picky\"> <div class=\"dashboard empty\"> <div class=\"feedback\"> <div class=\"status\"></div> <input type=\"text\" autocorrect=\"off\" class=\"query\"/> <div class=\"reset\" title=\"clear\"></div> </div> <input type=\"button\" class=\"search_button\" value=\"search\"> </div> <ol class=\"results\"></ol> <div class=\"no_results\">Sorry, no results found!</div> <div class=\"allocations\"> <ol class=\"shown\"></ol> <ol class=\"more\">more</ol> <ol class=\"hidden\"></ol> </div></div>"
+    end
+    it "should return good html" do
+      Picky::Helper.interface(:button => 'find', :no_results => 'SORRY!', :more => 'Click for more!').should == "<div id=\"picky\"> <div class=\"dashboard empty\"> <div class=\"feedback\"> <div class=\"status\"></div> <input type=\"text\" autocorrect=\"off\" class=\"query\"/> <div class=\"reset\" title=\"clear\"></div> </div> <input type=\"button\" class=\"search_button\" value=\"find\"> </div> <ol class=\"results\"></ol> <div class=\"no_results\">SORRY!</div> <div class=\"allocations\"> <ol class=\"shown\"></ol> <ol class=\"more\">Click for more!</ol> <ol class=\"hidden\"></ol> </div></div>"
+    end
+  end
+  
+end

data/spec/picky-client/serializer_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe Picky::Serializer do
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Florian Hanke
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-30 00:00:00 +02:00
+date: 2010-10-02 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -29,11 +29,13 @@ extra_rdoc_files:
 files: 
 - lib/picky-client/convenience.rb
 - lib/picky-client/engine.rb
+- lib/picky-client/helper.rb
 - lib/picky-client/serializer.rb
 - lib/picky-client.rb
 - README.rdoc
 - spec/picky-client/convenience_spec.rb
 - spec/picky-client/engine_spec.rb
+- spec/picky-client/helper_spec.rb
 - spec/picky-client/serializer_spec.rb
 has_rdoc: true
 homepage: http://floere.github.com/picky
@@ -70,4 +72,5 @@ summary: picky Search Engine Client
 test_files: 
 - spec/picky-client/convenience_spec.rb
 - spec/picky-client/engine_spec.rb
+- spec/picky-client/helper_spec.rb
 - spec/picky-client/serializer_spec.rb