nql 0.0.1 → 0.0.2

data/README.md

@@ -1,29 +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
-
-## Usage
-
-TODO: Write usage instructions here
-
-## 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

@@ -9,7 +9,16 @@ require 'nql/grammar'
 module NQL
 
   def self.to_ransack(query)
-    SyntaxParser.new.parse(query).to_ransack
+    return nil if query.nil? || query.strip.empty?
+    expression = SyntaxParser.new.parse(query)
+    return invalid_condition unless expression
+    expression.to_ransack
+  end
+
+  private
+
+  def self.invalid_condition
+    {c: [{a: {'0' => {name: 'id'}}, p: 'eq', v: {'0' => {value: '0'}}}]}
   end
 
 end

data/lib/nql/grammar.rb

@@ -63,14 +63,14 @@ module NQL
 
     module Boolean1
       def to_ransack
-        group = {'g' => [{'m' => coordinator.to_ransack}]}
+        group = {g: [{m: coordinator.to_ransack}]}
 
         [left, right].each do |side|
           if side.is_node?(:boolean)
-            group['g'][0].merge! side.to_ransack
+            group[:g][0].merge! side.to_ransack
           else
-            group['g'][0]['c'] ||= []
-            group['g'][0]['c'] << side.to_ransack
+            group[:g][0][:c] ||= []
+            group[:g][0][:c] << side.to_ransack
           end
         end
 
@@ -330,8 +330,8 @@ module NQL
 
     module Comparison1
       def to_ransack
-        hash = {'a' => {'0' => {'name' => self.variable.text_value.gsub('.', '_')}}, 'p' => self.comparator.to_ransack, 'v' => {'0' => {'value' => self.value.text_value}}}
-        hash = {'c' => [hash]} if !parent || !parent.parent || text_value == parent.parent.text_value
+        hash = {a: {'0' => {name: self.variable.text_value.gsub('.', '_')}}, p: self.comparator.to_ransack, v: {'0' => {value: self.value.text_value}}}
+        hash = {c: [hash]} if !parent || !parent.parent || text_value == parent.parent.text_value
         hash
       end
 

data/lib/nql/grammar.treetop

@@ -8,14 +8,14 @@ module NQL
     rule boolean
       left:primary space coordinator:coordinator space right:expression {
         def to_ransack
-          group = {'g' => [{'m' => coordinator.to_ransack}]}
+          group = {g: [{m: coordinator.to_ransack}]}
 
           [left, right].each do |side|
             if side.is_node?(:boolean)
-              group['g'][0].merge! side.to_ransack
+              group[:g][0].merge! side.to_ransack
             else
-              group['g'][0]['c'] ||= []
-              group['g'][0]['c'] << side.to_ransack
+              group[:g][0][:c] ||= []
+              group[:g][0][:c] << side.to_ransack
             end
           end
 
@@ -56,8 +56,8 @@ module NQL
     rule comparison
       variable:alphanumeric space comparator:comparator space value:text {
         def to_ransack
-          hash = {'a' => {'0' => {'name' => self.variable.text_value.gsub('.', '_')}}, 'p' => self.comparator.to_ransack, 'v' => {'0' => {'value' => self.value.text_value}}}
-          hash = {'c' => [hash]} if !parent || !parent.parent || text_value == parent.parent.text_value
+          hash = {a: {'0' => {name: self.variable.text_value.gsub('.', '_')}}, p: self.comparator.to_ransack, v: {'0' => {value: self.value.text_value}}}
+          hash = {c: [hash]} if !parent || !parent.parent || text_value == parent.parent.text_value
           hash
         end
 

data/lib/nql/version.rb

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

data/spec/ransack_spec.rb

@@ -9,65 +9,65 @@ describe 'Ransack Query' do
     it 'Equals' do
       q = parser.parse('id = 1234').to_ransack
 
-      q['c'][0].should have_attribute 'id'
-      q['c'][0].should have_predicate 'eq'
-      q['c'][0].should have_value '1234'
+      q[:c][0].should have_attribute 'id'
+      q[:c][0].should have_predicate 'eq'
+      q[:c][0].should have_value '1234'
     end
 
     it 'Not equals' do
       q = parser.parse('id != 1234').to_ransack
 
-      q['c'][0].should have_attribute 'id'
-      q['c'][0].should have_predicate 'not_eq'
-      q['c'][0].should have_value '1234'
+      q[:c][0].should have_attribute 'id'
+      q[:c][0].should have_predicate 'not_eq'
+      q[:c][0].should have_value '1234'
     end
 
     it 'Greater than' do
       q = parser.parse('id > 1234').to_ransack
 
-      q['c'][0].should have_attribute 'id'
-      q['c'][0].should have_predicate 'gt'
-      q['c'][0].should have_value '1234'
+      q[:c][0].should have_attribute 'id'
+      q[:c][0].should have_predicate 'gt'
+      q[:c][0].should have_value '1234'
     end
 
     it 'Greater or equals than' do
       q = parser.parse('id >= 1234').to_ransack
 
-      q['c'][0].should have_attribute 'id'
-      q['c'][0].should have_predicate 'gteq'
-      q['c'][0].should have_value '1234'
+      q[:c][0].should have_attribute 'id'
+      q[:c][0].should have_predicate 'gteq'
+      q[:c][0].should have_value '1234'
     end
 
     it 'Less than' do
       q = parser.parse('id < 1234').to_ransack
 
-      q['c'][0].should have_attribute 'id'
-      q['c'][0].should have_predicate 'lt'
-      q['c'][0].should have_value '1234'
+      q[:c][0].should have_attribute 'id'
+      q[:c][0].should have_predicate 'lt'
+      q[:c][0].should have_value '1234'
     end
 
     it 'Less or equals than' do
       q = parser.parse('id <= 1234').to_ransack
 
-      q['c'][0].should have_attribute 'id'
-      q['c'][0].should have_predicate 'lteq'
-      q['c'][0].should have_value '1234'
+      q[:c][0].should have_attribute 'id'
+      q[:c][0].should have_predicate 'lteq'
+      q[:c][0].should have_value '1234'
     end
 
     it 'Contains' do
       q = parser.parse('id % 1234').to_ransack
 
-      q['c'][0].should have_attribute 'id'
-      q['c'][0].should have_predicate 'cont'
-      q['c'][0].should have_value '1234'
+      q[:c][0].should have_attribute 'id'
+      q[:c][0].should have_predicate 'cont'
+      q[:c][0].should have_value '1234'
     end
 
     it 'Model references' do
       q = parser.parse('models.id = 1234').to_ransack
 
-      q['c'][0].should have_attribute 'models_id'
-      q['c'][0].should have_predicate 'eq'
-      q['c'][0].should have_value '1234'
+      q[:c][0].should have_attribute 'models_id'
+      q[:c][0].should have_predicate 'eq'
+      q[:c][0].should have_value '1234'
     end
 
   end
@@ -77,57 +77,57 @@ describe 'Ransack Query' do
     it 'And' do
       q = parser.parse('id > 1234 & name = abcd').to_ransack
 
-      q['g'][0]['m'].should eq 'and'
-      q['g'][0]['c'][0].should have_attribute 'id'
-      q['g'][0]['c'][0].should have_predicate 'gt'
-      q['g'][0]['c'][0].should have_value '1234'
-      q['g'][0]['c'][1].should have_attribute 'name'
-      q['g'][0]['c'][1].should have_predicate 'eq'
-      q['g'][0]['c'][1].should have_value 'abcd'
+      q[:g][0][:m].should eq 'and'
+      q[:g][0][:c][0].should have_attribute 'id'
+      q[:g][0][:c][0].should have_predicate 'gt'
+      q[:g][0][:c][0].should have_value '1234'
+      q[:g][0][:c][1].should have_attribute 'name'
+      q[:g][0][:c][1].should have_predicate 'eq'
+      q[:g][0][:c][1].should have_value 'abcd'
     end
 
     it 'Or' do
       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'
-      q['g'][0]['c'][0].should have_predicate 'lt'
-      q['g'][0]['c'][0].should have_value '1234'
-      q['g'][0]['c'][1].should have_attribute 'name'
-      q['g'][0]['c'][1].should have_predicate 'cont'
-      q['g'][0]['c'][1].should have_value 'abcd'
+      q[:g][0][:m].should eq 'or'
+      q[:g][0][:c][0].should have_attribute 'id'
+      q[:g][0][:c][0].should have_predicate 'lt'
+      q[:g][0][:c][0].should have_value '1234'
+      q[:g][0][:c][1].should have_attribute 'name'
+      q[:g][0][:c][1].should have_predicate 'cont'
+      q[:g][0][:c][1].should have_value 'abcd'
     end
 
     it 'And then Or' do
       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'
-      q['g'][0]['c'][0].should have_predicate 'gt'
-      q['g'][0]['c'][0].should have_value '1234'
-      q['g'][0]['g'][0]['m'].should eq 'or'
-      q['g'][0]['g'][0]['c'][0].should have_attribute 'name'
-      q['g'][0]['g'][0]['c'][0].should have_predicate 'eq'
-      q['g'][0]['g'][0]['c'][0].should have_value 'abcd'
-      q['g'][0]['g'][0]['c'][1].should have_attribute 'name'
-      q['g'][0]['g'][0]['c'][1].should have_predicate 'cont'
-      q['g'][0]['g'][0]['c'][1].should have_value 'efgh'
+      q[:g][0][:m].should eq 'and'
+      q[:g][0][:c][0].should have_attribute 'id'
+      q[:g][0][:c][0].should have_predicate 'gt'
+      q[:g][0][:c][0].should have_value '1234'
+      q[:g][0][:g][0][:m].should eq 'or'
+      q[:g][0][:g][0][:c][0].should have_attribute 'name'
+      q[:g][0][:g][0][:c][0].should have_predicate 'eq'
+      q[:g][0][:g][0][:c][0].should have_value 'abcd'
+      q[:g][0][:g][0][:c][1].should have_attribute 'name'
+      q[:g][0][:g][0][:c][1].should have_predicate 'cont'
+      q[:g][0][:g][0][:c][1].should have_value 'efgh'
     end
 
     it 'With parentheses' do
       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'
-      q['g'][0]['g'][0]['c'][0].should have_predicate 'gt'
-      q['g'][0]['g'][0]['c'][0].should have_value '1234'
-      q['g'][0]['g'][0]['c'][1].should have_attribute 'name'
-      q['g'][0]['g'][0]['c'][1].should have_predicate 'eq'
-      q['g'][0]['g'][0]['c'][1].should have_value 'abcd'
-      q['g'][0]['m'].should eq 'or'
-      q['g'][0]['c'][0].should have_attribute 'name'
-      q['g'][0]['c'][0].should have_predicate 'cont'
-      q['g'][0]['c'][0].should have_value 'efgh'
+      q[:g][0][:g][0][:m].should eq 'and'
+      q[:g][0][:g][0][:c][0].should have_attribute 'id'
+      q[:g][0][:g][0][:c][0].should have_predicate 'gt'
+      q[:g][0][:g][0][:c][0].should have_value '1234'
+      q[:g][0][:g][0][:c][1].should have_attribute 'name'
+      q[:g][0][:g][0][:c][1].should have_predicate 'eq'
+      q[:g][0][:g][0][:c][1].should have_value 'abcd'
+      q[:g][0][:m].should eq 'or'
+      q[:g][0][:c][0].should have_attribute 'name'
+      q[:g][0][:c][0].should have_predicate 'cont'
+      q[:g][0][:c][0].should have_value 'efgh'
     end
 
   end

data/spec/spec_helper.rb

@@ -6,37 +6,37 @@ ActiveRecord::Migrator.migrations_path = "#{File.dirname(__FILE__)}/migrations"
 
 RSpec::Matchers.define :have_attribute do |expected|
   match do |actual|
-    actual['a']['0']['name'] == expected
+    actual[:a]['0'][:name] == expected
   end
 
   failure_message_for_should do |actual|
-    "expected: #{actual['a']['0']['name']}\n     got: #{expected}"
+    "expected: #{actual[:a]['0'][:name]}\n     got: #{expected}"
   end
 end
 
 RSpec::Matchers.define :have_predicate do |expected|
   match do |actual|
-    actual['p'] == expected
+    actual[:p] == expected
   end
 
   failure_message_for_should do |actual|
-    "expected: #{actual['p']}\n     got: #{expected}"
+    "expected: #{actual[:p]}\n     got: #{expected}"
   end
 end
 
 RSpec::Matchers.define :have_value do |expected|
   match do |actual|
-    actual['v']['0']['value'] == expected
+    actual[:v]['0'][:value] == expected
   end
 
   failure_message_for_should do |actual|
-    "expected: #{actual['v']['0']['value']}\n     got: #{expected}"
+    "expected: #{actual[:v]['0'][:value]}\n     got: #{expected}"
   end
 end
 
 RSpec::Matchers.define :produce_sql do |expected|
   match do |actual|
-    actual.to_sql == expected
+    actual.to_sql.strip == expected
   end
 
   failure_message_for_should do |actual|

data/spec/sql_spec.rb

@@ -90,4 +90,28 @@ describe 'SQL generation' do
 
   end
 
+  context 'Invalid queries' do
+
+    it 'Nil' do
+      q = nil
+      Country.search(NQL.to_ransack(q)).result.should produce_sql "SELECT \"countries\".* FROM \"countries\""
+    end
+
+    it 'Empty' do
+      q = ''
+      Country.search(NQL.to_ransack(q)).result.should produce_sql "SELECT \"countries\".* FROM \"countries\""
+    end
+
+    it 'Empty with spaces' do
+      q = '   '
+      Country.search(NQL.to_ransack(q)).result.should produce_sql "SELECT \"countries\".* FROM \"countries\""
+    end
+
+    it 'Partial expression' do
+      q = 'id ='
+      Country.search(NQL.to_ransack(q)).result.should produce_sql "SELECT \"countries\".* FROM \"countries\"  WHERE \"countries\".\"id\" = 0"
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nql
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-08 00:00:00.000000000 Z
+date: 2012-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
-  requirement: &25509144 !ruby/object:Gem::Requirement
+  requirement: &28497180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25509144
+  version_requirements: *28497180
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &25508652 !ruby/object:Gem::Requirement
+  requirement: &28496880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *25508652
+  version_requirements: *28496880
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &25508232 !ruby/object:Gem::Requirement
+  requirement: &28496568 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *25508232
+  version_requirements: *28496568
 - !ruby/object:Gem::Dependency
   name: ransack
-  requirement: &25507908 !ruby/object:Gem::Requirement
+  requirement: &28496340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25507908
+  version_requirements: *28496340
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &25507440 !ruby/object:Gem::Requirement
+  requirement: &28496064 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25507440
+  version_requirements: *28496064
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &25506972 !ruby/object:Gem::Requirement
+  requirement: &28495812 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25506972
+  version_requirements: *28495812
 description: Natural Query Language built on top of ActiveRecord and Ransack
 email:
 - gabynaiman@gmail.com