elastic_queue 0.0.10 → 0.0.11

data/spec/lib/integration/elastic_queue_persistence_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe ElasticQueue::Persistence do
+  before :all do
+    class Animal < ActiveRecord::Base
+      include ElasticQueue::Queueable
+      queue_attributes :dangerous, :cute, :birthdate
+      not_analyzed_queue_attributes :species, :description, :name
+    end
+  
+    class TestAnimalsQueue < ElasticQueue::Base
+      models :animal
+    end
+  end
+
+  after :all do
+    [:Animal, :TestAnimalsQueue].each do |constant|
+      Object.send(:remove_const, constant)
+    end
+  end
+
+  after :each do
+    delete_index('test_animals_queue')
+  end
+
+  describe '#index_exists?' do
+    it 'gives false when its index doesnt exist' do
+      delete_index('test_animals_queue')
+      expect(TestAnimalsQueue.index_exists?).to be false
+    end
+
+    it 'gives true when its index exists' do
+      create_index('test_animals_queue')
+      expect(TestAnimalsQueue.index_exists?).to be true
+    end
+  end
+
+  describe '#reset_index' do
+    pending
+  end
+
+  describe '#create_index' do
+    it 'sets the default analyzer to use the whitespace tokenizer with the lowercase filter and no stopwords' do
+      TestAnimalsQueue.create_index
+      expect(`curl -XGET 'localhost:9200/test_animals_queue/_analyze?' -d 'AND OR'`)
+      .to eq('{"tokens":[{"token":"and","start_offset":0,"end_offset":3,"type":"word","position":1},{"token":"or","start_offset":4,"end_offset":6,"type":"word","position":2}]}')
+
+      expect(`curl -XGET 'localhost:9200/test_animals_queue/_analyze?' -d 'under_scored_word'`)
+      .to eq('{"tokens":[{"token":"under_scored_word","start_offset":0,"end_offset":17,"type":"word","position":1}]}')
+    end
+  end
+
+  describe '#delete_index' do
+    pending
+  end
+  
+  describe '#bulk_index' do
+    before :all do
+      ActiveRecord::Base.connection.execute("INSERT INTO animals (name, species)
+                                             VALUES ('pom-pom', 'dog'), ('fluffy', 'dog'), ('muffy', 'cat');")
+    end
+    it 'creates the index if one doesn\t exist' do
+      expect(test_search_client.indices.exists index: 'test_animals_queue').to be false
+      TestAnimalsQueue.bulk_index
+      expect(test_search_client.indices.exists index: 'test_animals_queue').to be true
+    end
+
+    it 'indexes all existing models' do
+      TestAnimalsQueue.bulk_index
+      refresh_index('test_animals_queue')
+      expect(query_all('test_animals_queue')['hits']['total']).to be 3
+    end
+
+    it 'takes scopes' do
+      class Animal < ActiveRecord::Base
+        scope :not_fluffy, where("name != 'fluffy'")
+        scope :only_dogs, where(species: 'dog')
+      end
+      TestAnimalsQueue.bulk_index(scopes: { animal: [:not_fluffy, :only_dogs], some_other_model: [:this_wont_get_called] })
+      refresh_index('test_animals_queue')
+      expect(query_all('test_animals_queue')['hits']['total']).to be 1
+    end
+  end
+
+  describe '#add_mappings' do
+    pending
+  end
+
+  describe '#index_model' do
+    pending
+  end
+
+  describe '#upsert_model' do
+    pending
+  end
+
+  describe '#remove_model' do
+    pending
+  end
+end

data/spec/lib/integration/elastic_queue_query_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe ElasticQueue::Query do
+  before :all do
+    class Animal < ActiveRecord::Base
+      include ElasticQueue::Queueable
+      queues :test_animals_queue
+      queue_attributes :dangerous, :cute, :birthdate
+      not_analyzed_queue_attributes :species, :description, :name
+    end
+
+    class TestAnimalsQueue < ElasticQueue::Base
+      models :animal
+    end
+
+    TestAnimalsQueue.create_index
+
+    animals = []
+    (0...55).each { |name| animals << { name: name } }
+    Animal.create(animals)
+  end
+
+  after :all do
+    Animal.all.each(&:destroy)
+    [:Animal, :TestAnimalsQueue].each do |constant|
+      Object.send(:remove_const, constant)
+    end
+    delete_index('test_animals_queue')
+  end
+
+  describe '#paginate' do
+    it 'runs the query and returns a WillPaginate::Collection' do
+      expect(TestAnimalsQueue.query.paginate).to be_a(WillPaginate::Collection)
+    end
+
+    it 'has pagination defaults of { page: 1, per_page: 30 }' do
+      expect(TestAnimalsQueue.query.paginate.length).to eq 30
+      expect(TestAnimalsQueue.query.paginate.current_page).to eq 1
+    end
+
+    it 'the returned collection knows how many results there are total' do
+      expect(TestAnimalsQueue.query.paginate.total_entries).to eq 55
+    end
+
+    it 'can take per_page as an option' do
+      expect(TestAnimalsQueue.query.paginate({ per_page: 2 }).length).to eq 2
+    end
+
+    it 'can take page as an option' do
+      first_result_on_page_1 = TestAnimalsQueue.query.paginate({ page: 1 }).first.id
+      first_result_on_page_2 = TestAnimalsQueue.query.paginate({ page: 2 }).first.id
+      expect(first_result_on_page_1).to_not eq first_result_on_page_2
+    end
+
+    it 'can take both page and per_page as options at the same time' do
+       expect(TestAnimalsQueue.query.paginate({ page: 2, per_page: 2 }).length).to eq 2
+       expect(TestAnimalsQueue.query.paginate({ page: 2, per_page: 2 }).current_page).to eq 2
+    end
+  end
+
+  describe '#all' do
+    it 'returns an array' do
+      expect(TestAnimalsQueue.query.all).to be_a(Array)
+    end
+
+    it 'returns all results' do
+      expect(TestAnimalsQueue.query.all.length).to be 55
+    end
+  end
+
+  describe '#count' do
+    it 'returns the count of the number of results' do
+     expect(TestAnimalsQueue.query.all.count).to be 55
+    end
+
+    it 'does not make elasticsearch fetch all the records' do
+      TestAnimalsQueue.search_client.stub(:search) { { hits: { total: 0, hits: [] } } }
+      TestAnimalsQueue.search_client.should_receive(:search).with({ index: 'test_animals_queue', body: {}, search_type: 'count' })
+      TestAnimalsQueue.query.count
+    end
+  end
+end

data/spec/lib/integration/elastic_queue_queuable_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe 'ElasticQueue::Queueable integration' do
+  before :all do
+    class Animal < ActiveRecord::Base
+      include ElasticQueue::Queueable
+      queues :test_animals_queue
+      queue_attributes :dangerous, :cute, :birthdate
+      not_analyzed_queue_attributes :species, :description, :name
+    end
+
+    class TestAnimalsQueue < ElasticQueue::Base
+      models :animal
+    end
+  end
+
+  after :all do
+    [:Animal, :TestAnimalsQueue].each do |constant|
+      Object.send(:remove_const, constant)
+    end
+  end
+
+  describe 'callbacks' do
+    before :each do
+      TestAnimalsQueue.create_index
+      @fluffy = Animal.create({ name: 'Fluffy' })
+    end
+
+    after :each do
+      Animal.all.each(&:destroy)
+      delete_index('test_animals_queue')
+    end
+
+    it 'adds newly created models to the queue' do
+      # model was created in before block
+      expect(query_all('test_animals_queue')['hits']['hits'].first['_source']['name']).to eq 'Fluffy'
+    end
+
+    it 'deletes deleted models from the queue' do
+      Animal.find(@fluffy.id).destroy
+      refresh_index('test_animals_queue')
+      expect(query_all('test_animals_queue')['hits']['total']).to be 0
+    end
+
+    it 'updates a changed model in the queue' do
+      @fluffy.update_attributes(name: 'Muffy')
+      refresh_index('test_animals_queue')
+      expect(query_all('test_animals_queue')['hits']['hits'].first['_source']['name']).to eq 'Muffy'
+    end
+  end
+
+  # TODO: Turn back on later
+  # describe '#add_queue' do
+  #   after :each do
+  #     [:SomeModel, :SomeOtherModel, :SomeQueue, :SomeOtherQueue].each do |constant|
+  #       Object.send(:remove_const, constant) if Object.constants.include? constant
+  #     end
+  #   end
+  #   it 'adds a queue to its list of queues' do
+  #     class SomeModel < ActiveRecord::Base
+  #       include ElasticQueue::Queueable
+  #     end
+  #     class SomeQueue < ElasticQueue::Base
+  #     end
+  #     SomeModel.add_queue(:some_queue)
+  #     expect(SomeModel.queues.sort).to eq [:some_queue]
+  #   end
+  # 
+  #   it 'only adds each queue once' do
+  #     class SomeOtherModel < ActiveRecord::Base
+  #       include ElasticQueue::Queueable
+  #     end
+  #     class SomeQueue < ElasticQueue::Base
+  #     end
+  #     class SomeOtherQueue < ElasticQueue::Base
+  #     end
+  #     SomeOtherModel.add_queue(:some_queue)
+  #     SomeOtherModel.add_queue(:some_other_queue)
+  #     SomeOtherModel.add_queue(:some_queue)
+  #     expect(SomeOtherModel.queues.sort).to eq [:some_other_queue, :some_queue]
+  #   end
+  # end
+end

data/spec/lib/integration/elastic_queue_sorts_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe 'ElasticQueue::Sorts integration' do
+  before :all do
+    class Animal < ActiveRecord::Base
+      include ElasticQueue::Queueable
+      queues :test_animals_queue
+      queue_attributes :dangerous, :cute, :birthdate
+      not_analyzed_queue_attributes :species, :description, :name
+    end
+
+    class TestAnimalsQueue < ElasticQueue::Base
+      models :animal
+    end
+
+    TestAnimalsQueue.create_index
+  end
+
+  after :all do
+    Animal.all.each(&:destroy)
+    [:Animal, :TestAnimalsQueue].each do |constant|
+      Object.send(:remove_const, constant)
+    end
+    delete_index('test_animals_queue')
+  end
+
+  describe 'ElasticQueue::Query#sort' do
+    after :each do
+      Animal.all.each(&:destroy)
+    end
+
+    it 'sorts ascending and descending on one value' do
+      Animal.create({ name: 'a', birthdate: Date.today.at_midnight - 1.year })
+      Animal.create({ name: 'b', birthdate: Date.today.at_midnight - 2.years })
+      Animal.create({ name: 'c', birthdate: Date.today.at_midnight - 3.years })
+      expect(TestAnimalsQueue.query.sort(birthdate: 'asc').all.map(&:name)).to eq ['c', 'b', 'a']
+      expect(TestAnimalsQueue.query.sort(birthdate: 'desc').all.map(&:name)).to eq ['a', 'b', 'c']
+    end
+
+    it 'sorts ascending and descending on two values' do
+      Animal.create({ name: 'a', birthdate: Date.today.at_midnight - 1.year })
+      Animal.create({ name: 'b', birthdate: Date.today.at_midnight - 1.years })
+      Animal.create({ name: 'c', birthdate: Date.today.at_midnight - 3.years })
+      expect(TestAnimalsQueue.query.sort(birthdate: 'asc').sort(name: 'asc').all.map(&:name)).to eq ['c', 'a', 'b']
+      expect(TestAnimalsQueue.query.sort(birthdate: 'asc').sort(name: 'desc').all.map(&:name)).to eq ['c', 'b', 'a']
+    end
+
+    it 'doesn\'t fail to sort because of stopwords' do
+      Animal.create({ name: 'and' })
+      Animal.create({ name: 'or' })
+      Animal.create({ name: 'if' })
+      expect(TestAnimalsQueue.query.sort(name: 'asc').all.map(&:name)).to eq ['and', 'if', 'or']
+    end
+
+    it 'doesn\'t error if you try to sort on a nonexistent value' do
+      Animal.create({ name: 'a'})
+      expect { TestAnimalsQueue.query.sort(fake_value: 'yes').all }.to_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -5,20 +5,13 @@ require 'rspec/autorun'
 require 'factory_girl'
 require File.expand_path('../../lib/elastic_queue', __FILE__)
 require 'support/elastic_queue_helper'
+require 'support/database_helper'
 
-# Requires supporting ruby files with custom matchers and macros, etc,
-# in spec/support/ and its subdirectories.
-# Dir['spec/support/**/*.rb'].each { |f| require f }
-# require_relative '../../lib/elastic_queue'
+DatabaseHelper.new({ :adapter  => 'sqlite3', :database => './spec/eq_test.db' }).initialize_db
 
 RSpec.configure do |config|
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
   config.order = 'random'
   config.color_enabled = true
-
   config.include FactoryGirl::Syntax::Methods
   config.include(ElasticQueueHelper)
 end

data/spec/support/database_helper.rb

@@ -0,0 +1,37 @@
+require 'active_record'
+require 'sqlite3'
+
+class DatabaseHelper
+
+  def initialize(opts)
+    @opts = opts
+  end
+
+  def initialize_db
+    ActiveRecord::Base.establish_connection(@opts)
+    drop_tables
+    initialize_tables
+  end
+
+  def initialize_tables
+    ActiveRecord::Migration.class_eval do
+      create_table :animals do |t|
+        t.string   :name
+        t.string   :species
+        t.datetime :birthdate
+        t.boolean  :dangerous
+        t.boolean  :cute
+        t.text     :description
+      end
+    end
+  end
+
+  def drop_tables
+    if ActiveRecord::Base.connection.table_exists? 'animals'
+      ActiveRecord::Migration.class_eval do
+        drop_table :animals
+      end
+    end
+  end
+
+end

data/spec/support/elastic_queue_helper.rb

@@ -1,18 +1,30 @@
 module ElasticQueueHelper
+  ElasticQueue::OPTIONS = { elasticsearch_hosts: [{ host: 'localhost', port: 9200, protocol: 'http' }] }
 
   TEST_SEARCH_CLIENT = Elasticsearch::Client.new
-  
+
   def test_search_client
     TEST_SEARCH_CLIENT
   end
 
-  def refresh_index
+  def create_index(index_name)
+    delete_index(index_name)
+    test_search_client.indices.create index: index_name
+  end
+
+  def delete_index(index_name)
+    if test_search_client.indices.exists index: index_name
+      test_search_client.indices.delete index: index_name
+    end
+  end
+
+  def refresh_index(index_name)
     # forces the index to refresh itself so the search doesn't happen before the models are done being added to the index
-    TEST_SEARCH_CLIENT.indices.refresh index: 'test_queue'
+    test_search_client.indices.refresh index: index_name
   end
 
-  def query_all
+  def query_all(index_name)
     query = { 'query' => {'match_all' => {} } }.to_json
-    TEST_SEARCH_CLIENT.search index: 'test_queue', body: query, size: 500
+    test_search_client.search index: index_name, body: query, size: 500
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastic_queue
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Ruth Thompson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-02 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,6 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: elasticsearch
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +137,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: A library for storing and filtering documents on elastic search with
   a queue paradigm for retrieval.
 email:
@@ -153,9 +181,14 @@ files:
 - lib/elastic_queue/sorts.rb
 - lib/elastic_queue/version.rb
 - spec/factories.rb
-- spec/lib/elastic_queue_functional_spec.rb
-- spec/lib/elastic_queue_unit_spec.rb
+- spec/lib/integration/elastic_queue_base_spec.rb
+- spec/lib/integration/elastic_queue_filters_spec.rb
+- spec/lib/integration/elastic_queue_persistence_spec.rb
+- spec/lib/integration/elastic_queue_query_spec.rb
+- spec/lib/integration/elastic_queue_queuable_spec.rb
+- spec/lib/integration/elastic_queue_sorts_spec.rb
 - spec/spec_helper.rb
+- spec/support/database_helper.rb
 - spec/support/elastic_queue_helper.rb
 homepage: https://github.com/RuthThompson/elastic_queue
 licenses:
@@ -183,7 +216,12 @@ specification_version: 4
 summary: A queueing system built on top of elasticsearch.
 test_files:
 - spec/factories.rb
-- spec/lib/elastic_queue_functional_spec.rb
-- spec/lib/elastic_queue_unit_spec.rb
+- spec/lib/integration/elastic_queue_base_spec.rb
+- spec/lib/integration/elastic_queue_filters_spec.rb
+- spec/lib/integration/elastic_queue_persistence_spec.rb
+- spec/lib/integration/elastic_queue_query_spec.rb
+- spec/lib/integration/elastic_queue_queuable_spec.rb
+- spec/lib/integration/elastic_queue_sorts_spec.rb
 - spec/spec_helper.rb
+- spec/support/database_helper.rb
 - spec/support/elastic_queue_helper.rb