mongoid-giza 0.1.0

data/spec/mongoid/giza_spec.rb

@@ -0,0 +1,282 @@
+require "spec_helper"
+
+describe Mongoid::Giza do
+  before do
+    allow(Mongoid::Giza::GizaID).to receive(:create).with(id: :Person)
+    allow(Mongoid::Giza::Configuration.instance).to receive(:add_index)
+
+    class Person
+      include Mongoid::Document
+      include Mongoid::Giza
+
+      field :name, type: String
+      field :age, type: Integer
+    end
+  end
+
+  after do
+    Object.send(:remove_const, :Person)
+  end
+
+  let(:index) do
+    index = double("index")
+    allow(index).to receive(:name) { :Person }
+    index
+  end
+
+  let(:new_index) { allow(Mongoid::Giza::Index).to receive(:new).with(Person, {}) { index } }
+
+  let(:search) do
+    search = double("search")
+    allow(Mongoid::Giza::Search).to receive(:new).with("localhost", 9132) { search }
+    search
+  end
+
+  let(:search_run) { allow(search).to receive(:run) { double("results").as_null_object } }
+
+  let(:search_indexes) { allow(search).to receive(:indexes=) }
+
+  let(:config) { Mongoid::Giza::Configuration.instance }
+
+  describe "sphinx_index" do
+    context "static index" do
+      it "should add the index" do
+        expect(Person).to receive(:add_static_sphinx_index).with({}, kind_of(Proc))
+        Person.sphinx_index { }
+      end
+    end
+
+    context "dynamic index" do
+      it "should add the index to the dynamic index list" do
+        expect(Person).to receive(:add_dynamic_sphinx_index).with({}, kind_of(Proc))
+        Person.sphinx_index { |person| }
+      end
+    end
+  end
+
+  describe "add_static_sphinx_index" do
+    it "should create an index" do
+      expect(Mongoid::Giza::Index).to receive(:new).with(Person, {}) { index }
+      Person.add_static_sphinx_index({}, Proc.new { })
+    end
+
+    it "should call index methods" do
+      expect(index).to receive(:field).with(:name)
+      new_index
+      Person.add_static_sphinx_index({}, Proc.new { field :name })
+    end
+
+    it "should register the index on the class" do
+      sphinx_indexes = double("sphinx_indexes")
+      expect(sphinx_indexes).to receive(:[]=).with(index.name, index)
+      allow(Person).to receive(:static_sphinx_indexes) { sphinx_indexes }
+      new_index
+      Person.add_static_sphinx_index({}, Proc.new { })
+    end
+
+    it "should accept settings" do
+      expect(Mongoid::Giza::Index).to receive(:new).with(Person, enable_star: 1) { index }
+      Person.add_static_sphinx_index({enable_star: 1}, Proc.new { })
+    end
+
+    it "should add the index to the configuration" do
+      expect(config).to receive(:add_index).with(index)
+      new_index
+      Person.add_static_sphinx_index({}, Proc.new { })
+    end
+  end
+
+  describe "add_dynamic_sphinx_index" do
+    let(:dynamic_index) { double("dynamic index") }
+
+    before do
+      allow(Person).to receive(:process_dynamic_sphinx_index)
+    end
+
+    it "should create a dynamic index" do
+      allow(Person).to receive(:generated_sphinx_indexes) { double.as_null_object }
+      expect(Mongoid::Giza::DynamicIndex).to receive(:new).with(Person, {}, kind_of(Proc)) { double.as_null_object }
+      Person.add_dynamic_sphinx_index({}, Proc.new { })
+    end
+
+    it "should generate the indexes" do
+      allow(Mongoid::Giza::DynamicIndex).to receive(:new) { dynamic_index }
+      expect(Person).to receive(:process_dynamic_sphinx_index).with(dynamic_index)
+      Person.add_dynamic_sphinx_index({}, Proc.new { })
+    end
+  end
+
+  describe "process_dynamic_sphinx_index" do
+    let(:dynamic_index) { double("dynamic index") }
+
+    let(:generated) { double("generated") }
+
+    let(:generated_sphinx_indexes) { double("sphinx generated indexes") }
+
+    before do
+      allow(generated).to receive(:each)
+      allow(Person).to receive(:generated_sphinx_indexes) { generated_sphinx_indexes }
+      allow(generated_sphinx_indexes).to receive(:merge!)
+    end
+
+    it "should generate the indexes" do
+      expect(dynamic_index).to receive(:generate!) { {} }
+      Person.process_dynamic_sphinx_index(dynamic_index)
+    end
+
+    it "should merge the generated indexes" do
+      allow(dynamic_index).to receive(:generate!) { generated }
+      expect(generated_sphinx_indexes).to receive(:merge!).with(generated)
+      Person.process_dynamic_sphinx_index(dynamic_index)
+    end
+
+    it "should add the generated indexes to the configuration" do
+      allow(dynamic_index).to receive(:generate!) { generated }
+      allow(generated).to receive(:each).and_yield(:name, :generated_index)
+      expect(config).to receive(:add_index).with(:generated_index, true)
+      Person.process_dynamic_sphinx_index(dynamic_index)
+    end
+  end
+
+  describe "search" do
+    before do
+      allow(Mongoid::Giza::Configuration.instance.searchd).to receive(:address) { "localhost" }
+      allow(Mongoid::Giza::Configuration.instance.searchd).to receive(:port) { 9132 }
+    end
+
+    it "should create a search" do
+      expect(Mongoid::Giza::Search).to receive(:new).with("localhost", 9132, :Person, :Person_2) { double("search").as_null_object }
+      Person.sphinx_index { }
+      Person.sphinx_index { name :Person_2 }
+      Person.search {  }
+    end
+
+    it "should call search methods" do
+      search_run
+      search_indexes
+      expect(search).to receive(:fulltext).with("query")
+      Person.search { fulltext "query" }
+    end
+
+    it "should run the query" do
+      search_run
+      search_indexes
+      Person.search { }
+    end
+
+    it "should return an array of results" do
+      search_indexes
+      allow(search).to receive(:run) { [{matches: []}, {matches: []}] }
+      allow(Person).to receive(:in) { Mongoid::Criteria.new(Person) }
+      expect(Person.search { }).to be_a_kind_of(Array)
+    end
+
+    it "should return a Mongoid::Criteria with on each search results" do
+      search_indexes
+      allow(search).to receive(:run) { [{matches: []}, {matches: []}] }
+      expect(Person).to receive(:in).twice { Mongoid::Criteria.new(Person) }
+      Person.search { }
+    end
+  end
+
+  describe "giza_id" do
+    let(:person) { Person.new }
+
+    it "should use a previously created giza id" do
+      person[:giza_id] = 1
+      expect(person.giza_id).to eql(1)
+    end
+
+    it "should create a new giza id when needed" do
+      allow(Mongoid::Giza::GizaID).to receive(:next_id).with(:Person) { 1 }
+      expect(person.giza_id).to eql(1)
+    end
+
+    it "should save the object when the id is created" do
+      allow(Mongoid::Giza::GizaID).to receive(:next_id).with(:Person) { 1 }
+      expect(person).to receive(:set).with(:giza_id, 1)
+      person.giza_id
+    end
+
+    it "should not save the object when the id is reused" do
+      person[:giza_id] = 1
+      expect(person).not_to receive(:set)
+      person.giza_id
+    end
+  end
+
+  describe "sphinx_indexes" do
+    it "should return an collection containg static indexes and generated indexes" do
+      static = double("static")
+      generated = double("generated")
+      merged = double("merged")
+      allow(Person).to receive(:static_sphinx_indexes) { static }
+      allow(Person).to receive(:generated_sphinx_indexes) { generated }
+      allow(static).to receive(:merge).with(generated) { merged }
+      expect(Person.sphinx_indexes).to be(merged)
+    end
+  end
+
+  describe "sphinx_indexer!" do
+    let(:indexer) { Mongoid::Giza::Indexer.instance }
+
+    it "should execute the index with all indexes from this class" do
+      expect(indexer).to receive(:index!).with(:Person, :Person_2)
+      Person.sphinx_index { }
+      Person.sphinx_index { name :Person_2 }
+      Person.sphinx_indexer!
+    end
+
+    it "should accept a list of indexes names" do
+      expect(indexer).to receive(:index!).with(:Person, :Person_3)
+      Person.sphinx_index { }
+      Person.sphinx_index { name :Person_2 }
+      Person.sphinx_index { name :Person_3 }
+      Person.sphinx_indexer!(:Person, :Person_3)
+    end
+
+    it "should not execute if the class has no indexes" do
+      expect(indexer).not_to receive(:index!)
+      Person.sphinx_indexer!
+    end
+
+    it "should not execute if the supplied names do not match any index name of the current class" do
+      expect(indexer).not_to receive(:index!)
+      Person.sphinx_index { }
+      Person.sphinx_indexer!(:Person_2)
+    end
+  end
+
+  describe "sphinx_indexes_names" do
+    it "should return the name of all indexes" do
+      static = double("static")
+      generated = double("generated")
+      merged = double("merged")
+      names = double("names")
+      allow(Person).to receive(:static_sphinx_indexes) { static }
+      allow(Person).to receive(:generated_sphinx_indexes) { generated }
+      allow(static).to receive(:merge).with(generated) { merged }
+      allow(merged).to receive(:keys) { names }
+      expect(Person.sphinx_indexes_names).to be(names)
+    end
+  end
+
+  describe "regenerate_dynamic_sphinx_indexes" do
+    let(:generated) { double("generated") }
+
+    let(:dynamic) { double("dynamic") }
+
+    it "should clear the generated indexes" do
+      allow(Person).to receive(:generated_sphinx_indexes) { generated }
+      expect(generated).to receive(:clear)
+      Person.regenerate_dynamic_sphinx_indexes
+    end
+
+    it "should process all dynamic indexes" do
+      allow(Person).to receive(:dynamic_sphinx_indexes) { dynamic }
+      allow(dynamic).to receive(:each).and_yield(:dynamic_index)
+      expect(Person).to receive(:process_dynamic_sphinx_index).with(:dynamic_index)
+      Person.regenerate_dynamic_sphinx_indexes
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,51 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'coveralls'
+Coveralls.wear!
+
+require "database_cleaner"
+require "mongoid-rspec"
+require "mongoid/giza"
+
+MONGOID_CONFIG = {
+  sessions: {
+    default: {
+      database: "mongoid_giza_test",
+      hosts: [ "localhost:27017" ]
+    }
+  }
+}
+
+Mongoid.configure do |config|
+  config.load_configuration(MONGOID_CONFIG)
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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.include Mongoid::Matchers, type: :model
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-giza
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maurício Batista
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: mongoid-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: riddle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: builder
+  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: docile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Mongoid layer for the Sphinx fulltext search server that supports block
+  fields and dynamic indexes
+email:
+- eddloschi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid/giza.rb
+- lib/mongoid/giza/configuration.rb
+- lib/mongoid/giza/dynamic_index.rb
+- lib/mongoid/giza/index.rb
+- lib/mongoid/giza/index/attribute.rb
+- lib/mongoid/giza/index/field.rb
+- lib/mongoid/giza/indexer.rb
+- lib/mongoid/giza/models/giza_id.rb
+- lib/mongoid/giza/railtie.rb
+- lib/mongoid/giza/search.rb
+- lib/mongoid/giza/version.rb
+- lib/mongoid/giza/xml_pipe2.rb
+- mongoid-giza.gemspec
+- spec/mongoid/giza/configuration_spec.rb
+- spec/mongoid/giza/dynamic_index_spec.rb
+- spec/mongoid/giza/index/attribute_spec.rb
+- spec/mongoid/giza/index/field_spec.rb
+- spec/mongoid/giza/index_spec.rb
+- spec/mongoid/giza/indexer_spec.rb
+- spec/mongoid/giza/models/giza_id_spec.rb
+- spec/mongoid/giza/search_spec.rb
+- spec/mongoid/giza/xml_pipe2_spec.rb
+- spec/mongoid/giza_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/yadevteam/mongoid-giza
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Mongoid layer for the Sphinx fulltext search server
+test_files:
+- spec/mongoid/giza/configuration_spec.rb
+- spec/mongoid/giza/dynamic_index_spec.rb
+- spec/mongoid/giza/index/attribute_spec.rb
+- spec/mongoid/giza/index/field_spec.rb
+- spec/mongoid/giza/index_spec.rb
+- spec/mongoid/giza/indexer_spec.rb
+- spec/mongoid/giza/models/giza_id_spec.rb
+- spec/mongoid/giza/search_spec.rb
+- spec/mongoid/giza/xml_pipe2_spec.rb
+- spec/mongoid/giza_spec.rb
+- spec/spec_helper.rb
+has_rdoc: