daedal 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c4bde7051a2f331ec26642e3ffc6b517bec4ffc
-  data.tar.gz: 834a366bd9a23949f0db2a878c71450fc83ed09e
+  metadata.gz: 11c6ae3d232c10eb5d671406d9fe201d778c77dc
+  data.tar.gz: b59495f804fbc653fb9515c1fe6d0f29478d4a55
 SHA512:
-  metadata.gz: d7e1c3d7af4517105b94b3182e205f1de57b50c5e9ac9e1cfbbb8dd65463ac37ecef64bb0c092246aa608c63a41e86a110be4da5e4d5987c10cb976bbee63997
-  data.tar.gz: 5d3c1e527051b559fd0eec04254c8f68ee596cbb3515805630e035153c51c6b2a084bcbaa94b5aff1bfaf36f60790d88674617e0848fed0f29d8737d08952577
+  metadata.gz: 1886174417cd61ff5ffa31cd6807bb6eb1211f05f6237951ab39f7c09542edc744391bb70793caed483b92943a73b7b8bf4dd185f6a1d8cd97762f9bbe26a2f1
+  data.tar.gz: f2a586eefd70d05cbfcd925427ee691198d8bb2caab383ab66e641325a0ecb8d4378e2eb2200b0a4981b0efef057cac0f940b54c5a7b1f4b348f1348a5ef56f4

data/Gemfile.lock

@@ -1,20 +1,21 @@
 PATH
   remote: .
   specs:
-    daedal (0.0.14)
+    daedal (0.0.15)
       virtus (>= 1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    axiom-types (0.1.1)
-      descendants_tracker (~> 0.0.4)
-      ice_nine (~> 0.11.0)
-      thread_safe (~> 0.3, >= 0.3.1)
+    axiom-types (0.0.5)
+      descendants_tracker (~> 0.0.1)
+      ice_nine (~> 0.9)
+    backports (3.3.5)
     celluloid (0.15.2)
       timers (~> 1.1.0)
     coderay (1.1.0)
-    coercible (1.0.0)
+    coercible (0.2.0)
+      backports (~> 3.0, >= 3.1.0)
       descendants_tracker (~> 0.0.1)
     coveralls (0.7.0)
       multi_json (~> 1.3)
@@ -22,10 +23,9 @@ GEM
       simplecov (>= 0.7)
       term-ansicolor
       thor
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
+    descendants_tracker (0.0.3)
     diff-lcs (1.2.5)
-    equalizer (0.0.9)
+    equalizer (0.0.8)
     ffi (1.9.3)
     formatador (0.2.4)
     fuubar (1.2.1)
@@ -41,7 +41,7 @@ GEM
     guard-rspec (4.2.0)
       guard (>= 2.1.1)
       rspec (>= 2.14, < 4.0)
-    ice_nine (0.11.0)
+    ice_nine (0.10.0)
     listen (2.4.0)
       celluloid (>= 0.15.2)
       rb-fsevent (>= 0.9.3)
@@ -77,14 +77,13 @@ GEM
     term-ansicolor (1.2.2)
       tins (~> 0.8)
     thor (0.18.1)
-    thread_safe (0.3.4)
     timers (1.1.0)
     tins (0.13.1)
-    virtus (1.0.2)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0.3)
-      equalizer (~> 0.0.9)
+    virtus (1.0.0)
+      axiom-types (~> 0.0.5)
+      coercible (~> 0.2)
+      descendants_tracker (~> 0.0.1)
+      equalizer (~> 0.0.7)
 
 PLATFORMS
   ruby

data/README.md

@@ -23,9 +23,6 @@ query DSL into Ruby objects, Daedal addresses the following issues:
 Daedal also makes it easy to define custom queries tailored to your specific use case - you can see
 a simple example at the end of the documentation.
 
-Daedal itself is designed more as a "low level" library, and doesn't necessarily make for terribly elegant code.
-If you'd prefer a more Ruby-friendly block DSL, you can take a look at a new project I've been working on, [DaedalSL](https://github.com/RallyPointNetworks/daedal-sl).
-
 Installation
 ------------
 
@@ -135,6 +132,7 @@ Currently, the following filters have been implemented:
 * [and filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-and-filter.html)
 * [bool filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-bool-filter.html)
 * [geo distance filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-filter.html)
+* [geo distance range filter](http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/geo-distance.html#geo-distance-range)
 * [or filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-or-filter.html)
 * [range filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-range-filter.html)
 * [term filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-term-filter.html)
@@ -257,4 +255,4 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/daedal.rb

@@ -26,6 +26,7 @@ require 'daedal/filters/term_filter'
 require 'daedal/filters/terms_filter'
 require 'daedal/filters/range_filter'
 require 'daedal/filters/geo_distance_filter'
+require 'daedal/filters/geo_distance_range_filter'
 require 'daedal/filters/and_filter'
 require 'daedal/filters/or_filter'
 require 'daedal/filters/bool_filter'

data/lib/daedal/filters/geo_distance_range_filter.rb

@@ -0,0 +1,55 @@
+module Daedal
+  module Filters
+    """Class for the geo filter with range abilities"""
+    class GeoDistanceRangeFilter < Filter
+      POSSIBLE_COMPARE_OPTIONS = %i(gte gt lte lt)
+
+      # required attributes
+      attribute :field,         Daedal::Attributes::Field
+      attribute :lat,           Float
+      attribute :lon,           Float
+
+      # non required attributes
+      attribute :unit,          Daedal::Attributes::DistanceUnit, default: 'km'
+      POSSIBLE_COMPARE_OPTIONS.each do |possible_compare|
+        attribute possible_compare,   Daedal::Attributes::QueryValue, required: false
+      end
+
+      def initialize(options={})
+        super options
+        validate_compare_options(options)
+      end
+
+      def to_hash
+        {
+          geo_distance_range: {
+            field =>  {
+              lat: lat,
+              lon: lon
+            }
+          }.merge(compare_options)
+        }
+      end
+
+      private
+
+      def compare_options
+        POSSIBLE_COMPARE_OPTIONS.each_with_object({}) do |compare_option, compare_options|
+          compare_options[compare_option] = decorate_distance(attributes[compare_option]) if attributes[compare_option]
+        end
+      end
+
+      def decorate_distance(distance)
+        "#{distance}#{unit}"
+      end
+
+      def validate_compare_options(options)
+        if options.values_at(*POSSIBLE_COMPARE_OPTIONS).compact.empty?
+          raise 'Must give at least one of gte, gt, lt, or lte'
+        end
+        raise 'gte & gt are not valid together' if gte && gt
+        raise 'gte & gt are not valid together' if lte && lt
+      end
+    end
+  end
+end

data/lib/daedal/queries/range_query.rb

@@ -23,11 +23,10 @@ module Daedal
 
       def to_hash
         inner_result = attributes.select { |k,v| MINIMUM_ATTRIBUTES.include?(k) && !v.nil? }
-        inner_result.merge(boost: boost) if boost
-        
-        {range: {field => inner_result} }
+        inner_result.merge!(boost: boost) if boost
 
+        {range: {field => inner_result} }
       end
     end
   end
-end
+end

data/lib/daedal/version.rb

@@ -1,3 +1,3 @@
 module Daedal
-  VERSION = '0.0.14'
-end
+  VERSION = '0.0.15'
+end

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

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe Daedal::Filters::GeoDistanceRangeFilter do
+
+  subject do
+    Daedal::Filters::GeoDistanceRangeFilter
+  end
+
+  context 'without a field specified' do
+    it 'will raise an error' do
+      expect{subject.new(lat: 10, lon: 30, gte: 5)}.to raise_error(Virtus::CoercionError)
+    end
+  end
+
+  context 'without a compare options specified' do
+    it 'will raise an error' do
+      expect{subject.new(field: :location, lat: 10, lon: 30)}.to raise_error
+    end
+  end
+
+  context 'without a lat specified' do
+    it 'will raise an error' do
+      expect{subject.new(field: :location, gte: 5, lon: 30)}.to raise_error(Virtus::CoercionError)
+    end
+  end
+
+  context 'without a lon specified' do
+    it 'will raise an error' do
+      expect{subject.new(field: :location, lat: 10, gte: 5)}.to raise_error(Virtus::CoercionError)
+    end
+  end
+
+  context 'with an invalid unit specified' do
+    it 'will raise an error' do
+      expect{subject.new(field: :test, gte: 5, lat: 10, lon: 30, unit: 'test')}.to raise_error(Virtus::CoercionError)
+    end
+  end
+
+  context 'with an invalid lat specified' do
+    it 'will raise an error' do
+      expect{subject.new(field: :location, gte: 5, lat: 'test', lon: 30)}.to raise_error(Virtus::CoercionError)
+    end
+  end
+
+  context 'with an invalid lon specified' do
+    it 'will raise an error' do
+      expect{subject.new(field: :location, gte: 5, lat: 10, lon: 'test')}.to raise_error(Virtus::CoercionError)
+    end
+  end
+
+  context 'with wrong compare options' do
+    it 'will raise error with less than or equal to + less than compare' do
+      expect{subject.new(field: :test, lat: 10, lon: 30, lte: 5, lt: 5)}.to raise_error
+    end
+
+    it 'will raise error with more than or equal to + more than compare' do
+      expect{subject.new(field: :test, lat: 10, lon: 30, gte: 5, gt: 5)}.to raise_error
+    end
+  end
+
+  context 'with all attributes' do
+    let(:filter) do
+      subject.new(field: :location, lat: 10, lon: 30, gte: 1, lte: 2)
+    end
+
+    let(:filter_hash) do
+      {
+        geo_distance_range: {
+          gte: '1km',
+          lte: '2km',
+          location: {
+            lat: 10,
+            lon: 30
+          }
+        }
+      }
+    end
+
+    it 'will have correct filter hash' do
+      expect(filter.to_hash).to eq filter_hash
+    end
+
+    it 'will use km as the default unit' do
+      expect(filter.unit).to eq 'km'
+    end
+  end
+
+  context 'with miles as unit' do
+    let(:filter) do
+      subject.new(field: :location, lat: 10, lon: 30, gte: 1, lte: 2, unit: 'mi')
+    end
+
+    let(:filter_hash) do
+      {
+        geo_distance_range: {
+          gte: '1mi',
+          lte: '2mi',
+          location: {
+            lat: 10,
+            lon: 30
+          }
+        }
+      }
+    end
+
+    it 'should be possible to specify miles' do
+      expect(filter.to_hash).to eq filter_hash
+    end
+  end
+end

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

@@ -64,7 +64,7 @@ describe Daedal::Queries::RangeQuery do
       context 'with field, boost and one or more minimum attribute' do
         let(:params)     { { field: field, boost: boost }.merge(attr_hash) }
         let(:query)      { subject.new(params) }
-        let(:hash_query) { { range: { field => attr_hash } } }
+        let(:hash_query) { { range: { field => attr_hash.merge(boost: boost) } } }
         it "will not raise an error when only #{attrs.join(', ')} is specified" do
           expect { query }.to_not raise_error
         end
@@ -84,4 +84,4 @@ describe Daedal::Queries::RangeQuery do
       it_behaves_like "range query with minimum attributes", attrs
     end
   end
-end
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: daedal
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Christopher Schuch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-30 00:00:00.000000000 Z
+date: 2015-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
 description: Classes for easier ElasticSearch query creation
@@ -30,9 +30,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -59,6 +59,7 @@ files:
 - lib/daedal/filters/exists_filter.rb
 - lib/daedal/filters/filter.rb
 - lib/daedal/filters/geo_distance_filter.rb
+- lib/daedal/filters/geo_distance_range_filter.rb
 - lib/daedal/filters/nested_filter.rb
 - lib/daedal/filters/or_filter.rb
 - lib/daedal/filters/range_filter.rb
@@ -85,6 +86,7 @@ files:
 - spec/unit/daedal/filters/bool_filter_spec.rb
 - spec/unit/daedal/filters/exists_filter_spec.rb
 - spec/unit/daedal/filters/geo_distance_filter_spec.rb
+- spec/unit/daedal/filters/geo_distance_range_filter_spec.rb
 - spec/unit/daedal/filters/nested_filter_spec.rb
 - spec/unit/daedal/filters/or_filter_spec.rb
 - spec/unit/daedal/filters/range_filter_spec.rb
@@ -114,19 +116,18 @@ 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.2.2
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: ElasticSearch Query DSL Builders
 test_files: []
-has_rdoc: