elasticsearch-rails2 0.0.1

data/spec/client_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Elasticsearch::Rails2::Client do
+
+  context "Client module" do
+    class ::FooClientModule
+      include Elasticsearch::Rails2
+      # extend Elasticsearch::Rails2::Client::ClassMethods
+      # include Elasticsearch::Rails2::Client::InstanceMethods
+    end
+
+    context "default client method" do
+      it "should be an Elasticsearch::Transport::Client" do
+        expect(FooClientModule.client).to be_an Elasticsearch::Transport::Client
+        expect(FooClientModule.new.client).to be_an Elasticsearch::Transport::Client
+      end
+    end
+
+    context "set the client for the model" do
+      it "should set the client for the class and for new instances" do
+        obj = 'foo'
+        FooClientModule.client = obj
+        expect(FooClientModule.client).to be obj
+        expect(FooClientModule.new.client).to be obj
+      end
+    end
+
+    context "set the client for an instance" do
+      it "should set the client for the instance" do
+        obj = 'foo'
+        instance = FooClientModule.new
+        instance.client = obj
+        expect(instance.client).to be obj
+      end
+    end
+
+  end
+end

data/spec/naming_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Elasticsearch::Rails2::Naming do
+  context "Naming module" do
+    class ::NamingDummyModel < ActiveRecord::Base
+      include Elasticsearch::Rails2
+    end
+
+    before(:each){create_dummy_table :naming_dummy_models}
+
+    describe "index_name" do
+      context "Elasticsearch::Rails2.index_name is not defined" do
+        it "should return default index_name" do
+          expect(NamingDummyModel.index_name).to eq("naming_dummy_models_index")
+          expect(NamingDummyModel.new.index_name).to eq("naming_dummy_models_index")
+        end
+      end
+
+      context "Elasticsearch::Rails2.index_name is defined" do
+
+        before(:each) {Elasticsearch::Rails2.index_name = 'foo'}
+        after(:each) {Elasticsearch::Rails2.reset}
+
+        it "should return the Elasticsearch::Rails2.index_name" do
+          expect(NamingDummyModel.index_name).to eq("foo")
+          expect(NamingDummyModel.new.index_name).to eq("foo")
+        end
+      end
+
+      context "when the index_name is defined in the class" do
+        before(:each){ NamingDummyModel.index_name = 'foobar'}
+        after(:each){ NamingDummyModel.index_name = nil}
+
+        it "should return the index_name defined in the class" do
+          expect(NamingDummyModel.index_name).to eq("foobar")
+          expect(NamingDummyModel.new.index_name).to eq("foobar")
+        end
+
+      end
+
+
+      context "when the index_name is defined for an instance" do
+        before(:each){
+          @foo = NamingDummyModel.new
+          @foo.index_name = 'foobar_instance'
+        }
+
+        it "should return the index_name defined in the instance" do
+          expect(NamingDummyModel.index_name).to eq("naming_dummy_models_index")
+          expect(@foo.index_name).to eq("foobar_instance")
+        end
+
+      end
+
+    end
+
+    describe "document_type" do
+
+      it "should return the default calculated document_type" do
+        expect(NamingDummyModel.document_type).to eq("naming_dummy_models")
+        expect(NamingDummyModel.new.document_type).to eq("naming_dummy_models")
+      end
+
+      context "when document_type is defined in the class" do
+        before(:each){ NamingDummyModel.document_type = 'foobar'}
+        after(:each){ NamingDummyModel.document_type = nil}
+
+        it "should return the new document_type" do
+          expect(NamingDummyModel.document_type).to eq("foobar")
+          expect(NamingDummyModel.new.document_type).to eq("foobar")
+        end
+      end
+
+      context "when document_type is defined in the instance" do
+        before(:each){
+          @foo = NamingDummyModel.new
+          @foo.document_type = 'foobar_instance'
+        }
+
+        it "should return the new document_type" do
+          expect(NamingDummyModel.document_type).to eq("naming_dummy_models")
+          expect(@foo.document_type).to eq("foobar_instance")
+        end
+      end
+
+    end
+  end
+end

data/spec/rails2_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Elasticsearch::Rails2 do
+
+  after do
+    Elasticsearch::Rails2.reset
+  end
+
+  describe ".client" do
+    it "should return a default Elasticsearch::Transport::Client" do
+      expect(Elasticsearch::Rails2.client).to be_an Elasticsearch::Transport::Client
+    end
+  end
+
+  describe ".client=" do
+    it "should set the client" do
+      obj = 'foo'
+      Elasticsearch::Rails2.client = obj
+      expect(Elasticsearch::Rails2.client).to be obj
+    end
+  end
+
+  describe '.index_name' do
+    it "should return the default index_name" do
+      expect(Elasticsearch::Rails2.index_name).to eq(Elasticsearch::Rails2::Configuration::DEFAULT_INDEX_NAME)
+    end
+  end
+
+  describe '.index_name=' do
+    it "should set the index_name" do
+      Elasticsearch::Rails2.index_name = 'production'
+      expect(Elasticsearch::Rails2.index_name).to eq('production')
+    end
+  end
+
+  describe '.options=' do
+    before do
+      @keys = Elasticsearch::Rails2::Configuration::VALID_OPTIONS_KEYS
+
+      @options = {
+        :index_name => 'production'
+      }
+    end
+
+    it "should override default configuration" do
+      Elasticsearch::Rails2.options = @options
+      @keys.each do |key|
+        expect(Elasticsearch::Rails2.send(key)).to eq(@options[key])
+      end
+    end
+  end
+
+end

data/spec/response/result_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Elasticsearch::Rails2::Response::Result do
+
+  it "should have method access to properties" do
+    result = Elasticsearch::Rails2::Response::Result.new foo: 'bar', bar: { bam: 'baz' }
+
+    expect(result).to respond_to :foo
+    expect(result).to respond_to :bar
+
+    expect(result.foo).to eq('bar')
+    expect(result.bar.bam).to eq('baz')
+
+    expect{result.xoxo}.to raise_error(NoMethodError)
+  end
+
+  it "should return _id as #id" do
+    result = Elasticsearch::Rails2::Response::Result.new foo: 'bar', _id: 42, _source: { id: 12 }
+
+    expect(result.id).to eq(42)
+    expect(result._source.id).to eq(12)
+  end
+
+  it "should return _type as #type" do
+    result = Elasticsearch::Rails2::Response::Result.new foo: 'bar', _type: 'baz', _source: { type: 'BAM' }
+
+    expect(result.type).to eq('baz')
+    expect(result._source.type).to eq('BAM')
+  end
+
+  it "should delegate method calls to `_source` when available" do
+    result = Elasticsearch::Rails2::Response::Result.new foo: 'bar', _source: { bar: 'baz' }
+
+    expect(result).to respond_to :foo
+    expect(result).to respond_to :_source
+    expect(result).to respond_to :bar
+
+    expect(result.foo).to eq('bar')
+    expect(result._source.bar).to eq('baz')
+    expect(result.bar).to eq('baz')
+  end
+
+  it "should delegate existence method calls to `_source`" do
+    result = Elasticsearch::Rails2::Response::Result.new foo: 'bar', _source: { bar: { bam: 'baz' } }
+
+    expect(result._source).to respond_to :bar?
+    expect(result).to respond_to :bar?
+
+    expect(result._source.bar?).to be true
+    expect(result.bar?).to be true
+    expect(result.boo?).to be false
+
+    expect(result.bar.bam?).to be true
+    expect(result.bar.boo?).to be false
+  end
+
+  it "should delegate methods to @result" do
+    result = Elasticsearch::Rails2::Response::Result.new foo: 'bar'
+
+
+    expect(result.foo).to eq('bar')
+    expect(result.fetch('foo')).to eq('bar')
+    expect(result.fetch('NOT_EXIST', 'moo')).to eq('moo')
+    expect(result.keys).to eq(['foo'])
+
+    expect(result).to respond_to :to_hash
+    expect(result.to_hash).to eq({'foo' => 'bar'})
+
+    expect{result.does_not_exist}.to raise_error(NoMethodError)
+  end
+
+  it "should delegate existence method calls to @result" do
+    result = Elasticsearch::Rails2::Response::Result.new foo: 'bar', _source: { bar: 'bam' }
+    expect(result).to respond_to :foo?
+
+    expect(result.foo?).to be true
+    expect(result.boo?).to be false
+    expect(result._source.foo?).to be false
+    expect(result._source.boo?).to be false
+  end
+
+  it "should delegate as_json to @result even when ActiveSupport changed half of Ruby" do
+    require 'active_support/json/encoding'
+    result = Elasticsearch::Rails2::Response::Result.new foo: 'bar'
+
+    expect(result.instance_variable_get(:@result)).to receive(:as_json).with(:except => 'foo')
+    result.as_json(:except => 'foo')
+  end
+end

data/spec/response/results_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Elasticsearch::Rails2::Response::Results do
+  context "Response results" do
+    class ::ResultsDummyModel < ActiveRecord::Base
+      include Elasticsearch::Rails2
+    end
+
+    before do
+      create_dummy_table :results_dummy_models
+
+      @els_response = { 'hits' => { 'total' => 123, 'max_score' => 456, 'hits' => [{'foo' => 'bar'}] } }
+
+      @search   = Elasticsearch::Rails2::Searching::SearchRequest.new ResultsDummyModel, '*'
+      allow(@search).to receive(:execute!){@els_response}
+      @response = Elasticsearch::Rails2::Response::Response.new ResultsDummyModel, @search
+      @results  = Elasticsearch::Rails2::Response::Results.new  ResultsDummyModel, @response
+    end
+
+    it "should access the results" do
+      expect(@results).to respond_to :results
+      results_results = @results.results
+      expect(results_results.size).to eq 1
+      expect(results_results.first.foo).to eq 'bar'
+    end
+
+    it "should delegate Enumerable methods to results" do
+      expect(@results).to_not be_empty
+      expect(@results.first.foo).to eq 'bar'
+    end
+
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Elasticsearch::Rails2::Response do
+
+  class ::ResponseFooModel < ActiveRecord::Base
+    include Elasticsearch::Rails2
+    index_name :test_index
+  end
+
+  RESPONSE = { 'took' => '5', 'timed_out' => false, '_shards' => {'one' => 'OK'}, 'hits' => { 'hits' => [] } }
+
+
+end

data/spec/searching_search_request_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Elasticsearch::Rails2::Searching::SearchRequest do
+  class ::SearchingDummyModel < ActiveRecord::Base
+    include Elasticsearch::Rails2
+  end
+
+  before do
+    create_dummy_table :searching_dummy_models
+
+    @client = double('client')
+    expect(SearchingDummyModel).to receive(:client).and_return(@client)
+  end
+
+  context "when the query is an string" do
+    it "should pass the search definition as a simple query" do
+      expect(@client).to receive(:search).with(hash_including(q: 'foo'))
+
+      search_request = Elasticsearch::Rails2::Searching::SearchRequest.new SearchingDummyModel, 'foo'
+      search_request.execute!
+    end
+  end
+
+  context "when the query is a hash" do
+    it "should pass the search definition as a hash" do
+      expect(@client).to receive(:search).with(hash_including(body: {foo: 'bar'}))
+
+      search_request = Elasticsearch::Rails2::Searching::SearchRequest.new SearchingDummyModel, {foo: 'bar'}
+      search_request.execute!
+    end
+  end
+
+  context "when the query is a JSON string" do
+    it "should pass the search definition as a JSON string" do
+      expect(@client).to receive(:search).with(hash_including(body: "{'foo':'bar'}"))
+
+      search_request = Elasticsearch::Rails2::Searching::SearchRequest.new SearchingDummyModel, "{'foo':'bar'}"
+      search_request.execute!
+    end
+  end
+
+  context "when the query responds to_hash" do
+    class CustomQuery
+      def to_hash; {foo: 'bar'}; end
+    end
+
+    it "should pass the search definition as a hash" do
+      expect(@client).to receive(:search).with(hash_including(body: {foo: 'bar'}))
+
+      search_request = Elasticsearch::Rails2::Searching::SearchRequest.new SearchingDummyModel, CustomQuery.new
+      search_request.execute!
+    end
+  end
+
+  it "should pass the options to the client" do
+    expect(@client).to receive(:search).with(hash_including(q: 'foo', size: 15))
+
+    search_request = Elasticsearch::Rails2::Searching::SearchRequest.new SearchingDummyModel, 'foo', size: 15
+    search_request.execute!
+  end
+
+end

data/spec/searching_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Elasticsearch::Rails2::Searching do
+  class ::SearchingDummyModel < ActiveRecord::Base
+    include Elasticsearch::Rails2
+  end
+
+  before do
+    create_dummy_table :searching_dummy_models
+  end
+
+  it "should have the search method" do
+    expect(SearchingDummyModel).to respond_to :search
+  end
+
+  it "should have the scan_all_ids method" do
+    expect(SearchingDummyModel).to respond_to :scan_all_ids
+  end
+
+  describe ".search" do
+    it "should initialize the search request object" do
+      expect(Elasticsearch::Rails2::Searching::SearchRequest).to receive(:new)
+        .with(SearchingDummyModel, 'foo', {default_operator: 'AND'})
+
+      SearchingDummyModel.search 'foo', default_operator: 'AND'
+    end
+
+    it "should not execute the actual search" do
+      # the search is executed when the response is accessed
+      search_request = double('search_request')
+      allow(Elasticsearch::Rails2::Searching::SearchRequest).to receive(:new).and_return(search_request)
+      expect(search_request).to_not receive(:execute!)
+      SearchingDummyModel.search 'foo'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+RUBY_1_8 = defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
+
+exit(0) if RUBY_1_8
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'elasticsearch/rails2'
+require 'rspec'
+require 'support/active_record'
+
+RSpec.configure do |config|
+  config.before(:each) {@dummy_tables = []}
+  config.after(:each) {drop_dummy_tables}
+end
+
+def create_dummy_table(table_name)
+  ActiveRecord::Migration.verbose = false
+  ActiveRecord::Migration.create_table table_name do |t|
+    t.string :name
+  end
+  @dummy_tables << table_name
+end
+
+def drop_dummy_tables
+  ActiveRecord::Migration.verbose = false
+  @dummy_tables.each {|table_name| ActiveRecord::Migration.drop_table table_name}
+end