indexes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: faa93cb564f7f71a3010f4916dc4d92f81fd594f
+  data.tar.gz: 39befa425667065d4a45ce753f99ecce58258833
+SHA512:
+  metadata.gz: ce9a43f8196973a30f58699bc301cad72335aea1d11f2b69ca1a8e6aceab80bd5654044ce2f081cea2ffcd2de4923abfcabbd730c25e8fdc21e77e059fc85aec
+  data.tar.gz: f3ed34a51d459a4b49ca7848d422db677971e33cd7fb3fc4804c107bfc3a886cfaa8015d38ec5ac53c58c937e5b5eca0e36351de42059d2e712ca7996d7286cb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Mathías Montossi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,245 @@
+[![Gem Version](https://badge.fury.io/rb/indexes.svg)](http://badge.fury.io/rb/indexes)
+[![Code Climate](https://codeclimate.com/github/mmontossi/indexes/badges/gpa.svg)](https://codeclimate.com/github/mmontossi/indexes)
+[![Build Status](https://travis-ci.org/mmontossi/indexes.svg)](https://travis-ci.org/mmontossi/indexes)
+[![Dependency Status](https://gemnasium.com/mmontossi/indexes.svg)](https://gemnasium.com/mmontossi/indexes)
+
+# Indexes
+
+Model search indexes with elasticsearch in rails.
+
+## Why
+
+I did this gem to:
+
+- Gain control of the queries without losing simplicity.
+- Have out of the box integration with activerecord and pagers.
+- Deal with the just in time nature of elasticsearch.
+- Integrate activerecord includes on it.
+- Have a convention of how to use suggestions.
+
+## Install
+
+Put this line in your Gemfile:
+```ruby
+gem 'indexes'
+```
+
+Then bundle:
+```
+$ bundle
+```
+
+To install Redis you can use homebrew:
+```
+$ brew install elasticsearch24
+```
+
+NOTE: This gem is tested agains version 2.4.
+
+## Configuration
+
+Run the install generator:
+```
+$ bundle exec rails g indexes:install
+```
+
+Set the global settings:
+```ruby
+Indexes.configure do |config|
+
+  config.hosts = %w(localhost:9200)
+  config.log = false
+  config.trace = false
+
+  config.mappings do
+    name do
+      type 'string'
+      fields do
+        raw do
+          type 'string'
+          index 'not_analyzed'
+        end
+      end
+    end
+    category type: 'string'
+    price type: 'long'
+    currency type: 'string'
+    product_suggestions do
+      type 'completion'
+      analyzer 'simple'
+    end
+  end
+
+  config.analysis do
+    filter do
+      ngram do
+        type 'nGram'
+        min_gram 2
+        max_gram 20
+      end
+    end
+  end
+
+  config.suggestions do |name, term, options={}|
+    type = name.to_s.singularize
+    text (term || '')
+    completion do
+      field "#{type}_suggestions"
+    end
+  end
+
+  config.add_computed_sort :price do |direction|
+    _script do
+      type 'number'
+      script do
+        inline "if (_source.currency == 'UYU') { doc['price'].value * 30 }"
+      end
+      order direction
+    end
+  end
+
+end
+```
+
+Generate an index:
+```
+$ bundle exec rails g indexes:index products
+```
+
+Define the index:
+```ruby
+Indexes.define :products do
+
+  mappings do
+    properties :name, :category, :price, :product_suggestions
+  end
+
+  serializer do |record|
+    set record, :name, :category, :price
+    product_suggestions do
+      input [record.name, transliterate(record.name)].uniq
+      output record.name
+    end
+  end
+
+  search do |*args|
+    options = args.extract_options!
+    term = args.first
+    query do
+      if term.present?
+        multi_match do
+          query term
+          type 'phrase_prefix'
+          fields %w(name category)
+        end
+      else
+        match_all
+      end
+    end
+  end
+
+end
+```
+
+## Usage
+
+### Indexing
+
+Ocurrs everytime you create, update or destroy a record:
+```ruby
+product = Product.create(name: 'Les Paul', category: 'Gibson')
+```
+
+You can force it manually by:
+```ruby
+product.index
+product.reindex
+product.unindex
+```
+
+At any time you can force a full rebuild:
+```
+$ bundle exec rake indexes:rebuild
+```
+
+Or if you need just a build:
+```
+$ bundle exec rake indexes:build
+```
+
+### Search
+
+The search parameters are sent to previous configured block:
+```ruby
+products = Product.search(name: 'Test')
+```
+
+You can use the returned value as a collection in views:
+```erb
+<%= render products %>
+```
+
+### Includes
+
+Same as using activerecord relations:
+```ruby
+Product.search(includes: :shop)
+```
+
+### With / Without
+
+You can force a record to be part of the results by id:
+```ruby
+Product.search(with: 4)
+```
+
+Or the opposite:
+```ruby
+Product.search(without: 4)
+```
+
+### Pagination
+
+Works the same as [pagers gem](https://github.com/mmontossi/pagers):
+```ruby
+products.page 1, padding: 4, length: 30
+```
+
+And you can send the collection directly to the helper in views:
+```erb
+<%= paginate products %>
+```
+
+### Order
+
+Works the same as in relations:
+```ruby
+products.order(name: :asc)
+```
+
+To use a computed_sort:
+```ruby
+products.order(price: :asc)
+```
+
+NOTE: To sort by a string column, you must declare the mapping raw.
+
+### Suggestions
+
+The suggestion parameters are sent to previous configured block:
+```ruby
+Indexes.suggest :products, 'gibson'
+```
+
+Returns array of hashes with a text property:
+```ruby
+[{ text: 'Les Paul' }, ...]
+```
+
+## Credits
+
+This gem is maintained and funded by [mmontossi](https://github.com/mmontossi).
+
+## License
+
+It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+  t.warning = false
+end
+
+task default: :test

data/lib/generators/indexes/index_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+
+module Indexes
+  module Generators
+    class IndexGenerator < Rails::Generators::NamedBase
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_index_file
+        template 'index.rb', "app/indexes/#{table_name}_index.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/indexes/install_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+
+module Indexes
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_initializer_file
+        copy_file 'initializer.rb', 'config/initializers/indexes.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/indexes/templates/index.rb

@@ -0,0 +1,12 @@
+Indexes.define :<%= table_name %> do
+
+  mappings do
+  end
+
+  serializer do |record|
+  end
+
+  search do |*args|
+  end
+
+end

data/lib/generators/indexes/templates/initializer.rb

@@ -0,0 +1,10 @@
+Indexes.configure do |config|
+
+  config.hosts = %w(localhost:9200)
+  config.log = true
+  config.trace = true
+
+  config.mappings do
+  end
+
+end

data/lib/indexes.rb

@@ -0,0 +1,102 @@
+require 'generators/indexes/index_generator'
+require 'generators/indexes/install_generator'
+require 'indexes/dsl/api'
+require 'indexes/dsl/mappings'
+require 'indexes/dsl/search'
+require 'indexes/dsl/serializer'
+require 'indexes/concern'
+require 'indexes/configuration'
+require 'indexes/index'
+require 'indexes/pagination'
+require 'indexes/proxy'
+require 'indexes/railtie'
+require 'indexes/collection'
+require 'indexes/version'
+
+module Indexes
+  class << self
+
+    delegate :any?, :none?, to: :registry
+
+    def namespace
+      "#{Rails.application.class.parent_name} #{Rails.env}".parameterize('_')
+    end
+
+    def client
+      @client ||= begin
+        require 'elasticsearch'
+        Elasticsearch::Client.new(
+          hosts: configuration.hosts,
+          log: configuration.log,
+          trace: configuration.trace
+        )
+      end
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def define(*args, &block)
+      Proxy.new *args, &block
+    end
+
+    def add(*args)
+      index = Index.new(*args)
+      registry[index.name] = index
+    end
+
+    def find(name)
+      registry[name]
+    end
+    alias_method :[], :find
+
+    def each(&block)
+      registry.values.sort.each &block
+    end
+
+    def build
+      unless client.indices.exists?(index: namespace)
+        client.indices.create(
+          index: namespace,
+          body: { settings: configuration.analysis }
+        )
+      end
+      each &:build
+    end
+
+    def exist?(type)
+      client.indices.exists? index: namespace, type: type
+    end
+
+    def rebuild
+      destroy
+      build
+    end
+
+    def destroy
+      if client.indices.exists?(index: namespace)
+        client.indices.delete index: namespace
+      end
+    end
+
+    def suggest(*args)
+      response = client.suggest(
+        index: namespace,
+        body: { suggestions: Dsl::Api.new(args, &configuration.suggestions).to_h }
+      )
+      response['suggestions'].first['options'].map &:symbolize_keys
+    end
+
+    private
+
+    def registry
+      @registry ||= {}
+    end
+
+  end
+end