qiita-elasticsearch 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e3d2f73e88e60c1d6b4e3b43fdbd53d8d205f55
-  data.tar.gz: 283b4bb3a7aebe01f57e9d2973d0513244483cb9
+  metadata.gz: 7d6570d03729c979346948b0cc263aba403bee28
+  data.tar.gz: c8124642ae04a4f72ef23897b57281c854af6b0e
 SHA512:
-  metadata.gz: 405882ddc1197902022a273cc4d196d4230b8165f6db854eb709e05aafdf206297a3a3e334aeb9f574d5cdf237c008c402464c086ec3235d9a5196410de01120
-  data.tar.gz: 486f63464413202789ee596c9bb4ca5083d5c8c688b3b0edd27548b211d0dfcd15aba12979062baefed00c829dea57aea47ff0bf6a4587471c4cd635dd9f1356
+  metadata.gz: f9fdd319e921675775c7ed2db8e3708243f2e1faaa2b254765a77e43b52dcac50eb44a3ceea3270469694b9257d87550d36764577d84d8a9ba35be00dfadbf37
+  data.tar.gz: 878f11a6496aa4801c732ee0bf844211eb2ed354ab90b0aa271d099f7f89a046cdff2f10d7d8519885c46cd8648d864b8a676b0c487fa2b3ce3f2cffb73b4f6b

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,6 +1,16 @@
+## 0.17.0
+
+* Add support for relative date expression in date fields
+* Enable specifying optional query parameters in MatchableToken
+
 ## 0.16.0
 - Support groups filter query
 
+## 0.15.0
+- Use `match` query for non-filterable `field:value` input
+- Add `:all_fields` option to `QueryBuilder#initialize` to distinguish `field:value` input and non-field input including a `:`
+- Rename `:matchable_fields` option to `:default_fields` in `QueryBuilder#initialize`
+
 ## 0.14.3
 - Use match phrase for code search
 

data/lib/qiita/elasticsearch/concerns/range_operand_includable.rb

@@ -8,8 +8,6 @@ module Qiita
 
         RANGE_TERM_REGEXP = /\A(?<operand>\<=|\<|\>=|\>)(?<query>.*)\z/
 
-        private
-
         # @return [String, nil]
         # @example Suppose @term is "created_at:>=2015-04-16"
         #   range_parameter #=> "gte"
@@ -24,6 +22,8 @@ module Qiita
           range_match[:query]
         end
 
+        private
+
         def range_match
           @range_match ||= RANGE_TERM_REGEXP.match(@term) || {}
         end

data/lib/qiita/elasticsearch/date_token.rb

@@ -8,100 +8,163 @@ module Qiita
     class DateToken < Token
       include Concerns::RangeOperandIncludable
 
-      # @note Matches to "YYYY", "YYYY-MM" and "YYYY-MM-DD"
-      DATE_PATTERN = /\A
-        (?<year>\d{4})
-        (?:
-          -
-          (?<month>\d{1,2})
+      attr_accessor :time_zone
+
+      class BaseDateExpression
+        FIELD_NAMES_TABLE = {
+          "created" => "created_at",
+          "updated" => "updated_at",
+        }
+
+        # @param [DateToken] token date token instance containing date expressions
+        def initialize(token)
+          @token = token
+        end
+
+        def match
+          @match ||= self.class::PATTERN.match(@token.range_query || @token.term)
+        end
+
+        def to_hash
+          fail NotImplementedError
+        end
+
+        # e.g. created:2000-01-01 -> created_at
+        # @return [String]
+        def converted_field_name
+          FIELD_NAMES_TABLE[@token.field_name] || @token.field_name
+        end
+      end
+
+      class AbsoluteDateExpression < BaseDateExpression
+        # @note Matches to "YYYY", "YYYY-MM" and "YYYY-MM-DD"
+        PATTERN = /\A
+          (?<year>\d{4})
           (?:
             -
-            (?<day>\d{1,2})
+            (?<month>\d{1,2})
+            (?:
+              -
+              (?<day>\d{1,2})
+            )?
           )?
-        )?
-      \z/x
+        \z/x
 
-      FIELD_NAMES_TABLE = {
-        "created" => "created_at",
-        "updated" => "updated_at",
-      }
+        def to_hash
+          if @token.range_parameter
+            range_block(@token.range_parameter => @token.range_query, "time_zone" => @token.time_zone)
+          else
+            range_block("gte" => beginning_of_range.to_s, "lt" => end_of_range.to_s, "time_zone" => @token.time_zone)
+          end
+        end
 
-      attr_writer :time_zone
+        private
 
-      # @return [Hash]
-      # @raise [InvalidQuery]
-      def to_hash
-        if date_match
-          if range_parameter
-            {
-              "range" => {
-                converted_field_name => {
-                  range_parameter => range_query,
-                  "time_zone" => @time_zone,
-                }.reject do |key, value|
-                  key == "time_zone" && value.nil?
-                end,
-              },
+        def range_block(field_block)
+          {
+            "range" => {
+              converted_field_name => field_block.reject do |key, value|
+                key == "time_zone" && value.nil?
+              end,
             }
-          else
+          }
+        end
+
+        # @return [Date]
+        def end_of_range
+          @end_of_range ||=
+            case
+            when match[:day]
+              beginning_of_range + 1.day
+            when match[:month]
+              beginning_of_range + 1.month
+            else
+              beginning_of_range + 1.year
+            end
+        end
+
+        # @return [Date]
+        def beginning_of_range
+          @beginning_of_range ||=
+            case
+            when match[:day]
+              Date.new(match[:year].to_i, match[:month].to_i, match[:day].to_i)
+            when match[:month]
+              Date.new(match[:year].to_i, match[:month].to_i)
+            else
+              Date.new(match[:year].to_i)
+            end
+        end
+      end
+
+      class RelativeDateExpression < BaseDateExpression
+        # @note Matches to "30d" and "30days"
+        PATTERN = /\A
+          (?<digit>\d+)
+          (?<type>d|y|day|days|year|years)
+        \z/x
+
+        def to_hash
+          if @token.range_parameter
             {
               "range" => {
                 converted_field_name => {
-                  "gte" => beginning_of_range.to_s,
-                  "lt" => end_of_range.to_s,
-                  "time_zone" => @time_zone,
-                }.reject do |key, value|
-                  key == "time_zone" && value.nil?
-                end,
+                  @token.range_parameter => relative_range_with_hours,
+                },
               },
             }
+          else
+            Nodes::NullNode.new.to_hash
           end
-        else
-          Nodes::NullNode.new.to_hash
         end
-      end
 
-      private
+        private
 
-      # @return [Date]
-      def beginning_of_range
-        @beginning_of_range ||=
-          case
-          when date_match[:day]
-            Date.new(date_match[:year].to_i, date_match[:month].to_i, date_match[:day].to_i)
-          when date_match[:month]
-            Date.new(date_match[:year].to_i, date_match[:month].to_i)
+        def relative_range_with_hours
+          @relative_range_with_hours ||=
+            "now-" + convert_to_hours.to_s + "h"
+        end
+
+        # @return [Integer]
+        def convert_to_hours
+          case match[:type]
+          when "d", "day", "days"
+            match[:digit].to_i * 24
+          when "y", "year", "years"
+            match[:digit].to_i * 24 * 365
           else
-            Date.new(date_match[:year].to_i)
+            fail NotImplementedError
           end
+        end
       end
 
-      # e.g. created:2000-01-01 -> created_at
-      # @return [String]
-      def converted_field_name
-        FIELD_NAMES_TABLE[@field_name] || @field_name
+      # @return [Hash]
+      def to_hash
+        if date
+          date.to_hash
+        else
+          Nodes::NullNode.new.to_hash
+        end
       end
 
-      def date_match
-        @date_match ||= DATE_PATTERN.match(range_query || @term)
+      private
+
+      # @return [BaseDateExpression, nil]
+      def date
+        @date ||= select_date
       end
 
-      # @return [Date]
-      def end_of_range
-        @end_of_range ||=
-          case
-          when date_match[:day]
-            beginning_of_range + 1.day
-          when date_match[:month]
-            beginning_of_range + 1.month
-          else
-            beginning_of_range + 1.year
-          end
+      def select_date
+        date = AbsoluteDateExpression.new(self)
+        return date if date.match
+        date = RelativeDateExpression.new(self)
+        return date if date.match
+        nil
       end
 
       # @note Override
       def has_invalid_term?
-        !!date_match
+        !date
       end
     end
   end

data/lib/qiita/elasticsearch/matchable_token.rb

@@ -27,14 +27,14 @@ module Qiita
 
       # @return [Hash]
       def build_multi_match_query(type: nil, boost: 1)
-        {
-          "multi_match" => {
-            "boost" => boost,
-            "fields" => matchable_fields,
-            "query" => @term,
-            "type" => type,
-          },
+        query = {
+          "boost" => boost,
+          "fields" => matchable_fields,
+          "query" => @term,
+          "type" => type,
         }
+        query.merge!(options)
+        { "multi_match" => query }
       end
 
       def matchable_fields

data/lib/qiita/elasticsearch/query_builder.rb

@@ -12,8 +12,10 @@ module Qiita
       # @param [Array<String>, nil] hierarchal_fields
       # @param [Array<String>, nil] int_fields
       # @param [Array<String>, nil] default_fields
+      # @param [Hash] matchable_options
       # @param [String, nil] time_zone
-      def initialize(all_fields: nil, date_fields: nil, downcased_fields: nil, hierarchal_fields: nil, filterable_fields: nil, int_fields: nil, default_fields: nil, time_zone: nil)
+      def initialize(all_fields: nil, date_fields: nil, downcased_fields: nil, hierarchal_fields: nil,
+                     filterable_fields: nil, int_fields: nil, default_fields: nil, time_zone: nil, matchable_options: nil)
         @all_fields = all_fields
         @date_fields = date_fields
         @downcased_fields = downcased_fields
@@ -22,6 +24,7 @@ module Qiita
         @int_fields = int_fields
         @default_fields = default_fields
         @time_zone = time_zone
+        @matchable_options = matchable_options
       end
 
       # @param [String] query_string Raw query string
@@ -50,6 +53,7 @@ module Qiita
           int_fields: @int_fields,
           default_fields: @default_fields,
           time_zone: @time_zone,
+          matchable_options: @matchable_options,
         )
       end
     end

data/lib/qiita/elasticsearch/token.rb

@@ -13,6 +13,9 @@ module Qiita
       #                        term
       attr_reader :term
 
+      # @return [Hash]
+      attr_accessor :options
+
       # @param [true, false] downcased True if given term must be downcased on query representation
       # @param [String, nil] field_name Field name part
       # @param [true, false] negative True if this term represents negative token (e.g. "-Perl")
@@ -20,7 +23,8 @@ module Qiita
       # @param [true, false] filter True if this term should be used as filter
       # @param [String] term Term part
       # @param [String] token_string Original entire string
-      def initialize(downcased: nil, field_name: nil, negative: nil, quoted: nil, filter: nil, term: nil, token_string: nil)
+      # @param [Hash] options Optional search parameters
+      def initialize(downcased: nil, field_name: nil, negative: nil, quoted: nil, filter: nil, term: nil, token_string: nil, options: nil)
         @downcased = downcased
         @field_name = field_name
         @negative = negative
@@ -28,6 +32,7 @@ module Qiita
         @filter = filter
         @term = term
         @token_string = token_string
+        @options = options
       end
 
       # @return [true, false] True if its term must be treated with downcased

data/lib/qiita/elasticsearch/tokenizer.rb

@@ -3,6 +3,7 @@ require "qiita/elasticsearch/filterable_token"
 require "qiita/elasticsearch/hierarchal_token"
 require "qiita/elasticsearch/matchable_token"
 require "qiita/elasticsearch/int_token"
+require "qiita/elasticsearch/range_token"
 
 module Qiita
   module Elasticsearch
@@ -15,6 +16,7 @@ module Qiita
       DEFAULT_DEFAULT_FIELDS = []
       EXTRA_DATE_FIELDS = %w(created updated)
       EXTRA_FILTERABLE_FIELDS = %w(created is sort updated)
+      DEFAULT_MATCHABLE_OPTIONS = {}
 
       TOKEN_PATTERN = /
         (?<token_string>
@@ -35,14 +37,16 @@ module Qiita
       # @param [Array<String>, nil] hierarchal_fields
       # @param [Array<String>, nil] int_fields
       # @param [Array<String>, nil] default_fields
+      # @param [Hash] matchable_options Optional search parameters for MatchableToken
       # @param [String, nil] time_zone
-      def initialize(all_fields: nil, date_fields: nil, downcased_fields: nil, filterable_fields: nil, hierarchal_fields: nil, int_fields: nil, default_fields: nil, time_zone: nil)
+      def initialize(all_fields: nil, date_fields: nil, downcased_fields: nil, filterable_fields: nil, hierarchal_fields: nil, int_fields: nil, default_fields: nil, time_zone: nil, matchable_options: nil)
         @date_fields = (date_fields || DEFAULT_DATE_FIELDS) | EXTRA_DATE_FIELDS
         @downcased_fields = downcased_fields || DEFAULT_DOWNCASED_FIELDS
         @filterable_fields = (filterable_fields || DEFAULT_FILTERABLE_FIELDS) | EXTRA_FILTERABLE_FIELDS
         @hierarchal_fields = hierarchal_fields || DEFAULT_HIERARCHAL_FIELDS
         @int_fields = int_fields || DEFAULT_INT_FIELDS
         @default_fields = default_fields || DEFAULT_DEFAULT_FIELDS
+        @matchable_options = matchable_options || DEFAULT_MATCHABLE_OPTIONS
         @all_fields = aggregate_all_fields(all_fields)
         @time_zone = time_zone
       end
@@ -65,6 +69,7 @@ module Qiita
             term: term,
             token_string: token_string,
           )
+          token.options = @matchable_options if token.is_a?(MatchableToken)
           token.default_fields = @default_fields if token.is_a?(MatchableToken)
           token.time_zone = @time_zone if token.is_a?(DateToken)
           token

data/lib/qiita/elasticsearch/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Elasticsearch
-    VERSION = "0.16.0"
+    VERSION = "0.17.0"
   end
 end

data/qiita-elasticsearch.gemspec

@@ -16,7 +16,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_dependency "activesupport"
   spec.add_development_dependency "bundler", ">= 1.7"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.3"
   spec.add_development_dependency "rubocop", "0.29.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-20 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !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: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -153,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Elasticsearch client helper for Qiita.