elasticsearch-rails 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 702e99d736daeaca35a28b5c9b0410c22076eee2
-  data.tar.gz: f0bcd67eb479b7eff5b9324ca5b3c646dc6931c9
+  metadata.gz: 6acf0a64b1de80131443fe7818364e938af6e466
+  data.tar.gz: f234b64f5d8eda579694406c216bffb37d08a991
 SHA512:
-  metadata.gz: 8191b30a62f1f5dffa9d4efa6b0a0c1b08beb9992f8cc52036c427886f7da1ff51e191a8e39df62e5f29c63d0495c47860d7c2724050a119eb7534adf2f0c08a
-  data.tar.gz: 91710af6b69d1bf1360b01994949f7e6cb5515006cb78242c9986bf66c7acc69a943563d841dec322d7cc4a93e556ec9f809441318f6501e7e7f073f836fe887
+  metadata.gz: efc3dc4312de0805bd9742029a4b1e09b1b03fffbb3460e4bfb25b7e897d21d7d3f3a5c5bb28f4606ec24438584d45d096a1d51c1f9cf2403508cfd42a3190f7
+  data.tar.gz: e50eee5092e29fa9c24fcf96ad64ccc791008ce1b2eb9d2df1e5ddad860150b468d66451ea77c79f220159aa3432d9e7c34d338e6c2a64394d5f549817dba93c

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 0.1.7
+
+* Updated dependencies for the gem and example applications
+* Fixed various small errors in the `01-basic.rb` template
+* Fixed error when inserting the Kaminari gem into Gemfile in the 02-pretty.rb template
+* Fixed incorrect regex for adding Rails instrumentation into the application.rb in the `02-pretty.rb` template
+* Fixed other small errors in the `02-pretty.rb` template
+* Improved and added tests for the generated application from the `02-pretty.rb` template
+* Added the `04-dsl.rb` template which uses the `elasticsearch-dsl` gem to build the search definition
+
 ## 0.1.6
 
 * Fixed errors in templates for the Rails example applications

data/elasticsearch-rails.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "elasticsearch-model"
 
   s.add_development_dependency "oj"
-  s.add_development_dependency "rails",  "> 3.0"
+  s.add_development_dependency "rails",  ">= 3.1"
 
   s.add_development_dependency "lograge"
 

data/lib/elasticsearch/rails/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Rails
-    VERSION = "0.1.6"
+    VERSION = "0.1.7"
   end
 end

data/lib/rails/templates/01-basic.rb

@@ -115,8 +115,7 @@ end
 
 # ----- Auxiliary gems ----------------------------------------------------------------------------
 
-gem 'turn',  group: 'test'
-gem 'mocha', group: 'test', require: 'mocha/setup'
+gem 'mocha', group: 'test', require: 'mocha/api'
 
 # ----- Remove CoffeeScript, Sass and "all that jazz" ---------------------------------------------
 
@@ -209,9 +208,10 @@ inject_into_file 'app/controllers/articles_controller.rb', before: %r|^\s*# GET
   CODE
 end
 
-inject_into_file 'app/views/articles/index.html.erb', after: %r{<h1>Listing articles</h1>} do
+inject_into_file 'app/views/articles/index.html.erb', after: %r{<h1>Listing articles</h1>}i do
   <<-CODE
 
+
   <hr>
 
   <%= form_tag search_articles_path, method: 'get' do %>
@@ -221,7 +221,6 @@ inject_into_file 'app/views/articles/index.html.erb', after: %r{<h1>Listing arti
   <% end %>
 
   <hr>
-
   CODE
 end
 

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

@@ -29,8 +29,8 @@ say_status  "Rubygems", "Adding Rails logger integration...\n", :yellow
 puts        '-'*80, ''; sleep 0.25
 
 insert_into_file 'config/application.rb',
-                 "\n\nrequire 'elasticsearch/rails/instrumentation'\n",
-                 after: 'Bundler.require(:default, Rails.env)'
+                 "\n\nrequire 'elasticsearch/rails/instrumentation'",
+                 after: /Bundler\.require.+$/
 
 git add:    "config/application.rb"
 git commit: "-m 'Added the Rails logger integration to application.rb'"
@@ -43,7 +43,7 @@ puts        '-'*80, ''; sleep 0.25
 
 # NOTE: Kaminari has to be loaded before Elasticsearch::Model so the callbacks are executed
 #
-insert_into_file 'Gemfile', <<-CODE, before: 'gem "elasticsearch"'
+insert_into_file 'Gemfile', <<-CODE, before: /gem ["']elasticsearch["'].+$/
 
 # NOTE: Kaminari has to be loaded before Elasticsearch::Model so the callbacks are executed
 gem 'kaminari'
@@ -86,6 +86,14 @@ insert_into_file 'app/models/article.rb', <<-CODE, after: 'include Elasticsearch
   end
 CODE
 
+insert_into_file "#{Rails::VERSION::STRING > '4' ? 'test/models' : 'test/unit' }/article_test.rb", <<-CODE, after: /class ArticleTest < ActiveSupport::TestCase$/
+
+  teardown do
+    Article.__elasticsearch__.unstub(:search)
+  end
+
+CODE
+
 gsub_file "#{Rails::VERSION::STRING > '4' ? 'test/models' : 'test/unit' }/article_test.rb", %r{# test "the truth" do.*?# end}m, <<-CODE
 
   test "has a search method delegating to __elasticsearch__" do

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

@@ -154,6 +154,8 @@ class Article < ActiveRecord::Base
 end
 CODE
 
+gsub_file "#{Rails::VERSION::STRING > '4' ? 'test/models' : 'test/unit' }/article_test.rb", %r{assert_equal 'foo', definition\[:query\]\[:multi_match\]\[:query\]}, "assert_equal 'foo', definition.to_hash[:query][:bool][:should][0][:multi_match][:query]"
+
 # copy_file File.expand_path('../searchable.rb', __FILE__), 'app/models/concerns/searchable.rb'
 get 'https://raw.github.com/elasticsearch/elasticsearch-rails/templates/elasticsearch-rails/lib/rails/templates/searchable.rb',
     'app/models/concerns/searchable.rb'
@@ -170,7 +172,7 @@ insert_into_file "app/models/article.rb", after: "ActiveRecord::Base" do
   CODE
 end
 
-git add:    "app/models/"
+git add:    "app/models/ test/models"
 git commit: "-m 'Refactored the Elasticsearch integration into a concern\n\nSee:\n\n* http://37signals.com/svn/posts/3372-put-chubby-models-on-a-diet-with-concerns\n* http://joshsymonds.com/blog/2012/10/25/rails-concerns-v-searchable-with-elasticsearch/'"
 
 # ----- Add Sidekiq indexer -----------------------------------------------------------------------
@@ -199,8 +201,6 @@ puts        '-'*80, ''; sleep 0.25
 create_file 'app/controllers/search_controller.rb' do
   <<-CODE.gsub(/^  /, '')
   class SearchController < ApplicationController
-    respond_to :json, :html
-
     def index
       options = {
         category:       params[:c],
@@ -211,15 +211,16 @@ create_file 'app/controllers/search_controller.rb' do
         comments:       params[:comments]
       }
       @articles = Article.search(params[:q], options).page(params[:page]).results
-
-      respond_with @articles
     end
-
   end
 
   CODE
 end
 
+copy_file File.expand_path('../search_controller_test.rb', __FILE__), 'test/controllers/search_controller_test.rb'
+# get 'https://raw.github.com/elasticsearch/elasticsearch-rails/templates/elasticsearch-rails/lib/rails/templates/search_controller_test.rb',
+    'test/controllers/search_controller_test.rb'
+
 route "get '/search', to: 'search#index', as: 'search'"
 gsub_file 'config/routes.rb', %r{root to: 'articles#index'$}, "root to: 'search#index'"
 
@@ -231,7 +232,7 @@ get 'https://raw.github.com/elasticsearch/elasticsearch-rails/templates/elastics
 get 'https://raw.github.com/elasticsearch/elasticsearch-rails/templates/elasticsearch-rails/lib/rails/templates/search.css',
     'app/assets/stylesheets/search.css'
 
-git add:    "app/controllers/ config/routes.rb"
+git add:    "app/controllers/ test/controllers/ config/routes.rb"
 git add:    "app/views/search/ app/assets/stylesheets/search.css"
 git commit: "-m 'Added SearchController#index'"
 

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

@@ -0,0 +1,128 @@
+#     $ 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)
+
+append_to_file 'README.rdoc', <<-README
+
+== [4] DSL
+
+The `dsl` template refactors the search definition in SearchController#index
+to use the [`elasticsearch-dsl`](https://github.com/elastic/elasticsearch-ruby/tree/dsl/elasticsearch-dsl)
+Rubygem for better expresivity and readability of the code.
+
+README
+
+git add:    "README.rdoc"
+git commit: "-m '[03] Updated the application README'"
+
+run 'rm -f app/assets/stylesheets/*.scss'
+run 'rm -f app/assets/javascripts/*.coffee'
+
+# ----- Add gems into Gemfile ---------------------------------------------------------------------
+
+puts
+say_status  "Rubygems", "Adding Rubygems into Gemfile...\n", :yellow
+puts        '-'*80, ''; sleep 0.25
+
+gem "elasticsearch-dsl", git: "git://github.com/elastic/elasticsearch-ruby.git"
+
+git add:    "Gemfile*"
+git commit: "-m 'Added the `elasticsearch-dsl` gem'"
+
+# ----- Run bundle install ------------------------------------------------------------------------
+
+run "bundle install"
+
+# ----- Change the search definition implementation and associated views and tests ----------------
+
+# 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'
+
+# 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'
+
+gsub_file "test/controllers/search_controller_test.rb", %r{test "should return facets" do.*?end}m, <<-CODE
+test "should return aggregations" do
+    get :index, q: 'one'
+    assert_response :success
+
+    aggregations = assigns(:articles).response.response['aggregations']
+
+    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 'John Smith', aggregations['authors']['authors']['buckets'][0]['key']
+    assert_equal 'One', aggregations['categories']['categories']['buckets'][0]['key']
+    assert_equal '2015-03-02T00:00:00.000Z', aggregations['published']['published']['buckets'][0]['key_as_string']
+  end
+CODE
+
+gsub_file "test/controllers/search_controller_test.rb", %r{test "should filter search results and the author and published date facets when user selects a category" do.*?end}m, <<-CODE
+test "should filter search results and the author and published date facets when user selects a category" do
+    get :index, q: 'one', c: 'One'
+    assert_response :success
+
+    assert_equal 2, assigns(:articles).size
+
+    aggregations = assigns(:articles).response.response['aggregations']
+
+    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, aggregations['categories']['categories']['buckets'].size
+  end
+CODE
+
+gsub_file "test/controllers/search_controller_test.rb", %r{test "should filter search results and the category and published date facets when user selects a category" do.*?end}m, <<-CODE
+test "should filter search results and the category and published date facets when user selects a category" do
+    get :index, q: 'one', a: 'Mary Smith'
+    assert_response :success
+
+    assert_equal 1, assigns(:articles).size
+
+    aggregations = assigns(:articles).response.response['aggregations']
+
+    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, aggregations['authors']['authors']['buckets'].size
+  end
+CODE
+
+git add:    "app/models/concerns/ app/views/search/ test/controllers/search_controller_test.rb"
+git commit: "-m 'Updated the Article.search method to use the Ruby DSL and updated the associated views and tests'"
+
+# ----- Print Git log -----------------------------------------------------------------------------
+
+puts
+say_status  "Git", "Details about the application:", :yellow
+puts        '-'*80, ''
+
+git tag: "dsl"
+git log: "--reverse --oneline HEAD...expert"
+
+# ----- Start the application ---------------------------------------------------------------------
+
+unless ENV['RAILS_NO_SERVER_START']
+  require 'net/http'
+  if (begin; Net::HTTP.get(URI('http://localhost:3000')); rescue Errno::ECONNREFUSED; false; rescue Exception; true; end)
+    puts        "\n"
+    say_status  "ERROR", "Some other application is running on port 3000!\n", :red
+    puts        '-'*80
+
+    port = ask("Please provide free port:", :bold)
+  else
+    port = '3000'
+  end
+
+  puts  "", "="*80
+  say_status  "DONE", "\e[1mStarting the application. Open http://localhost:#{port}\e[0m", :yellow
+  puts  "="*80, ""
+
+  run  "rails server --port=#{port}"
+end

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

@@ -0,0 +1,160 @@
+<div class="col-md-12">
+  <h1 class="text-right"><%= link_to 'Search New York Times articles', root_path %></h1>
+
+  <%= form_tag search_path, method: 'get', role: 'search' do %>
+    <div class="input-group">
+      <%= text_field_tag :q, params[:q], class: 'form-control', placeholder: 'Search...' %>
+
+      <span class="input-group-btn">
+        <button type="submit" class="btn btn-default">
+          <span class="glyphicon glyphicon-search"></span>
+        </button>
+      </span>
+    </div>
+
+    <div id="form-options" class="clearfix">
+      <div class="btn-group pull-left">
+        <label class="checkbox-inline">
+          <%= check_box_tag 'comments', 'y', params[:comments] == 'y', onclick: "$(this).closest('form').submit()" %>
+          Search in comments?
+        </label>
+        <% params.slice(:a, :c, :s).each do |name, value| %>
+          <%= hidden_field_tag name, value %>
+        <% end %>
+      </div>
+
+      <div class="btn-group pull-right">
+        <p style="float: left; margin: 0.1em 0 0 0"><small>Displaying <%= (params[:page] || 1).to_i.ordinalize %> page with <%= @articles.size %> articles
+                   of <strong>total <%= @articles.total %></strong></small></p>
+
+        <button class="btn btn-default btn-xs dropdown-toggle" type="button" data-toggle="dropdown" style="margin-left: 0.5em">
+          <% sort = case
+              when params[:s] then params[:s]
+              when params[:q].blank? then 'published_on'
+              else 'relevancy'
+             end
+          %>
+          sorted by <%= sort.humanize.downcase %> <span class="caret"></span>
+        </button>
+        <ul class="dropdown-menu" role="menu">
+          <li><%= link_to "Sort by published on", search_path(params.except(:controller, :action).merge(s: 'published_on')), class: 'btn-xs' %></li>
+          <li><%= link_to "Sort by relevancy",    search_path(params.except(:controller, :action).merge(s: nil)), class: 'btn-xs' %></li>
+        </ul>
+      </div>
+    </div>
+  <% end %>
+
+  <hr>
+</div>
+
+<% if @articles.size < 1 && (suggestions = @articles.response.response['suggest']) && 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? %>
+      Maybe you mean
+      <%= suggestions.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 %>
+  </p>
+</div>
+<% end %>
+
+<div id="facets" class="col-md-3">
+  <% unless @articles.size < 1 %>
+
+    <div class="categories panel panel-default">
+      <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['aggregations']['categories']['categories']['buckets'].each do |c| %>
+        <%=
+          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 %>
+      </div>
+    </div>
+
+    <div class="authors panel panel-default">
+      <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['aggregations']['authors']['authors']['buckets'].each do |a| %>
+        <%=
+          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 %>
+      </div>
+    </div>
+
+    <div class="authors panel panel-default">
+      <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['aggregations']['published']['published']['buckets'].each do |w| %>
+        <%=
+          __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['doc_count'], class: 'badge').html_safe
+          end
+        %>
+        <% end %>
+      </div>
+    </div>
+  <% end %>
+</div>
+
+<div class="col-md-9">
+  <div id="results">
+    <% @articles.each do |article|  %>
+      <div class="result">
+        <h3 class="title">
+          <%= (article.try(:highlight).try(:title) ? article.highlight.title.join.html_safe : article.title) %>
+          <small class="category"><%= article.categories.to_sentence %></small>
+        </h3>
+
+        <p class="body">
+          <% if article.try(:highlight).try(:abstract) %>
+            <%= article.highlight.abstract.join.html_safe %>
+          <% else  %>
+            <%= article.try(:highlight).try(:content) ? article.highlight.content.join('&hellip;').html_safe : article.abstract %>
+          <% end  %>
+        </p>
+
+        <% if comments = article.try(:highlight) && article.highlight['comments.body'] %>
+        <p class="comments">
+          Comments: <%= comments.join('&hellip;').html_safe %>
+        </p>
+        <% end  %>
+
+        <p class="text-muted">
+          <small>Authors: <%= article.authors.map(&:full_name).to_sentence %></small> |
+          <small>Published: <%= article.published_on %></small> |
+          <small>Score: <%= article._score %></small>
+        </p>
+      </div>
+    <% end %>
+  </div>
+
+  <ul class="pager">
+    <li class="previous"><%= link_to_previous_page @articles, 'Previous Page', params: params.slice(:q, :c, :a, :comments) %></li>
+    <li class="next"><%= link_to_next_page     @articles, 'Next Page', params: params.slice(:q, :c, :a, :comments) %></li>
+  </ul>
+
+</div>
+
+<div class="footer <%= @articles.size < 1 ? 'col-md-12' : 'col-md-9 col-md-offset-3' %>">
+  <p><small>Content provided by <a href="http://nytimes.com"><em>The New York Times</em></a>.</small></p>
+</div>

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

@@ -37,8 +37,8 @@
           sorted by <%= sort.humanize.downcase %> <span class="caret"></span>
         </button>
         <ul class="dropdown-menu" role="menu">
-          <li><%= link_to "Sort by published on", search_path(params.merge(s: 'published_on')), class: 'btn-xs' %></li>
-          <li><%= link_to "Sort by relevancy",    search_path(params.merge(s: nil)), class: 'btn-xs' %></li>
+          <li><%= link_to "Sort by published on", search_path(params.except(:controller, :action).merge(s: 'published_on')), class: 'btn-xs' %></li>
+          <li><%= link_to "Sort by relevancy",    search_path(params.except(:controller, :action).merge(s: nil)), class: 'btn-xs' %></li>
         </ul>
       </div>
     </div>
@@ -54,7 +54,7 @@
     <% if suggestions['suggest_title'].present? || suggestions['suggest_body'].present? %>
       Maybe you mean
       <%= suggestions.map { |k,v| v.first['options'] }.flatten.map {|v| v['text']}.uniq.map do |term|
-        link_to term, search_path(params.merge q: term)
+        link_to term, search_path(params.except(:controller, :action).merge q: term)
       end.to_sentence(last_word_connector: ' or ').html_safe %>?
     <% end %>
   </p>
@@ -65,12 +65,12 @@
   <% unless @articles.size < 1 %>
 
     <div class="categories panel panel-default">
-      <p class="panel-heading"><%= link_to 'All Sections &rarr;'.html_safe, search_path(params.merge(c: nil))%></p>
+      <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| %>
         <%=
-          link_to search_path(params.merge(c: c['term'])),
+          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
           end
@@ -80,12 +80,12 @@
     </div>
 
     <div class="authors panel panel-default">
-      <p class="panel-heading"><%= link_to 'All Authors &rarr;'.html_safe, search_path(params.merge(a: nil))%></p>
+      <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| %>
         <%=
-          link_to search_path(params.merge(a: a['term'])),
+          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
           end
@@ -95,7 +95,7 @@
     </div>
 
     <div class="authors panel panel-default">
-      <p class="panel-heading"><%= link_to 'Any Date &rarr;'.html_safe, search_path(params.merge(w: nil))%></p>
+      <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| %>
@@ -104,7 +104,7 @@
           __end   = __start.end_of_week
           __date  = __start.to_date.to_s(:iso)
 
-          link_to search_path(params.merge(w: __date)),
+          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

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

@@ -0,0 +1,130 @@
+require 'test_helper'
+
+class SearchControllerTest < ActionController::TestCase
+  setup do
+    Time.stubs(:now).returns(Time.parse('2015-03-16 10:00:00 UTC'))
+
+    Article.delete_all
+
+    articles = [
+      { title: 'Article One', abstract: 'One', content: 'One', published_on: 1.day.ago, category_title: 'One', author_first_name: 'John', author_last_name: 'Smith' },
+      { title: 'Article One Another', abstract: '', content: '', published_on: 2.days.ago, category_title: 'One', author_first_name: 'John', author_last_name: 'Smith' },
+      { title: 'Article One Two', abstract: '', content: '', published_on: 10.days.ago, category_title: 'Two', author_first_name: 'Mary', author_last_name: 'Smith' },
+      { title: 'Article Two', abstract: '', content: '', published_on: 12.days.ago, category_title: 'Two', author_first_name: 'Mary', author_last_name: 'Smith' },
+      { title: 'Article Three', abstract: '', content: '', published_on: 12.days.ago, category_title: 'Three', author_first_name: 'Alice', author_last_name: 'Smith' }
+    ]
+
+    articles.each do |a|
+      article = Article.create! \
+        title:    a[:title],
+        abstract: a[:abstract],
+        content:  a[:content],
+        published_on: a[:published_on]
+
+      article.categories << Category.find_or_create_by!(title: a[:category_title])
+
+      article.authors << Author.find_or_create_by!(first_name: a[:author_first_name], last_name: a[:author_last_name])
+
+      article.save!
+    end
+
+    Article.find_by_title('Article Three').comments.create body: 'One'
+
+    Sidekiq::Queue.new("elasticsearch").clear
+
+    Article.__elasticsearch__.import force: true
+    Article.__elasticsearch__.refresh_index!
+  end
+
+  test "should return search results" do
+    get :index, q: 'one'
+    assert_response :success
+    assert_equal 3, assigns(:articles).size
+  end
+
+  test "should return search results in comments" do
+    get :index, q: 'one', comments: 'y'
+    assert_response :success
+    assert_equal 4, assigns(:articles).size
+  end
+
+  test "should return highlighted snippets" do
+    get :index, q: 'one'
+    assert_response :success
+    assert_match %r{<em class="label label-highlight">One</em>}, assigns(:articles).first.highlight.title.first
+  end
+
+  test "should return suggestions" do
+    get :index, q: 'one'
+    assert_response :success
+
+    suggestions = assigns(:articles).response.response['suggest']
+
+    assert_equal 'one', suggestions['suggest_title'][0]['text']
+  end
+
+  test "should return aggregations" do
+    get :index, q: 'one'
+    assert_response :success
+
+    aggregations = assigns(:articles).response.response['aggregations']
+
+    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 'John Smith', aggregations['authors']['authors']['buckets'][0]['key']
+    assert_equal 'One', aggregations['categories']['categories']['buckets'][0]['key']
+    assert_equal '2015-03-02T00:00:00.000Z', aggregations['published']['published']['buckets'][0]['key_as_string']
+  end
+
+  test "should sort on the published date" do
+    get :index, q: 'one', s: 'published_on'
+    assert_response :success
+
+    assert_equal 3, assigns(:articles).size
+    assert_equal '2015-03-15', assigns(:articles)[0].published_on
+    assert_equal '2015-03-14', assigns(:articles)[1].published_on
+    assert_equal '2015-03-06', assigns(:articles)[2].published_on
+  end
+
+  test "should sort on the published date when no query is provided" do
+    get :index, q: ''
+    assert_response :success
+
+    assert_equal 5, assigns(:articles).size
+    assert_equal '2015-03-15', assigns(:articles)[0].published_on
+    assert_equal '2015-03-14', assigns(:articles)[1].published_on
+    assert_equal '2015-03-06', assigns(:articles)[2].published_on
+  end
+
+  test "should filter search results and the author and published date facets when user selects a category" do
+    get :index, q: 'one', c: 'One'
+    assert_response :success
+
+    assert_equal 2, assigns(:articles).size
+
+    aggregations = assigns(:articles).response.response['aggregations']
+
+    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, aggregations['categories']['categories']['buckets'].size
+  end
+
+  test "should filter search results and the category and published date facets when user selects a category" do
+    get :index, q: 'one', a: 'Mary Smith'
+    assert_response :success
+
+    assert_equal 1, assigns(:articles).size
+
+    aggregations = assigns(:articles).response.response['aggregations']
+
+    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, aggregations['authors']['authors']['buckets'].size
+  end
+end

data/lib/rails/templates/search_controller_test.rb

@@ -0,0 +1,130 @@
+require 'test_helper'
+
+class SearchControllerTest < ActionController::TestCase
+  setup do
+    Time.stubs(:now).returns(Time.parse('2015-03-16 10:00:00 UTC'))
+
+    Article.delete_all
+
+    articles = [
+      { title: 'Article One', abstract: 'One', content: 'One', published_on: 1.day.ago, category_title: 'One', author_first_name: 'John', author_last_name: 'Smith' },
+      { title: 'Article One Another', abstract: '', content: '', published_on: 2.days.ago, category_title: 'One', author_first_name: 'John', author_last_name: 'Smith' },
+      { title: 'Article One Two', abstract: '', content: '', published_on: 10.days.ago, category_title: 'Two', author_first_name: 'Mary', author_last_name: 'Smith' },
+      { title: 'Article Two', abstract: '', content: '', published_on: 12.days.ago, category_title: 'Two', author_first_name: 'Mary', author_last_name: 'Smith' },
+      { title: 'Article Three', abstract: '', content: '', published_on: 12.days.ago, category_title: 'Three', author_first_name: 'Alice', author_last_name: 'Smith' }
+    ]
+
+    articles.each do |a|
+      article = Article.create! \
+        title:    a[:title],
+        abstract: a[:abstract],
+        content:  a[:content],
+        published_on: a[:published_on]
+
+      article.categories << Category.find_or_create_by!(title: a[:category_title])
+
+      article.authors << Author.find_or_create_by!(first_name: a[:author_first_name], last_name: a[:author_last_name])
+
+      article.save!
+    end
+
+    Article.find_by_title('Article Three').comments.create body: 'One'
+
+    Sidekiq::Queue.new("elasticsearch").clear
+
+    Article.__elasticsearch__.import force: true
+    Article.__elasticsearch__.refresh_index!
+  end
+
+  test "should return search results" do
+    get :index, q: 'one'
+    assert_response :success
+    assert_equal 3, assigns(:articles).size
+  end
+
+  test "should return search results in comments" do
+    get :index, q: 'one', comments: 'y'
+    assert_response :success
+    assert_equal 4, assigns(:articles).size
+  end
+
+  test "should return highlighted snippets" do
+    get :index, q: 'one'
+    assert_response :success
+    assert_match %r{<em class="label label-highlight">One</em>}, assigns(:articles).first.highlight.title.first
+  end
+
+  test "should return suggestions" do
+    get :index, q: 'one'
+    assert_response :success
+
+    suggestions = assigns(:articles).response.response['suggest']
+
+    assert_equal 'one', suggestions['suggest_title'][0]['text']
+  end
+
+  test "should return facets" do
+    get :index, q: 'one'
+    assert_response :success
+
+    facets = assigns(:articles).response.response['facets']
+
+    assert_equal 2, facets['categories']['terms'].size
+    assert_equal 2, facets['authors']['terms'].size
+    assert_equal 2, facets['published']['entries'].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']
+  end
+
+  test "should sort on the published date" do
+    get :index, q: 'one', s: 'published_on'
+    assert_response :success
+
+    assert_equal 3, assigns(:articles).size
+    assert_equal '2015-03-15', assigns(:articles)[0].published_on
+    assert_equal '2015-03-14', assigns(:articles)[1].published_on
+    assert_equal '2015-03-06', assigns(:articles)[2].published_on
+  end
+
+  test "should sort on the published date when no query is provided" do
+    get :index, q: ''
+    assert_response :success
+
+    assert_equal 5, assigns(:articles).size
+    assert_equal '2015-03-15', assigns(:articles)[0].published_on
+    assert_equal '2015-03-14', assigns(:articles)[1].published_on
+    assert_equal '2015-03-06', assigns(:articles)[2].published_on
+  end
+
+  test "should filter search results and the author and published date facets when user selects a category" do
+    get :index, q: 'one', c: 'One'
+    assert_response :success
+
+    assert_equal 2, assigns(:articles).size
+
+    facets = assigns(:articles).response.response['facets']
+
+    assert_equal 1, facets['authors']['terms'].size
+    assert_equal 1, facets['published']['entries'].size
+
+    # Do NOT filter the category facet
+    assert_equal 2, facets['categories']['terms'].size
+  end
+
+  test "should filter search results and the category and published date facets when user selects a category" do
+    get :index, q: 'one', a: 'Mary Smith'
+    assert_response :success
+
+    assert_equal 1, assigns(:articles).size
+
+    facets = assigns(:articles).response.response['facets']
+
+    assert_equal 1, facets['categories']['terms'].size
+    assert_equal 1, facets['published']['entries'].size
+
+    # Do NOT filter the authors facet
+    assert_equal 2, facets['authors']['terms'].size
+  end
+end

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

@@ -0,0 +1,217 @@
+module Searchable
+  extend ActiveSupport::Concern
+
+  included do
+    include Elasticsearch::Model
+
+    # Customize the index name
+    #
+    index_name [Rails.application.engine_name, Rails.env].join('_')
+
+    # Set up index configuration and mapping
+    #
+    settings index: { number_of_shards: 1, number_of_replicas: 0 } do
+      mapping do
+        indexes :title, type: 'multi_field' do
+          indexes :title,     analyzer: 'snowball'
+          indexes :tokenized, analyzer: 'simple'
+        end
+
+        indexes :content, type: 'multi_field' do
+          indexes :content,   analyzer: 'snowball'
+          indexes :tokenized, analyzer: 'simple'
+        end
+
+        indexes :published_on, type: 'date'
+
+        indexes :authors do
+          indexes :full_name, type: 'multi_field' do
+            indexes :full_name
+            indexes :raw, analyzer: 'keyword'
+          end
+        end
+
+        indexes :categories, analyzer: 'keyword'
+
+        indexes :comments, type: 'nested' do
+          indexes :body, analyzer: 'snowball'
+          indexes :stars
+          indexes :pick
+          indexes :user, analyzer: 'keyword'
+          indexes :user_location, type: 'multi_field' do
+            indexes :user_location
+            indexes :raw, analyzer: 'keyword'
+          end
+        end
+      end
+    end
+
+    # Set up callbacks for updating the index on model changes
+    #
+    after_commit lambda { Indexer.perform_async(:index,  self.class.to_s, self.id) }, on: :create
+    after_commit lambda { Indexer.perform_async(:update, self.class.to_s, self.id) }, on: :update
+    after_commit lambda { Indexer.perform_async(:delete, self.class.to_s, self.id) }, on: :destroy
+    after_touch  lambda { Indexer.perform_async(:update, self.class.to_s, self.id) }
+
+    # Customize the JSON serialization for Elasticsearch
+    #
+    def as_indexed_json(options={})
+      hash = self.as_json(
+        include: { authors:    { methods: [:full_name], only: [:full_name] },
+                   comments:   { only: [:body, :stars, :pick, :user, :user_location] }
+                 })
+      hash['categories'] = self.categories.map(&:title)
+      hash
+    end
+
+    # Return documents matching the user's query, include highlights and aggregations in response,
+    # and implement a "cross" faceted navigation
+    #
+    # @param q [String] The user query
+    # @return [Elasticsearch::Model::Response::Response]
+    #
+    def self.search(q, options={})
+      @search_definition = Elasticsearch::DSL::Search.search do
+        query do
+
+          # If a user query is present...
+          #
+          unless q.blank?
+            bool do
+
+              # ... search in `title`, `abstract` and `content`, boosting `title`
+              #
+              should do
+                multi_match do
+                  query    q
+                  fields   ['title^10', 'abstract^2', 'content']
+                  operator 'and'
+                end
+              end
+
+              # ... search in comment body if user checked the comments checkbox
+              #
+              if q.present? && options[:comments]
+                should do
+                  nested do
+                    path :comments
+                    query do
+                      multi_match do
+                        query q
+                        fields   'body'
+                        operator 'and'
+                      end
+                    end
+                  end
+                end
+              end
+            end
+
+          # ... otherwise, just return all articles
+          else
+            match_all
+          end
+        end
+
+        # Filter the search results based on user selection
+        #
+        post_filter do
+          bool do
+            must { term categories: options[:category] } if options[:category]
+            must { match_all } if options.keys.none? { |k| [:c, :a, :w].include? k }
+            must { term 'authors.full_name.raw' => options[:author] } if options[:author]
+            must { range published_on: { gte: options[:published_week], lte: "#{options[:published_week]}||+1w" } } if options[:published_week]
+          end
+        end
+
+        # Return top categories for faceted navigation
+        #
+        aggregation :categories do
+          # Filter the aggregation with any selected `author` and `published_week`
+          #
+          f = Elasticsearch::DSL::Search::Filters::Bool.new
+          f.must { match_all }
+          f.must { term 'authors.full_name.raw' => options[:author] } if options[:author]
+          f.must { range published_on: { gte: options[:published_week], lte: "#{options[:published_week]}||+1w" } } if options[:published_week]
+
+          filter f.to_hash do
+            aggregation :categories do
+              terms field: 'categories'
+            end
+          end
+        end
+
+        # Return top authors for faceted navigation
+        #
+        aggregation :authors do
+          # Filter the aggregation with any selected `category` and `published_week`
+          #
+          f = Elasticsearch::DSL::Search::Filters::Bool.new
+          f.must { match_all }
+          f.must { term categories: options[:category] } if options[:category]
+          f.must { range published_on: { gte: options[:published_week], lte: "#{options[:published_week]}||+1w" } } if options[:published_week]
+
+          filter f do
+            aggregation :authors do
+              terms field: 'authors.full_name.raw'
+            end
+          end
+        end
+
+        # Return the published date ranges for faceted navigation
+        #
+        aggregation :published do
+          # Filter the aggregation with any selected `author` and `category`
+          #
+          f = Elasticsearch::DSL::Search::Filters::Bool.new
+          f.must { match_all }
+          f.must { term 'authors.full_name.raw' => options[:author] } if options[:author]
+          f.must { term categories: options[:category] } if options[:category]
+
+          filter f do
+            aggregation :published do
+              date_histogram do
+                field    'published_on'
+                interval 'week'
+              end
+            end
+          end
+        end
+
+        # Highlight the snippets in results
+        #
+        highlight do
+          fields title:    { number_of_fragments: 0 },
+                 abstract: { number_of_fragments: 0 },
+                 content:  { fragment_size: 50 }
+
+          field  'comments.body', fragment_size: 50 if q.present? && options[:comments]
+
+          pre_tags  '<em class="label label-highlight">'
+          post_tags '</em>'
+        end
+
+        case
+          # By default, sort by relevance, but when a specific sort option is present, use it ...
+          #
+          when options[:sort]
+            sort options[:sort].to_sym => 'desc'
+            track_scores true
+          #
+          # ... when there's no user query, sort on published date
+          #
+          when q.blank?
+            sort published_on: 'desc'
+        end
+
+        # Return suggestions unless there's no query from the user
+        unless q.blank?
+          suggest :suggest_title, text: q, term: { field: 'title.tokenized', suggest_mode: 'always' }
+          suggest :suggest_body,  text: q, term: { field: 'content.tokenized', suggest_mode: 'always' }
+        end
+      end
+
+      __elasticsearch__.search(@search_definition)
+    end
+  end
+end

data/test/unit/instrumentation/lograge_test.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 
 require 'rails/railtie'
+require 'action_pack'
 require 'lograge'
 
 require 'elasticsearch/rails/lograge'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,16 +84,16 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: lograge
   requirement: !ruby/object:Gem::Requirement
@@ -290,10 +290,15 @@ files:
 - lib/rails/templates/01-basic.rb
 - lib/rails/templates/02-pretty.rb
 - lib/rails/templates/03-expert.rb
+- lib/rails/templates/04-dsl.rb
 - lib/rails/templates/articles.yml.gz
+- lib/rails/templates/index.html.dsl.erb
 - lib/rails/templates/index.html.erb
 - lib/rails/templates/indexer.rb
 - lib/rails/templates/search.css
+- lib/rails/templates/search_controller_test.dsl.rb
+- lib/rails/templates/search_controller_test.rb
+- lib/rails/templates/searchable.dsl.rb
 - lib/rails/templates/searchable.rb
 - lib/rails/templates/seeds.rb
 - test/test_helper.rb