daedal 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67944926b6a5ef6c6eb5165191a03f089e784c89
-  data.tar.gz: 0082ced2272905533bf4eae8912abb2bdb178ab6
+  metadata.gz: 27cd710adc4e066c10e7a70e93e7bcc021f39e97
+  data.tar.gz: adc66f8d210e1f33e56cc4d39dd9b9467a68546f
 SHA512:
-  metadata.gz: f2a28d5bc4314a4827127eee9c300e14fefc2417c2fd25c7bd660d19f41a40bab560d051365c2449da4ee163a3c039e186ae5790b379022b13ad850a4128173e
-  data.tar.gz: 80b821a4d5050ec57b8806548e1e2768a93b0b4af8df6b9299f11ba228950080aec796c201bb660d93585523fdccea9130e66c2954a5353d615fd095a6514f00
+  metadata.gz: 8b9509704bf2f5965b25dd09c8f6370bcca897bc62a7ffec635368b363f275261cba9b39ddb99dfedb54b4314cc33d71b44ca5e0fa4375c64c46be91a181ea5e
+  data.tar.gz: 4fb13110837bf95334b67fbc247f36ccff48a627948e40ea9a699632c3a68a4924aff8012a78744948e1d00dac46debf4f8af332bbb7c7f709aa3f30a6ffe646

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    daedal (0.0.16)
+    daedal (0.0.17)
       virtus (>= 1.0.0)
 
 GEM
@@ -58,7 +58,7 @@ GEM
     rb-inotify (0.9.2)
       ffi (>= 0.5.0)
     rest-client (1.6.7)
-      mime-types (>= 1.16)
+      mime-types (>= 1.17)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)

data/README.md

@@ -102,6 +102,7 @@ Currently, the following queries have been implemented:
 * [nested query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html)
 * [prefix query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html)
 * [query string query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html)
+* [simple query string query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html)
 * [range query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-range-query.html)
 * [term query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-term-query.html)
 * [terms query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html)
@@ -140,6 +141,7 @@ Currently, the following filters have been implemented:
 * [terms filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-terms-filter.html)
 * [nested filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-nested-filter.html)
 * [exists filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-exists-filter.html)
+* [type filter](http://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-type-filter.html)
 
 ### Type checking and attribute coercion
 

data/lib/daedal.rb

@@ -20,6 +20,8 @@ require 'daedal/attributes/field'
 require 'daedal/attributes/query_value'
 require 'daedal/attributes/boost'
 require 'daedal/attributes/score_function_array'
+require 'daedal/attributes/type_value'
+require 'daedal/attributes/flag'
 
 # filters
 require 'daedal/filters/exists_filter'
@@ -32,6 +34,7 @@ require 'daedal/filters/and_filter'
 require 'daedal/filters/or_filter'
 require 'daedal/filters/bool_filter'
 require 'daedal/filters/nested_filter'
+require 'daedal/filters/type_filter'
 
 # queries
 require 'daedal/queries/match_all_query'
@@ -49,5 +52,6 @@ require 'daedal/queries/term_query'
 require 'daedal/queries/terms_query'
 require 'daedal/queries/range_query'
 require 'daedal/queries/function_score_query'
+require 'daedal/queries/simple_query_string_query'
 
-# facets
+# facets

data/lib/daedal/attributes/flag.rb

@@ -0,0 +1,33 @@
+module Daedal
+  module Attributes
+    """Custom coercer for the flag attribute"""
+    class Flag < Virtus::Attribute
+      ALLOWED_FLAGS = [
+        :all,
+        :none,
+        :and,
+        :or,
+        :not,
+        :prefix,
+        :phrase,
+        :precedence,
+        :escape,
+        :whitespace,
+        :fuzzy,
+        :near,
+        :slop
+      ]
+
+      def coerce(value)
+        unless value.nil?
+          value = value.to_sym
+          unless ALLOWED_FLAGS.include? value
+            raise Virtus::CoercionError.new(value, 'Daedal::Attributes::Flag')
+          end
+        end
+        value
+      end
+    end
+  end
+end
+

data/lib/daedal/attributes/type_value.rb

@@ -0,0 +1,18 @@
+module Daedal
+  module Attributes
+    """Custom coercer for the value of a type - can be a string or a symbol. If
+    it's none of those, raises a coercion error."""
+    class TypeValue < Virtus::Attribute
+      ALLOWED_QUERY_VALUE_CLASSES = [String, Symbol]
+      def coerce(q)
+        if !required? and q.nil?
+          return q
+        elsif ALLOWED_QUERY_VALUE_CLASSES.include? q.class
+          return q
+        else
+          raise Virtus::CoercionError.new(q, self.class)
+        end
+      end
+    end
+  end
+end

data/lib/daedal/filters/type_filter.rb

@@ -0,0 +1,14 @@
+module Daedal
+  module Filters
+    """Class for the type filter"""
+    class TypeFilter < Filter
+
+      # required attributes
+      attribute :type, Daedal::Attributes::TypeValue
+
+      def to_hash
+        {type: {:value => type}}
+      end
+    end
+  end
+end

data/lib/daedal/queries/simple_query_string_query.rb

@@ -0,0 +1,43 @@
+module Daedal
+  module Queries
+    """Class for the simple query string query"""
+    class SimpleQueryStringQuery < Query
+
+      # required attributes
+      attribute :query,                         String
+
+      # non required attributes
+      attribute :default_field,                 Daedal::Attributes::Field, required: false
+      attribute :fields,                        Array[Daedal::Attributes::Field], required: false
+      attribute :default_operator,              String, required: false
+      attribute :analyzer,                      Symbol, required: false
+      attribute :lowercase_expanded_terms,      Boolean, required: false
+      attribute :minimum_should_match,          Integer, required: false
+      attribute :lenient,                       Boolean, required: false
+      attribute :flags,                         Array[Daedal::Attributes::Flag], required: false
+
+      def to_hash
+        parameters = present_attributes
+
+        if parameters[:flags]
+          parameters[:flags] = parameters[:flags].map(&:to_s).join('|')
+        end
+
+        { simple_query_string: parameters }
+      end
+
+      private
+
+      def present_attributes
+        attributes.select do |parameter, value|
+          case parameter
+          when :fields, :flags
+            !value.empty?
+          else
+            !value.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/daedal/version.rb

@@ -1,3 +1,3 @@
 module Daedal
-  VERSION = '0.0.16'
+  VERSION = '0.0.17'
 end

data/spec/unit/daedal/attributes/flag_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Daedal::Attributes::Flag do
+  class Whatever
+    include Virtus.model
+
+    attribute :flag, Daedal::Attributes::Flag
+  end
+
+  describe '#coerce' do
+    it 'coerces a coercible value' do
+      model = Whatever.new(flag: 'prefix')
+
+      expect(model.flag).to eq :prefix
+    end
+
+    it 'raises a coercion error if flag is not allowed' do
+      expect do
+        Whatever.new(flag: 'asdasdasdsa')
+      end.to raise_error Virtus::CoercionError
+    end
+  end
+end

data/spec/unit/daedal/filters/type_filter_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Daedal::Filters::TypeFilter do
+
+  subject do
+    Daedal::Filters::TypeFilter
+  end
+
+  let(:type) do
+    :bar
+  end
+
+  let(:hash_filter) do
+    {type: {:value => type}}
+  end
+
+  context 'without a type specified' do
+    it 'will raise an error' do
+      expect {subject.new}.to raise_error(Virtus::CoercionError)
+    end
+  end
+
+  context 'with a type specified' do
+    let(:filter) do
+      subject.new(type: type)
+    end
+    it 'will populate the type attribute appropriately' do
+      expect(filter.type).to eq type
+    end
+    it 'will have the correct hash representation' do
+      expect(filter.to_hash).to eq hash_filter
+    end
+    it 'will have the correct json representation' do
+      expect(filter.to_json).to eq hash_filter.to_json
+    end
+  end
+end

data/spec/unit/daedal/queries/simple_query_string_spec.rb

@@ -0,0 +1,168 @@
+require 'spec_helper'
+
+describe Daedal::Queries::SimpleQueryStringQuery do
+
+  subject do
+    Daedal::Queries::SimpleQueryStringQuery
+  end
+
+  let(:hash_query) do
+    {simple_query_string: {query: 'foo'}}
+  end
+
+  context 'without a query string' do
+    it 'will raise an error' do
+      expect{subject.new}.to raise_error(Virtus::CoercionError)
+    end
+  end
+
+  context 'with a query that is not a string given' do
+    let(:query) do
+      subject.new query: :foo
+    end
+    it 'will convert to a string' do
+      expect(query.query).to eq 'foo'
+    end
+  end
+
+  context 'with a query' do
+    let(:query) do
+      subject.new query: 'foo'
+    end
+    it 'will create a query string with the correct value' do
+      expect(query.query).to eq 'foo'
+    end
+    it 'will have the correct hash and json representation' do
+      expect(query.to_hash).to eq hash_query
+      expect(query.to_json).to eq hash_query.to_json
+    end
+  end
+
+  context 'with a default_field' do
+    let(:query) do
+      subject.new query: 'foo', default_field: :bar
+    end
+    before do
+      hash_query[:simple_query_string][:default_field] = :bar
+    end
+    it 'will set the default_field' do
+      expect(query.default_field).to eq :bar
+    end
+    it 'will have the correct hash and json representations' do
+      expect(query.to_hash).to eq hash_query
+      expect(query.to_json).to eq hash_query.to_json
+    end
+  end
+
+  context 'with an array of fields' do
+    let(:query) do
+      subject.new query: 'foo', fields: [:bar]
+    end
+    before do
+      hash_query[:simple_query_string][:fields] = [:bar]
+    end
+    it 'will set the fields' do
+      expect(query.fields).to eq [:bar]
+    end
+    it 'will have the correct hash and json representations' do
+      expect(query.to_hash).to eq hash_query
+      expect(query.to_json).to eq hash_query.to_json
+    end
+  end
+
+  context 'with a default_operator' do
+    let(:query) do
+      subject.new query: 'foo', default_operator: 'OR'
+    end
+    before do
+      hash_query[:simple_query_string][:default_operator] = 'OR'
+    end
+    it 'will set the default_operator' do
+      expect(query.default_operator).to eq 'OR'
+    end
+    it 'will have the correct hash and json representations' do
+      expect(query.to_hash).to eq hash_query
+      expect(query.to_json).to eq hash_query.to_json
+    end
+  end
+
+  context 'with an analyzer' do
+    let(:query) do
+      subject.new query: 'foo', analyzer: :bar
+    end
+    before do
+      hash_query[:simple_query_string][:analyzer] = :bar
+    end
+    it 'will set the analyzer' do
+      expect(query.analyzer).to eq :bar
+    end
+    it 'will have the correct hash and json representations' do
+      expect(query.to_hash).to eq hash_query
+      expect(query.to_json).to eq hash_query.to_json
+    end
+  end
+
+  context 'with flags' do
+    let(:query) do
+      subject.new query: 'foo', flags: [:or, :and, :prefix]
+    end
+    before do
+      hash_query[:simple_query_string][:flags] = 'or|and|prefix'
+    end
+    it 'will set the flags' do
+      expect(query.flags).to eq [:or, :and, :prefix]
+    end
+    it 'will have the correct hash and json representations' do
+      expect(query.to_hash).to eq hash_query
+      expect(query.to_json).to eq hash_query.to_json
+    end
+  end
+
+  context 'with a lowercase_expanded_terms' do
+    let(:query) do
+      subject.new query: 'foo', lowercase_expanded_terms: true
+    end
+    before do
+      hash_query[:simple_query_string][:lowercase_expanded_terms] = true
+    end
+    it 'will set the lowercase_expanded_terms' do
+      expect(query.lowercase_expanded_terms).to eq true
+    end
+    it 'will have the correct hash and json representations' do
+      expect(query.to_hash).to eq hash_query
+      expect(query.to_json).to eq hash_query.to_json
+    end
+  end
+
+  context 'with a minimum_should_match' do
+    let(:query) do
+      subject.new query: 'foo', minimum_should_match: 2
+    end
+    before do
+      hash_query[:simple_query_string][:minimum_should_match] = 2
+    end
+    it 'will set the minimum_should_match' do
+      expect(query.minimum_should_match).to eq 2
+    end
+    it 'will have the correct hash and json representations' do
+      expect(query.to_hash).to eq hash_query
+      expect(query.to_json).to eq hash_query.to_json
+    end
+  end
+
+  context 'with a lenient' do
+    let(:query) do
+      subject.new query: 'foo', lenient: true
+    end
+    before do
+      hash_query[:simple_query_string][:lenient] = true
+    end
+    it 'will set the lenient' do
+      expect(query.lenient).to eq true
+    end
+    it 'will have the correct hash and json representations' do
+      expect(query.to_hash).to eq hash_query
+      expect(query.to_json).to eq hash_query.to_json
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: daedal
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Christopher Schuch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2015-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -46,6 +46,7 @@ files:
 - lib/daedal/attributes/field.rb
 - lib/daedal/attributes/filter.rb
 - lib/daedal/attributes/filter_array.rb
+- lib/daedal/attributes/flag.rb
 - lib/daedal/attributes/lower_case_string.rb
 - lib/daedal/attributes/match_type.rb
 - lib/daedal/attributes/operator.rb
@@ -54,6 +55,7 @@ files:
 - lib/daedal/attributes/query_value.rb
 - lib/daedal/attributes/score_function_array.rb
 - lib/daedal/attributes/score_mode.rb
+- lib/daedal/attributes/type_value.rb
 - lib/daedal/facets/facet.rb
 - lib/daedal/filters/and_filter.rb
 - lib/daedal/filters/bool_filter.rb
@@ -66,6 +68,7 @@ files:
 - lib/daedal/filters/range_filter.rb
 - lib/daedal/filters/term_filter.rb
 - lib/daedal/filters/terms_filter.rb
+- lib/daedal/filters/type_filter.rb
 - lib/daedal/queries/bool_query.rb
 - lib/daedal/queries/constant_score_query.rb
 - lib/daedal/queries/dis_max_query.rb
@@ -80,10 +83,12 @@ files:
 - lib/daedal/queries/query.rb
 - lib/daedal/queries/query_string_query.rb
 - lib/daedal/queries/range_query.rb
+- lib/daedal/queries/simple_query_string_query.rb
 - lib/daedal/queries/term_query.rb
 - lib/daedal/queries/terms_query.rb
 - lib/daedal/version.rb
 - spec/spec_helper.rb
+- spec/unit/daedal/attributes/flag_spec.rb
 - spec/unit/daedal/filters/and_filter_spec.rb
 - spec/unit/daedal/filters/bool_filter_spec.rb
 - spec/unit/daedal/filters/exists_filter_spec.rb
@@ -94,6 +99,7 @@ files:
 - spec/unit/daedal/filters/range_filter_spec.rb
 - spec/unit/daedal/filters/term_filter_spec.rb
 - spec/unit/daedal/filters/terms_filter_spec.rb
+- spec/unit/daedal/filters/type_filter_spec.rb
 - spec/unit/daedal/queries/bool_query_spec.rb
 - spec/unit/daedal/queries/constant_score_query_spec.rb
 - spec/unit/daedal/queries/dis_max_query_spec.rb
@@ -107,6 +113,7 @@ files:
 - spec/unit/daedal/queries/prefix_query_spec.rb
 - spec/unit/daedal/queries/query_string_spec.rb
 - spec/unit/daedal/queries/range_query_spec.rb
+- spec/unit/daedal/queries/simple_query_string_spec.rb
 - spec/unit/daedal/queries/term_query_spec.rb
 - spec/unit/daedal/queries/terms_query_spec.rb
 homepage: https://github.com/cschuch/daedal