elasticsearch-dsl 0.0.0 → 0.1.0

data/elasticsearch-dsl.gemspec

@@ -3,21 +3,38 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'elasticsearch/dsl/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = "elasticsearch-dsl"
-  spec.version       = Elasticsearch::Dsl::VERSION
-  spec.authors       = ["Karel Minarik"]
-  spec.email         = ["karel.minarik@elasticsearch.org"]
-  spec.description   = %q{Elasticsearch Ruby DSL sugar (WIP)}
-  spec.summary       = spec.description
-  spec.homepage      = ""
-  spec.license       = "Apache 2"
+Gem::Specification.new do |s|
+  s.name          = "elasticsearch-dsl"
+  s.version       = Elasticsearch::DSL::VERSION
+  s.authors       = ["Karel Minarik"]
+  s.email         = ["karel.minarik@elasticsearch.com"]
+  s.description   = %q{A Ruby DSL builder for Elasticsearch}
+  s.summary       = s.description
+  s.homepage      = "https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-dsl"
+  s.license       = "Apache 2"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  s.extra_rdoc_files  = [ "README.md", "LICENSE.txt" ]
+  s.rdoc_options      = [ "--charset=UTF-8" ]
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+
+  s.add_development_dependency "elasticsearch"
+  s.add_development_dependency "elasticsearch-extensions"
+
+  s.add_development_dependency 'shoulda-context'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'minitest', '~> 4.0'
+  s.add_development_dependency 'minitest-reporters'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'simplecov-rcov'
+  s.add_development_dependency 'ci_reporter', '~> 1.9'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'cane'
+  s.add_development_dependency 'pry'
 end

data/lib/elasticsearch-dsl.rb

@@ -0,0 +1 @@
+require 'elasticsearch/dsl'

data/lib/elasticsearch/dsl.rb

@@ -1,7 +1,47 @@
-require "elasticsearch/dsl/version"
+require 'elasticsearch/dsl/version'
+
+require 'elasticsearch/dsl/utils'
+require 'elasticsearch/dsl/search/base_component'
+require 'elasticsearch/dsl/search/base_compound_filter_component'
+require 'elasticsearch/dsl/search/base_aggregation_component'
+require 'elasticsearch/dsl/search/query'
+require 'elasticsearch/dsl/search/filter'
+require 'elasticsearch/dsl/search/aggregation'
+require 'elasticsearch/dsl/search/highlight'
+require 'elasticsearch/dsl/search/sort'
+require 'elasticsearch/dsl/search/options'
+require 'elasticsearch/dsl/search/suggest'
+
+Dir[ File.expand_path('../dsl/search/queries/**/*.rb', __FILE__) ].each        { |f| require f }
+Dir[ File.expand_path('../dsl/search/filters/**/*.rb', __FILE__) ].each        { |f| require f }
+Dir[ File.expand_path('../dsl/search/aggregations/**/*.rb', __FILE__) ].each   { |f| require f }
+
+require 'elasticsearch/dsl/search'
 
 module Elasticsearch
-  module Dsl
-    # Your code goes here...
+
+  # The main module, which can be included into your own class or namespace,
+  # to provide the DSL methods.
+  #
+  # @example
+  #
+  #     include Elasticsearch::DSL
+  #
+  #     definition = search do
+  #       query do
+  #         match title: 'test'
+  #       end
+  #     end
+  #
+  #     definition.to_hash
+  #     # => { query: { match: { title: "test"} } }
+  #
+  # @see Search
+  # @see http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/query-dsl-intro.html
+  #
+  module DSL
+    def self.included(base)
+      base.__send__ :include, Elasticsearch::DSL::Search
+    end
   end
 end

data/lib/elasticsearch/dsl/search.rb

@@ -0,0 +1,241 @@
+module Elasticsearch
+  module DSL
+
+    # Provides DSL methods for building the search definition
+    # (queries, filters, aggregations, sorting, etc)
+    #
+    module Search
+
+      # Initialize a new Search object
+      #
+      # @example Building a search definition declaratively
+      #
+      #     definition = search do
+      #       query do
+      #         match title: 'test'
+      #       end
+      #     end
+      #
+      # @example Using the class imperatively
+      #
+      #     definition = Search.new
+      #     query = Query.new
+      #     definition.query query
+      #     definition.to_hash
+      #     # => => {:query=>{:match=>{:title=>"Test"}}}
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search.html
+      #
+      def search(*args, &block)
+        Search.new(*args, &block)
+      end
+
+      extend self
+
+      # Wraps the whole search definition (queries, filters, aggregations, sorting, etc)
+      #
+      class Search
+        attr_reader :aggregations
+
+        def initialize(*args, &block)
+          @options = Options.new
+          instance_eval(&block) if block
+        end
+
+        # DSL method for building or accessing the `query` part of a search definition
+        #
+        # @return [self, {Query}]
+        #
+        def query(*args, &block)
+          case
+            when block
+              @query = Query.new(*args, &block)
+              self
+            when !args.empty?
+              @query = args.first
+              self
+            else
+              @query
+          end
+        end
+
+        # Set the query part of a search definition
+        #
+        def query=(value)
+          query value
+        end
+
+        # DSL method for building the `filter` part of a search definition
+        #
+        # @return [self]
+        #
+        def filter(*args, &block)
+          case
+            when block
+              @filter = Filter.new(*args, &block)
+              self
+            when !args.empty?
+              @filter = args.first
+              self
+            else
+              @filter
+          end
+        end
+
+        # Set the filter part of a search definition
+        #
+        def filter=(value)
+          filter value
+        end
+
+        # DSL method for building the `post_filter` part of a search definition
+        #
+        # @return [self]
+        #
+        def post_filter(*args, &block)
+          case
+            when block
+              @post_filter = Filter.new(*args, &block)
+              self
+            when !args.empty?
+              @post_filter = args.first
+              self
+            else
+              @post_filter
+          end
+        end
+
+        # Set the post_filter part of a search definition
+        #
+        def post_filter=(value)
+          post_filter value
+        end
+
+        # DSL method for building the `aggregations` part of a search definition
+        #
+        # @return [self]
+        #
+        def aggregation(*args, &block)
+          @aggregations ||= {}
+
+          if block
+            @aggregations.update args.first => Aggregation.new(*args, &block)
+          else
+            name = args.shift
+            @aggregations.update name => args.shift
+          end
+          self
+        end
+
+        # Set the aggregations part of a search definition
+        #
+        def aggregations=(value)
+          @aggregations = value
+        end
+
+        # DSL method for building the `highlight` part of a search definition
+        #
+        # @return [self]
+        #
+        def highlight(*args, &block)
+          if !args.empty? || block
+            @highlight = Highlight.new(*args, &block)
+            self
+          else
+            @highlight
+          end
+        end
+
+        # DSL method for building the `sort` part of a search definition
+        #
+        # @return [self]
+        #
+        def sort(*args, &block)
+          if !args.empty? || block
+            @sort = Sort.new(*args, &block)
+            self
+          else
+            @sort
+          end
+        end
+
+        # DSL method for building the `size` part of a search definition
+        #
+        # @return [self]
+        #
+        def size(value=nil)
+          if value
+            @size = value
+            self
+          else
+            @size
+          end
+        end; alias_method :size=, :size
+
+        # DSL method for building the `from` part of a search definition
+        #
+        # @return [self]
+        #
+        def from(value=nil)
+          if value
+            @from = value
+            self
+          else
+            @from
+          end
+        end; alias_method :from=, :from
+
+        # DSL method for building the `suggest` part of a search definition
+        #
+        # @return [self]
+        #
+        def suggest(*args, &block)
+          if !args.empty? || block
+            @suggest ||= {}
+            key, options = args
+            @suggest.update key => Suggest.new(key, options, &block)
+            self
+          else
+            @suggest
+          end
+        end
+
+        # Set the suggest part of a search definition
+        #
+        def suggest=(value)
+          @suggest = value
+        end
+
+        # Delegates to the methods provided by the {Options} class
+        #
+        def method_missing(name, *args, &block)
+          if @options.respond_to? name
+            @options.__send__ name, *args, &block
+            self
+          else
+            super
+          end
+        end
+
+        # Converts the search definition to a Hash
+        #
+        # @return [Hash]
+        #
+        def to_hash
+          hash = {}
+          hash.update(query: @query.to_hash)   if @query
+          hash.update(filter: @filter.to_hash) if @filter
+          hash.update(post_filter: @post_filter.to_hash) if @post_filter
+          hash.update(aggregations: @aggregations.reduce({}) { |sum,item| sum.update item.first => item.last.to_hash }) if @aggregations
+          hash.update(sort: @sort.to_hash) if @sort
+          hash.update(size: @size) if @size
+          hash.update(from: @from) if @from
+          hash.update(suggest: @suggest.reduce({}) { |sum,item| sum.update item.last.to_hash }) if @suggest
+          hash.update(highlight: @highlight.to_hash) if @highlight
+          hash.update(@options) unless @options.empty?
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregation.rb

@@ -0,0 +1,79 @@
+module Elasticsearch
+  module DSL
+    module Search
+
+      # Contains the classes for Elasticsearch aggregations
+      #
+      module Aggregations;end
+
+      # Wraps the `aggregations` part of a search definition
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations.html
+      #
+      class Aggregation
+        def initialize(*args, &block)
+          @block = block
+        end
+
+        # Looks up the corresponding class for a method being invoked, and initializes it
+        #
+        # @raise [NoMethodError] When the corresponding class cannot be found
+        #
+        def method_missing(name, *args, &block)
+          klass = Utils.__camelize(name)
+          if Aggregations.const_defined? klass
+            @value = Aggregations.const_get(klass).new *args, &block
+          else
+            raise NoMethodError, "undefined method '#{name}' for #{self}"
+          end
+        end
+
+        # Defines a nested aggregation
+        #
+        def aggregation(*args, &block)
+          call
+          @value.__send__ :aggregation, *args, &block
+        end
+
+        # Returns the aggregations
+        #
+        def aggregations
+          call
+          @value.__send__ :aggregations
+        end
+
+        # Evaluates the block passed to initializer, ensuring it is called just once
+        #
+        # @return [self]
+        #
+        # @api private
+        #
+        def call
+          @block.arity < 1 ? self.instance_eval(&@block) : @block.call(self) if @block && ! @_block_called
+          @_block_called = true
+          self
+        end
+
+        # Converts the object to a Hash
+        #
+        # @return [Hash]
+        #
+        def to_hash(options={})
+          call
+
+          if @value
+            case
+              when @value.respond_to?(:to_hash)
+                @value.to_hash
+              else
+                @value
+            end
+          else
+            {}
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/avg.rb

@@ -0,0 +1,25 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A single-value metric aggregation which returns the average of numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :avg_clicks do
+        #         avg field: 'clicks'
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html
+        #
+        class Avg
+          include BaseComponent
+        end
+
+      end
+    end
+  end
+end