tire 0.3.3 → 0.3.4

data/README.markdown

@@ -134,6 +134,17 @@ We can easily manipulate the documents before storing them in the index, by pass
     end
 ```
 
+If this _declarative_ notation does not fit well in your context,
+you can use _Tire's_ classes directly, in a more imperative manner:
+
+```ruby
+    index = Tire::Index.new('oldskool')
+    index.delete
+    index.create
+    index.store :title => "Let's do it the old way!"
+    index.refresh
+```
+
 OK. Now, let's go search all the data.
 
 We will be searching for articles whose `title` begins with letter “T”, sorted by `title` in `descending` order,
@@ -281,7 +292,21 @@ a plain old Ruby `Hash` (or JSON string) with the query declaration to the `sear
 If this sounds like a great idea to you, you are probably able to write your application
 using just `curl`, `sed` and `awk`.
 
-For debugging purposes, we can display the full query JSON for close inspection:
+Do note again, however, that you're not tied to the declarative block-style DSL _Tire_ offers to you.
+If it makes more sense in your context, you can use its classes directly, in a more imperative style:
+
+```ruby
+    search = Tire::Search::Search.new('articles')
+    search.query  { string('title:T*') }
+    search.filter :terms, :tags => ['ruby']
+    search.sort   { by :title, 'desc' }
+    search.facet('global-tags') { terms :tags, :global => true }
+    # ...
+    p search.perform.results
+```
+
+To debug the query we have laboriously set up like this,
+we can display the full query JSON for close inspection:
 
 ```ruby
     puts s.to_json
@@ -692,6 +717,14 @@ This will result in Article instances being stored in an index called 'test_arti
 Please be sure to peruse the [integration test suite](https://github.com/karmi/tire/tree/master/test/integration)
 for examples of the API and _ActiveModel_ integration usage.
 
+
+Extensions and Additions
+------------------------
+
+The [_tire-contrib_](http://github.com/karmi/tire-contrib/) project contains additions
+and extensions to the _Tire_ functionality.
+
+
 Todo, Plans & Ideas
 -------------------
 
@@ -699,8 +732,6 @@ _Tire_ is already used in production by its authors. Nevertheless, it's not cons
 
 There are todos, plans and ideas, some of which are listed below, in the order of importance:
 
-* Wrap all Tire functionality mixed into a model in a "forwardable" object, and proxy everything via this object. (The immediate problem: [Mongoid](http://mongoid.org/docs/indexing.html))
-* If we're not stepping on other's toes, bring Tire methods like `index`, `search`, `mapping` also to the class/instance top-level namespace.
 * Proper RDoc annotations for the source code
 * [Statistical](http://www.elasticsearch.org/guide/reference/api/search/facets/statistical-facet.html) facets
 * [Geo Distance](http://www.elasticsearch.org/guide/reference/api/search/facets/geo-distance-facet.html) facets

data/examples/tire-dsl.rb

@@ -697,7 +697,7 @@ s = Tire.search 'articles' do
 
     # and by their `title` property, in _descending_ order.
     #
-    by :title 'desc'
+    by :title, 'desc'
   end
 end
 

data/lib/tire/http/client.rb

@@ -8,31 +8,31 @@ module Tire
 
         def self.get(url, data=nil)
           perform ::RestClient::Request.new(:method => :get, :url => url, :payload => data).execute
-        rescue Exception => e
+        rescue ::RestClient::Exception => e
           Response.new e.http_body, e.http_code
         end
 
         def self.post(url, data)
           perform ::RestClient.post(url, data)
-        rescue Exception => e
+        rescue ::RestClient::Exception => e
           Response.new e.http_body, e.http_code
         end
 
         def self.put(url, data)
           perform ::RestClient.put(url, data)
-        rescue Exception => e
+        rescue ::RestClient::Exception => e
           Response.new e.http_body, e.http_code
         end
 
         def self.delete(url)
           perform ::RestClient.delete(url)
-        rescue Exception => e
+        rescue ::RestClient::Exception => e
           Response.new e.http_body, e.http_code
         end
 
         def self.head(url)
           perform ::RestClient.head(url)
-        rescue Exception => e
+        rescue ::RestClient::Exception => e
           Response.new e.http_body, e.http_code
         end
 

data/lib/tire/index.rb

@@ -9,7 +9,11 @@ module Tire
     end
 
     def exists?
-      Configuration.client.head("#{Configuration.url}/#{@name}").success?
+      @response = Configuration.client.head("#{Configuration.url}/#{@name}")
+      @response.success?
+    ensure
+      curl = %Q|curl -I "#{Configuration.url}/#{@name}"|
+      logged(@response.body, 'HEAD', curl) if @response
     end
 
     def delete
@@ -26,7 +30,7 @@ module Tire
       @response.success? ? @response : false
     ensure
       curl = %Q|curl -X POST "#{Configuration.url}/#{@name}" -d '#{MultiJson.encode(options)}'|
-      logged(@response.body, 'CREATE', curl)
+      logged(@response.body, 'CREATE', curl) if @response
     end
 
     def mapping
@@ -230,7 +234,7 @@ module Tire
         if Configuration.logger.level.to_s == 'debug'
           # FIXME: Depends on RestClient implementation
           body = if @response
-            defined?(Yajl) ? Yajl::Encoder.encode(@json, :pretty => true) : MultiJson.encode(@json)
+            defined?(Yajl) ? Yajl::Encoder.encode(@response.body, :pretty => true) : MultiJson.encode(@response.body)
           else
             error.http_body rescue ''
           end

data/lib/tire/model/callbacks.rb

@@ -9,9 +9,6 @@ module Tire
     # The model must respond to `after_save` and `after_destroy` callbacks
     # (ActiveModel and ActiveRecord models do so, by default).
     #
-    # By including the model, you will also have the `after_update_elasticsearch_index` and
-    # `before_update_elasticsearch_index` callbacks available.
-    # 
     module Callbacks
 
       # A hook triggered by the `include Tire::Model::Callbacks` statement in the model.
@@ -35,11 +32,6 @@ module Tire
           end
         end
 
-        # Define _Tire's_ callbacks.
-        #
-        base.class_eval do
-          define_model_callbacks(:update_elasticsearch_index, :only => [:after, :before])
-        end if base.respond_to?(:define_model_callbacks)
       end
 
     end

data/lib/tire/model/indexing.rb

@@ -92,6 +92,9 @@ module Tire
           unless index.exists?
             index.create :mappings => mapping_to_hash, :settings => settings
           end
+        rescue Errno::ECONNREFUSED => e
+          STDERR.puts "Skipping index creation, cannot connect to ElasticSearch",
+                      "(The original exception was: #{e.inspect})"
         end
 
         def store_mapping?

data/lib/tire/model/naming.rb

@@ -20,8 +20,16 @@ module Tire
         #
         #     Article.index_name 'my-custom-name'
         #
-        def index_name name=nil
+        # You can also use a block for defining the index name,
+        # which is evaluated in the class context:
+        #
+        #     Article.index_name { "articles-#{Time.now.year}" }
+        #
+        #     Article.index_name { "articles-#{Rails.env}" }
+        #
+        def index_name name=nil, &block
           @index_name = name if name
+          @index_name = block if block_given?
           @index_name || [index_prefix, klass.model_name.plural].compact.join('_')
         end
 

data/lib/tire/model/persistence/finders.rb

@@ -22,7 +22,7 @@ module Tire
             else
               case args = args.pop
                 when Fixnum, String
-                  Index.new(index_name).retrieve document_type, args
+                  index.retrieve document_type, args
                 when :all, :first
                   send(args)
                 else
@@ -37,7 +37,7 @@ module Tire
             # TODO: Options like `sort`; Possibly `filters`
             old_wrapper = Tire::Configuration.wrapper
             Tire::Configuration.wrapper self
-            s = Tire::Search::Search.new(index_name).query { all }
+            s = Tire::Search::Search.new(index.name).query { all }
             s.perform.results
           ensure
             Tire::Configuration.wrapper old_wrapper
@@ -47,7 +47,7 @@ module Tire
             # TODO: Options like `sort`; Possibly `filters`
             old_wrapper = Tire::Configuration.wrapper
             Tire::Configuration.wrapper self
-            s = Tire::Search::Search.new(index_name).query { all }.size(1)
+            s = Tire::Search::Search.new(index.name).query { all }.size(1)
             s.perform.results.first
           ensure
             Tire::Configuration.wrapper old_wrapper

data/lib/tire/model/persistence/storage.rb

@@ -25,10 +25,6 @@ module Tire
             document
           end
 
-          def index
-            @index = Index.new(index_name)
-          end
-
         end
 
         module InstanceMethods

data/lib/tire/model/search.rb

@@ -99,7 +99,8 @@ module Tire
         # Example usage: `Article.index.refresh`.
         #
         def index
-          @index = Index.new(index_name)
+          name = index_name.respond_to?(:to_proc) ? klass.instance_eval(&index_name) : index_name
+          @index = Index.new(name)
         end
 
       end
@@ -120,8 +121,7 @@ module Tire
         #
         # On model destroy, it will remove the corresponding document from the index.
         #
-        # It will also call the `<after|before>_update_elasticsearch_index` callbacks,
-        # if defined by the model.
+        # It will also execute any `<after|before>_update_elasticsearch_index` callback hooks.
         #
         def update_index
           instance.send :_run_update_elasticsearch_index_callbacks do
@@ -237,6 +237,11 @@ module Tire
             @__tire__
           end
 
+          # Define _Tire's_ callbacks (<after|before>_update_elasticsearch_index).
+          #
+          define_model_callbacks(:update_elasticsearch_index, :only => [:after, :before]) if \
+            respond_to?(:define_model_callbacks)
+
           # Serialize the model as a Hash.
           #
           # Uses `serializable_hash` representation of the model,

data/lib/tire/results/pagination.rb

@@ -1,6 +1,8 @@
 module Tire
   module Results
 
+    # Adds support for WillPaginate and Kaminari
+    #
     module Pagination
 
       def total_entries
@@ -39,6 +41,13 @@ module Tire
         current_page > total_pages
       end
 
+      # Kaminari support
+      #
+      alias :limit_value  :per_page
+      alias :total_count  :total_entries
+      alias :num_pages    :total_pages
+      alias :offset_value :offset
+
     end
 
   end

data/lib/tire/search.rb

@@ -1,5 +1,6 @@
 module Tire
   module Search
+    class SearchRequestFailed < StandardError; end
   
     class Search
 
@@ -70,7 +71,7 @@ module Tire
         @response = Configuration.client.get(@url, self.to_json)
         if @response.failure?
           STDERR.puts "[REQUEST FAILED] #{self.to_curl}\n"
-          return false
+          raise SearchRequestFailed
         end
         @json     = MultiJson.decode(@response.body)
         @results  = Results::Collection.new(@json, @options)

data/lib/tire/version.rb

@@ -1,34 +1,14 @@
 module Tire
-  VERSION   = "0.3.3"
+  VERSION   = "0.3.4"
 
   CHANGELOG =<<-END
     IMPORTANT CHANGES LATELY:
 
-    0.2.0
+    0.3.4
     ---------------------------------------------------------
-    # By default, results are wrapped in Item class
-    # Completely rewritten ActiveModel/ActiveRecord support
-    # Added infrastructure for loading "real" models from database (eagerly or in runtime)
-    # Deprecated the dynamic sort methods in favour of the 'sort { by :field_name }' syntax
-
-    0.2.1
-    ---------------------------------------------------------
-    # Lighweight check for index presence
-    # Added the 'settings' method for models to define index settings
-    # Fixed errors when importing data with will_paginate vs Kaminari (MongoDB)
-    # Added support for histogram facets [Paco Guzman]
-
-    0.3.0
-    ---------------------------------------------------------
-    # Isolated Tire ActiveModel integration into `tire` class and instance method.
-    
-      When there's no conflict with existing methods, Tire methods are added
-      to the class namespace, as well, so the change is 100% backwards-compatible.
-
-    0.3.3
-    ---------------------------------------------------------
-    # Added proper will_paginate compatibility
-    # Added support for plugging in another HTTP library (see lib/http/clients/curb for an example)
+    # Added documentation (RDoc annotations and README)
+    # Kaminari pagination support
+    # Bugfixes (dependency on ES running, callbacks, bogus exceptions)
 
   END
 end

data/test/integration/active_record_searchable_test.rb

@@ -29,6 +29,9 @@ module Tire
         create_table :active_record_class_with_tire_methods do |t|
           t.string     :title
         end
+        create_table :active_record_class_with_dynamic_index_names do |t|
+          t.string     :title
+        end
       end
     end
 
@@ -72,6 +75,14 @@ module Tire
         assert_equal   'Test', results.first.title
       end
 
+      should "raise exception on invalid query" do
+        ActiveRecordArticle.create! :title => 'Test'
+
+        assert_raise Search::SearchRequestFailed do
+          ActiveRecordArticle.search '[x'
+        end
+      end
+
       context "with eager loading" do
         setup do
           ActiveRecordArticle.destroy_all
@@ -147,11 +158,20 @@ module Tire
             results = ActiveRecordArticle.search 'test*', :sort => 'title', :per_page => 5, :page => 1
             assert_equal 5, results.size
 
+            # WillPaginate
+            #
             assert_equal 2, results.total_pages
             assert_equal 1, results.current_page
             assert_equal nil, results.previous_page
             assert_equal 2, results.next_page
 
+            # Kaminari
+            #
+            assert_equal 5, results.limit_value
+            assert_equal 9, results.total_count
+            assert_equal 2, results.num_pages
+            assert_equal 0, results.offset_value
+
             assert_equal 'Test1', results.first.title
           end
 
@@ -164,6 +184,12 @@ module Tire
             assert_equal 1, results.previous_page
             assert_equal nil, results.next_page
 
+            #kaminari
+            assert_equal 5, results.limit_value
+            assert_equal 9, results.total_count
+            assert_equal 2, results.num_pages
+            assert_equal 5, results.offset_value
+
             assert_equal 'Test6', results.first.title
           end
 
@@ -176,6 +202,12 @@ module Tire
             assert_equal 2, results.previous_page
             assert_equal nil, results.next_page
 
+            #kaminari
+            assert_equal 5, results.limit_value
+            assert_equal 9, results.total_count
+            assert_equal 2, results.num_pages
+            assert_equal 10, results.offset_value
+
             assert_nil results.first
           end
 
@@ -267,6 +299,21 @@ module Tire
 
       end
 
+      context "with dynamic index name" do
+        setup do
+          @a = ActiveRecordClassWithDynamicIndexName.create! :title => 'Test'
+          @a.index.refresh
+        end
+
+        should "search in proper index" do
+          assert_equal 'dynamic_index', ActiveRecordClassWithDynamicIndexName.index.name
+          assert_equal 'dynamic_index', @a.index.name
+
+          results = ActiveRecordClassWithDynamicIndexName.search 'test'
+          assert_equal 'dynamic_index', results.first._index
+        end
+      end
+
       context "within Rails" do
 
         setup do