elasticsearch_query_parser 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c23d8074f9260bd26bf623701beeb91875157a163ee7737b0694d7426d9b9f3
+  data.tar.gz: 21d2f8ae94b1f1831ed53a3cc6a475dc820dcbc44c048b6ccc4fb49de2af5ec9
+SHA512:
+  metadata.gz: c16fb5af9ae5e50af78d0df43700175fcf3ff7e81c8d843959c60d832462c1eab3b77645be2a6b0d137bcf8f9284c18b365ce2b6d1331088d6a147e73d56a0a3
+  data.tar.gz: 2bc6b81b3fb1cd976101b919480815b2d2545230b0f2c2b3a05222e49008944d914039037116d5158a34ba7ed6b599cdad01b2190e8f329f8befc6b6f2368bae

data/LICENSE

@@ -0,0 +1,27 @@
+// Copyright (c) 2010 The Chromium Authors. All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//    * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//    * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//    * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,196 @@
+# Elasticsearch query parser
+
+[![Build Status](https://semaphoreci.com/api/v1/khabibullin_ruslan/elasticsearch_query_parser/branches/master/badge.svg)](https://semaphoreci.com/khabibullin_ruslan/elasticsearch_query_parser)
+[![Gem Version](https://badge.fury.io/rb/elasticsearch_query_parser.svg)](https://badge.fury.io/rb/elasticsearch_query_parser)
+
+- I can search “London” and it will return everyone with “London”
+- And then a complex example could be a boolean search such as: ((('London' OR 'Paris') OR 'Madrid') AND 'Venture Capital') NOT VC
+
+## Hot to install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "elasticsearch_query_parser"
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+## How to use
+
+```ruby
+require "elasticsearch_query_parser"
+
+ElasticsearchQueryParser.parse_query("London")
+# => { query: { bool: { should: [{ match: { text: { query: "London", operator: "and" } } }] } } }
+
+ElasticsearchQueryParser.parse_query("London Madrid")
+=begin
+{
+  query: {
+    bool: {
+      should: [
+        { match: { text: { query: "London", operator: "and" } } },
+        { match: { text: { query: "Madrid", operator: "and" } } }
+      ]
+    }
+  }
+}
+=end
+
+ElasticsearchQueryParser.parse_query("London OR Madrid")
+=begin
+{
+  query: {
+    bool: {
+      should: [
+        { match: { text: { query: "London", operator: "and" } } },
+        { match: { text: { query: "Madrid", operator: "and" } } }
+      ]
+    }
+  }
+}
+=end
+
+ElasticsearchQueryParser.parse_query("(London OR Madrid) AND Paris")
+=begin
+{
+  query: {
+    bool: {
+      must: [
+        { match: { text: { query: "Paris", operator: "and" } } },
+        {
+          bool: {
+            should:[
+              { match: { text: { query: "Madrid", operator: "and" } } },
+              { match: { text: { query: "London", operator:"and" } } }
+            ]
+          }
+        }
+      ]
+    }
+  }
+}
+=end
+
+ElasticsearchQueryParser.parse_query("(((London OR Paris) OR Madrid) AND 'Venture Capital') NOT VC")
+=begin
+{
+  query: {
+    bool: {
+      must: [
+        { match: { text: { query: "Venture Capital", operator: "and" } } },
+        {
+          bool: {
+            should: [
+              { match: { text: { query: "Madrid", operator: "and" } } },
+              {
+                bool: {
+                  should: [
+                    { match: { text: { query: "Paris", operator: "and" }}},
+                    { match: { text: { query: "London", operator: "and" } } }
+                  ]
+                }
+              }
+            ]
+          }
+        }
+      ],
+      must_not:[{ match: { text: { query: "VC", operator: "and" } } }]
+    }
+  }
+}
+=end
+
+ElasticsearchQueryParser.parse_query("Paris AND (London OR Madrid)")
+=begin
+{
+  query:{
+    bool: {
+      must:[
+        { match: { text: { query: "Paris", operator: "and" } } },
+        {
+          bool: {
+            should:[
+              { match: { text: { query: "London", operator: "and" } } },
+              { match: { text: { query: "Madrid", operator: "and" } } }
+            ]
+          }
+        }
+      ]
+    }
+  }
+}
+=end
+
+ElasticsearchQueryParser.parse_query("VC AND ('Venture Capital' AND (Madrid OR (Paris AND London)))")
+=begin
+{
+  query: {
+    bool: {
+      must:[
+        { match: { text: { query: "VC", operator: "and" } } },
+        {
+          bool: {
+            must: [
+              { match: { text: { query: "Venture Capital", operator: "and" } } },
+              {
+                bool: {
+                  should:[
+                    { match: { text: { query: "Madrid", operator: "and" } } },
+                    {
+                      bool: {
+                        must: [
+                          { match: { text: { query: "Paris", operator: "and" } } },
+                          { match: { text: { query: "London", operator: "and" } } }
+                        ]
+                      }
+                    }
+                  ]
+                }
+              }
+            ]
+          }
+        }
+      ]
+    }
+  }
+}
+=end
+
+ElasticsearchQueryParser.parse_query("((London OR Madrid) NOT VC) NOT 'Venture Capital'")
+=begin
+{
+  query: {
+    bool: {
+      should: [
+        { match: { text: { query: "Madrid", operator: "and" } } },
+        { match: { text: { query: "London", operator: "and" } } }
+      ],
+      must_not: [
+        { match: { text: { query: "VC", operator: "and" } } },
+        { match: { text: { query: "Venture Capital", operator: "and" } } }
+      ]
+    }
+  }
+}
+=end
+```
+
+## How to change Elastic field name
+
+By default `#parse_query` generates elastic query with `text` attribute. You can customize field name via config:
+
+```ruby
+ElasticsearchQueryParser.configure do |config|
+  # elastic_field_name can accepts symbol or string
+  config.elastic_field_name = "title"
+end
+
+ElasticsearchQueryParser.parse_query("London")
+# => { query: { bool: { should: [{ match: { "title": { query: "London", operator: "and" } } }] } } }
+```

data/lib/doc/ElasticsearchQueryParser/Grammar/Parser.html

@@ -0,0 +1,108 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class ElasticsearchQueryParser::Grammar::Parser - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../../";
+  var index_rel_prefix = "../../";
+</script>
+
+<script src="../../js/navigation.js" defer></script>
+<script src="../../js/search.js" defer></script>
+<script src="../../js/search_index.js" defer></script>
+<script src="../../js/searcher.js" defer></script>
+<script src="../../js/darkfish.js" defer></script>
+
+<link href="../../css/fonts.css" rel="stylesheet">
+<link href="../../css/rdoc.css" rel="stylesheet">
+
+
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="../../index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="../../table_of_contents.html#pages">Pages</a>
+    <a href="../../table_of_contents.html#classes">Classes</a>
+    <a href="../../table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    <div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  
+  <p class="link">Parslet::Parser
+  
+</div>
+
+    
+    
+    
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-ElasticsearchQueryParser::Grammar::Parser">
+  <h1 id="class-ElasticsearchQueryParser::Grammar::Parser" class="class">
+    class ElasticsearchQueryParser::Grammar::Parser
+  </h1>
+
+  <section class="description">
+    
+<p>User query grammar description (PEG tree)</p>
+
+  </section>
+
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+
+    
+  </section>
+
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.0.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+

data/lib/doc/ElasticsearchQueryParser/Grammar/Presenters/Operator/InvalidOperatorString.html

@@ -0,0 +1,206 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class ElasticsearchQueryParser::Grammar::Presenters::Operator::InvalidOperatorString - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../../../../";
+  var index_rel_prefix = "../../../../";
+</script>
+
+<script src="../../../../js/navigation.js" defer></script>
+<script src="../../../../js/search.js" defer></script>
+<script src="../../../../js/search_index.js" defer></script>
+<script src="../../../../js/searcher.js" defer></script>
+<script src="../../../../js/darkfish.js" defer></script>
+
+<link href="../../../../css/fonts.css" rel="stylesheet">
+<link href="../../../../css/rdoc.css" rel="stylesheet">
+
+
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="../../../../index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="../../../../table_of_contents.html#pages">Pages</a>
+    <a href="../../../../table_of_contents.html#classes">Classes</a>
+    <a href="../../../../table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    <div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  
+  <p class="link">StandardError
+  
+</div>
+
+    
+    
+    <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+
+  <ul class="link-list" role="directory">
+    
+    <li class="calls-super" ><a href="#method-c-new">::new</a>
+    
+    <li ><a href="#method-i-message">#message</a>
+    
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-ElasticsearchQueryParser::Grammar::Presenters::Operator::InvalidOperatorString">
+  <h1 id="class-ElasticsearchQueryParser::Grammar::Presenters::Operator::InvalidOperatorString" class="class">
+    class ElasticsearchQueryParser::Grammar::Presenters::Operator::InvalidOperatorString
+  </h1>
+
+  <section class="description">
+    
+  </section>
+
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+
+    
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Class Methods</h3>
+       </header>
+
+    
+      <div id="method-c-new" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">new</span><span
+            class="method-args">(string)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+            <div class="method-calls-super">
+              Calls superclass method
+              
+            </div>
+          
+
+          
+          <div class="method-source-code" id="new-source">
+            <pre><span class="ruby-comment"># File elasticsearch_query_parser/grammar/presenters/operator.rb, line 9</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">string</span>)
+  <span class="ruby-ivar">@string</span> = <span class="ruby-identifier">string</span>
+  <span class="ruby-keyword">super</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+    </section>
+  
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Instance Methods</h3>
+       </header>
+
+    
+      <div id="method-i-message" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">message</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+
+          
+          <div class="method-source-code" id="message-source">
+            <pre><span class="ruby-comment"># File elasticsearch_query_parser/grammar/presenters/operator.rb, line 14</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">message</span>
+  <span class="ruby-node">&quot;Invalid operator: #{string}&quot;</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+    </section>
+  
+  </section>
+
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.0.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+