[STORE] Added the template for generating a full Rails application with persistence model

Usage:

    rails new music --force --skip --skip-bundle --skip-active-record --template /path/to/template.rb
    rails new music --force --skip --skip-bundle --skip-active-record --template https://raw.githubusercontent.com/elasticsearch/elasticsearch-rails/persistence-model/elasticsearch-persistence/examples/music/template.rb

Author: karmi

elasticsearch-persistence/README.md

@@ -606,6 +606,25 @@ The library provides a Rails ORM generator:
 rails generate scaffold Person name:String email:String birthday:Date --orm=elasticsearch
 ```
 
+#### Example application
+
+A fully working Ruby on Rails application can be generated with the following command:
+
+```bash
+rails new music --force --skip --skip-bundle --skip-active-record --template https://raw.githubusercontent.com/elasticsearch/elasticsearch-rails/persistence-model/elasticsearch-persistence/examples/music/template.rb
+```
+
+The application demonstrates:
+
+* How to set up model attributes with custom mappings
+* How to configure model relationships with Elasticsearch's parent/child
+* How to configure models to use a common index, and create the index with proper mappings
+* How to use Elasticsearch's completion suggester to drive auto-complete functionality
+* How to use Elasticsearch-persisted model in Rails' views and forms
+* How to write controller tests
+
+The source files for the application are available in the [`examples/music`](examples/music) folder.
+
 ## License
 
 This software is licensed under the Apache 2 license, quoted below.

elasticsearch-persistence/examples/music/album.rb

@@ -0,0 +1,34 @@
+class Meta
+  include Virtus.model
+
+  attribute :rating
+  attribute :have
+  attribute :want
+  attribute :formats
+end
+
+class Album
+  include Elasticsearch::Persistence::Model
+
+  index_name [Rails.application.engine_name, Rails.env].join('-')
+
+  mapping _parent: { type: 'artist' } do
+    indexes :suggest_title, type: 'completion', payloads: true
+    indexes :suggest_track, type: 'completion', payloads: true
+  end
+
+  attribute :artist
+  attribute :artist_id, String, mapping: { index: 'not_analyzed' }
+  attribute :label, Hash, mapping: { type: 'object' }
+
+  attribute :title
+  attribute :suggest_title, String, default: {}, mapping: { type: 'completion', payloads: true }
+  attribute :released, Date
+  attribute :notes
+  attribute :uri
+
+  attribute :tracklist, Array, mapping: { type: 'object' }
+
+  attribute :styles
+  attribute :meta, Meta, mapping: { type: 'object' }
+end

elasticsearch-persistence/examples/music/artist.rb

@@ -0,0 +1,50 @@
+class Artist
+  include Elasticsearch::Persistence::Model
+
+  index_name [Rails.application.engine_name, Rails.env].join('-')
+
+  analyzed_and_raw = { fields: {
+    name: { type: 'string', analyzer: 'snowball' },
+    raw:  { type: 'string', analyzer: 'keyword' }
+  } }
+
+  attribute :name, String, mapping: analyzed_and_raw
+  attribute :suggest_name, String, default: {}, mapping: { type: 'completion', payloads: true }
+
+  attribute :profile
+  attribute :date, Date
+
+  attribute :members, String, default: [], mapping: analyzed_and_raw
+  attribute :members_combined, String, default: [], mapping: { analyzer: 'snowball' }
+  attribute :suggest_member, String, default: {}, mapping: { type: 'completion', payloads: true }
+
+  attribute :urls, String, default: []
+  attribute :album_count, Integer, default: 0
+
+  validates :name, presence: true
+
+  def albums
+    Album.search(
+      { query: {
+          has_parent: {
+            type: 'artist',
+            query: {
+              filtered: {
+                filter: {
+                  ids: { values: [ self.id ] }
+                }
+              }
+            }
+          }
+        },
+        sort: 'released',
+        size: 100
+      },
+      { type: 'album' }
+  )
+  end
+
+  def to_param
+    [id, name.parameterize].join('-')
+  end
+end

elasticsearch-persistence/examples/music/artists/_form.html.erb

@@ -0,0 +1,8 @@
+<%= simple_form_for @artist do |f| %>
+  <%= f.input :name %>
+  <%= f.input :profile, as: :text %>
+  <%= f.input :date, as: :date %>
+  <%= f.input :members, hint: 'Separate names by comma', input_html: { value: f.object.members.join(', ') } %>
+
+  <%= f.button :submit %>
+<% end %>

elasticsearch-persistence/examples/music/artists/artists_controller.rb

@@ -0,0 +1,67 @@
+class ArtistsController < ApplicationController
+  before_action :set_artist, only: [:show, :edit, :update, :destroy]
+
+  rescue_from Elasticsearch::Persistence::Repository::DocumentNotFound do
+    render file: "public/404.html", status: 404, layout: false
+  end
+
+  def index
+    @artists = Artist.all sort: 'name.raw', _source: ['name', 'album_count']
+  end
+
+  def show
+    @albums = @artist.albums
+  end
+
+  def new
+    @artist = Artist.new
+  end
+
+  def edit
+  end
+
+  def create
+    @artist = Artist.new(artist_params)
+
+    respond_to do |format|
+      if @artist.save refresh: true
+        format.html { redirect_to @artist, notice: 'Artist was successfully created.' }
+        format.json { render :show, status: :created, location: @artist }
+      else
+        format.html { render :new }
+        format.json { render json: @artist.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  def update
+    respond_to do |format|
+      if @artist.update(artist_params, refresh: true)
+        format.html { redirect_to @artist, notice: 'Artist was successfully updated.' }
+        format.json { render :show, status: :ok, location: @artist }
+      else
+        format.html { render :edit }
+        format.json { render json: @artist.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  def destroy
+    @artist.destroy refresh: true
+    respond_to do |format|
+      format.html { redirect_to artists_url, notice: 'Artist was successfully destroyed.' }
+      format.json { head :no_content }
+    end
+  end
+
+  private
+    def set_artist
+      @artist = Artist.find(params[:id].split('-').first)
+    end
+
+    def artist_params
+      a = params.require(:artist)
+      a[:members] = a[:members].split(/,\s?/) unless a[:members].is_a?(Array) || a[:members].blank?
+      return a
+    end
+end

elasticsearch-persistence/examples/music/artists/artists_controller_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class ArtistsControllerTest < ActionController::TestCase
+  setup do
+    IndexManager.create_index force: true
+    @artist = Artist.create(id: 1, name: 'TEST')
+    Artist.gateway.refresh_index!
+  end
+
+  test "should get index" do
+    get :index
+    assert_response :success
+    assert_not_nil assigns(:artists)
+  end
+
+  test "should get new" do
+    get :new
+    assert_response :success
+  end
+
+  test "should create artist" do
+    assert_difference('Artist.count') do
+      post :create, artist: { name: @artist.name }
+      Artist.gateway.refresh_index!
+    end
+
+    assert_redirected_to artist_path(assigns(:artist))
+  end
+
+  test "should show artist" do
+    get :show, id: @artist
+    assert_response :success
+  end
+
+  test "should get edit" do
+    get :edit, id: @artist
+    assert_response :success
+  end
+
+  test "should update artist" do
+    patch :update, id: @artist, artist: { name: @artist.name }
+    assert_redirected_to artist_path(assigns(:artist))
+  end
+
+  test "should destroy artist" do
+    assert_difference('Artist.count', -1) do
+      delete :destroy, id: @artist
+      Artist.gateway.refresh_index!
+    end
+
+    assert_redirected_to artists_path
+  end
+end

elasticsearch-persistence/examples/music/artists/index.html.erb

@@ -0,0 +1,57 @@
+<header>
+  <h1>
+    Artists
+    <%= button_to 'New Artist', new_artist_path, method: 'get', tabindex: 5 %>
+  </h1>
+</header>
+
+<section id="searchbox">
+<%= form_tag search_path, method: 'get' do %>
+  <input type="text" name="q" value="<%= params[:q] %>" id="q" autofocus="autofocus" placeholder="start typing to search..." tabindex="0" />
+<% end %>
+</section>
+
+<section class="artists">
+  <% @artists.each do |artist| %>
+    <%= div_for artist, class: 'result clearfix' do %>
+      <h2>
+        <%= link_to artist do %>
+          <span class="name"><%= artist.name %></span>
+          <small><%= pluralize artist.album_count, 'album' %></small>
+        <% end %>
+      </h2>
+      <div class="actions clearfix">
+        <%= button_to 'Edit', edit_artist_path(artist), method: 'get' %>
+        <%= button_to 'Destroy', artist, method: :delete, data: { confirm: 'Are you sure?' } %>
+      </div>
+    <% end %>
+  <% end %>
+</section>
+
+<% if @artists.empty? %>
+<section class="no-results">
+  <p>The search hasn't returned any results...</p>
+</section>
+<% end %>
+
+<script>
+$.widget( "custom.suggest", $.ui.autocomplete, {
+    _renderMenu: function( ul, items ) {
+      $.each( items, function( index, item ) {
+        var category = ul.append( "<li class='ui-autocomplete-category'>" + item.label + "</li>" );
+
+        $.each( item.value, function( index, item ) {
+          var li = $('<li class="ui-autocomplete-item"><a href="<%= Rails.application.config.relative_url_root %>'+ item.payload.url +'">'+ item.text +'</a></li>').data('ui-autocomplete-item', item )
+          category.append(li)
+        } )
+      });
+    }
+  });
+
+$( "#q" ).suggest({
+  source: '<%= suggest_path %>',
+  select: function(event, ui) {
+    document.location.href = '<%= Rails.application.config.relative_url_root %>'+ui.item.payload.url
+  }
+});
+</script>

elasticsearch-persistence/examples/music/artists/show.html.erb

@@ -0,0 +1,51 @@
+<header>
+  <h1>
+    <span class="back"><%= link_to "〈".html_safe, artists_path, title: "Back" %></span>
+    <%= @artist.name %>
+    <%= button_to 'Edit', edit_artist_path(@artist), method: 'get' %>
+  </h1>
+</header>
+
+<p id="notice"><%= notice %></p>
+
+<section class="artist-info">
+  <span><%= @artist.members.to_sentence last_word_connector: ' and ' %></span> |
+  <span><%= pluralize @albums.size, 'album' %></span>
+  <p class="artist-profile"><%= @artist.profile %></p>
+</section>
+
+<section class="albums">
+  <% @albums.each do |album| %>
+  <%= div_for album, class: 'clearfix' do %>
+      <h3>
+        <span class="title"><%= album.title %></span>
+        <div class="info">
+          <small><%= album.meta.formats.join(', ') %></small>
+          <small><%= album.released %></small>
+        </div>
+      </h3>
+
+      <div class="cover">
+        <%= image_tag "http://ruby-demo-assets.s3.amazonaws.com/discogs/covers/#{album.id}.jpeg", width: '100px', class: 'cover' %>
+      </div>
+
+      <div class="content">
+        <% album.tracklist.in_groups_of(album.tracklist.size/2+1).each_with_index do |half, g| %>
+          <ul class=<%= cycle 'first', 'second' %> start="<%= g < 1 ? 1 : album.tracklist.size/2+2 %>">
+            <% half.compact.each_with_index do |track, i| %>
+              <li>
+                <i class="counter"><%= g < 1 ? i+1 : i+(g*album.tracklist.size/2+2)  %></i>
+                <%= track['title'] %>
+                <small><%= track['duration'] %></small>
+              </li>
+            <% end %>
+          </ul>
+        <% end %>
+      </div>
+    <% end %>
+
+  <% end %>
+
+  <script>$('img').error(function(){ $(this).attr('src', '/images/blank_cover.png'); });</script>
+  <script>$(document.location.hash).effect('highlight', 1500)</script>
+</section>