elasticband 0.1.4 → 0.1.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDIyZmVkODQxNTU1MzJkODExOTU3YjQ1MGNhNGVhNDc2YmU4MWZmNw==
+    MWFmN2E3YzkzYjMxY2Y0NjFlMGFiODRhZjM4MmFlMzE2NGE5ODNjZA==
   data.tar.gz: !binary |-
-    NmRkZWU0ZWQwOGQxYWZlNzEwZmZlZjU1YjRhZWZiYTVlNWJjYTllNA==
+    NzcyMzlmZTg2YmU3ZmZjNTAxNDMxMTQ3OTFhZmY1ZDA5NWY4ODQwYQ==
 SHA512:
   metadata.gz: !binary |-
-    ZDE5ZjIzNTFkMTM0MWNiOTE3NzJjYmVmYzJiNTQ5OWU4YWEwZjI2YTZjMzM3
-    ODVmNzdmODU2YmVhYzk3N2ZjMzNhNTY5MTAxNTg4ODg4Mjg0NDNmYmI3NzJl
-    MDc3ZGMwMGMxMDZmYWQ4NzIzMjYwMTk3Y2JmZjg4MWFhY2E0Zjg=
+    NGRmZDJlYzQ2NzliMzM0MWE0ZDY0MTgwY2NkYjEwYjAxNzk4YjVhNzA1ZTA3
+    YWMxYzAwZDJlZDRkMTgyOWQyOGQwNjdmNWQ2MWI4N2QyODgwZDI4MDhkYjI1
+    YWUyYTcyMmY1NjAzMTA3ZWI1NTU3ZjIxZGJjMGFlZDkzZTE2Yjk=
   data.tar.gz: !binary |-
-    N2Q4NjNmOTJhODc4MTZiYTc2ZTMzZWJhYjBiODllNjg1OGQ4MmVlMDVjZTky
-    NmNmMzMyM2JhOWUxMWFjNWFiMGQ3YjI4ZWU1N2IxMzY5NWUxODA1ZmM3MDg4
-    ZWQzNTBiNDZiMjRiOWZhMTAzOThjNDIzMTU4NDAxMWI0NTkxYzE=
+    OGQyOWY1OGIxOWU2ZWQ3NzgxNzdlOTYxYTM3ODRkYTE3ZmUzMGVjMDU0YTQx
+    ZjZhNGI2MThkMDFlODVhYTU0MWUwZjFiYzA1YWVjZWM3NTliMDVhZTE3NGNm
+    ZWJkZmNkZGI1ZDYwOThiMTQwNjc0ZjgyMzZjNTQyZDdiNTBkMTI=

data/.gitignore

@@ -4,7 +4,6 @@
 
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    elasticband (0.1.5)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    dotenv (2.0.2)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.0)
+    parser (2.2.2.6)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.32.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter
+  dotenv
+  elasticband!
+  rake
+  rspec (~> 3.3.0)
+  rubocop
+
+BUNDLED WITH
+   1.10.6

data/lib/elasticband.rb

@@ -7,6 +7,7 @@ require 'elasticband/aggregation'
 require 'elasticband/filter'
 require 'elasticband/query'
 require 'elasticband/search'
+require 'elasticband/sort'
 require 'elasticband/version'
 
 module Elasticband

data/lib/elasticband/query.rb

@@ -93,7 +93,7 @@ module Elasticband
 
       def parse_boost_function(boost_options)
         if boost_options[:boost_by].present?
-          ScoreFunction::FieldValueFactor.new(boost_options[:boost_by], modifier: :ln2p)
+          ScoreFunction::FieldValueFactor.new(boost_options[:boost_by], modifier: :ln2p, missing: 1)
         elsif boost_options[:boost_where].present?
           filter = Filter.parse(only: boost_options[:boost_where])
           ScoreFunction::Filtered.new(filter, ScoreFunction::BoostFactor.new(1_000))

data/lib/elasticband/search.rb

@@ -7,11 +7,18 @@ module Elasticband
       # #### Examples
       # ```
       # Search.parse('foo', on: :name, group_by: :status)
-      # => { query: { match: { name: 'foo' } }, aggs: { status: { terms: { field: :status } } } }
+      # => {
+      #      query: { match: { name: 'foo' } },
+      #      aggs: { status: { terms: { field: :status } } },
+      #      sort: [{name: 'desc'}, '+created_at']
+      #    }
       # ```
       def parse(query_text, options)
-        hash = { query: Query.parse(query_text, options), aggs: Aggregation.parse(options) }
-        hash.reject { |_, value| value.blank? }
+        {
+          sort: Sort.parse(options),
+          query: Query.parse(query_text, options),
+          aggs: Aggregation.parse(options)
+        }.reject { |_, value| value.blank? }
       end
     end
   end

data/lib/elasticband/sort.rb

@@ -0,0 +1,40 @@
+module Elasticband
+  class Sort
+    class << self
+      # Parses sort option to a Elasticsearch syntax.
+      #
+      # #### Options
+      #
+      # * `sort:` List of sort params.
+      #
+      # #### Examples
+      # ```
+      # Sort.parse(sort: [{ name: :desc }])
+      # => { sort: [{ name: :desc }] }
+      #
+      # Sort.parse(sort: [{ name: :asc }])
+      # => { sort: [{ name: :asc }] }
+      #
+      # Sort.parse(sort: ['+name'])
+      # => { sort: [{ name: :asc }] }
+      #
+      # Sort.parse(sort: ['-name'])
+      # => { sort: [{ name: :desc }] }
+      # ```
+      def parse(options)
+        options[:sort].map { |param| parse_param(param) }
+      end
+
+      private
+
+      def parse_param(param)
+        return param unless param.is_a?(String)
+
+        direction = param.start_with?('-') ? :desc : :asc
+        field = param.start_with?('-') || param.start_with?('+') ? param[1..-1] : param
+
+        { field.to_sym => direction }
+      end
+    end
+  end
+end

data/lib/elasticband/version.rb

@@ -1,3 +1,3 @@
 module Elasticband
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/spec/query_spec.rb

@@ -62,7 +62,8 @@ RSpec.describe Elasticband::Query do
               query: { match: { _all: 'foo' } },
               field_value_factor: {
                 field: :contents_count,
-                modifier: :ln2p
+                modifier: :ln2p,
+                missing: 1
               }
             }
           )

data/spec/search_spec.rb

@@ -2,16 +2,19 @@ require 'spec_helper'
 
 RSpec.describe Elasticband::Search do
   describe '.parse' do
-    subject { described_class.parse('foo', on: :name, group_by: :status) }
+    subject { described_class.parse('foo', options) }
+    let(:options) { { on: :name, group_by: :status, sort: [{ name: :desc }] } }
 
     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 }
+      allow(Elasticband::Sort).to receive(:parse).with(options) { sort }
+      allow(Elasticband::Query).to receive(:parse).with('foo', options) { query }
+      allow(Elasticband::Aggregation).to receive(:parse).with(options) { aggregation }
     end
 
     context 'with only query' do
       let(:query) { 'query' }
       let(:aggregation) { {} }
+      let(:sort) { [] }
 
       it { is_expected.to eq(query: 'query') }
     end
@@ -19,15 +22,25 @@ RSpec.describe Elasticband::Search do
     context 'with only aggregation' do
       let(:query) { {} }
       let(:aggregation) { 'aggregation' }
+      let(:sort) { [] }
 
       it { is_expected.to eq(aggs: 'aggregation') }
     end
 
-    context 'with query and aggregation' do
+    context 'with only sort' do
+      let(:query) { {} }
+      let(:aggregation) { {} }
+      let(:sort) { [{ name: :desc }] }
+
+      it { is_expected.to eq(sort: [{ name: :desc }]) }
+    end
+
+    context 'with query and aggregation and sort' do
       let(:query) { 'query' }
       let(:aggregation) { 'aggregation' }
+      let(:sort) { [{ name: :desc }] }
 
-      it { is_expected.to eq(query: 'query', aggs: 'aggregation') }
+      it { is_expected.to eq(query: 'query', aggs: 'aggregation', sort: [{ name: :desc }]) }
     end
   end
 end

data/spec/sort_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+RSpec.describe Elasticband::Sort do
+  describe '.parse' do
+    subject { described_class.parse(sort: sort_params) }
+
+    context 'with name desc' do
+      let(:sort_params) { [{ name: :desc }] }
+
+      it { is_expected.to eq([{ name: :desc }]) }
+    end
+
+    context 'with name asc short way' do
+      let(:sort_params) { ['+name'] }
+
+      it { is_expected.to eq([{ name: :asc }]) }
+    end
+
+    context 'with name desc short way' do
+      let(:sort_params) { ['-name'] }
+
+      it { is_expected.to eq([{ name: :desc }]) }
+    end
+
+    context 'with name as string' do
+      let(:sort_params) { ['name'] }
+
+      it { is_expected.to eq([{ name: :asc }]) }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticband
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Glauber Campinho
@@ -109,6 +109,7 @@ files:
 - .travis.yml
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -138,6 +139,7 @@ files:
 - lib/elasticband/query/score_function/filtered.rb
 - lib/elasticband/query/score_function/script_score.rb
 - lib/elasticband/search.rb
+- lib/elasticband/sort.rb
 - lib/elasticband/version.rb
 - spec/aggregation/field_based_spec.rb
 - spec/aggregation/filter_spec.rb
@@ -163,6 +165,7 @@ files:
 - spec/query/score_function_spec.rb
 - spec/query_spec.rb
 - spec/search_spec.rb
+- spec/sort_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/LoveMondays/elasticband
 licenses: