elasticsearch-persistence-queryable 0.1.8

data/Rakefile

@@ -0,0 +1,57 @@
+require "bundler/gem_tasks"
+
+desc "Run unit tests"
+task :default => 'test:unit'
+task :test    => 'test:unit'
+
+# ----- Test tasks ------------------------------------------------------------
+
+require 'rake/testtask'
+namespace :test do
+  task :ci_reporter do
+    ENV['CI_REPORTS'] ||= 'tmp/reports'
+    require 'ci/reporter/rake/minitest'
+    Rake::Task['ci:setup:minitest'].invoke
+  end
+
+  Rake::TestTask.new(:unit) do |test|
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
+    test.libs << 'lib' << 'test'
+    test.test_files = FileList["test/unit/**/*_test.rb"]
+    # test.verbose = true
+    # test.warning = true
+  end
+
+  Rake::TestTask.new(:integration) do |test|
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
+    test.libs << 'lib' << 'test'
+    test.test_files = FileList["test/integration/**/*_test.rb"]
+  end
+
+  Rake::TestTask.new(:all) do |test|
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
+    test.libs << 'lib' << 'test'
+    test.test_files = FileList["test/unit/**/*_test.rb", "test/integration/**/*_test.rb"]
+  end
+end
+
+# ----- Documentation tasks ---------------------------------------------------
+
+require 'yard'
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.options = %w| --embed-mixins --markup=markdown |
+end
+
+# ----- Code analysis tasks ---------------------------------------------------
+
+if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
+  begin
+    require 'cane/rake_task'
+    Cane::RakeTask.new(:quality) do |cane|
+      cane.abc_max = 15
+      cane.style_measure = 120
+    end
+  rescue LoadError
+    warn "cane not available, quality task not provided."
+  end
+end

data/elasticsearch-persistence.gemspec

@@ -0,0 +1,57 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "elasticsearch/persistence/version"
+
+Gem::Specification.new do |s|
+  s.name = "elasticsearch-persistence-queryable"
+  s.version = Elasticsearch::Persistence::VERSION
+  s.authors = ["Karel Minarik"]
+  s.email = ["karel.minarik@elasticsearch.org"]
+  s.description = "Persistence layer for Ruby models and Elasticsearch."
+  s.summary = "Persistence layer for Ruby models and Elasticsearch."
+  s.homepage = "https://github.com/elasticsearch/elasticsearch-rails/"
+  s.license = "Apache 2"
+
+  s.files = `git ls-files -z`.split("\x0")
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.extra_rdoc_files = ["README.md", "LICENSE.txt"]
+  s.rdoc_options = ["--charset=UTF-8"]
+
+  s.required_ruby_version = ">= 1.9.3"
+
+  s.add_dependency "elasticsearch", "> 0.4"
+  s.add_dependency "elasticsearch-model", ">= 0.1"
+  s.add_dependency "activesupport", "> 3"
+  s.add_dependency "activemodel", "> 3"
+  s.add_dependency "hashie"
+  s.add_dependency "virtus"
+  s.add_dependency "jbuilder"
+
+  s.add_development_dependency "bundler", "~> 1.5"
+  s.add_development_dependency "rake"
+
+  s.add_development_dependency "oj"
+
+  s.add_development_dependency "rails"
+
+  s.add_development_dependency "elasticsearch-extensions"
+
+  s.add_development_dependency "minitest", "~> 4"
+  s.add_development_dependency "test-unit" if defined?(RUBY_VERSION) && RUBY_VERSION > "2.2"
+  s.add_development_dependency "shoulda-context"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "turn"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "ruby-prof"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "ci_reporter", "~> 1.9"
+
+  if defined?(RUBY_VERSION) && RUBY_VERSION > "1.9"
+    s.add_development_dependency "simplecov"
+    s.add_development_dependency "cane"
+  end
+end

data/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

data/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

data/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 %>

data/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

data/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

data/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>

data/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>

data/examples/music/assets/application.css

@@ -0,0 +1,226 @@
+/*
+ *= require_tree .
+ *= require_self
+ *= require ui-lightness/jquery-ui-1.10.4.custom.min.css
+ */
+
+.clearfix {
+  *zoom: 1;
+}
+
+.clearfix:before,
+.clearfix:after {
+  display: table;
+  line-height: 0;
+  content: "";
+}
+
+.clearfix:after {
+  clear: both;
+}
+
+body {
+  font-family: 'Helvetica Neue', Helvetica, sans-serif !important;
+  margin: 2em 4em;
+}
+
+header {
+  margin: 0;
+  padding: 0 0 1em 0;
+  border-bottom: 1px solid #666;
+}
+
+header h1 {
+  color: #999;
+  font-weight: 100;
+  text-transform: uppercase;
+  margin: 0; padding: 0;
+}
+
+header a {
+  color: #0b6aff;
+  text-decoration: none;
+}
+
+header .back {
+  font-size: 100%;
+  margin: 0 0.5em 0 -0.5em;
+}
+
+h1 form {
+  float: right;
+}
+
+#searchbox {
+  border-bottom: 1px solid #666;
+}
+
+#searchbox input {
+  color: #444;
+  font-size: 100%;
+  font-weight: 100;
+  border: none;
+  padding: 1em 0 1em 0;
+  width: 100%;
+}
+
+#searchbox input:focus {
+  outline-width: 0;
+}
+
+.actions form {
+  float: right;
+  position: relative;
+  top: 0.2em;
+}
+
+.no-results {
+  font-weight: 200;
+  font-size: 200%;
+}
+
+.result,
+.artist {
+  padding: 1em 0 1em 0;
+  margin: 0;
+  border-bottom: 1px solid #999;
+}
+
+.result:hover,
+.artist:hover {
+  background: #f9f9f9;
+}
+
+.result h2,
+.artist h2 {
+  color: #444;
+  margin: 0;
+  padding: 0;
+}
+
+.artist h2 {
+  float: left;
+}
+
+.result h2 a,
+.artist h2 a {
+  color: #444;
+}
+
+.result h2 small,
+.artist h2 small {
+  font-size: 70%;
+  font-weight: 100;
+  margin-left: 0.5em;
+}
+
+.result h2 a,
+.artist h2 a {
+  text-decoration: none;
+}
+
+.result h2 a:hover name,
+.artist h2 a:hover .name {
+  text-decoration: underline;
+}
+
+.result .small {
+  font-size: 90%;
+  font-weight: 200;
+  padding: 0;
+  margin: 0.25em 0 0.25em 0;
+}
+
+.result .small .label {
+  color: #999;
+  font-size: 80%;
+  min-width: 5em;
+  display: inline-block;
+}
+
+.artist-info {
+  color: #5f5f5f;
+  text-transform: uppercase;
+  font-weight: 200;
+  border-bottom: 1px solid #666;
+  padding: 0 0 1em 0;
+  margin: 0 0 1em 0;
+}
+
+.artist-profile {
+  color: #999;
+  font-size: 95%;
+  font-weight: 100;
+  text-transform: none;
+  padding: 0;
+  margin: 0.25em 0 0 0;
+}
+
+.album {
+  margin: 0 0 4em 0;
+}
+
+.album .cover {
+  float: left;
+  width: 150px;
+}
+
+.album .cover img {
+  border: 1px solid rgba(0,0,0,0.15);
+  box-shadow: 0px 0px 1px 0px rgba(0,0,0,0.05);
+}
+
+.album .content {
+  float: left;
+  margin-left: 25px;
+}
+
+.album .content ul {
+  float: left;
+  margin: 0 2em 0 0;
+  padding: 0;
+  min-width: 18em;
+}
+
+.album .content ul li {
+  line-height: 1.5em;
+  padding: 0.5em 0 0.5em 0;
+  border-bottom:1px solid #f8f8f8;
+  list-style: none;
+}
+
+.album .content ul li .counter {
+  color: #999;
+  font-style: normal;
+  font-size: 80%;
+  font-weight: 100;
+  margin-right: 0.5em;
+}
+
+.album h3 {
+  margin: 0; padding: 0;
+  border-bottom: 2px solid #e0e0e0;
+  padding: 0 0 0.5em 0;
+  margin: 0 0 1em 0;
+}
+
+.album h3 .title {
+  text-transform: uppercase;
+  font-weight: 200;
+}
+
+.album small {
+  color: #a3a3a3;
+  font-weight: 200;
+}
+
+.album .info {
+  float: right;
+}
+
+em[class^=hl] {
+  font-style: normal;
+  background: #e6efff;
+  padding: 0.15em 0.35em;
+  border-radius: 5px;
+}