nql 0.0.2 → 0.0.3

data/README.md

@@ -1,54 +1,54 @@
-# NQL
-
-Natural Query Language built on top of ActiveRecord and Ransack
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'nql'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install nql
-
-## Supported comparators
-
-    ----------------------------------
-    | Symbol | Description           |
-    ----------------------------------
-    | %      | Contains              |
-    | =      | Equals                |
-    | !=     | Not equals            |
-    | >      | Grater than           |
-    | >=     | Grater or equals than |
-    | <      | Less than             |
-    | <=     | Less or equals than   |
-    ----------------------------------
-
-
-## Usage
-
-Converts from natural language to query expression
-
-    q = '(name % arg | name % br) & region = south'
-    Country.search(NQL.to_ransack(q)).result.to_sql
-    => "SELECT coutries.* FROM countries WHERE (countries.name LIKE '%arg%' OR countries.name LIKE '%br%') AND region = 'south'"
-
-### Joins support
-
-    q = 'cities.name % buenos'
-    Country.search(NQL.to_ransack(q)).result.to_sql
-    => "SELECT countries.* FROM countries LEFT OUTER JOIN cities ON countries.id = cities.country_id WHERE cities.name LIKE '%buenos%'"
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+# NQL
+
+Natural Query Language built on top of ActiveRecord and Ransack
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nql'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nql
+
+## Supported comparators
+
+    ----------------------------------
+    | Symbol | Description           |
+    ----------------------------------
+    | :      | Contains              |
+    | =      | Equals                |
+    | !=     | Not equals            |
+    | >      | Grater than           |
+    | >=     | Grater or equals than |
+    | <      | Less than             |
+    | <=     | Less or equals than   |
+    ----------------------------------
+
+
+## Usage
+
+Converts from natural language to query expression
+
+    q = '(name: arg | name: br) & region = south'
+    Country.search(NQL.to_ransack(q)).result.to_sql
+    => "SELECT coutries.* FROM countries WHERE (countries.name LIKE '%arg%' OR countries.name LIKE '%br%') AND region = 'south'"
+
+### Joins support
+
+    q = 'cities.name: buenos'
+    Country.search(NQL.to_ransack(q)).result.to_sql
+    => "SELECT countries.* FROM countries LEFT OUTER JOIN cities ON countries.id = cities.country_id WHERE cities.name LIKE '%buenos%'"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/nql.rb

@@ -5,20 +5,21 @@ require 'ransack'
 
 require 'nql/version'
 require 'nql/grammar'
+require 'nql/invalid_expression_error'
 
 module NQL
 
   def self.to_ransack(query)
     return nil if query.nil? || query.strip.empty?
-    expression = SyntaxParser.new.parse(query)
-    return invalid_condition unless expression
+    expression = parser.parse(query)
+    raise InvalidExpressionError.new(parser.failure_reason) unless expression
     expression.to_ransack
   end
 
   private
 
-  def self.invalid_condition
-    {c: [{a: {'0' => {name: 'id'}}, p: 'eq', v: {'0' => {value: '0'}}}]}
+  def self.parser
+    @@parser ||= SyntaxParser.new
   end
 
 end

data/lib/nql/grammar.rb

@@ -393,7 +393,7 @@ module NQL
           '>=' => 'gteq',
           '<' => 'lt',
           '<=' => 'lteq',
-          '%' => 'cont'
+          ':' => 'cont'
         }
         comparators[text_value]
       end
@@ -473,11 +473,11 @@ module NQL
                   if r7
                     r1 = r7
                   else
-                    if has_terminal?('%', false, index)
+                    if has_terminal?(':', false, index)
                       r8 = instantiate_node(SyntaxNode,input, index...(index + 1))
                       @index += 1
                     else
-                      terminal_parse_failure('%')
+                      terminal_parse_failure(':')
                       r8 = nil
                     end
                     if r8

data/lib/nql/grammar.treetop

@@ -68,7 +68,7 @@ module NQL
     end
 
     rule comparator
-      ('=' / '!=' / '>' / '>=' / '<' / '<=' / '%')+ {
+      ('=' / '!=' / '>' / '>=' / '<' / '<=' / ':')+ {
         def to_ransack
           comparators = {
             '=' => 'eq',
@@ -77,7 +77,7 @@ module NQL
             '>=' => 'gteq',
             '<' => 'lt',
             '<=' => 'lteq',
-            '%' => 'cont'
+            ':' => 'cont'
           }
           comparators[text_value]
         end

data/lib/nql/invalid_expression_error.rb

@@ -0,0 +1,7 @@
+module NQL
+  class InvalidExpressionError < StandardError
+    def initialize(message)
+      super
+    end
+  end
+end

data/lib/nql/version.rb

@@ -1,3 +1,3 @@
 module NQL
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/comparison_parser_spec.rb

@@ -55,10 +55,10 @@ describe NQL::SyntaxParser, '-> Comparison' do
     end
 
     it 'Contains' do
-      tree = parser.parse('var % value')
+      tree = parser.parse('var : value')
 
       tree.comparison.variable.text_value.should eq 'var'
-      tree.comparison.comparator.text_value.should eq '%'
+      tree.comparison.comparator.text_value.should eq ':'
       tree.comparison.value.text_value.should eq 'value'
     end
 

data/spec/ransack_spec.rb

@@ -55,7 +55,7 @@ describe 'Ransack Query' do
     end
 
     it 'Contains' do
-      q = parser.parse('id % 1234').to_ransack
+      q = parser.parse('id : 1234').to_ransack
 
       q[:c][0].should have_attribute 'id'
       q[:c][0].should have_predicate 'cont'
@@ -87,7 +87,7 @@ describe 'Ransack Query' do
     end
 
     it 'Or' do
-      q = parser.parse('id < 1234 | name % abcd').to_ransack
+      q = parser.parse('id < 1234 | name : abcd').to_ransack
 
       q[:g][0][:m].should eq 'or'
       q[:g][0][:c][0].should have_attribute 'id'
@@ -99,7 +99,7 @@ describe 'Ransack Query' do
     end
 
     it 'And then Or' do
-      q = parser.parse('id > 1234 & name = abcd | name % efgh').to_ransack
+      q = parser.parse('id > 1234 & name = abcd | name : efgh').to_ransack
 
       q[:g][0][:m].should eq 'and'
       q[:g][0][:c][0].should have_attribute 'id'
@@ -115,7 +115,7 @@ describe 'Ransack Query' do
     end
 
     it 'With parentheses' do
-      q = parser.parse('(id > 1234 & name = abcd) | name % efgh').to_ransack
+      q = parser.parse('(id > 1234 & name = abcd) | name : efgh').to_ransack
 
       q[:g][0][:g][0][:m].should eq 'and'
       q[:g][0][:g][0][:c][0].should have_attribute 'id'

data/spec/sql_spec.rb

@@ -41,7 +41,7 @@ describe 'SQL generation' do
     end
 
     it 'Contains' do
-      q = 'name % abcd'
+      q = 'name : abcd'
       Country.search(NQL.to_ransack(q)).result.should produce_sql "SELECT \"countries\".* FROM \"countries\"  WHERE (\"countries\".\"name\" LIKE '%abcd%')"
     end
 
@@ -55,17 +55,17 @@ describe 'SQL generation' do
     end
 
     it 'Or' do
-      q = 'id < 1234 | name % abcd'
+      q = 'id < 1234 | name : abcd'
       Country.search(NQL.to_ransack(q)).result.should produce_sql "SELECT \"countries\".* FROM \"countries\"  WHERE ((\"countries\".\"id\" < 1234 OR \"countries\".\"name\" LIKE '%abcd%'))"
     end
 
     it 'And then Or' do
-      q = 'id > 1234 & name = abcd | name % efgh'
+      q = 'id > 1234 & name = abcd | name : efgh'
       Country.search(NQL.to_ransack(q)).result.should produce_sql "SELECT \"countries\".* FROM \"countries\"  WHERE ((\"countries\".\"id\" > 1234 AND (\"countries\".\"name\" = 'abcd' OR \"countries\".\"name\" LIKE '%efgh%')))"
     end
 
     it 'With parentheses' do
-      q = '(id > 1234 & name = abcd) | name % efgh'
+      q = '(id > 1234 & name = abcd) | name : efgh'
       Country.search(NQL.to_ransack(q)).result.should produce_sql "SELECT \"countries\".* FROM \"countries\"  WHERE ((\"countries\".\"name\" LIKE '%efgh%' OR (\"countries\".\"id\" > 1234 AND \"countries\".\"name\" = 'abcd')))"
     end
 
@@ -74,17 +74,17 @@ describe 'SQL generation' do
   context 'Model joins' do
 
     it 'Parent join' do
-      q = 'country.name % abcd'
+      q = 'country.name : abcd'
       City.search(NQL.to_ransack(q)).result.should produce_sql "SELECT \"cities\".* FROM \"cities\" LEFT OUTER JOIN \"countries\" ON \"countries\".\"id\" = \"cities\".\"country_id\" WHERE (\"countries\".\"name\" LIKE '%abcd%')"
     end
 
     it 'Children join' do
-      q = 'cities.name % abcd'
+      q = 'cities.name : abcd'
       Country.search(NQL.to_ransack(q)).result.should produce_sql "SELECT \"countries\".* FROM \"countries\" LEFT OUTER JOIN \"cities\" ON \"cities\".\"country_id\" = \"countries\".\"id\" WHERE (\"cities\".\"name\" LIKE '%abcd%')"
     end
 
     it 'Children join distinct' do
-      q = 'cities.name % abcd'
+      q = 'cities.name : abcd'
       Country.search(NQL.to_ransack(q)).result(distinct: true).should produce_sql "SELECT DISTINCT \"countries\".* FROM \"countries\" LEFT OUTER JOIN \"cities\" ON \"cities\".\"country_id\" = \"countries\".\"id\" WHERE (\"cities\".\"name\" LIKE '%abcd%')"
     end
 
@@ -109,7 +109,7 @@ describe 'SQL generation' do
 
     it 'Partial expression' do
       q = 'id ='
-      Country.search(NQL.to_ransack(q)).result.should produce_sql "SELECT \"countries\".* FROM \"countries\"  WHERE \"countries\".\"id\" = 0"
+      expect{Country.search(NQL.to_ransack(q)).result}.should raise_exception NQL::InvalidExpressionError
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nql
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
-  requirement: &28497180 !ruby/object:Gem::Requirement
+  requirement: &28678476 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *28497180
+  version_requirements: *28678476
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &28496880 !ruby/object:Gem::Requirement
+  requirement: &28678152 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *28496880
+  version_requirements: *28678152
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &28496568 !ruby/object:Gem::Requirement
+  requirement: &28677828 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *28496568
+  version_requirements: *28677828
 - !ruby/object:Gem::Dependency
   name: ransack
-  requirement: &28496340 !ruby/object:Gem::Requirement
+  requirement: &28677600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *28496340
+  version_requirements: *28677600
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &28496064 !ruby/object:Gem::Requirement
+  requirement: &28677324 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *28496064
+  version_requirements: *28677324
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &28495812 !ruby/object:Gem::Requirement
+  requirement: &28677060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *28495812
+  version_requirements: *28677060
 description: Natural Query Language built on top of ActiveRecord and Ransack
 email:
 - gabynaiman@gmail.com
@@ -92,6 +92,7 @@ files:
 - lib/nql.rb
 - lib/nql/grammar.rb
 - lib/nql/grammar.treetop
+- lib/nql/invalid_expression_error.rb
 - lib/nql/version.rb
 - nql.gemspec
 - spec/comparison_parser_spec.rb