daedal 0.0.4 → 0.0.5

data/daedal.gemspec

@@ -3,7 +3,6 @@ require File.expand_path('../lib/daedal/version', __FILE__)
 Gem::Specification.new do |s|
   s.name        = 'daedal'
   s.version     = Daedal::VERSION
-  s.date        = '2013-12-06'
   s.summary     = "ElasticSearch Query DSL Builders"
   s.description = "Classes for easier ElasticSearch query creation"
   s.authors     = ["Christopher Schuch"]

data/lib/daedal.rb

@@ -1,9 +1,45 @@
 require 'json'
+require 'virtus'
 
-require 'daedal/queries'
-require 'daedal/filters'
-require 'daedal/attributes'
+# base query and filter classes needed by the attributes
+require 'daedal/queries/query'
+require 'daedal/filters/filter'
+require 'daedal/facets/facet'
 
-module Daedal
+# attributes
+require 'daedal/attributes/operator'
+require 'daedal/attributes/match_type'
+require 'daedal/attributes/query_array'
+require 'daedal/attributes/filter_array'
+require 'daedal/attributes/score_mode'
+require 'daedal/attributes/lower_case_string'
+require 'daedal/attributes/distance_unit'
+require 'daedal/attributes/query'
+require 'daedal/attributes/filter'
+require 'daedal/attributes/field'
+require 'daedal/attributes/query_value'
+require 'daedal/attributes/boost'
 
-end
+# filters
+require 'daedal/filters/term_filter'
+require 'daedal/filters/terms_filter'
+require 'daedal/filters/range_filter'
+require 'daedal/filters/geo_distance_filter'
+require 'daedal/filters/and_filter'
+require 'daedal/filters/or_filter'
+require 'daedal/filters/bool_filter'
+
+# queries
+require 'daedal/queries/match_all_query'
+require 'daedal/queries/bool_query'
+require 'daedal/queries/constant_score_query'
+require 'daedal/queries/dis_max_query'
+require 'daedal/queries/filtered_query'
+require 'daedal/queries/match_query'
+require 'daedal/queries/multi_match_query'
+require 'daedal/queries/nested_query'
+require 'daedal/queries/prefix_query'
+require 'daedal/queries/fuzzy_query'
+require 'daedal/queries/query_string_query'
+
+# facets

data/lib/daedal/attributes/boost.rb

@@ -0,0 +1,7 @@
+module Daedal
+  module Attributes
+    """Attribute for the boost parameter"""
+    class Boost < Float
+    end
+  end
+end

data/lib/daedal/attributes/facet.rb

@@ -0,0 +1,13 @@
+module Daedal
+  module Attributes
+    class Facet < Virtus::Attribute
+      def coerce(f)
+        unless f.is_a? Daedal::Facets::Facet or !required? && f.nil?
+          raise Virtus::CoercionError.new(f, 'Daedal::Facets::Facet')
+        end
+
+        f
+      end
+    end
+  end
+end

data/lib/daedal/attributes/field.rb

@@ -0,0 +1,7 @@
+module Daedal
+  module Attributes
+    """Attribute for any ElasticSearch document field, currently just a Symbol"""
+    class Field < Symbol
+    end
+  end
+end

data/lib/daedal/attributes/filter.rb

@@ -2,8 +2,8 @@ module Daedal
   module Attributes
     class Filter < Virtus::Attribute
       def coerce(f)
-        unless f.is_a? Daedal::Filters::BaseFilter or !required? && f.nil?
-          raise Virtus::CoercionError.new(f, 'Daedal::Filters::BaseFilter')
+        unless f.is_a? Daedal::Filters::Filter or !required? && f.nil?
+          raise Virtus::CoercionError.new(f, 'Daedal::Filters::Filter')
         end
 
         f

data/lib/daedal/attributes/filter_array.rb

@@ -5,18 +5,18 @@ module Daedal
       # override the << method so that you throw
       # an error if you don't try to append a query
       def <<(f)
-        if f.is_a? Daedal::Filters::BaseFilter
+        if f.is_a? Daedal::Filters::Filter
           super f
         else
-          raise Virtus::CoercionError.new(f, 'Daedal::Filters::BaseFilter')
+          raise Virtus::CoercionError.new(f, 'Daedal::Filters::Filter')
         end
       end
 
       def unshift(f)
-        if f.is_a? Daedal::Filters::BaseFilter
+        if f.is_a? Daedal::Filters::Filter
           super f
         else
-          raise Virtus::CoercionError.new(f, 'Daedal::Filters::BaseFilter')
+          raise Virtus::CoercionError.new(f, 'Daedal::Filters::Filter')
         end
       end
     end

data/lib/daedal/attributes/query.rb

@@ -2,8 +2,8 @@ module Daedal
   module Attributes
     class Query < Virtus::Attribute
       def coerce(q)
-        unless q.is_a? Daedal::Queries::BaseQuery or !required? && q.nil?
-          raise Virtus::CoercionError.new(q, 'Daedal::Queries::BaseQuery')
+        unless q.is_a? Daedal::Queries::Query or !required? && q.nil?
+          raise Virtus::CoercionError.new(q, 'Daedal::Queries::Query')
         end
 
         q

data/lib/daedal/attributes/query_array.rb

@@ -7,10 +7,10 @@ module Daedal
       # an error if you don't try to append a query
 
       def <<(q)
-        if q.is_a? Daedal::Queries::BaseQuery
+        if q.is_a? Daedal::Queries::Query
           super q
         else
-          raise Virtus::CoercionError.new(q, 'Daedal::Queries::BaseQuery')
+          raise Virtus::CoercionError.new(q, 'Daedal::Queries::Query')
         end
       end
     end

data/lib/daedal/attributes/query_value.rb

@@ -0,0 +1,19 @@
+module Daedal
+  module Attributes
+    """Custom coercer for the value of any query - can be 
+    a string, a symbol, a float, or an integer. If it's none
+    of those, raises a coercion error."""
+    class QueryValue < Virtus::Attribute
+      ALLOWED_QUERY_VALUE_CLASSES = [String, Symbol, Float, Fixnum]
+      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/facets/facet.rb

@@ -0,0 +1,15 @@
+module Daedal
+  module Facets
+    class Facet
+      # Virtus coercion is set to strict so that errors
+      # are returned when supplied fields cannot be properly
+      # coerced.
+      include Virtus.model strict: true
+
+      # requires the subclasses to define #to_hash
+      def to_json
+        to_hash.to_json
+      end
+    end
+  end
+end

data/lib/daedal/filters/and_filter.rb

@@ -1,13 +1,10 @@
-require 'daedal/filters/base_filter'
-require 'daedal/attributes'
-
 module Daedal
   module Filters
     """Class for the basic term filter"""
-    class AndFilter < BaseFilter
+    class AndFilter < Filter
   
       # required attributes
-      attribute :filters, Attributes::FilterArray
+      attribute :filters, Daedal::Attributes::FilterArray
   
       def to_hash
         unless filters.empty?

data/lib/daedal/filters/bool_filter.rb

@@ -0,0 +1,15 @@
+module Daedal
+  module Filters
+    """Class for the basic term filter"""
+    class BoolFilter < Filter
+  
+      attribute :should,        Daedal::Attributes::FilterArray
+      attribute :must,          Daedal::Attributes::FilterArray
+      attribute :must_not,      Daedal::Attributes::FilterArray
+  
+      def to_hash
+        {bool: {should: should.map {|f| f.to_hash}, must: must.map {|f| f.to_hash}, must_not: must_not.map {|f| f.to_hash}}}
+      end
+    end
+  end
+end

data/lib/daedal/filters/{base_filter.rb → filter.rb}

@@ -1,8 +1,6 @@
-require 'virtus'
-
 module Daedal
   module Filters
-    class BaseFilter
+    class Filter
       include Virtus.model strict: true
 
       def to_hash

data/lib/daedal/filters/geo_distance_filter.rb

@@ -1,19 +1,16 @@
-require 'daedal/filters/base_filter'
-require 'daedal/attributes'
-
 module Daedal
   module Filters
     """Class for the basic term filter"""
-    class GeoDistanceFilter < BaseFilter
+    class GeoDistanceFilter < Filter
   
       # required attributes
-      attribute :field, Symbol
-      attribute :lat, Float
-      attribute :lon, Float
-      attribute :distance, Float
+      attribute :field,     Daedal::Attributes::Field
+      attribute :lat,       Float
+      attribute :lon,       Float
+      attribute :distance,  Float
 
       # non required attributes
-      attribute :unit, Attributes::DistanceUnit, default: 'km'
+      attribute :unit,      Daedal::Attributes::DistanceUnit, default: 'km'
   
       def full_distance
         "#{distance}#{unit}"

data/lib/daedal/filters/or_filter.rb

@@ -0,0 +1,18 @@
+module Daedal
+  module Filters
+    """Class for the basic term filter"""
+    class OrFilter < Filter
+  
+      # required attributes
+      attribute :filters, Daedal::Attributes::FilterArray
+  
+      def to_hash
+        unless filters.empty?
+          {:or => filters.map {|f| f.to_hash}}
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/daedal/filters/range_filter.rb

@@ -1,16 +1,16 @@
-require 'daedal/filters/base_filter'
-
 module Daedal
   module Filters
     """Class for the basic term filter"""
-    class RangeFilter < BaseFilter
+    class RangeFilter < Filter
   
       # required attributes
-      attribute :field, Symbol
-      attribute :gte
-      attribute :lte
-      attribute :gt
-      attribute :lt
+      attribute :field, Daedal::Attributes::Field
+
+      # non required attributes
+      attribute :gte,   Daedal::Attributes::QueryValue, required: false
+      attribute :lte,   Daedal::Attributes::QueryValue, required: false
+      attribute :gt,    Daedal::Attributes::QueryValue, required: false
+      attribute :lt,    Daedal::Attributes::QueryValue, required: false
 
       def initialize(options={})
         super options

data/lib/daedal/filters/term_filter.rb

@@ -1,14 +1,11 @@
-require 'daedal/filters/base_filter'
-require 'daedal/attributes'
-
 module Daedal
   module Filters
     """Class for the basic term filter"""
-    class TermFilter < BaseFilter
+    class TermFilter < Filter
   
       # required attributes
-      attribute :field, Symbol
-      attribute :term, Symbol
+      attribute :field,     Daedal::Attributes::Field
+      attribute :term,      Daedal::Attributes::QueryValue
   
       def to_hash
         {term: {field => term}}

data/lib/daedal/filters/terms_filter.rb

@@ -1,14 +1,11 @@
-require 'daedal/filters/base_filter'
-require 'daedal/attributes'
-
 module Daedal
   module Filters
     """Class for the basic term filter"""
-    class TermsFilter < BaseFilter
+    class TermsFilter < Filter
   
       # required attributes
-      attribute :field, Symbol
-      attribute :terms, Array[Symbol]
+      attribute :field,     Daedal::Attributes::Field
+      attribute :terms,     Array[Daedal::Attributes::QueryValue]
   
       def to_hash
         {terms: {field => terms}}

data/lib/daedal/queries/bool_query.rb

@@ -1,24 +1,21 @@
-require 'daedal/queries/base_query'
-require 'daedal/attributes'
-
 module Daedal
   module Queries
     """Class for the bool query"""
-    class BoolQuery < BaseQuery
+    class BoolQuery < Query
   
       # required attributes
 
       # should, must, and must_not must be an array of queries
       # these queries must inherit from the BaseQuery class
-      attribute :should, Attributes::QueryArray, default: Array.new
-      attribute :must, Attributes::QueryArray, default: Array.new
-      attribute :must_not, Attributes::QueryArray, default: Array.new
+      attribute :should,                Daedal::Attributes::QueryArray
+      attribute :must,                  Daedal::Attributes::QueryArray
+      attribute :must_not,              Daedal::Attributes::QueryArray
   
       # non required attributes
-      attribute :minimum_should_match, Integer, required: false
-      attribute :boost, Integer, required: false
-      attribute :name, Symbol, required: false
-      attribute :disable_coord, Boolean, required: false
+      attribute :minimum_should_match,  Integer,  required: false
+      attribute :boost,                 Daedal::Attributes::Boost,  required: false
+      attribute :name,                  Symbol,   required: false
+      attribute :disable_coord,         Boolean,  required: false
   
       def to_hash
         result = {bool: {should: should.map {|q| q.to_hash}, must: must.map {|q| q.to_hash}, must_not: must_not.map {|q| q.to_hash}}}

data/lib/daedal/queries/constant_score_query.rb

@@ -1,18 +1,14 @@
-require 'daedal/queries/base_query'
-require 'daedal/filters/base_filter'
-require 'daedal/attributes'
-
 module Daedal
   module Queries
     """Class for the constant score query"""
-    class ConstantScoreQuery < BaseQuery
+    class ConstantScoreQuery < Query
 
       # required attributes
-      attribute :boost, Float
+      attribute :boost,     Daedal::Attributes::Boost
 
       # non required attributes, but one must be required of the two
-      attribute :query, Attributes::Query, required: false
-      attribute :filter, Attributes::Filter, required: false
+      attribute :query,     Daedal::Attributes::Query,  required: false
+      attribute :filter,    Daedal::Attributes::Filter, required: false
 
       # you must require *one of* query or filter in order for this to be valid
       def initialize(options={})

data/lib/daedal/queries/dis_max_query.rb

@@ -1,19 +1,15 @@
-require 'daedal/queries/base_query'
-require 'daedal/attributes'
-
 module Daedal
   module Queries
-
     """Class for the dis max query"""
-    class DisMaxQuery < BaseQuery
+    class DisMaxQuery < Query
   
       # required attributes
-      attribute :queries, Attributes::QueryArray, default: Array.new
+      attribute :queries,       Daedal::Attributes::QueryArray
   
       # non required attributes
-      attribute :tie_breaker, Float, required: false
-      attribute :boost, Integer, required: false
-      attribute :name, Symbol, required: false
+      attribute :tie_breaker,   Float,    required: false
+      attribute :boost,         Daedal::Attributes::Boost,  required: false
+      attribute :name,          Symbol,   required: false
   
       def to_hash
         result = {dis_max: {queries: queries.map {|q| q.to_hash }}}

data/lib/daedal/queries/filtered_query.rb

@@ -1,16 +1,11 @@
-require 'daedal/queries/match_all_query'
-require 'daedal/filters/base_filter'
-require 'daedal/queries/base_query'
-require 'daedal/attributes'
-
 module Daedal
   module Queries
     """Class for the filtered query"""
-    class FilteredQuery < BaseQuery
+    class FilteredQuery < Query
   
       # required attributes
-      attribute :query, Attributes::Query, default: Daedal::Queries::MatchAllQuery.new
-      attribute :filter, Attributes::Filter, default: Daedal::Filters::BaseFilter.new
+      attribute :query,     Daedal::Attributes::Query,  default: Daedal::Queries::MatchAllQuery.new
+      attribute :filter,    Daedal::Attributes::Filter, default: Daedal::Filters::Filter.new
   
       def to_hash
         {filtered: {query: query.to_hash, filter: filter.to_hash}}