elasticsearch-rails 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 056008177dc6455f594126c6d1402930964812d9
-  data.tar.gz: 07c8b5cfaaa536c67648df8d9d24ecee62f5eed4
+  metadata.gz: 0787291aba03d312879a2ce76404dcf85842a2bc
+  data.tar.gz: 271098b78bda71302678b132ab85d0a3efd8ef4d
 SHA512:
-  metadata.gz: d43e2b96ba3873e5b70652469d55a311537fba4cf9f020e6eec6638d816d3dc8e87c9b288b3fe9c1a5b285d1e57e022d09af23023d455902d9d8920e176a0395
-  data.tar.gz: a26d5d3fa224e6a7c7ff2752df9cf0c6ed8ec12a18a996c5d081ffa71437e3794fbede55cd010ab64647cd432953c7eedec45d52a4af967b222ee14d6f3359ed
+  metadata.gz: 39225728dce276bf9b5e2d7613912fd75fcbf208d3b9dd3c92ad8886e69eaa1355da24f2684a15590affcb9f54b246c6c23d4bd88274efe3156e4862cad88d8e
+  data.tar.gz: 05d38f3aa061b4c5dbe260c53eaeb3e79b3b73fc3e62b61304bfc76e5b596241e42dc366db6639e0cc3a66e36b9af8a000350c5f21bc9552f156338624dad3e6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.1.9
+
+* Added checks for proper launch order and other updates to the example application templates
+* Updated the example application to work with Elasticsearch 2.x
+* Used the `suggest` method instead of `response['suggest']` in the application template
+
 ## 0.1.8
 
 * Added an example application template that loads settings from a file

data/elasticsearch-rails.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.9.3"
 
   s.add_development_dependency "bundler", "~> 1.3"
-  s.add_development_dependency "rake"
+  s.add_development_dependency "rake", "< 11.0"
 
   s.add_development_dependency "elasticsearch-extensions"
   s.add_development_dependency "elasticsearch-model"

data/lib/elasticsearch/rails/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Rails
-    VERSION = "0.1.8"
+    VERSION = "0.1.9"
   end
 end

data/lib/rails/templates/02-pretty.rb

@@ -1,6 +1,9 @@
 # $ rails new searchapp --skip --skip-bundle --template https://raw.github.com/elasticsearch/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/02-pretty.rb
 
-# (See: 01-basic.rb)
+unless File.read('README.rdoc').include? '== [1] Basic'
+  say_status  "ERROR", "You have to run the 01-basic.rb template first.", :red
+  exit(1)
+end
 
 puts
 say_status  "README", "Updating Readme...\n", :yellow

data/lib/rails/templates/03-expert.rb

@@ -1,6 +1,25 @@
 #     $ rails new searchapp --skip --skip-bundle --template https://raw.github.com/elasticsearch/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/03-expert.rb
 
-# (See: 01-basic.rb, 02-pretty.rb)
+unless File.read('README.rdoc').include? '== [2] Pretty'
+  say_status  "ERROR", "You have to run the 01-basic.rb and 02-pretty.rb templates first.", :red
+  exit(1)
+end
+
+begin
+  require 'redis'
+rescue LoadError
+  say_status  "ERROR", "Please install the 'redis' gem before running this template", :red
+  exit(1)
+end
+
+begin
+  Redis.new.info
+rescue Redis::CannotConnectError
+  puts
+  say_status  "ERROR", "Redis not available", :red
+  say_status  "", "This template uses an asynchronous indexer via Sidekiq, and requires a running Redis server."
+  exit(1)
+end
 
 append_to_file 'README.rdoc', <<-README
 
@@ -189,7 +208,11 @@ run "bundle install"
 get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/indexer.rb',
     'app/workers/indexer.rb'
 
-git add:    "Gemfile* app/workers/"
+insert_into_file "test/test_helper.rb",
+                 "require 'sidekiq/testing'\n\n",
+                 before: "class ActiveSupport::TestCase\n"
+
+git add:    "Gemfile* app/workers/ test/test_helper.rb"
 git commit: "-m 'Added a Sidekiq indexer\n\nRun:\n\n    $ bundle exec sidekiq --queue elasticsearch --verbose\n\nSee http://sidekiq.org'"
 
 # ----- Add SearchController -----------------------------------------------------------------------

data/lib/rails/templates/04-dsl.rb

@@ -1,6 +1,9 @@
 #     $ rails new searchapp --skip --skip-bundle --template https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/04-dsl.rb
 
-# (See: 01-basic.rb, 02-pretty.rb, 03-expert.rb)
+unless File.read('README.rdoc').include? '== [3] Expert'
+  say_status  "ERROR", "You have to run the 01-basic.rb, 02-pretty.rb and 03-expert.rb templates first.", :red
+  exit(1)
+end
 
 append_to_file 'README.rdoc', <<-README
 
@@ -37,11 +40,11 @@ run "bundle install"
 
 # copy_file File.expand_path('../searchable.dsl.rb', __FILE__), 'app/models/concerns/searchable.rb', force: true
 get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/searchable.dsl.rb',
-    'app/models/concerns/searchable.rb'
+    'app/models/concerns/searchable.rb', force: true
 
 # copy_file File.expand_path('../index.html.dsl.erb', __FILE__), 'app/views/search/index.html.erb', force: true
 get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/index.html.dsl.erb',
-    'app/views/search/index.html.erb'
+    'app/views/search/index.html.erb', force: true
 
 gsub_file "test/controllers/search_controller_test.rb", %r{test "should return facets" do.*?end}m, <<-CODE
 test "should return aggregations" do

data/lib/rails/templates/05-settings-files.rb

@@ -25,7 +25,9 @@ git commit: "-m 'Setup the Searchable module to load settings from file'"
 
 # ----- Copy the articles_settings.json file -------------------------------------------------------
 
-copy_file File.expand_path('../articles_settings.json', __FILE__), 'config/elasticsearch/articles_settings.json'
+# copy_file File.expand_path('../articles_settings.json', __FILE__), 'config/elasticsearch/articles_settings.json'
+get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/articles_settings.json',
+    'config/elasticsearch/articles_settings.json', force: true
 
 git add:    "config/elasticsearch/articles_settings.json"
 git commit: "-m 'Create the articles settings file'"

data/lib/rails/templates/index.html.dsl.erb

@@ -47,13 +47,13 @@
   <hr>
 </div>
 
-<% if @articles.size < 1 && (suggestions = @articles.response.response['suggest']) && suggestions.present?  %>
+<% if @articles.size < 1 && @articles.response.suggestions.present? %>
 <div class="col-md-12">
   <p class="alert alert-warning">
     No documents have been found.
-    <% if suggestions['suggest_title'].present? || suggestions['suggest_body'].present? %>
+    <% if @articles.response.suggestions.terms.present? %>
       Maybe you mean
-      <%= suggestions.map { |k,v| v.first['options'] }.flatten.map {|v| v['text']}.uniq.map do |term|
+      <%= @articles.response.suggestions.terms.map do |term|
         link_to term, search_path(params.except(:controller, :action).merge q: term)
       end.to_sentence(last_word_connector: ' or ').html_safe %>?
     <% end %>

data/lib/rails/templates/index.html.erb

@@ -47,13 +47,13 @@
   <hr>
 </div>
 
-<% if @articles.size < 1 && (suggestions = @articles.response.response['suggest']) && suggestions.present?  %>
+<% if @articles.size < 1 && @articles.response.suggest.present? %>
 <div class="col-md-12">
   <p class="alert alert-warning">
     No documents have been found.
-    <% if suggestions['suggest_title'].present? || suggestions['suggest_body'].present? %>
+    <% if @articles.response.suggest['suggest_title'].present? || @articles.response.suggest['suggest_body'].present? %>
       Maybe you mean
-      <%= suggestions.map { |k,v| v.first['options'] }.flatten.map {|v| v['text']}.uniq.map do |term|
+      <%= @articles.response.suggest.map { |k,v| v.first['options'] }.flatten.map {|v| v['text']}.uniq.map do |term|
         link_to term, search_path(params.except(:controller, :action).merge q: term)
       end.to_sentence(last_word_connector: ' or ').html_safe %>?
     <% end %>
@@ -68,11 +68,11 @@
       <p class="panel-heading"><%= link_to 'All Sections &rarr;'.html_safe, search_path(params.except(:controller, :action).merge(c: nil))%></p>
 
       <div class="list-group">
-        <% @articles.response.response['facets']['categories']['terms'].each do |c| %>
+        <% @articles.response.response['aggregations']['categories']['categories']['buckets'].each do |c| %>
         <%=
-          link_to search_path(params.except(:controller, :action).merge(c: c['term'])),
-                  class: "list-group-item#{' active' if params[:c] == c['term']}" do
-                    c['term'].titleize.html_safe + content_tag(:small, c['count'], class: 'badge').html_safe
+          link_to search_path(params.except(:controller, :action).merge(c: c['key'])),
+                  class: "list-group-item#{' active' if params[:c] == c['key']}" do
+                    c['key'].titleize.html_safe + content_tag(:small, c['doc_count'], class: 'badge').html_safe
           end
         %>
         <% end %>
@@ -83,11 +83,11 @@
       <p class="panel-heading"><%= link_to 'All Authors &rarr;'.html_safe, search_path(params.except(:controller, :action).merge(a: nil))%></p>
 
       <div class="list-group">
-        <% @articles.response.response['facets']['authors']['terms'].each do |a| %>
+        <% @articles.response.response['aggregations']['authors']['authors']['buckets'].each do |a| %>
         <%=
-          link_to search_path(params.except(:controller, :action).merge(a: a['term'])),
-                  class: "list-group-item#{' active' if params[:a] == a['term']}" do
-                    a['term'].titleize.html_safe + content_tag(:small, a['count'], class: 'badge').html_safe
+          link_to search_path(params.except(:controller, :action).merge(a: a['key'])),
+                  class: "list-group-item#{' active' if params[:a] == a['key']}" do
+                    a['key'].titleize.html_safe + content_tag(:small, a['doc_count'], class: 'badge').html_safe
           end
         %>
         <% end %>
@@ -98,16 +98,16 @@
       <p class="panel-heading"><%= link_to 'Any Date &rarr;'.html_safe, search_path(params.except(:controller, :action).merge(w: nil))%></p>
 
       <div class="list-group">
-        <% @articles.response.response['facets']['published']['entries'].each do |w| %>
+        <% @articles.response.response['aggregations']['published']['published']['buckets'].each do |w| %>
         <%=
-          __start = Time.at(w['time']/1000)
+          __start = Time.at(w['key']/1000)
           __end   = __start.end_of_week
           __date  = __start.to_date.to_s(:iso)
 
           link_to search_path(params.except(:controller, :action).merge(w: __date)),
                   class: "list-group-item#{' active' if params[:w] == __date}" do
                     "#{__start.to_date.to_s(:short)} &mdash; #{__end.to_date.to_s(:short)}".html_safe + \
-                    content_tag(:small, w['count'], class: 'badge').html_safe
+                    content_tag(:small, w['doc_count'], class: 'badge').html_safe
           end
         %>
         <% end %>

data/lib/rails/templates/search_controller_test.dsl.rb

@@ -58,7 +58,7 @@ class SearchControllerTest < ActionController::TestCase
     get :index, q: 'one'
     assert_response :success
 
-    suggestions = assigns(:articles).response.response['suggest']
+    suggestions = assigns(:articles).response.suggest
 
     assert_equal 'one', suggestions['suggest_title'][0]['text']
   end

data/lib/rails/templates/search_controller_test.rb

@@ -30,7 +30,7 @@ class SearchControllerTest < ActionController::TestCase
 
     Article.find_by_title('Article Three').comments.create body: 'One'
 
-    Sidekiq::Queue.new("elasticsearch").clear
+    Sidekiq::Worker.clear_all
 
     Article.__elasticsearch__.import force: true
     Article.__elasticsearch__.refresh_index!
@@ -45,6 +45,7 @@ class SearchControllerTest < ActionController::TestCase
   test "should return search results in comments" do
     get :index, q: 'one', comments: 'y'
     assert_response :success
+
     assert_equal 4, assigns(:articles).size
   end
 
@@ -58,7 +59,7 @@ class SearchControllerTest < ActionController::TestCase
     get :index, q: 'one'
     assert_response :success
 
-    suggestions = assigns(:articles).response.response['suggest']
+    suggestions = assigns(:articles).response.suggest
 
     assert_equal 'one', suggestions['suggest_title'][0]['text']
   end
@@ -67,15 +68,15 @@ class SearchControllerTest < ActionController::TestCase
     get :index, q: 'one'
     assert_response :success
 
-    facets = assigns(:articles).response.response['facets']
+    aggregations = assigns(:articles).response.response['aggregations']
 
-    assert_equal 2, facets['categories']['terms'].size
-    assert_equal 2, facets['authors']['terms'].size
-    assert_equal 2, facets['published']['entries'].size
+    assert_equal 2, aggregations['categories']['categories']['buckets'].size
+    assert_equal 2, aggregations['authors']['authors']['buckets'].size
+    assert_equal 2, aggregations['published']['published']['buckets'].size
 
-    assert_equal 'One', facets['categories']['terms'][0]['term']
-    assert_equal 'John Smith', facets['authors']['terms'][0]['term']
-    assert_equal 1425254400000, facets['published']['entries'][0]['time']
+    assert_equal 'One', aggregations['categories']['categories']['buckets'][0]['key']
+    assert_equal 'John Smith', aggregations['authors']['authors']['buckets'][0]['key']
+    assert_equal 1425254400000, aggregations['published']['published']['buckets'][0]['key']
   end
 
   test "should sort on the published date" do
@@ -104,13 +105,13 @@ class SearchControllerTest < ActionController::TestCase
 
     assert_equal 2, assigns(:articles).size
 
-    facets = assigns(:articles).response.response['facets']
+    aggregations = assigns(:articles).response.response['aggregations']
 
-    assert_equal 1, facets['authors']['terms'].size
-    assert_equal 1, facets['published']['entries'].size
+    assert_equal 1, aggregations['authors']['authors']['buckets'].size
+    assert_equal 1, aggregations['published']['published']['buckets'].size
 
     # Do NOT filter the category facet
-    assert_equal 2, facets['categories']['terms'].size
+    assert_equal 2, aggregations['categories']['categories']['buckets'].size
   end
 
   test "should filter search results and the category and published date facets when user selects a category" do
@@ -119,12 +120,12 @@ class SearchControllerTest < ActionController::TestCase
 
     assert_equal 1, assigns(:articles).size
 
-    facets = assigns(:articles).response.response['facets']
+    aggregations = assigns(:articles).response.response['aggregations']
 
-    assert_equal 1, facets['categories']['terms'].size
-    assert_equal 1, facets['published']['entries'].size
+    assert_equal 1, aggregations['categories']['categories']['buckets'].size
+    assert_equal 1, aggregations['published']['published']['buckets'].size
 
     # Do NOT filter the authors facet
-    assert_equal 2, facets['authors']['terms'].size
+    assert_equal 2, aggregations['authors']['authors']['buckets'].size
   end
 end

data/lib/rails/templates/searchable.rb

@@ -71,15 +71,14 @@ module Searchable
     #
     def self.search(query, options={})
 
-      # Prefill and set the filters (top-level `filter` and `facet_filter` elements)
+      # Prefill and set the filters (top-level `post_filter` and aggregation `filter` elements)
       #
       __set_filters = lambda do |key, f|
+        @search_definition[:post_filter][:and] ||= []
+        @search_definition[:post_filter][:and]  |= [f]
 
-        @search_definition[:filter][:and] ||= []
-        @search_definition[:filter][:and]  |= [f]
-
-        @search_definition[:facets][key.to_sym][:facet_filter][:and] ||= []
-        @search_definition[:facets][key.to_sym][:facet_filter][:and]  |= [f]
+        @search_definition[:aggregations][key.to_sym][:filter][:bool][:must] ||= []
+        @search_definition[:aggregations][key.to_sym][:filter][:bool][:must]  |= [f]
       end
 
       @search_definition = {
@@ -95,27 +94,22 @@ module Searchable
           }
         },
 
-        filter: {},
+        post_filter: {},
 
-        facets: {
+        aggregations: {
           categories: {
-            terms: {
-              field: 'categories'
-            },
-            facet_filter: {}
+            filter: { bool: { must: [ match_all: {} ] } },
+            aggregations: { categories: { terms: { field: 'categories' } } }
           },
           authors: {
-            terms: {
-              field: 'authors.full_name.raw'
-            },
-            facet_filter: {}
+            filter: { bool: { must: [ match_all: {} ] } },
+            aggregations: { authors: { terms: { field: 'authors.full_name.raw' } } }
           },
           published: {
-            date_histogram: {
-              field: 'published_on',
-              interval: 'week'
-            },
-            facet_filter: {}
+            filter: { bool: { must: [ match_all: {} ] } },
+            aggregations: {
+              published: { date_histogram: { field: 'published_on', interval: 'week' } }
+            }
           }
         }
       }
@@ -174,7 +168,7 @@ module Searchable
             query: {
               multi_match: {
                 query: query,
-                fields: ['body'],
+                fields: ['comments.body'],
                 operator: 'and'
               }
             }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: elasticsearch-extensions
   requirement: !ruby/object:Gem::Requirement