[RAILS] Updated the application templates to support Rails 5 & Elasticsearch 5

This patch adds support for both Rails 5 and Elasticsearch 5 for the
application templates in `elasticsearch-rails/lib/rails/templates/`.

The main problems on the Elasticsearch side have been in incorrect mapping,
which still used the `multi_field` property type. The mapping definition
in the `searchable.rb` and `searchable.dsl.rb` has been fixed, along
with small fixes in HTML views an the `SearchController`.

On the Rails side, the `quiet_assets` gem has been removed, as originally
reported by @frontandstart in elastic#634, and various fixes in the HTML views
(using `params.permit`, ...) and in the controller test (using the new
syntax for passing parameters) have been done.

The templates are still compatible with Rails 4.

Closes elastic#655

Author: karmi

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

@@ -41,7 +41,9 @@
 
 # ----- Download Elasticsearch --------------------------------------------------------------------
 
-unless (Net::HTTP.get(URI.parse('http://localhost:9200')) rescue false)
+ELASTICSEARCH_URL = ENV.fetch('ELASTICSEARCH_URL', 'http://localhost:9200')
+
+unless (Net::HTTP.get(URI.parse(ELASTICSEARCH_URL)) rescue false)
   COMMAND = <<-COMMAND.gsub(/^    /, '')
     curl -# -O "http://download.elasticsearch.org/elasticsearch/elasticsearch/elasticsearch-1.0.1.tar.gz"
     tar -zxf elasticsearch-1.0.1.tar.gz
@@ -116,6 +118,7 @@
 # ----- Auxiliary gems ----------------------------------------------------------------------------
 
 gem 'mocha', group: 'test', require: 'mocha/api'
+gem 'rails-controller-testing', group: 'test'
 
 # ----- Remove CoffeeScript, Sass and "all that jazz" ---------------------------------------------
 
@@ -145,9 +148,8 @@
 puts        '-'*80, ''; sleep 0.25
 
 environment 'config.assets.logger = false', env: 'development'
-gem 'quiet_assets',  group: "development"
+environment 'config.assets.quiet  = true',  env: 'development'
 
-git add:    "Gemfile*"
 git add:    "config/"
 git commit: "-m 'Disabled asset logging in development'"
 
@@ -208,7 +210,7 @@ def search
   CODE
 end
 
-inject_into_file 'app/views/articles/index.html.erb', after: %r{<h1>Listing articles</h1>}i do
+inject_into_file 'app/views/articles/index.html.erb', after: %r{<h1>.*Articles</h1>}i do
   <<-CODE
 
 
@@ -236,21 +238,21 @@ def search
   end
 CODE
 
-gsub_file "#{Rails::VERSION::STRING > '4' ? 'test/controllers' : 'test/functional'}/articles_controller_test.rb", %r{setup do.*?end}m, <<-CODE
+gsub_file "test/controllers/articles_controller_test.rb", %r{setup do.*?end}m, <<-CODE
 setup do
     @article = articles(:one)
 
-    Article.__elasticsearch__.import
+    Article.__elasticsearch__.import force: true
     Article.__elasticsearch__.refresh_index!
   end
 CODE
 
-inject_into_file "#{Rails::VERSION::STRING > '4' ? 'test/controllers' : 'test/functional'}/articles_controller_test.rb", after: %r{test "should get index" do.*?end}m do
+inject_into_file "test/controllers/articles_controller_test.rb", after: %r{test "should get index" do.*?end}m do
   <<-CODE
 
 
   test "should get search results" do
-    get :search, q: 'mystring'
+    #{ Rails::VERSION::STRING > '5' ? 'get search_articles_url(q: "mystring")' : 'get :search, q: "mystring"' }
     assert_response :success
     assert_not_nil assigns(:articles)
     assert_equal 2, assigns(:articles).size

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

@@ -154,8 +154,8 @@ def self.search(query)
 
 # ----- Customize the header -----------------------------------------------------------------
 
-gsub_file 'app/views/articles/index.html.erb', %r{<h1>Listing articles</h1>} do |match|
-  "<h1><%= controller.action_name == 'search' ? 'Searching articles' : 'Listing articles' %></h1>"
+gsub_file 'app/views/articles/index.html.erb', %r{<h1>.*Articles</h1>} do |match|
+  "<h1><%= controller.action_name == 'search' ? 'Search results' : 'Articles' %></h1>"
 end
 
 # ----- Customize the results listing -------------------------------------------------------------

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

@@ -77,19 +77,6 @@
 git add:    "config/"
 git commit: "-m 'Added Pry as the console for development'"
 
-# ----- Disable asset logging in development ------------------------------------------------------
-
-puts
-say_status  "Application", "Disabling asset logging in development...\n", :yellow
-puts        '-'*80, ''; sleep 0.25
-
-environment 'config.assets.logger = false', env: 'development'
-gem 'quiet_assets',  group: "development"
-
-git add:    "Gemfile*"
-git add:    "config/"
-git commit: "-m 'Disabled asset logging in development'"
-
 # ----- Run bundle install ------------------------------------------------------------------------
 
 run "bundle install"
@@ -173,11 +160,10 @@ 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]"
+gsub_file "test/models/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.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/searchable.rb',
-    'app/models/concerns/searchable.rb'
+get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/searchable.rb', 'app/models/concerns/searchable.rb'
 
 insert_into_file "app/models/article.rb", after: "ActiveRecord::Base" do
   <<-CODE
@@ -205,8 +191,7 @@ class Article < ActiveRecord::Base
 run "bundle install"
 
 # copy_file File.expand_path('../indexer.rb', __FILE__), 'app/workers/indexer.rb'
-get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/indexer.rb',
-    'app/workers/indexer.rb'
+get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/indexer.rb', 'app/workers/indexer.rb'
 
 insert_into_file "test/test_helper.rb",
                  "require 'sidekiq/testing'\n\n",
@@ -241,19 +226,16 @@ def index
 end
 
 # copy_file File.expand_path('../search_controller_test.rb', __FILE__), 'test/controllers/search_controller_test.rb'
-get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/search_controller_test.rb',
-    'test/controllers/search_controller_test.rb'
+get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/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'"
 
 # copy_file File.expand_path('../index.html.erb', __FILE__), 'app/views/search/index.html.erb'
-get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/index.html.erb',
-    'app/views/search/index.html.erb'
+get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/index.html.erb', 'app/views/search/index.html.erb'
 
 # copy_file File.expand_path('../search.css', __FILE__), 'app/assets/stylesheets/search.css'
-get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/search.css',
-    'app/assets/stylesheets/search.css'
+get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/search.css', 'app/assets/stylesheets/search.css'
 
 git add:    "app/controllers/ test/controllers/ config/routes.rb"
 git add:    "app/views/search/ app/assets/stylesheets/search.css"
@@ -304,13 +286,11 @@ def index
 puts        '-'*80, ''; sleep 0.25
 
 # copy_file File.expand_path('../articles.yml.gz', __FILE__), 'db/articles.yml.gz'
-get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/articles.yml.gz',
-    'db/articles.yml.gz'
+get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/articles.yml.gz', 'db/articles.yml.gz'
 
 remove_file 'db/seeds.rb'
 # copy_file File.expand_path('../seeds.rb', __FILE__), 'db/seeds.rb'
-get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/seeds.rb',
-    'db/seeds.rb'
+get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/seeds.rb', 'db/seeds.rb'
 
 rake "db:reset"
 rake "environment elasticsearch:import:model CLASS='Article' BATCH=100 FORCE=y"

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

@@ -39,16 +39,14 @@
 # ----- 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', force: true
+get 'https://raw.githubusercontent.com/elastic/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/searchable.dsl.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', 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', force: true
 
 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'
+    get :index, params: { q: 'one' }
     assert_response :success
 
     aggregations = assigns(:articles).response.response['aggregations']
@@ -65,7 +63,7 @@
 
 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'
+    get :index, params: { q: 'one', c: 'One' }
     assert_response :success
 
     assert_equal 2, assigns(:articles).size
@@ -82,7 +80,7 @@
 
 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'
+    get :index, params: { q: 'one', a: 'Mary Smith' }
     assert_response :success
 
     assert_equal 1, assigns(:articles).size

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

@@ -32,12 +32,6 @@
 git add:    "config/elasticsearch/articles_settings.json"
 git commit: "-m 'Create the articles settings file'"
 
-# ----- Temporarily set local repo for testing ----------------------------------------------------
-
-gsub_file "Gemfile",
-    %r{gem 'elasticsearch-model', git: 'git://github.com/elasticsearch/elasticsearch-rails.git'},
-    "gem 'elasticsearch-model', path: File.expand_path('../../../../../../elasticsearch-model', __FILE__)"
-
 # ----- Run bundle install ------------------------------------------------------------------------
 
 run "bundle install"

elasticsearch-rails/lib/rails/templates/index.html.dsl.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.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>
+          <li><%= link_to "Sort by published on", search_path(params.permit(:q, :a, :c, :s, :w, :comments).merge(s: 'published_on')), class: 'btn-xs' %></li>
+          <li><%= link_to "Sort by relevancy",    search_path(params.permit(:q, :a, :c, :s, :w, :comments).merge(s: nil)), class: 'btn-xs' %></li>
         </ul>
       </div>
     </div>
@@ -54,7 +54,7 @@
     <% if @articles.response.suggestions.terms.present? %>
       Maybe you mean
       <%= @articles.response.suggestions.terms.map do |term|
-        link_to term, search_path(params.except(:controller, :action).merge q: term)
+        link_to term, search_path(params.permit(:q, :a, :c, :s, :w, :comments).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.except(:controller, :action).merge(c: nil))%></p>
+      <p class="panel-heading"><%= link_to 'All Sections &rarr;'.html_safe, search_path(params.permit(:q, :a, :c, :s, :w, :comments).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'])),
+          link_to search_path(params.permit(:q, :a, :c, :s, :w, :comments).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
@@ -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.except(:controller, :action).merge(a: nil))%></p>
+      <p class="panel-heading"><%= link_to 'All Authors &rarr;'.html_safe, search_path(params.permit(:q, :a, :c, :s, :w, :comments).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'])),
+          link_to search_path(params.permit(:q, :a, :c, :s, :w, :comments).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
@@ -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.except(:controller, :action).merge(w: nil))%></p>
+      <p class="panel-heading"><%= link_to 'Any Date &rarr;'.html_safe, search_path(params.permit(:q, :a, :c, :s, :w, :comments).merge(w: nil))%></p>
 
       <div class="list-group">
         <% @articles.response.response['aggregations']['published']['published']['buckets'].each do |w| %>
@@ -104,7 +104,7 @@
           __end   = __start.end_of_week
           __date  = __start.to_date.to_s(:iso)
 
-          link_to search_path(params.except(:controller, :action).merge(w: __date)),
+          link_to search_path(params.permit(:q, :a, :c, :s, :w, :comments).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

elasticsearch-rails/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.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>
+          <li><%= link_to "Sort by published on", search_path(params.permit(:q, :a, :c, :s, :w, :comments).merge(s: 'published_on')), class: 'btn-xs' %></li>
+          <li><%= link_to "Sort by relevancy",    search_path(params.permit(:q, :a, :c, :s, :w, :comments).merge(s: nil)), class: 'btn-xs' %></li>
         </ul>
       </div>
     </div>
@@ -47,14 +47,14 @@
   <hr>
 </div>
 
-<% if @articles.size < 1 && @articles.response.suggest.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 @articles.response.suggest['suggest_title'].present? || @articles.response.suggest['suggest_body'].present? %>
+    <% if @articles.response.suggestions['suggest_title'].present? || @articles.response.suggestions['suggest_body'].present? %>
       Maybe you mean
-      <%= @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)
+      <%= @articles.response.suggestions.map { |k,v| v.first['options'] }.flatten.map {|v| v['text']}.uniq.map do |term|
+        link_to term, search_path(params.permit(:q, :a, :c, :s, :w, :comments).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.except(:controller, :action).merge(c: nil))%></p>
+      <p class="panel-heading"><%= link_to 'All Sections &rarr;'.html_safe, search_path(params.permit(:q, :a, :c, :s, :w, :comments).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'])),
+          link_to search_path(params.permit(:q, :a, :c, :s, :w, :comments).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
@@ -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.except(:controller, :action).merge(a: nil))%></p>
+      <p class="panel-heading"><%= link_to 'All Authors &rarr;'.html_safe, search_path(params.permit(:q, :a, :c, :s, :w, :comments).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'])),
+          link_to search_path(params.permit(:q, :a, :c, :s, :w, :comments).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
@@ -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.except(:controller, :action).merge(w: nil))%></p>
+      <p class="panel-heading"><%= link_to 'Any Date &rarr;'.html_safe, search_path(params.permit(:q, :a, :c, :s, :w, :comments).merge(w: nil))%></p>
 
       <div class="list-group">
         <% @articles.response.response['aggregations']['published']['published']['buckets'].each do |w| %>
@@ -104,7 +104,7 @@
           __end   = __start.end_of_week
           __date  = __start.to_date.to_s(:iso)
 
-          link_to search_path(params.except(:controller, :action).merge(w: __date)),
+          link_to search_path(params.permit(:q, :a, :c, :s, :w, :comments).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