estella 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf61c93e5566773e32ae933239e245236cce24e3
-  data.tar.gz: c3d455dacea867bd1e53d325120991ff59cc0979
+  metadata.gz: bfebaabb0c030f132e17e046fcfea05c28d2fa9d
+  data.tar.gz: 9dbe818723ccfa698c3ad7e6f2775aaef20ec26e
 SHA512:
-  metadata.gz: 56bb154fc881a5670a089247dbb4d83134cbbb9303707835a3138ae987d13385e3598c2b7841ce912e635d5177885cda1441e321db7854cfcc0df87765ee90ea
-  data.tar.gz: 4b6ad124cba5f0a4bfd777de3afcf81c6d17af16796ff160825b190a26359942450e1b657ef9024206e3e5c4831c378100355f0a3cfe5e0c2425d8816d1442f0
+  metadata.gz: 3ddf9ea6b35d7e9e3a7a9b2f35c908a3ff3d02b65410fd4a7fad89adbf376946c99930126c78e8a6884c67793cca77018d22b7a9e59742ad80600de576ef4ebd
+  data.tar.gz: 5ff181eaed10c332c34fa21aafc78e415269515c5d0eaf7dfec77eecfe15079d6c0463ae9627f5253443b783abad53170c07be3fe8e888aaac70f71f05b76c34

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+

data/.gitignore

@@ -1 +1,3 @@
 Gemfile.lock
+pkg
+coverage

data/.rubocop_todo.yml

@@ -1,25 +1,25 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-01-24 13:49:04 -0500 using RuboCop version 0.47.1.
+# on 2017-01-25 11:50:14 -0500 using RuboCop version 0.47.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 2
 Metrics/AbcSize:
   Max: 24
 
 # Offense count: 3
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 94
+  Max: 117
 
-# Offense count: 26
+# Offense count: 28
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 131
+  Max: 135
 
 # Offense count: 1
 # Configuration parameters: CountComments.

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Changelog
 
+### 0.2.2 (Next)
+
+* [#15](https://github.com/artsy/estella/pull/15): Removed undocumented `set_index_alias!` - [@dblock](https://github.com/dblock).
+* [#15](https://github.com/artsy/estella/pull/15): Added `delete_index!` and `create_index!` - [@dblock](https://github.com/dblock).
+* [#14](https://github.com/artsy/estella/pull/14): Fix: destroying documents fails to remove them from the index - [@dblock](https://github.com/dblock).
+* [#13](https://github.com/artsy/estella/pull/13): Added code coverage w/ Coveralls - [@dblock](https://github.com/dblock).
+* Your contribution here.
+
 ### 0.2.1 (1/24/2017)
 
 * Initial public release as the `estella` gem - [@cavia](https://github.com/cavvia), [@mzikherman](https://github.com/mzikherman).

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :development, :test do
+  gem 'coveralls', '~> 0.8.17', require: false
+end

data/README.md

@@ -3,6 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/estella.svg)](https://badge.fury.io/rb/estella)
 [![Build Status](https://travis-ci.org/artsy/estella.svg?branch=master)](https://travis-ci.org/artsy/estella)
 [![License Status](https://git.legal/projects/3493/badge.svg)](https://git.legal/projects/3493)
+[![Coverage Status](https://coveralls.io/repos/github/artsy/estella/badge.svg?branch=master)](https://coveralls.io/github/artsy/estella?branch=master)
 
 Builds on [elasticsearch-model](https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-model) to make your Ruby objects searchable with Elasticsearch. Provides fine-grained control of fields, analysis, filters, weightings and boosts.
 
@@ -87,6 +88,28 @@ class Artist < ActiveRecord::Base
 end
 ```
 
+A number of class methods are available for indexing.
+
+```
+# returns true if the index exists
+Artist.index_exists?
+
+# creates the index
+Artist.create_index!
+
+# delete and re-create the index without reindexing data
+Artist.reload_index!
+
+# recreate the index and reindex all data
+Artist.recreate_index!
+
+# deletes the index
+Artist.delete_index!
+
+# commit any outstanding writes
+Artist.refresh_index!
+```
+
 ## Custom Analysis
 
 Estella defines `standard`, `snowball`, `ngram` and `shingle` analysers by default. These cover most search contexts, including auto-suggest. In order to enable full-text search for a field, use:

data/lib/estella/helpers.rb

@@ -28,7 +28,7 @@ module Estella
     end
 
     def es_delete
-      es_delete_document id
+      self.class.es_delete_document(id)
     end
 
     def es_transform
@@ -38,13 +38,13 @@ module Estella
     module ClassMethods
       ## Searching
 
-      def stella_raw_search(params = {})
+      def estella_raw_search(params = {})
         __elasticsearch__.search(estella_query(params))
       end
 
       # @return an array of database records mapped using an adapter
       def estella_search(params = {})
-        rsp = stella_raw_search(params)
+        rsp = estella_raw_search(params)
         params[:raw] ? rsp.response : rsp.records.to_a
       end
 
@@ -60,18 +60,28 @@ module Estella
       end
 
       def bulk_index(batch_of_ids)
+        create_index! unless index_exists?
         __elasticsearch__.client.bulk index: index_name, type: model_name.element, body: batch_to_bulk(batch_of_ids)
       end
 
+      # @return true if the index exists
       def index_exists?
         __elasticsearch__.client.indices.exists index: index_name
       end
 
-      def reload_index!
-        __elasticsearch__.client.indices.delete index: index_name if index_exists?
+      def delete_index!
+        __elasticsearch__.client.indices.delete index: index_name
+      end
+
+      def create_index!
         __elasticsearch__.client.indices.create index: index_name, body: { settings: settings.to_hash, mappings: mappings.to_hash }
       end
 
+      def reload_index!
+        delete_index! if index_exists?
+        create_index!
+      end
+
       def recreate_index!
         reload_index!
         import
@@ -82,10 +92,6 @@ module Estella
         __elasticsearch__.refresh_index!
       end
 
-      def set_index_alias!(name)
-        __elasticsearch__.client.indices.put_alias index: index_name, name: name
-      end
-
       def es_delete_document(id)
         __elasticsearch__.client.delete type: document_type, id: id, index: index_name
       end

data/lib/estella/query.rb

@@ -109,17 +109,5 @@ module Estella
         end
       end
     end
-
-    def bool_filter(field, param)
-      if param
-        { term: { field => true } }
-      elsif !param.nil?
-        { term: { field => false } }
-      end
-    end
-
-    def add_bool_filter(field, param)
-      must bool_filter(field, param) if bool_filter(field, param)
-    end
   end
 end

data/lib/estella/searchable.rb

@@ -56,7 +56,7 @@ module Estella
 
     module ClassMethods
       # support for mongoid::slug
-      # indexes slug attribue by default
+      # indexes slug attribute by default
       def index_slug
         if defined? slug
           indexed_fields.merge!(slug: { type: :string, index: :not_analyzed })

data/lib/estella/version.rb

@@ -1,3 +1,3 @@
 module Estella
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/spec/searchable_spec.rb

@@ -40,10 +40,11 @@ describe Estella::Searchable, type: :model do
       SearchableModel.reload_index!
       @jez = SearchableModel.create(title: 'jeremy corbyn', keywords: ['jez'])
       @tez = SearchableModel.create(title: 'theresa may', keywords: ['tez'])
+      @fab = SearchableModel.create(title: 'david faber', keywords: ['fab'])
       SearchableModel.refresh_index!
     end
     it 'returns relevant results' do
-      expect(SearchableModel.all.size).to eq(2)
+      expect(SearchableModel.all.size).to eq(3)
       expect(SearchableModel.estella_search(term: 'jeremy')).to eq([@jez])
       expect(SearchableModel.estella_search(term: 'theresa')).to eq([@tez])
     end
@@ -74,14 +75,36 @@ describe Estella::Searchable, type: :model do
       expect(SearchableModel.mappings.to_hash[:searchable_model][:properties].keys.include?(:slug)).to eq true
     end
     it 'supports boolean filters' do
-      @liapunov = SearchableModel.create(title: 'liapunov', published: true)
+      liapunov = SearchableModel.create(title: 'liapunov', published: true)
       SearchableModel.create(title: 'liapunov unpublished')
       SearchableModel.refresh_index!
-      expect(SearchableModel.estella_search(published: true)).to eq [@liapunov]
+      expect(SearchableModel.estella_search(published: true)).to eq [liapunov]
     end
     it 'does not override field method on class' do
       expect(SearchableModel.methods.include?(:field)).to eq(false)
     end
+    it 'removes a document from the index after deletion' do
+      @jez.destroy
+      expect(SearchableModel.estella_search(term: 'jeremy')).to eq([])
+      expect(SearchableModel.estella_search(term: 'theresa')).to eq([@tez])
+    end
+    context 'with a deleted index' do
+      before do
+        SearchableModel.delete_index!
+      end
+      it 'recreates an index' do
+        expect { SearchableModel.estella_search(term: 'theresa') }.to raise_error Elasticsearch::Transport::Transport::Errors::NotFound
+        SearchableModel.recreate_index!
+        expect(SearchableModel.estella_search(term: 'theresa')).to eq([@tez])
+      end
+      it 'indexes a bulk set of documents' do
+        SearchableModel.bulk_index([@fab.id, @tez.id])
+        SearchableModel.refresh_index!
+        expect(SearchableModel.estella_search(term: 'jeremy')).to eq([]) # not indexes
+        expect(SearchableModel.estella_search(term: 'theresa')).to eq([@tez])
+        expect(SearchableModel.estella_search(term: 'david')).to eq([@fab])
+      end
+    end
   end
 
   describe 'configuration errors' do

data/spec/spec_helper.rb

@@ -2,17 +2,12 @@ require 'active_support'
 require 'active_model'
 require 'rspec'
 
+require 'coveralls'
+Coveralls.wear!
+
 require File.expand_path('../../lib/estella.rb', __FILE__)
 
 RSpec.configure do |config|
-  config.mock_with :rspec do |c|
-    c.syntax = :expect
-  end
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-
   config.raise_errors_for_deprecations!
 
   config.before(:context, elasticsearch: true) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: estella
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Anil Bawa-Cavia
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-24 00:00:00.000000000 Z
+date: 2017-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch-model
@@ -144,6 +144,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -185,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Make your Ruby objects searchable with Elasticsearch.