qiita-elasticsearch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f70a16904b46ae70d71fd2c397a78f8252c04c0
+  data.tar.gz: 0da3883804dfa7142399a83ad16aa2f70a65711d
+SHA512:
+  metadata.gz: d75c39415180eeadec234d201bcbc9707780664595895d8afca43b0321ce111248dea3c809528c0aa9ef619735bf518335790d07e407e18716a69ed008ecedfc
+  data.tar.gz: 84bb7676429cd15af3b5efae5601a225120b24546b85b82439d7005be41dd51b1270771faa066a6096a357950be0a5050da69a9d6a31b6742cb11d2eafc08f68

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,38 @@
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/PredicateName:
+  Enabled: false
+
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingComma:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+- 2.0.0
+env:
+  global:
+    secure: f904YN7iTQRLl9mDSpRat+D5/JlFmdkL+3eXP1J8fsGV2jIdcSRc/RraAryra8trhGg69nGRsWhvwI4NLW2TgnUV8FU+474JRiAOS7sPvusCW6SdTBV5k1bW1cSFlBdtmvs9v8ew0WCptSXoZU5Ew6gEmHW+2YpUAbIvNqrC8oA=

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ryo Nakamura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+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.

data/README.md

@@ -0,0 +1,48 @@
+# Qiita::Elasticsearch [![Build Status](https://travis-ci.org/increments/qiita-elasticsearch.svg)](https://travis-ci.org/increments/qiita-elasticsearch) [![Code Climate](https://codeclimate.com/github/increments/qiita-elasticsearch/badges/gpa.svg)](https://codeclimate.com/github/increments/qiita-elasticsearch) [![Test Coverage](https://codeclimate.com/github/increments/qiita-elasticsearch/badges/coverage.svg)](https://codeclimate.com/github/increments/qiita-elasticsearch)
+Elasticsearch client helper for Qiita.
+
+## Usage
+```rb
+query_builder = Qiita::Elasticsearch::QueryBuilder.new
+#=> #<Qiita::Elasticsearch::QueryBuilder:0x007ff81e67c4d8 @filterable_fields=nil, @matchable_fields=nil>
+
+query_builder.build("a")
+#=> {"match"=>{"_all"=>"a"}}
+
+query_builder.build("a b")
+#=> {"bool"=>{"should"=>[{"match"=>{"_all"=>"a"}}, {"match"=>{"_all"=>"b"}}]}}
+
+query_builder.build("a -b")
+#=> {"bool"=>{"must_not"=>[{"match"=>{"_all"=>"b"}}], "should"=>[{"match"=>{"_all"=>"a"}}]}}
+
+query_builder.build('"a b"')
+#=> {"match_phrase"=>{"_all"=>"a b"}}
+
+query_builder.build("a OR b")
+#=> {"bool"=>{"should"=>[{"match"=>{"_all"=>"a"}}, {"match"=>{"_all"=>"b"}}]}}
+
+```
+
+### matchable_fields
+```rb
+query_builder = Qiita::Elasticsearch::QueryBuilder.new(matchable_fields: ["body", "title"])
+#=> #<Qiita::Elasticsearch::QueryBuilder:0x007ff81fa59168 @filterable_fields=nil, @matchable_fields=["body", "title"]>
+
+query_builder.build("a")
+#=> {"multi_match"=>{"fields"=>["body", "title"], "query"=>"a"}}
+```
+
+### filterable_fields
+```rb
+query_builder = Qiita::Elasticsearch::QueryBuilder.new(filterable_fields: ["tag", "title"])
+#=> #<Qiita::Elasticsearch::QueryBuilder:0x007ff81e2de1f0 @filterable_fields=["tag", "title"], @matchable_fields=nil>
+
+query_builder.build("tag:a")
+#=> {"filtered"=>{"filter"=>{"term"=>{"tag"=>"a"}}, "query"=>{"match_all"=>{}}}}
+
+query_builder.build("tag:a b")
+#=> {"bool"=>{"must"=>[{"filtered"=>{"filter"=>{"term"=>{"tag"=>"a"}}, "query"=>{"match_all"=>{}}}}], "should"=>[{"match"=>{"_all"=>"b"}}]}}
+
+query_builder.build("user:a b")
+#=> {"bool"=>{"should"=>[{"match"=>{"_all"=>"user:a"}}, {"match"=>{"_all"=>"b"}}]}}
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:style)
+task default: [:spec, :style]

data/lib/qiita/elasticsearch.rb

@@ -0,0 +1,2 @@
+require "qiita/elasticsearch/query_builder"
+require "qiita/elasticsearch/version"

data/lib/qiita/elasticsearch/nodes/bool_query_node.rb

@@ -0,0 +1,83 @@
+require "qiita/elasticsearch/nodes/token_node"
+
+module Qiita
+  module Elasticsearch
+    module Nodes
+      class BoolQueryNode
+        # @param [Array<Qiita::Elasticsearch::Tokens>] tokens
+        # @param [Array<String>, nil] matchable_fields
+        def initialize(tokens, matchable_fields: nil)
+          @matchable_fields = matchable_fields
+          @tokens = tokens
+        end
+
+        def to_hash
+          case
+          when has_only_one_should_token?
+            should_query
+          when has_only_one_must_token?
+            must_query
+          else
+            {
+              "bool" => {
+                "must" => must_queries,
+                "must_not" => must_not_queries,
+                "should" => should_queries,
+              }.reject do |key, value|
+                value.empty?
+              end,
+            }
+          end
+        end
+
+        private
+
+        def has_only_one_must_token?
+          must_not_tokens.empty? && should_tokens.empty? && must_tokens.size == 1
+        end
+
+        def has_only_one_should_token?
+          must_not_tokens.empty? && must_tokens.empty? && should_tokens.size == 1
+        end
+
+        def must_not_queries
+          must_not_tokens.map do |token|
+            Nodes::TokenNode.new(token, matchable_fields: @matchable_fields).to_hash
+          end
+        end
+
+        def must_not_tokens
+          @must_not_tokens ||= @tokens.select(&:must_not?)
+        end
+
+        def must_query
+          Nodes::TokenNode.new(must_tokens.first, matchable_fields: @matchable_fields).to_hash
+        end
+
+        def must_queries
+          must_tokens.map do |token|
+            Nodes::TokenNode.new(token, matchable_fields: @matchable_fields).to_hash
+          end
+        end
+
+        def must_tokens
+          @must_tokens ||= @tokens.select(&:must?)
+        end
+
+        def should_query
+          Nodes::TokenNode.new(should_tokens.first, matchable_fields: @matchable_fields).to_hash
+        end
+
+        def should_queries
+          should_tokens.map do |token|
+            Nodes::TokenNode.new(token, matchable_fields: @matchable_fields).to_hash
+          end
+        end
+
+        def should_tokens
+          @should_tokens ||= @tokens.select(&:should?)
+        end
+      end
+    end
+  end
+end

data/lib/qiita/elasticsearch/nodes/filter_query_node.rb

@@ -0,0 +1,28 @@
+module Qiita
+  module Elasticsearch
+    module Nodes
+      class FilterQueryNode
+        # @param [Qiita::Elasticsearch::Token] token
+        def initialize(token)
+          @token = token
+        end
+
+        # @return [Hash]
+        def to_hash
+          {
+            "filtered" => {
+              "filter" => {
+                "term" => {
+                  @token.field_name => @token.term,
+                },
+              },
+              "query" => {
+                "match_all" => {},
+              },
+            },
+          }
+        end
+      end
+    end
+  end
+end

data/lib/qiita/elasticsearch/nodes/match_query_node.rb

@@ -0,0 +1,34 @@
+module Qiita
+  module Elasticsearch
+    module Nodes
+      class MatchQueryNode
+        # @param [Qiita::Elasticsearch::Token] token
+        # @param [Array<String>, nil] matchable_fields
+        def initialize(token, matchable_fields: nil)
+          @matchable_fields = matchable_fields
+          @token = token
+        end
+
+        # @return [Hash] match query or multi_match query
+        def to_hash
+          if @matchable_fields.nil?
+            {
+              @token.quoted? ? "match_phrase" : "match" => {
+                "_all" => @token.term,
+              }
+            }
+          else
+            hash = {
+              "multi_match" => {
+                "fields" => @matchable_fields,
+                "query" => @token.term,
+              },
+            }
+            hash["multi_match"]["type"] = "phrase" if @token.quoted?
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/qiita/elasticsearch/nodes/null_node.rb

@@ -0,0 +1,17 @@
+module Qiita
+  module Elasticsearch
+    module Nodes
+      class NullNode
+        def to_hash
+          {
+            "query" => {
+              "ids" => {
+                "values" => [],
+              },
+            },
+          }
+        end
+      end
+    end
+  end
+end

data/lib/qiita/elasticsearch/nodes/or_separatable_node.rb

@@ -0,0 +1,53 @@
+require "qiita/elasticsearch/nodes/bool_query_node"
+require "qiita/elasticsearch/nodes/null_node"
+
+module Qiita
+  module Elasticsearch
+    module Nodes
+      class OrSeparatableNode
+        # @param [Array<Qiita::Elasticsearch::Tokens>] tokens
+        # @param [Array<String>, nil] matchable_fields
+        def initialize(tokens, matchable_fields: nil)
+          @matchable_fields = matchable_fields
+          @tokens = tokens
+        end
+
+        def to_hash
+          case tokens_grouped_by_or_token.size
+          when 0
+            Nodes::NullNode.new.to_hash
+          when 1
+            Nodes::BoolQueryNode.new(
+              tokens_grouped_by_or_token.first,
+              matchable_fields: @matchable_fields,
+            ).to_hash
+          else
+            {
+              "bool" => {
+                "should" => tokens_grouped_by_or_token.map do |tokens|
+                  Nodes::BoolQueryNode.new(
+                    tokens,
+                    matchable_fields: @matchable_fields,
+                  ).to_hash
+                end,
+              },
+            }
+          end
+        end
+
+        private
+
+        # @return [Array<Array<Qiita::Elasticsearch::Token>>]
+        def tokens_grouped_by_or_token
+          @tokens_grouped_by_or_token ||= @tokens.each_with_object([[]]) do |token, groups|
+            if token.or?
+              groups << []
+            else
+              groups.last << token
+            end
+          end.reject(&:empty?)
+        end
+      end
+    end
+  end
+end

data/lib/qiita/elasticsearch/nodes/token_node.rb

@@ -0,0 +1,25 @@
+require "qiita/elasticsearch/nodes/filter_query_node"
+require "qiita/elasticsearch/nodes/match_query_node"
+
+module Qiita
+  module Elasticsearch
+    module Nodes
+      class TokenNode
+        # @param [Qiita::Elasticsearch::Token] token
+        # @param [Array<String>, nil] matchable_fields
+        def initialize(token, matchable_fields: nil)
+          @matchable_fields = matchable_fields
+          @token = token
+        end
+
+        def to_hash
+          if @token.field_name
+            FilterQueryNode.new(@token).to_hash
+          else
+            MatchQueryNode.new(@token, matchable_fields: @matchable_fields).to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/qiita/elasticsearch/parser.rb

@@ -0,0 +1,24 @@
+require "qiita/elasticsearch/tokenizer"
+
+module Qiita
+  module Elasticsearch
+    class Parser
+      # @param [Array<String>, nil] filterable_fields
+      def initialize(filterable_fields: nil)
+        @filterable_fields = filterable_fields
+      end
+
+      # @param [String] query_string Raw query string
+      # @return [Array<Qiita::Elasticsearch::Token>]
+      def parse(query_string)
+        tokenizer.tokenize(query_string)
+      end
+
+      private
+
+      def tokenizer
+        @tokenizer ||= Tokenizer.new(filterable_fields: @filterable_fields)
+      end
+    end
+  end
+end

data/lib/qiita/elasticsearch/query_builder.rb

@@ -0,0 +1,36 @@
+require "qiita/elasticsearch/nodes/null_node"
+require "qiita/elasticsearch/nodes/or_separatable_node"
+require "qiita/elasticsearch/parser"
+
+module Qiita
+  module Elasticsearch
+    class QueryBuilder
+      # @param [Array<String>, nil] matchable_fields
+      # @param [Array<String>, nil] filterable_fields
+      def initialize(matchable_fields: nil, filterable_fields: nil)
+        @matchable_fields = matchable_fields
+        @filterable_fields = filterable_fields
+      end
+
+      # @param [String] query_string Raw query string
+      # @return [Hash]
+      def build(query_string)
+        tokens = parser.parse(query_string)
+        if tokens.size.zero?
+          Nodes::NullNode.new.to_hash
+        else
+          Nodes::OrSeparatableNode.new(
+            tokens,
+            matchable_fields: @matchable_fields,
+          ).to_hash
+        end
+      end
+
+      private
+
+      def parser
+        @parser ||= Parser.new(filterable_fields: @filterable_fields)
+      end
+    end
+  end
+end

data/lib/qiita/elasticsearch/token.rb

@@ -0,0 +1,56 @@
+module Qiita
+  module Elasticsearch
+    class Token
+      attr_reader :field_name, :term
+
+      def initialize(field_name: nil, minus: nil, quoted: nil, term: nil, token_string: nil)
+        @field_name = field_name
+        @minus = minus
+        @quoted = quoted
+        @term = term
+        @token_string = token_string
+      end
+
+      def must?
+        !field_name.nil?
+      end
+
+      def must_not?
+        negative?
+      end
+
+      # @return [true, false] True if this token is for negative filter
+      # @note `Ruby -Perl`
+      #             ^^^^^
+      #             This
+      def negative?
+        !positive?
+      end
+
+      # @return [true, false] True if this token is for OR filter
+      # @note `Ruby OR Perl`
+      #             ^^
+      #            This
+      def or?
+        @token_string.downcase == "or"
+      end
+
+      # @return [true, false] Opposite of #negative?
+      def positive?
+        @minus.nil?
+      end
+
+      # @return [true, false] True if this token is for phrase matching
+      # @note `Express OR "Ruby on Rails"`
+      #                   ^^^^^^^^^^^^^^^
+      #                        This
+      def quoted?
+        !!@quoted
+      end
+
+      def should?
+        !must? && !must_not?
+      end
+    end
+  end
+end

data/lib/qiita/elasticsearch/tokenizer.rb

@@ -0,0 +1,51 @@
+require "qiita/elasticsearch/token"
+
+module Qiita
+  module Elasticsearch
+    class Tokenizer
+      DEFAULT_FILTERABLE_FIELDS = []
+
+      TOKEN_PATTERN = /
+        (?<token_string>
+          (?<minus>-)?
+          (?:(?<field_name>\w+):)?
+          (?:
+            (?:"(?<quoted_term>.*?)(?<!\\)")
+            |
+            (?<term>\S+)
+          )
+        )
+      /x
+
+      # @param [Array<String>, nil] filterable_fields
+      def initialize(filterable_fields: nil)
+        @filterable_fields = filterable_fields
+      end
+
+      # @param [String] query_string Raw query string
+      # @return [Array<Qiita::Elasticsearch::Token>]
+      def tokenize(query_string)
+        query_string.scan(TOKEN_PATTERN).map do |token_string, minus, field_name, quoted_term, term|
+          term ||= quoted_term
+          if !field_name.nil? && !filterable_fields.include?(field_name)
+            term = "#{field_name}:#{term}"
+            field_name = nil
+          end
+          Token.new(
+            field_name: field_name,
+            minus: minus,
+            quoted: !quoted_term.nil?,
+            term: term,
+            token_string: token_string,
+          )
+        end
+      end
+
+      private
+
+      def filterable_fields
+        @filterable_fields || DEFAULT_FILTERABLE_FIELDS
+      end
+    end
+  end
+end

data/lib/qiita/elasticsearch/version.rb

@@ -0,0 +1,5 @@
+module Qiita
+  module Elasticsearch
+    VERSION = "0.1.0"
+  end
+end

data/qiita-elasticsearch.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "qiita/elasticsearch/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "qiita-elasticsearch"
+  spec.version       = Qiita::Elasticsearch::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "Elasticsearch client helper for Qiita."
+  spec.homepage      = "https://github.com/increments/qiita-elasticsearch"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", ">= 1.7"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "3.2.0"
+  spec.add_development_dependency "rubocop", "0.29.1"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: qiita-elasticsearch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/qiita/elasticsearch.rb
+- lib/qiita/elasticsearch/nodes/bool_query_node.rb
+- lib/qiita/elasticsearch/nodes/filter_query_node.rb
+- lib/qiita/elasticsearch/nodes/match_query_node.rb
+- lib/qiita/elasticsearch/nodes/null_node.rb
+- lib/qiita/elasticsearch/nodes/or_separatable_node.rb
+- lib/qiita/elasticsearch/nodes/token_node.rb
+- lib/qiita/elasticsearch/parser.rb
+- lib/qiita/elasticsearch/query_builder.rb
+- lib/qiita/elasticsearch/token.rb
+- lib/qiita/elasticsearch/tokenizer.rb
+- lib/qiita/elasticsearch/version.rb
+- qiita-elasticsearch.gemspec
+homepage: https://github.com/increments/qiita-elasticsearch
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Elasticsearch client helper for Qiita.
+test_files: []
+has_rdoc: