elasticsearch-persistence 0.0.0 → 0.0.1

data/Rakefile

@@ -1 +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

@@ -3,21 +3,49 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'elasticsearch/persistence/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = "elasticsearch-persistence"
-  spec.version       = Elasticsearch::Persistence::VERSION
-  spec.authors       = ["Karel Minarik"]
-  spec.email         = ["karel.minarik@elasticsearch.org"]
-  spec.description   = %q{Elasticsearch persistence (WIP)}
-  spec.summary       = spec.description
-  spec.homepage      = ""
-  spec.license       = "Apache 2"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+Gem::Specification.new do |s|
+  s.name          = "elasticsearch-persistence"
+  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 "hashie"
+
+  s.add_development_dependency "bundler", "~> 1.5"
+  s.add_development_dependency "rake"
+
+  s.add_development_dependency "oj"
+  s.add_development_dependency "virtus"
+
+  s.add_development_dependency "elasticsearch-extensions"
+
+  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"
+
+  if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
+    s.add_development_dependency "simplecov"
+    s.add_development_dependency "cane"
+  end
 end

data/examples/sinatra/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+Gemfile.lock
+tmp/*
+log/*
+doc/
+.yardoc
+.vagrant

data/examples/sinatra/Gemfile

@@ -0,0 +1,28 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'ansi'
+
+gem 'multi_json'
+gem 'oj'
+gem 'hashie'
+
+gem 'patron'
+gem 'elasticsearch'
+gem 'elasticsearch-model',       path: File.expand_path('../../../../elasticsearch-model', __FILE__)
+gem 'elasticsearch-persistence', path: File.expand_path('../../../', __FILE__)
+
+gem 'sinatra', require: false
+gem 'thin'
+
+group :development do
+  gem 'sinatra-contrib'
+end
+
+group :test do
+  gem 'elasticsearch-extensions'
+  gem 'rack-test'
+  gem 'shoulda-context'
+  gem 'turn'
+  gem 'mocha'
+end

data/examples/sinatra/README.markdown

@@ -0,0 +1,36 @@
+Demo Aplication for the Repository Pattern
+==========================================
+
+This directory contains a simple demo application for the repository pattern of the `Elasticsearch::Persistence`
+module in the [Sinatra](http://www.sinatrarb.com) framework.
+
+To run the application, first install the required gems and start the application:
+
+```
+bundle install
+bundle exec ruby application.rb
+```
+
+The application demonstrates:
+
+* How to use a plain old Ruby object (PORO) as the domain model
+* How to set up, configure and use the repository instance
+* How to use the repository in tests
+
+## License
+
+This software is licensed under the Apache 2 license, quoted below.
+
+    Copyright (c) 2014 Elasticsearch <http://www.elasticsearch.org>
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

data/examples/sinatra/application.rb

@@ -0,0 +1,238 @@
+$LOAD_PATH.unshift File.expand_path('../../../lib/', __FILE__)
+
+require 'sinatra/base'
+
+require 'multi_json'
+require 'oj'
+require 'hashie/mash'
+
+require 'elasticsearch'
+require 'elasticsearch/model'
+require 'elasticsearch/persistence'
+
+class Note
+  attr_reader :attributes
+
+  def initialize(attributes={})
+    @attributes = Hashie::Mash.new(attributes)
+    __add_date
+    __extract_tags
+    __truncate_text
+    self
+  end
+
+  def method_missing(method_name, *arguments, &block)
+    attributes.respond_to?(method_name) ? attributes.__send__(method_name, *arguments, &block) : super
+  end
+
+  def respond_to?(method_name, include_private=false)
+    attributes.respond_to?(method_name) || super
+  end
+
+  def tags; attributes.tags || []; end
+
+  def to_hash
+    @attributes.to_hash
+  end
+
+  def __extract_tags
+    tags = attributes['text'].scan(/(\[\w+\])/).flatten if attributes['text']
+    unless tags.nil? || tags.empty?
+      attributes.update 'tags' => tags.map { |t| t.tr('[]', '') }
+      attributes['text'].gsub!(/(\[\w+\])/, '').strip!
+    end
+  end
+
+  def __add_date
+    attributes['created_at'] ||=  Time.now.utc.iso8601
+  end
+
+  def __truncate_text
+    attributes['text'] = attributes['text'][0...80] + ' (...)' if attributes['text'] && attributes['text'].size > 80
+  end
+end
+
+class NoteRepository
+  include Elasticsearch::Persistence::Repository
+
+  client Elasticsearch::Client.new url: ENV['ELASTICSEARCH_URL'], log: true
+
+  index :notes
+  type  :note
+
+  mapping do
+    indexes :text,       analyzer: 'snowball'
+    indexes :tags,       analyzer:   'keyword'
+    indexes :created_at, type: 'date'
+  end
+
+  create_index!
+
+  def deserialize(document)
+    Note.new document['_source'].merge('id' => document['_id'])
+  end
+end unless defined?(NoteRepository)
+
+class Application < Sinatra::Base
+  enable :logging
+  enable :inline_templates
+  enable :method_override
+
+  configure :development do
+    enable   :dump_errors
+    disable  :show_exceptions
+
+    require  'sinatra/reloader'
+    register Sinatra::Reloader
+  end
+
+  set :repository, NoteRepository.new
+  set :per_page,   25
+
+  get '/' do
+    @page  = [ params[:p].to_i, 1 ].max
+
+    @notes = settings.repository.search \
+               query: ->(q, t) do
+                query = if q && !q.empty?
+                  { match: { text: q } }
+                else
+                  { match_all: {} }
+                end
+
+                filter = if t && !t.empty?
+                  { term: { tags: t } }
+                end
+
+                if filter
+                  { filtered: { query: query, filter: filter } }
+                else
+                  query
+                end
+               end.(params[:q], params[:t]),
+
+               sort: [{created_at: {order: 'desc'}}],
+
+               size: settings.per_page,
+               from: settings.per_page * (@page-1),
+
+               aggregations: { tags: { terms: { field: 'tags' } } },
+
+               highlight: { fields: { text: { fragment_size: 0, pre_tags: ['<em class="hl">'],post_tags: ['</em>'] } } }
+
+    erb :index
+  end
+
+  post '/' do
+    unless params[:text].empty?
+      @note = Note.new params
+      settings.repository.save(@note, refresh: true)
+    end
+
+    redirect back
+  end
+
+  delete '/:id' do |id|
+    settings.repository.delete(id, refresh: true)
+    redirect back
+  end
+end
+
+Application.run! if $0 == __FILE__
+
+__END__
+
+@@ layout
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Notes</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <style>
+    body   { color: #222; background: #fff; font: normal 80%/120% 'Helvetica Neue', sans-serif; margin: 4em; position: relative; }
+    header { color: #666; border-bottom: 2px solid #666;  }
+    header:after { display: table; content: ""; line-height: 0; clear: both; }
+    #left  { width: 20em; float: left }
+    #main  { margin-left: 20em; }
+    header h1 { font-weight: normal; float: left; padding: 0.4em 0 0 0; margin: 0; }
+    header form { margin-left: 19.5em; }
+    header form input { font-size: 120%; width: 40em; border: none; padding: 0.5em; position: relative; bottom: -0.2em; background: transparent; }
+    header form input:focus { outline-width: 0; }
+
+    #left h2 { color: #999; font-size: 160%; font-weight: normal; text-transform: uppercase; letter-spacing: -0.05em; }
+    #left h2 { border-top: 2px solid #999; width: 9.4em; padding: 0.5em 0 0.5em 0; margin: 0; }
+    #left textarea { font: normal 140%/140% monospace; border: 1px solid #999; padding: 0.5em; width: 12em; }
+    #left form p { margin: 0; }
+    #left a { color: #000; }
+    #left small.c { color: #333; background: #ccc; text-align: center; min-width: 1.75em; min-height: 1.5em; border-radius: 1em; display: inline-block; padding-top: 0.25em; float: right; margin-right: 6em; }
+    #left small.i { color: #ccc; background: #333; }
+
+    #facets { list-style-type: none; padding: 0; margin: 0 0 1em 0; }
+    #facets li { padding: 0 0 0.5em 0; }
+
+    .note   { border-bottom: 1px solid #999; position: relative; padding: 0.5em 0; }
+    .note p { font-size: 140%; }
+    .note small { font-size: 70%; color: #999; }
+    .note small.d { border-left: 1px solid #999; padding-left: 0.5em; margin-left: 0.5em; }
+    .note em.hl { background: #fcfcad; border-radius: 0.5em; padding: 0.2em 0.4em 0.2em 0.4em; }
+    .note strong.t { color: #fff; background: #999; font-size: 70%; font-weight: bold; border-radius: 0.6em; padding: 0.2em 0.6em 0.3em 0.7em; }
+    .note form { position: absolute; bottom: 1.5em; right: 1em; }
+
+    .pagination { color: #000; font-weight: bold; text-align: right;  }
+    .pagination:visited { color: #000; }
+    .pagination a        { text-decoration: none; }
+    .pagination:hover a  { text-decoration: underline; }
+}
+
+  </style>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>
+
+@@ index
+
+<header>
+  <h1>Notes</h1>
+  <form action="/" method='get'>
+    <input type="text" name="q" value="<%= params[:q] %>" id="q" autofocus="autofocus" placeholder="type a search query and press enter..." />
+  </form>
+</header>
+
+<section id="left">
+  <p><a href="/">All notes</a> <small class="c i"><%= @notes.size %></small></p>
+  <ul id="facets">
+  <% @notes.response.aggregations.tags.buckets.each do |term| %>
+  <li><a href="/?t=<%= term['key'] %>"><%= term['key'] %></a> <small class="c"><%= term['doc_count'] %></small></li>
+  <% end %>
+  </ul>
+  <h2>Add a note</h2>
+  <form action="/" method='post'>
+    <p><textarea name="text" rows="5"></textarea></p>
+    <p><input type="submit" accesskey="s" value="Save" /></p>
+  </form>
+</section>
+
+<section id="main">
+<% if @notes.empty?  %>
+  <p>No notes found.</p>
+<% end %>
+
+<% @notes.each_with_hit do |note, hit|  %>
+  <div class="note">
+    <p>
+      <%= hit.highlight && hit.highlight.size > 0 ? hit.highlight.text.first : note.text %>
+
+      <% note.tags.each do |tag| %> <strong class="t"><%= tag %></strong><% end %>
+      <small class="d"><%= Time.parse(note.created_at).strftime('%d/%m/%Y %H:%M') %></small>
+
+      <form action="/<%= note.id %>" method="post"><input type="hidden" name="_method" value="delete" /><button>Delete</button></form>
+    </p>
+  </div>
+<% end  %>
+
+<% if @notes.size > 0 && @page.next <= @notes.total / settings.per_page %>
+  <p class="pagination"><a href="?p=<%= @page.next %>">&rarr; Load next</a></p>
+<% end %>
+</section>

data/examples/sinatra/config.ru

@@ -0,0 +1,7 @@
+#\ --port 3000 --server thin
+
+require File.expand_path('../application', __FILE__)
+
+map '/' do
+  run Application
+end