daedal 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebac4bd85f7c907672a838d333679a3b8d46bd0c
-  data.tar.gz: ac87f2b4e1ea3fbf0eef292f848019e4616a7a4d
+  metadata.gz: 49b9a5ec5d8154e612f0a8e368b4a3ede833288a
+  data.tar.gz: 8df178f9d7d355ea309c260ac47f5ddb762df2f5
 SHA512:
-  metadata.gz: 1d4470546828b9f1606dd3244415a6c7dde5bc9a09c33de3f6d938755b3afcfd2a88537a4a90700cc3393b43d782f43612dbe763daa7f80a119b729c6455892b
-  data.tar.gz: 3c2929aa9091ef19e74b3a73d3363b7e3c62241de83bb9071a52ce2d747382f1eea20bbe013b37d07d353e09b160069c1e1d2765b1bd5b7827ebb1f21dc650fa
+  metadata.gz: a2393948c2748df8ff9adbf435ce79c910837eddefdef9fa80db35314136005af27e90d90de71be9da3a716cb4b26039c6822929de3a343c0c3a289ef17d13b5
+  data.tar.gz: 6a1950ca0d71446b5c5238b30c54f4f39e37a54bb362affb21bfe879d49e0708da7f38b0f306d8755212286c6529b06ee7a4c9681e7a6fd6f145d6fc021b2eed

data/README.md

@@ -23,6 +23,9 @@ 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
 ------------
 

data/lib/daedal.rb

@@ -43,5 +43,7 @@ require 'daedal/queries/nested_query'
 require 'daedal/queries/prefix_query'
 require 'daedal/queries/fuzzy_query'
 require 'daedal/queries/query_string_query'
+require 'daedal/queries/term_query'
+require 'daedal/queries/terms_query'
 
 # facets

data/lib/daedal/queries/term_query.rb

@@ -0,0 +1,44 @@
+module Daedal
+  module Queries
+    "" "Class for the basic term query" ""
+    class TermQuery < Query
+
+      # required attributes
+      attribute :field, Daedal::Attributes::Field
+
+      # non required attributes, but one must be required of the two, and one only
+      attribute :term, Daedal::Attributes::QueryValue, required: false
+      attribute :value, Daedal::Attributes::QueryValue, required: false
+
+      #non required attributes
+      attribute :boost, Daedal::Attributes::Boost, required: false
+
+      def initialize(options={})
+        super options
+
+        if value.nil? && term.nil?
+          raise "Must give a value or a term"
+        elsif value && term
+          raise "Use either Value or Term only, but not both"
+        elsif value && boost.nil?
+          raise "Please specified boost"
+        end
+
+      end
+
+      def to_hash
+        if boost
+          if value
+            result = {term: {field => {value: value, boost: boost}}}
+          else
+            result = {term: {field => {term: term, boost: boost}}}
+          end
+        else
+          result = {term: {field => term}}
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/daedal/queries/terms_query.rb

@@ -0,0 +1,18 @@
+module Daedal
+  module Queries
+    "" "Class for the basic terms query" ""
+    class TermsQuery < Query
+
+      # required attributes
+      attribute :field, Daedal::Attributes::Field
+      attribute :terms, Array[Daedal::Attributes::QueryValue]
+
+      # not required
+      attribute :minimum_should_match, Integer, default: 1, required: false
+
+      def to_hash
+         {terms: {field => terms}, minimum_should_match: minimum_should_match}
+      end
+    end
+  end
+end

data/lib/daedal/version.rb

@@ -1,3 +1,3 @@
 module Daedal
-  VERSION = '0.0.12'
+  VERSION = '0.0.13'
 end

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

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe Daedal::Queries::TermQuery do
+
+  subject do
+    Daedal::Queries::TermQuery
+  end
+
+  let(:field) do
+    :foo
+  end
+
+  let(:term) do
+    :bar
+  end
+
+  context 'without a field or a term specified' do
+    it 'will raise an error' do
+      expect { subject.new(boost: 2) }.to raise_error(Virtus::CoercionError)
+    end
+  end
+
+  context 'without a field specified' do
+    it 'will raise an error' do
+      expect { subject.new(term: term) }.to raise_error(Virtus::CoercionError)
+    end
+  end
+
+  context 'with both value and term specified' do
+    it 'will raise an error' do
+      expect { subject.new(field: field, term: term, value: term) }.to raise_error(RuntimeError)
+    end
+  end
+
+  context 'with value specified only (without boost)' do
+    it 'will raise an error' do
+      expect { subject.new(field: field, value: term) }.to raise_error(RuntimeError)
+    end
+  end
+
+  context 'with a field and a term specified (without boost)' do
+    let(:query) do
+      subject.new(field: field, term: term)
+    end
+
+    let(:hash_query) do
+      {term: {field => term}}
+    end
+
+    it 'will populate the field and term attributes appropriately' do
+      expect(query.field).to eq field
+      expect(query.term).to eq term
+    end
+    it 'will have the correct hash representation' do
+      expect(query.to_hash).to eq hash_query
+    end
+    it 'will have the correct json representation' do
+      expect(query.to_json).to eq hash_query.to_json
+    end
+  end
+
+  context 'with a field and a term specified (with boost)' do
+    let(:query) do
+      subject.new(field: field, term: term, boost: 2.0)
+    end
+
+    let(:hash_query) do
+      {term: {field => {term: term, boost: 2.0}}}
+    end
+
+    it 'will populate the field and term attributes appropriately' do
+      expect(query.field).to eq field
+      expect(query.term).to eq term
+    end
+    it 'will have the correct hash representation' do
+      expect(query.to_hash).to eq hash_query
+    end
+    it 'will have the correct json representation' do
+      expect(query.to_json).to eq hash_query.to_json
+    end
+
+  end
+
+  context 'with a field and a value specified (with boost)' do
+    let(:query) do
+      subject.new(field: field, value: term, boost: 2.0)
+    end
+
+    let(:hash_query) do
+      {term: {field => {value: term, boost: 2.0}}}
+    end
+
+    it 'will populate the field and term attributes appropriately' do
+      expect(query.field).to eq field
+      expect(query.value).to eq term
+    end
+    it 'will have the correct hash representation' do
+      expect(query.to_hash).to eq hash_query
+    end
+    it 'will have the correct json representation' do
+      expect(query.to_json).to eq hash_query.to_json
+    end
+
+  end
+
+end

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

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Daedal::Queries::TermsQuery do
+
+  subject do
+    Daedal::Queries::TermsQuery
+  end
+
+  let(:field) do
+    :foo
+  end
+
+  let(:terms) do
+    [:bar , :superfoo]
+  end
+
+  let(:hash_query) do
+    {terms: {field => terms} , minimum_should_match: 1}
+  end
+
+  context 'without a field or a list of terms specified' do
+    it 'will raise an error' do
+      expect {subject.new}.to raise_error(Virtus::CoercionError)
+    end
+  end
+
+  context 'without a field specified' do
+    it 'will raise an error' do
+      expect {subject.new(terms: terms)}.to raise_error(Virtus::CoercionError)
+    end
+  end
+
+  context 'with a field and a term specified' do
+    let(:terms_query) do
+      subject.new(field: field, terms: terms)
+    end
+
+    it 'will populate the field and term attributes appropriately' do
+      expect(terms_query.field).to eq field
+      expect(terms_query.terms).to eq terms
+    end
+
+    it 'will have minimum match option set to default 1' do
+      expect(terms_query.minimum_should_match).to eq 1
+    end
+
+    it 'will have the correct hash representation' do
+      expect(terms_query.to_hash).to eq hash_query
+    end
+
+    it 'will have the correct json representation' do
+      expect(terms_query.to_json).to eq hash_query.to_json
+    end
+  end
+
+  context 'with minimum should match of 2 specified' do
+    let(:terms_query) do
+      subject.new(field: field, terms: terms, minimum_should_match: 2)
+    end
+
+    before do
+      hash_query[:minimum_should_match] = 2
+    end
+
+    it 'will set the phrase type to :phrase' do
+      expect(terms_query.minimum_should_match).to eq 2
+    end
+
+    it 'will have the correct hash representation' do
+      expect(terms_query.to_hash).to eq hash_query
+    end
+
+    it 'will have the correct json representation' do
+      expect(terms_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.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Christopher Schuch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -76,6 +76,8 @@ files:
 - lib/daedal/queries/prefix_query.rb
 - lib/daedal/queries/query.rb
 - lib/daedal/queries/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/filters/and_filter_spec.rb
@@ -98,6 +100,8 @@ files:
 - spec/unit/daedal/queries/nested_query_spec.rb
 - spec/unit/daedal/queries/prefix_query_spec.rb
 - spec/unit/daedal/queries/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
 licenses:
 - MIT