elasticfusion 1.0.0

data/lib/elasticfusion/search/query/value_sanitizer.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require 'chronic'
+
+module Elasticfusion
+  module Search
+    module Query
+      class ValueSanitizer
+        def initialize(mapping)
+          @mapping = mapping
+        end
+
+        def value(value, field:)
+          case @mapping[field.to_sym][:type]
+          when 'keyword'
+            value
+          when 'integer'
+            es_integer(value, field: field)
+          when 'date'
+            es_date(value, field: field)
+          end
+        end
+
+        private
+
+        def es_integer(string, field:)
+          if string.match? /\A[+-]?\d+\z/
+            string
+          else
+            raise InvalidFieldValueError.new(field, string)
+          end
+        end
+
+        def es_date(string, field:)
+          parsed = Chronic.parse(string)
+
+          if parsed.nil?
+            raise InvalidFieldValueError.new(field, string)
+          else
+            parsed.iso8601
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticfusion/search/query/visitor.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module Elasticfusion
+  module Search
+    module Query
+      class Visitor
+        def accept(node)
+          visit(node)
+        end
+
+        # Roughly based on https://github.com/rails/arel/blob/7-1-stable/lib/arel/visitors/visitor.rb.
+
+        def visit(node)
+          send Visitor.visitor_method(node), node
+        end
+
+        def self.visitor_method(node)
+          (@visitor_methods ||= {})[node.class] ||= "visit_#{node.class.name.demodulize}"
+        end
+      end
+    end
+  end
+end

data/lib/elasticfusion/search/query/visitors/elasticsearch.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require 'elasticfusion/search/query/visitors/polyadic_tree'
+require 'elasticfusion/search/query/value_sanitizer'
+
+module Elasticfusion
+  module Search
+    module Query
+      module Visitors
+        class Elasticsearch < PolyadicTree
+          def initialize(keyword_field, mapping)
+            @keyword_field = keyword_field
+            @sanitizer = ValueSanitizer.new(mapping)
+          end
+
+          OPERATORS = { and: :must,
+                        or: :should }.freeze
+
+          def visit_PolyadicExpression(node)
+            operator = OPERATORS[node.op]
+            operands = node.children.map { |n| visit(n) }
+
+            { bool: { operator => operands } }
+          end
+
+          def visit_NegatedClause(node)
+            clause = if node.body.respond_to?(:op) && node.body.op == :and
+              node.body.children.map { |n| visit(n) }
+            else
+              [visit(node.body)]
+            end
+
+            { bool: { must_not: clause } }
+          end
+
+          def visit_FieldTerm(node)
+            value = @sanitizer.value(node.value, field: node.field)
+
+            if node.qualifier
+              { range: { node.field.to_sym => { node.qualifier => value } } }
+            else
+              { term: { node.field.to_sym => value } }
+            end
+          end
+
+          def visit_Term(node)
+            { term: { @keyword_field => node.body } }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticfusion/search/query/visitors/polyadic_tree.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+require 'elasticfusion/search/query/visitor'
+require 'elasticfusion/search/query/ast'
+
+module Elasticfusion
+  module Search
+    module Query
+      module Visitors
+        # +PolyadicTree+ is a base class for visitors that accept
+        # more than two operands for logical expressions.
+        # It converts a binary tree into multi-way tree, replacing all
+        # +Expression+ nodes with +PolyadicExpression+ nodes.
+        #
+        # Given an AST:
+        #
+        #    and
+        #  /     \
+        # A      and
+        #      /     \
+        #     B      and
+        #          /     \
+        #         C       or
+        #               /   \
+        #              D     E
+        #
+        # A polyadic representation would be:
+        #
+        #      and
+        #  /  /   \   \
+        # A  B    C   or
+        #            /  \
+        #           D    E
+
+        class PolyadicTree < Visitor
+          def accept(node)
+            super(rewrite(node))
+          end
+
+          def rewrite(node, parent: nil)
+            case node
+            when NegatedClause
+              node.body = rewrite(node.body)
+            when Expression
+              flattened = [rewrite(node.left, parent: node),
+                           rewrite(node.right, parent: node)].flatten
+
+              if parent && node.op && node.op == parent.op
+                return flattened
+              else
+                return PolyadicExpression.new(node.op, flattened)
+              end
+            end
+            node
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticfusion/search/wrapper.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+require 'elasticfusion/search/builder'
+require 'elasticfusion/search/peeker'
+require 'elasticfusion/search/errors'
+require 'elasticfusion/search/query/parser'
+require 'elasticfusion/search/query/visitors/elasticsearch'
+
+# An instance of this class represents a single search.
+# It encapsulates all custom search features (advanced query parsing,
+# query building, etc.)
+module Elasticfusion
+  module Search
+    class Wrapper
+      def initialize(model, query, &block)
+        @search_runner      = model.method(:search)
+
+        @searchable_mapping = model.elasticfusion[:searchable_mapping]
+        @searchable_fields  = model.elasticfusion[:searchable_fields]
+        @keyword_field      = model.elasticfusion[:keyword_field]
+
+        @builder = Search::Builder.new(model.elasticfusion)
+        @builder.instance_eval(&block) if block_given?
+
+        # The subset of queries that is currently supported can be executed
+        # in the filter context, which does not compute _score and can be cached.
+        # It cannot be used for relevance sorting, though.
+        @builder.filter parse_query(query) if query.present?
+      end
+
+      delegate :next_record, :previous_record, to: :peeker
+
+      def perform(request = elasticsearch_request)
+        @search_runner.call(request)
+      end
+
+      def elasticsearch_request
+        { query: { bool: { must: @builder.queries,
+                           filter: @builder.filters } },
+          sort: @builder.sorts }
+      end
+
+      def peeker
+        Peeker.new(self)
+      end
+
+      private
+
+      def parse_query(query)
+        ast = Query::Parser.new(query, @searchable_fields).ast
+        visitor = Query::Visitors::Elasticsearch.new(@keyword_field,
+                                                     @searchable_mapping)
+        visitor.accept(ast)
+      end
+    end
+  end
+end

data/lib/elasticfusion/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Elasticfusion
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: elasticfusion
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- little-bobby-tables
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- little-bobby-tables@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- elasticfusion.gemspec
+- lib/elasticfusion.rb
+- lib/elasticfusion/definition.rb
+- lib/elasticfusion/hooks.rb
+- lib/elasticfusion/jobs/reindex_job.rb
+- lib/elasticfusion/loader.rb
+- lib/elasticfusion/model/indexing.rb
+- lib/elasticfusion/model/searching.rb
+- lib/elasticfusion/model/settings.rb
+- lib/elasticfusion/search/builder.rb
+- lib/elasticfusion/search/errors.rb
+- lib/elasticfusion/search/peeker.rb
+- lib/elasticfusion/search/query/ast.rb
+- lib/elasticfusion/search/query/lexer.rb
+- lib/elasticfusion/search/query/parser.rb
+- lib/elasticfusion/search/query/value_sanitizer.rb
+- lib/elasticfusion/search/query/visitor.rb
+- lib/elasticfusion/search/query/visitors/elasticsearch.rb
+- lib/elasticfusion/search/query/visitors/polyadic_tree.rb
+- lib/elasticfusion/search/wrapper.rb
+- lib/elasticfusion/version.rb
+homepage: https://github.com/little-bobby-tables/elasticfusion
+licenses:
+- CC0-1.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.6.11
+signing_key: 
+specification_version: 4
+summary: elasticsearch-rails extensions
+test_files: []