slingshot-rb 0.0.2 → 0.0.3

data/README.markdown

@@ -13,7 +13,7 @@ You should seriously consider it to power search in your Ruby applications:
 it will deliver all the features you want — and many more you may have not
 imagined yet (native geo search? histogram facets?)
 
-_Slingshot_ currently allow basic operation with the index and searching. See chapters below.
+_Slingshot_ currently allows basic operation with the index and searching. More is planned.
 
 
 Installation
@@ -32,6 +32,7 @@ OK, easy. Now, install the gem via Rubygems:
 or from source:
 
     $ git clone git://github.com/karmi/slingshot.git
+    $ cd slingshot
     $ rake install
 
 
@@ -132,6 +133,13 @@ Currently, _Slingshot_ supports only a limited subset of vast _ElasticSearch_ [S
 
 See the [`examples/dsl.rb`](blob/master/examples/dsl.rb).
 
+_Slingshot_ wraps the results in a enumerable `Results::Collection` class, and every result in a `Results::Item` class,
+which looks like a child of `Hash` and `Openstruct`.
+
+You may wrap the result items in your own class by setting the `Configuration.wrapper` property.
+Check out file `test/unit/results_collection_test.rb` to see how to do that.
+
+
 Todo & Plans
 ------------
 
@@ -139,11 +147,11 @@ In order of importance:
 
 * Getting document [by ID](http://www.elasticsearch.org/guide/reference/api/get.html)
 * Seamless _ActiveModel_ compatibility for easy usage in _Rails_ applications (this also means nearly full _ActiveRecord_ compatibility)
-* Allowing to set custom non-ActiveModel wrapper class (your own)
 * Seamless [will_paginate](https://github.com/mislav/will_paginate) compatibility for easy pagination
 * [Histogram](http://www.elasticsearch.org/guide/reference/api/search/facets/histogram-facet.html) facets
 * Seamless support for [auto-updating _river_ index](http://www.elasticsearch.org/guide/reference/river/couchdb.html) for _CouchDB_ `_changes` feed
 * [Mapping](http://www.elasticsearch.org/guide/reference/mapping/) management
+* Proper RDoc annotations for the source code
 * Infrastructure for query filters
 * [Range](http://www.elasticsearch.org/guide/reference/query-dsl/range-filter.html) filters and queries
 * [Geo Filters](http://www.elasticsearch.org/blog/2010/08/16/geo_location_and_search.html) for queries
@@ -155,6 +163,13 @@ In order of importance:
 * [Bulk](http://www.elasticsearch.org/guide/reference/api/bulk.html) API
 * Embedded webserver to display cluster statistics and allow easy searches
 
+
+Other Clients
+-------------
+
+Check out [other _ElasticSearch_ clients](http://www.elasticsearch.org/guide/appendix/clients.html).
+
+
 Feedback
 --------
 

data/lib/slingshot/configuration.rb

@@ -10,6 +10,15 @@ module Slingshot
       @client = klass || @client || Client::RestClient
     end
 
+    def self.wrapper(klass=nil)
+      @wrapper = klass || @wrapper || Results::Item
+    end
+
+    def self.reset(*properties)
+      reset_variables = properties.empty? ? instance_variables : instance_variables & properties.map { |p| "@#{p}" }
+      reset_variables.each { |v| instance_variable_set(v, nil) }
+    end
+
   end
 
 end

data/lib/slingshot/dsl.rb

@@ -5,8 +5,8 @@ module Slingshot
       Configuration.class_eval(&block)
     end
 
-    def search(indices, &block)
-      Search::Search.new(indices, &block).perform
+    def search(indices, options={}, &block)
+      Search::Search.new(indices, options, &block).perform
     end
 
     def index(name, &block)

data/lib/slingshot/results/collection.rb

@@ -9,9 +9,13 @@ module Slingshot
         @time    = response['took']
         @total   = response['hits']['total']
         @results = response['hits']['hits'].map do |h|
-                     document = h['_source'] ? h['_source'] : h['fields']
-                     h.update document if document
-                     Item.new h
+                     if Configuration.wrapper == Hash
+                       h
+                     else
+                       document = h['_source'] ? h['_source'] : h['fields']
+                       h.update document if document
+                       Configuration.wrapper.new(h)
+                     end
                    end
         @facets  = response['facets']
       end

data/lib/slingshot/results/item.rb

@@ -13,7 +13,7 @@ module Slingshot
           end
           super.replace self
         else
-          super()
+          super
         end
       end
 
@@ -25,7 +25,7 @@ module Slingshot
       end
 
       def inspect
-        s = []; self.each { |k,v| s << ":#{k} => #{v.inspect}" }
+        s = []; self.each { |k,v| s << "#{k}: #{v.inspect}" }
         %Q|<Item #{s.join(', ')}>|
       end
 

data/lib/slingshot/search.rb

@@ -6,8 +6,12 @@ module Slingshot
       attr_reader :indices, :url, :results, :response, :query, :facets
 
       def initialize(*indices, &block)
-        raise ArgumentError, 'Please pass index or indices to search' if indices.empty?
+        @options = indices.pop if indices.last.is_a?(Hash)
         @indices = indices
+        raise ArgumentError, 'Please pass index or indices to search' if @indices.empty?
+        if @options
+          Configuration.wrapper @options[:wrapper] if @options[:wrapper]
+        end
         instance_eval(&block) if block_given?
       end
 

data/lib/slingshot/version.rb

@@ -1,3 +1,3 @@
 module Slingshot
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/unit/configuration_test.rb

@@ -27,6 +27,25 @@ module Slingshot
         assert_nothing_raised { Configuration.client Client::Base }
         assert_equal Client::Base, Configuration.client
       end
+
+      should "allow to reset the configuration for specific property" do
+        Configuration.url 'http://example.com'
+        Configuration.client Client::Base
+        assert_equal 'http://example.com', Configuration.url
+        Configuration.reset :url
+        assert_equal 'http://localhost:9200', Configuration.url
+        assert_equal Client::Base, Configuration.client
+      end
+
+      should "allow to reset the configuration for all properties" do
+        Configuration.url 'http://example.com'
+        Configuration.client Client::Base
+        assert_equal 'http://example.com', Configuration.url
+        assert_equal Client::Base, Configuration.client
+        Configuration.reset
+        assert_equal 'http://localhost:9200', Configuration.url
+        assert_equal Client::RestClient, Configuration.client
+      end
     end
 
   end

data/test/unit/results_collection_test.rb

@@ -1,11 +1,24 @@
 require 'test_helper'
 
+class Article
+  attr_reader :title, :body
+  def initialize(attributes={})
+    @title = attributes[:title]
+    @body  = attributes[:body]
+  end
+  def to_json
+    { :title => @title, :body => @body }.to_json
+  end
+  alias :to_indexed_json :to_json
+end
+
 module Slingshot
 
   class ResultsCollectionTest < Test::Unit::TestCase
 
     context "Collection" do
       setup do
+        Configuration.reset :wrapper
         @default_response = { 'hits' => { 'hits' => [{:_id => 1}, {:_id => 2}, {:_id => 3}] } }
       end
 
@@ -26,20 +39,39 @@ module Slingshot
 
       context "wrapping results" do
 
-        should "wrap hits in Item" do
-          response = { 'hits' => { 'hits' => [ { '_id' => 1, '_source' => { :title => 'Test', :body => 'Lorem' } } ] } }
-          document =  Results::Collection.new(response).first
+        setup do
+          @response = { 'hits' => { 'hits' => [ { '_id' => 1, '_source' => { :title => 'Test', :body => 'Lorem' } } ] } }
+        end
+
+        should "wrap hits in Item by default" do
+          document =  Results::Collection.new(@response).first
           assert_kind_of Results::Item, document
           assert_equal 'Test', document.title
         end
 
-        should "allow access to raw underlying Hash" do
-          response = { 'hits' => { 'hits' => [ { '_id' => 1, '_source' => { :title => 'Test', :body => 'Lorem' } } ] } }
-          document = Results::Collection.new(response).first
+        should "allow access to raw underlying Hash in Item" do
+          document = Results::Collection.new(@response).first
           assert_not_nil document[:_source][:title]
           assert_equal 'Test', document[:_source][:title]
         end
 
+        should "allow wrapping hits in a Hash" do
+          Configuration.wrapper(Hash)
+
+          document =  Results::Collection.new(@response).first
+          assert_kind_of Hash, document
+          assert_raise(NoMethodError) { document.title }
+          assert_equal   'Test', document['_source'][:title]
+        end
+
+        should "allow wrapping hits in custom class" do
+          Configuration.wrapper(Article)
+
+          article =  Results::Collection.new(@response).first
+          assert_kind_of Article, article
+          assert_equal   'Test',  article.title
+        end
+
       end
 
     end

data/test/unit/results_item_test.rb

@@ -10,6 +10,21 @@ module Slingshot
         @document = Results::Item.new :title => 'Test', :author => { :name => 'Kafka' }
       end
 
+      should "be initialized with a Hash" do
+        assert_nothing_raised do
+          d = Results::Item.new(:id => 1)
+          assert_instance_of Results::Item, d
+        end
+      end
+
+      should "delegate non-Hash params to Hash when initializing" do
+        assert_nothing_raised do
+          d = Results::Item.new('foo')
+          assert_instance_of Results::Item, d
+          assert_equal 'foo', d[:bar] # See http://www.ruby-doc.org/core/classes/Hash.html#M000718
+        end
+      end
+
       should "respond to :to_indexed_json" do
         assert_respond_to Results::Item.new, :to_indexed_json
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: slingshot-rb
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Karel Minarik
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-08 00:00:00 +01:00
+date: 2011-02-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency