elasticband 0.1.0

data/spec/query_spec.rb

@@ -0,0 +1,274 @@
+require 'spec_helper'
+
+RSpec.describe Elasticband::Query do
+  describe '#to_h' do
+    subject { described_class.new.to_h }
+
+    it { is_expected.to eq(match_all: {}) }
+  end
+
+  describe '.parse' do
+    context 'with only the query text' do
+      subject { described_class.parse('foo') }
+
+      it { is_expected.to eq(match: { _all: 'foo' }) }
+    end
+
+    context 'with options' do
+      subject { described_class.parse('foo', options) }
+
+      context 'with `:on` option' do
+        context 'with a single field' do
+          let(:options) { { on: :name } }
+
+          it { is_expected.to eq(match: { name: 'foo' }) }
+        end
+
+        context 'with multiple fields on `:on` option' do
+          let(:options) { { on: %i(name description) } }
+
+          it { is_expected.to eq(multi_match: { query: 'foo', fields: %i(name description) }) }
+        end
+
+        context 'with a composed name on `:on` option' do
+          let(:options) { { on: 'company.name' } }
+
+          it { is_expected.to eq(match: { 'company.name': 'foo' }) }
+        end
+      end
+
+      context 'with `:only/:except` option' do
+        context 'with only `:only` option' do
+          context 'with a single clause' do
+            let(:options) { { only: { status: :published } } }
+
+            it 'returns a filtered query with a `term` filter' do
+              is_expected.to eq(
+                filtered: {
+                  query: { match: { _all: 'foo' } },
+                  filter: { term: { status: :published } }
+                }
+              )
+            end
+          end
+
+          context 'with multiple clauses' do
+            let(:options) { { only: { status: :published, company_id: 1 } } }
+
+            it 'returns a filtered query with an `and` filter' do
+              is_expected.to eq(
+                filtered: {
+                  query: { match: { _all: 'foo' } },
+                  filter: {
+                    and: [
+                      { term: { status: :published } },
+                      term: { company_id: 1 }
+                    ]
+                  }
+                }
+              )
+            end
+          end
+
+          context 'with a nested attribute' do
+            let(:options) { { only: { company: { id: 1 } } } }
+
+            it 'returns a filtered query with a `term` filter on dotted notation' do
+              is_expected.to eq(
+                filtered: {
+                  query: { match: { _all: 'foo' } },
+                  filter: { term: { 'company.id': 1 } }
+                }
+              )
+            end
+          end
+
+          context 'with multiple values' do
+            let(:options) { { only: { status: %i(published rejected) } } }
+
+            it 'returns a filtered query with a `terms` filter' do
+              is_expected.to eq(
+                filtered: {
+                  query: { match: { _all: 'foo' } },
+                  filter: { terms: { status: %i(published rejected) } }
+                }
+              )
+            end
+          end
+        end
+
+        context 'with only `:except` option' do
+          context 'with a single clause' do
+            let(:options) { { except: { status: :published } } }
+
+            it 'returns a filtered query with a `not` filter wrapping a `term` filter' do
+              is_expected.to eq(
+                filtered: {
+                  query: { match: { _all: 'foo' } },
+                  filter: { not: { term: { status: :published } } }
+                }
+              )
+            end
+          end
+
+          context 'with multiple clauses' do
+            let(:options) { { except: { status: :published, company_id: 1 } } }
+
+            it 'returns a filtered query with a `not` filter wrapping an `and` filter' do
+              is_expected.to eq(
+                filtered: {
+                  query: { match: { _all: 'foo' } },
+                  filter: {
+                    and: [
+                      { not: { term: { status: :published } } },
+                      not: { term: { company_id: 1 } }
+                    ]
+                  }
+                }
+              )
+            end
+          end
+
+          context 'with a nested attribute' do
+            let(:options) { { except: { company: { id: 1 } } } }
+
+            it 'returns a filtered query with a `not` filter wrapping a `term` filter on dotted notation' do
+              is_expected.to eq(
+                filtered: {
+                  query: { match: { _all: 'foo' } },
+                  filter: { not: { term: { 'company.id': 1 } } }
+                }
+              )
+            end
+          end
+
+          context 'with multiple values' do
+            let(:options) { { except: { status: %i(published rejected) } } }
+
+            it 'returns a filtered query with `not` filter wrapping a `terms` filter' do
+              is_expected.to eq(
+                filtered: {
+                  query: { match: { _all: 'foo' } },
+                  filter: { not: { terms: { status: %i(published rejected) } } }
+                }
+              )
+            end
+          end
+        end
+
+        context 'with both options' do
+          let(:options) { { only: { status: :published }, except: { company_id: 1 } } }
+
+          it 'returns a filtered query combining the filters' do
+            is_expected.to eq(
+              filtered: {
+                query: { match: { _all: 'foo' } },
+                filter: {
+                  and: [
+                    { term: { status: :published } },
+                    not: { term: { company_id: 1 } }
+                  ]
+                }
+              }
+            )
+          end
+        end
+      end
+
+      context 'with `:boost_by` option' do
+        let(:options) { { boost_by: :contents_count } }
+
+        it 'returns a function score query with a `field_value_factor` function' do
+          is_expected.to eq(
+            function_score: {
+              query: { match: { _all: 'foo' } },
+              field_value_factor: {
+                field: :contents_count,
+                modifier: :ln2p
+              }
+            }
+          )
+        end
+      end
+
+      context 'with `:boost_where` option' do
+        context 'with a regular attribute' do
+          let(:options) { { boost_where: { status: :published } } }
+
+          it 'returns a function score query with a `boost_factor` filtered function' do
+            is_expected.to eq(
+              function_score: {
+                query: { match: { _all: 'foo' } },
+                functions: [
+                  {
+                    filter: { term: { status: :published } },
+                    boost_factor: 1000
+                  }
+                ]
+              }
+            )
+          end
+        end
+
+        context 'with a multiple attributes' do
+          let(:options) { { boost_where: { status: :published, company_id: 1 } } }
+
+          it 'returns a function score query with a `boost_factor` filtered function' do
+            is_expected.to eq(
+              function_score: {
+                query: { match: { _all: 'foo' } },
+                functions: [
+                  {
+                    filter: {
+                      and: [
+                        { term: { status: :published } },
+                        term: { company_id: 1 }
+                      ]
+                    },
+                    boost_factor: 1000
+                  }
+                ]
+              }
+            )
+          end
+        end
+
+        context 'with a nested attribute' do
+          let(:options) { { boost_where: { company: { id: 1 } } } }
+
+          it 'returns a function score query with a `boost_factor` filtered function' do
+            is_expected.to eq(
+              function_score: {
+                query: { match: { _all: 'foo' } },
+                functions: [
+                  {
+                    filter: { term: { 'company.id': 1 } },
+                    boost_factor: 1000
+                  }
+                ]
+              }
+            )
+          end
+        end
+
+        context 'with multiple values' do
+          let(:options) { { boost_where: { status: %i(published rejected) } } }
+
+          it 'returns a function score query with a `boost_factor` filtered function' do
+            is_expected.to eq(
+              function_score: {
+                query: { match: { _all: 'foo' } },
+                functions: [
+                  {
+                    filter: { terms: { status: %i(published rejected) } },
+                    boost_factor: 1000
+                  }
+                ]
+              }
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/spec/search_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe Elasticband::Search do
+  describe '.parse' do
+    subject { described_class.parse('foo', on: :name, group_by: :status) }
+
+    before do
+      allow(Elasticband::Query).to receive(:parse).with('foo', on: :name, group_by: :status) { query }
+      allow(Elasticband::Aggregation).to receive(:parse).with(on: :name, group_by: :status) { aggregation }
+    end
+
+    context 'with only query' do
+      let(:query) { 'query' }
+      let(:aggregation) { {} }
+
+      it { is_expected.to eq(query: 'query') }
+    end
+
+    context 'with only aggregation' do
+      let(:query) { {} }
+      let(:aggregation) { 'aggregation' }
+
+      it { is_expected.to eq(aggs: 'aggregation') }
+    end
+
+    context 'with query and aggregation' do
+      let(:query) { 'query' }
+      let(:aggregation) { 'aggregation' }
+
+      it { is_expected.to eq(query: 'query', aggs: 'aggregation') }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+require 'dotenv'
+Dotenv.load
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+
+  CodeClimate::TestReporter.start
+end
+
+require 'rspec'
+require 'elasticband'
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each { |f| require f }
+
+RSpec.configure do |config|
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
+  # Exclude tests marked as broken
+  config.filter_run_excluding :broken
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 5
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # Disable RSpec monkey patches
+  #
+  # - It force to use `RSpec.describe` at the top level spec
+  config.disable_monkey_patching!
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+
+  config.example_status_persistence_file_path = '.rspec_persistence'
+
+  config.alias_it_should_behave_like_to :it_has_behavior, 'has behavior:'
+
+  # Turn on aggregate_failures by default, if you don't want it specify `aggregate_failures: false`
+  # into your example
+  config.define_derived_metadata do |meta|
+    meta[:aggregate_failures] = true unless meta.key?(:aggregate_failures)
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: elasticband
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Glauber Campinho
+- Rubens Minoru Andako Bueno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: 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: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: codeclimate-test-reporter
+  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'
+description: 
+email:
+- ggcampinho@gmail.com
+- rubensmabueno@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- elasticband.gemspec
+- lib/elasticband.rb
+- lib/elasticband/aggregation.rb
+- lib/elasticband/aggregation/nested.rb
+- lib/elasticband/aggregation/terms.rb
+- lib/elasticband/aggregation/top_hits.rb
+- lib/elasticband/filter.rb
+- lib/elasticband/filter/and.rb
+- lib/elasticband/filter/not.rb
+- lib/elasticband/filter/query.rb
+- lib/elasticband/filter/term.rb
+- lib/elasticband/filter/terms.rb
+- lib/elasticband/query.rb
+- lib/elasticband/query/filtered.rb
+- lib/elasticband/query/function_score.rb
+- lib/elasticband/query/match.rb
+- lib/elasticband/query/multi_match.rb
+- lib/elasticband/query/score_function.rb
+- lib/elasticband/query/score_function/boost_factor.rb
+- lib/elasticband/query/score_function/field_value_factor.rb
+- lib/elasticband/query/score_function/filtered.rb
+- lib/elasticband/query/score_function/script_score.rb
+- lib/elasticband/search.rb
+- lib/elasticband/version.rb
+- spec/aggregation/nested_spec.rb
+- spec/aggregation/terms_spec.rb
+- spec/aggregation/top_hits_spec.rb
+- spec/aggregation_spec.rb
+- spec/filter/and_spec.rb
+- spec/filter/not_spec.rb
+- spec/filter/query_spec.rb
+- spec/filter/term_spec.rb
+- spec/filter/terms_spec.rb
+- spec/filter_spec.rb
+- spec/query/filtered_spec.rb
+- spec/query/function_score_spec.rb
+- spec/query/match_spec.rb
+- spec/query/multi_match_spec.rb
+- spec/query/score_function/boost_factor_spec.rb
+- spec/query/score_function/field_value_factor_spec.rb
+- spec/query/score_function/filtered_spec.rb
+- spec/query/score_function/script_score_spec.rb
+- spec/query/score_function_spec.rb
+- spec/query_spec.rb
+- spec/search_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/LoveMondays/elasticband
+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.4.7
+signing_key: 
+specification_version: 4
+summary: Query builder for elasticsearch-rails
+test_files: []