[RAILS] Updated and polished the "basic" and "pretty" application templates

Author: karmi

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

@@ -36,8 +36,8 @@
 append_to_file ".gitignore", "vendor/elasticsearch-0.90.7/\n"
 
 git :init
-git :add => '.'
-git :commit => "-m 'Initial commit: Clean application'"
+git add:    "."
+git commit: "-m 'Initial commit: Clean application'"
 
 # ----- Download Elasticsearch --------------------------------------------------------------------
 
@@ -75,9 +75,11 @@
 # ----- Add README --------------------------------------------------------------------------------
 
 puts
-say_status  "README", "Adding readme...\n", :yellow
+say_status  "README", "Adding Readme...\n", :yellow
 puts        '-'*80, ''; sleep 0.25
 
+remove_file 'README.rdoc'
+
 create_file 'README.rdoc', <<-README
 = Ruby on Rails and Elasticsearch: Example application
 
@@ -87,7 +89,7 @@
 It has been generated by application templates available at
 https://github.com/elasticsearch/elasticsearch-rails/tree/master/elasticsearch-rails/lib/rails/templates.
 
-== Basic
+== [1] Basic
 
 The `basic` version provides a simple integration for a simple Rails model, `Article`, showing how
 to include the search engine support in your model, import the data, and provide form to perform
@@ -96,8 +98,8 @@
 README
 
 
-git :add => '.'
-git :commit => "-m 'Added README for the application'"
+git add:    "."
+git commit: "-m 'Added README for the application'"
 
 # ----- Use Thin ----------------------------------------------------------------------------------
 
@@ -111,18 +113,20 @@
 rescue LoadError
 end
 
+# ----- Auxiliary gems -----------------------------------------------------------------------------
+
+gem 'turn',  group: 'test'
+gem 'mocha', group: 'test', require: 'mocha/setup'
+
 # ----- Add gems into Gemfile ---------------------------------------------------------------------
 
 puts
-say_status  "Rubygems", "Adding Rubygems into Gemfile...\n", :yellow
+say_status  "Rubygems", "Adding Elasticsearch libraries into Gemfile...\n", :yellow
 puts        '-'*80, ''; sleep 0.75
 
-gem 'elasticsearch', :git => 'git@github.com:elasticsearch/elasticsearch-ruby.git'
-gem 'elasticsearch-model', :git => 'git@github.com:elasticsearch/elasticsearch-rails.git'
-gem 'elasticsearch-rails', :git => 'git@github.com:elasticsearch/elasticsearch-rails.git'
-
-git :add => '.'
-git :commit => "-m 'Added gems'"
+gem 'elasticsearch',       git: 'git@github.com:elasticsearch/elasticsearch-ruby.git'
+gem 'elasticsearch-model', git: 'git@github.com:elasticsearch/elasticsearch-rails.git'
+gem 'elasticsearch-rails', git: 'git@github.com:elasticsearch/elasticsearch-rails.git'
 
 # ----- Install gems ------------------------------------------------------------------------------
 
@@ -132,18 +136,21 @@
 
 run "bundle install"
 
+git add:    "Gemfile*"
+git commit: "-m 'Added libraries into Gemfile'"
+
 # ----- Generate Article resource -----------------------------------------------------------------
 
 puts
 say_status  "Model", "Generating the Article resource...", :yellow
 puts        '-'*80, ''; sleep 0.75
 
 generate :scaffold, "Article title:string content:text published_on:date"
-route "root :to => 'articles#index'"
+route "root to: 'articles#index'"
 rake  "db:migrate"
 
-git :add => '.'
-git :commit => "-m 'Added the Article resource'"
+git add:    "."
+git commit: "-m 'Added the Article resource'"
 
 # ----- Add Elasticsearch integration into the model ----------------------------------------------
 
@@ -159,7 +166,7 @@ class Article < ActiveRecord::Base
 end
 CODE
 
-git :commit => "-a -m 'Added Elasticsearch support into the Article model'"
+git commit: "-a -m 'Added Elasticsearch support into the Article model'"
 
 # ----- Add Elasticsearch integration into the interface ------------------------------------------
 
@@ -172,18 +179,18 @@ class Article < ActiveRecord::Base
   def search
     @articles = Article.search(params[:q]).records
 
-    render :action => "index"
+    render action: "index"
   end
 
   # GET /articles/1
 CODE
 
-gsub_file 'app/views/articles/index.html.erb', %r{<h1>Listing articles</h1>}, <<-CODE
+gsub_file 'app/views/articles/index.html.erb', %r{<h1>Listing articles</h1>}, <<-CODE unless File.read('app/views/articles/index.html.erb').include?('form_tag search_articles_path')
 <h1>Listing articles</h1>
 
 <hr>
 
-<%= form_tag search_articles_path, :method => 'get' do %>
+<%= form_tag search_articles_path, method: 'get' do %>
   <%= label_tag :query %>
   <%= text_field_tag :q, params[:q] %>
   <%= submit_tag :search %>
@@ -197,13 +204,37 @@ def search
 <%= link_to 'All articles', articles_path if params[:q] %>
 CODE
 
-gsub_file 'config/routes.rb', %r{resources :articles}, <<-CODE
+gsub_file 'config/routes.rb', %r{resources :articles$}, <<-CODE
 resources :articles do
     collection { get :search }
   end
 CODE
 
-git :commit => "-a -m 'Added search form and controller action'"
+gsub_file 'test/controllers/articles_controller_test.rb', %r{setup do.*?end}m, <<-CODE
+setup do
+    @article = articles(:one)
+
+    Article.__elasticsearch__.import
+    Article.__elasticsearch__.refresh_index!
+  end
+CODE
+
+gsub_file 'test/controllers/articles_controller_test.rb', %r{test "should get index" do.*?end}m do |match|
+match << <<-CODE
+
+
+  test "should get search results" do
+    get :search, q: 'mystring'
+    assert_response :success
+    assert_not_nil assigns(:articles)
+    assert_equal 2, assigns(:articles).size
+  end
+CODE
+end
+
+
+
+git commit: "-a -m 'Added search form and controller action'"
 
 # ----- Seed the database -------------------------------------------------------------------------
 
@@ -228,33 +259,35 @@ def search
 
   puts "Creating articles..."
   %w[ One Two Three Four Five ].each_with_index do |title, i|
-    Article.create :title => title, :content => contents[i], :published_on => i.days.ago.utc
+    Article.create title: title, content: contents[i], published_on: i.days.ago.utc
   end
 
 else
 
-  puts "Creating 10,000 articles..."
+  print "Generating articles..."
   (1..ENV['COUNT'].to_i).each_with_index do |title, i|
-    Article.create :title => "Title #{title}", :content => 'Lorem', :published_on => i.days.ago.utc
-    print '.'
+    Article.create title: "Title #{title}", content: 'Lorem ipsum dolor', published_on: i.days.ago.utc
+    print '.' if i % ENV['COUNT'].to_i/10 == 0
   end
+  puts "\n"
 
 end
 }
 
+run  "rails runner 'Article.__elasticsearch__.create_index! force: true'"
 rake "db:seed"
 
-git :add    => "db/seeds.rb"
-git :commit => "-m 'Added database seeding script'"
+git add:    "db/seeds.rb"
+git commit: "-m 'Added database seeding script'"
 
 # ----- Print Git log -----------------------------------------------------------------------------
 
 puts
 say_status  "Git", "Details about the application:", :yellow
 puts        '-'*80, ''
 
-git :tag => "basic"
-git :log => "--reverse --oneline"
+git tag: "basic"
+git log: "--reverse --oneline"
 
 # ----- Start the application ---------------------------------------------------------------------