nql 0.0.3 → 0.1.2

data/lib/nql/grammar.treetop

@@ -1,109 +1,111 @@
-module NQL
-  grammar Syntax
-
-    rule expression
-      boolean / primary
-    end
-
-    rule boolean
-      left:primary space coordinator:coordinator space right:expression {
-        def 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
-            else
-              group[:g][0][:c] ||= []
-              group[:g][0][:c] << side.to_ransack
-            end
-          end
-
-          group
-        end
-
-        def is_node?(node_type)
-          node_type.to_sym == :boolean
-        end
-      }
-    end
-
-    rule primary
-      (space comparison space / '(' space expression space ')') {
-        def to_ransack
-          detect_node.to_ransack
-        end
-
-        def detect_node
-          self.send %w(comparison expression).detect { |m| self.respond_to? m }
-        end
-
-        def is_node?(node_type)
-          detect_node.is_node?(node_type)
-        end
-      }
-    end
-
-    rule coordinator
-      ('|' / '&') {
-        def to_ransack
-          coordinators = {'|' => 'or', '&' => 'and'}
-          coordinators[text_value]
-        end
-      }
-    end
-
-    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
-        end
-
-        def is_node?(node_type)
-          node_type.to_sym == :comparison
-        end
-      }
-    end
-
-    rule comparator
-      ('=' / '!=' / '>' / '>=' / '<' / '<=' / ':')+ {
-        def to_ransack
-          comparators = {
-            '=' => 'eq',
-            '!=' => 'not_eq',
-            '>' => 'gt',
-            '>=' => 'gteq',
-            '<' => 'lt',
-            '<=' => 'lteq',
-            ':' => 'cont'
-          }
-          comparators[text_value]
-        end
-      }
-    end
-
-    rule text
-      (alphanumeric / utf8 / symbol)+
-      (space (alphanumeric / utf8 / symbol)+)*
-    end
-
-    rule alphanumeric
-      [a-zA-Z0-9_.]+
-    end
-
-    rule space
-      ' '*
-    end
-
-    rule symbol
-      [><=+-\/\\@#$%!?:]
-    end
-
-    rule utf8
-      [\u00c1\u00c0\u00c9\u00c8\u00cd\u00cc\u00d3\u00d2\u00da\u00d9\u00dc\u00d1\u00c7\u00e1\u00e0\u00e9\u00e8\u00ed\u00ec\u00f3\u00f2\u00fa\u00f9\u00fc\u00f1\u00e7]
-    end
-
-  end
+module NQL
+  grammar Syntax
+
+    rule expression
+      boolean / primary
+    end
+
+    rule boolean
+      left:primary space coordinator:coordinator space right:expression {
+        def 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
+            else
+              group[:g][0][:c] ||= []
+              group[:g][0][:c] << side.to_ransack
+            end
+          end
+
+          group
+        end
+
+        def is_node?(node_type)
+          node_type.to_sym == :boolean
+        end
+      }
+    end
+
+    rule primary
+      (space comparison space / '(' space comparison space ')' / '(' space expression space ')') {
+        def to_ransack
+          detect_node.to_ransack
+        end
+
+        def detect_node
+          self.send %w(comparison expression).detect { |m| self.respond_to? m }
+        end
+
+        def is_node?(node_type)
+          detect_node.is_node?(node_type)
+        end
+      }
+    end
+
+    rule coordinator
+      ('|' / '&') {
+        def to_ransack
+          coordinators = {'|' => 'or', '&' => 'and'}
+          coordinators[text_value]
+        end
+      }
+    end
+
+    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
+        end
+
+        def is_node?(node_type)
+          node_type.to_sym == :comparison
+        end
+      }
+    end
+
+    rule comparator
+      ('=' / '!=' / '>' / '>=' / '<' / '<=' / ':' / '!:' / '~')+ {
+        def to_ransack
+          comparators = {
+            '=' => 'eq',
+            '!=' => 'not_eq',
+            '>' => 'gt',
+            '>=' => 'gteq',
+            '<' => 'lt',
+            '<=' => 'lteq',
+            ':' => 'cont',
+            '!:' => 'not_cont',
+            '~' => 'matches'
+          }
+          comparators[text_value]
+        end
+      }
+    end
+
+    rule text
+      (alphanumeric / utf8 / symbol)+
+      (space (alphanumeric / utf8 / symbol)+)*
+    end
+
+    rule alphanumeric
+      [a-zA-Z0-9_.]+
+    end
+
+    rule space
+      ' '*
+    end
+
+    rule symbol
+      [><=+-\/\\@#$%!?:]
+    end
+
+    rule utf8
+      [\u00c0\u00c1\u00c2\u00c3\u00c4\u00c7\u00c8\u00c9\u00ca\u00cb\u00cc\u00cd\u00ce\u00cf\u00d1\u00d2\u00d3\u00d4\u00d5\u00d6\u00d9\u00da\u00db\u00dc\u00e0\u00e1\u00e2\u00e3\u00e4\u00e7\u00e8\u00e9\u00ea\u00eb\u00ec\u00ed\u00ee\u00ef\u00f1\u00f2\u00f3\u00f4\u00f5\u00f6\u00f9\u00fa\u00fb\u00fc]
+    end
+
+  end
 end

data/lib/nql/query.rb

@@ -0,0 +1,62 @@
+module NQL
+  class Query
+
+    attr_reader :model
+    attr_reader :text
+    attr_reader :expression
+
+    def initialize(model, text)
+      raise InvalidModelError.new model unless model.ancestors.include? ::ActiveRecord::Base
+      raise DataTypeError.new text if text && !text.is_a?(String)
+      @model = model
+      @text = text
+      evaluate
+    end
+
+    def ransack_search
+      if expression
+        model.search(expression.to_ransack)
+      else
+        model.search
+      end
+    end
+
+    private
+
+    def evaluate
+      if text.nil? || text.strip.empty?
+        @expression = nil
+      else
+        parser = SyntaxParser.new
+        @expression = parser.parse(text)
+        raise SyntaxError.new(parser.failure_reason) unless expression
+        validate_attributes!
+      end
+    end
+
+    def validate_attributes!
+      return unless expression
+      extended_attributes = model.column_names | model.reflections.flat_map { |k, v| v.klass.column_names.map { |c| "#{k}_#{c}" } }
+      invalid_attributes(expression.to_ransack, extended_attributes).tap do |attributes|
+        raise AttributesNotFoundError.new model, attributes if attributes.any?
+      end
+    end
+
+    def invalid_attributes(node, valid_attributes)
+      return [] unless node
+
+      node.deep_symbolize_keys.flat_map do |k, v|
+        if k == :a
+          [v['0'.to_sym][:name]] unless valid_attributes.include?(v['0'.to_sym][:name])
+        else
+          if v.is_a?(Hash)
+            invalid_attributes(v, valid_attributes)
+          elsif v.is_a?(Array)
+            v.select { |e| e.is_a?(Hash) }.flat_map { |e| invalid_attributes(e, valid_attributes) }
+          end
+        end
+      end.compact
+    end
+
+  end
+end

data/lib/nql/version.rb

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

data/nql.gemspec

@@ -1,25 +1,27 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/nql/version', __FILE__)
-
-Gem::Specification.new do |s|
-  s.name          = 'nql'
-  s.version       = NQL::VERSION
-  s.authors       = ['Gabriel Naiman']
-  s.email         = ['gabynaiman@gmail.com']
-  s.description   = 'Natural Query Language built on top of ActiveRecord and Ransack'
-  s.summary       = 'Natural Query Language built on top of ActiveRecord and Ransack'
-  s.homepage      = 'https://github.com/gabynaiman/nql'
-
-  s.files         = `git ls-files`.split($\)
-  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ["lib"]
-
-  s.add_dependency 'treetop'
-  s.add_dependency 'activerecord', '>= 3.2.0'
-  s.add_dependency 'activesupport', '>= 3.2.0'
-  s.add_dependency 'ransack'
-
-  s.add_development_dependency 'sqlite3'
-  s.add_development_dependency 'rspec'
-end
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/nql/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'nql'
+  s.version       = NQL::VERSION
+  s.authors       = ['Gabriel Naiman']
+  s.email         = ['gabynaiman@gmail.com']
+  s.description   = 'Natural Query Language built on top of ActiveRecord and Ransack'
+  s.summary       = 'Natural Query Language built on top of ActiveRecord and Ransack'
+  s.homepage      = 'https://github.com/gabynaiman/nql'
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'treetop', '~> 1.4.0'
+  s.add_dependency 'activerecord', '>= 3.2.0'
+  s.add_dependency 'activesupport', '>= 3.2.0'
+  s.add_dependency 'ransack', '~> 0.7'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'sqlite3', '~> 1.3.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'simplecov'
+end

data/spec/comparison_parser_spec.rb

@@ -1,147 +1,164 @@
-require 'spec_helper'
-
-describe NQL::SyntaxParser, '-> Comparison' do
-
-  let(:parser) { NQL::SyntaxParser.new }
-
-  context 'Structure and comparators' do
-
-    it 'Equals' do
-      tree = parser.parse('var = value')
-
-      tree.comparison.variable.text_value.should eq 'var'
-      tree.comparison.comparator.text_value.should eq '='
-      tree.comparison.value.text_value.should eq 'value'
-    end
-
-    it 'Not equals' do
-      tree = parser.parse('var != value')
-
-      tree.comparison.variable.text_value.should eq 'var'
-      tree.comparison.comparator.text_value.should eq '!='
-      tree.comparison.value.text_value.should eq 'value'
-    end
-
-    it 'Greater than' do
-      tree = parser.parse('var > value')
-
-      tree.comparison.variable.text_value.should eq 'var'
-      tree.comparison.comparator.text_value.should eq '>'
-      tree.comparison.value.text_value.should eq 'value'
-    end
-
-    it 'Greater or equals than' do
-      tree = parser.parse('var >= value')
-
-      tree.comparison.variable.text_value.should eq 'var'
-      tree.comparison.comparator.text_value.should eq '>='
-      tree.comparison.value.text_value.should eq 'value'
-    end
-
-    it 'Less than' do
-      tree = parser.parse('var < value')
-
-      tree.comparison.variable.text_value.should eq 'var'
-      tree.comparison.comparator.text_value.should eq '<'
-      tree.comparison.value.text_value.should eq 'value'
-    end
-
-    it 'Less or equals than' do
-      tree = parser.parse('var <= value')
-
-      tree.comparison.variable.text_value.should eq 'var'
-      tree.comparison.comparator.text_value.should eq '<='
-      tree.comparison.value.text_value.should eq 'value'
-    end
-
-    it 'Contains' do
-      tree = parser.parse('var : value')
-
-      tree.comparison.variable.text_value.should eq 'var'
-      tree.comparison.comparator.text_value.should eq ':'
-      tree.comparison.value.text_value.should eq 'value'
-    end
-
-  end
-
-  context 'Space separators' do
-
-    it 'Without spaces' do
-      tree = parser.parse('var=value')
-
-      tree.comparison.variable.text_value.should eq 'var'
-      tree.comparison.comparator.text_value.should eq '='
-      tree.comparison.value.text_value.should eq 'value'
-    end
-
-    it 'With many spaces' do
-      tree = parser.parse('var   =   value')
-
-      tree.comparison.variable.text_value.should eq 'var'
-      tree.comparison.comparator.text_value.should eq '='
-      tree.comparison.value.text_value.should eq 'value'
-    end
-
-  end
-
-  context 'Variable names' do
-
-    it 'With numbers' do
-      tree = parser.parse('var1 = value')
-      tree.comparison.variable.text_value.should eq 'var1'
-    end
-
-    it 'With uppercase' do
-      tree = parser.parse('varName = value')
-      tree.comparison.variable.text_value.should eq 'varName'
-    end
-
-    it 'With underscore' do
-      tree = parser.parse('var_name = value')
-      tree.comparison.variable.text_value.should eq 'var_name'
-    end
-
-    it 'With dot' do
-      tree = parser.parse('var.name = value')
-      tree.comparison.variable.text_value.should eq 'var.name'
-    end
-
-  end
-
-  context 'Values' do
-
-    it 'With numbers' do
-      tree = parser.parse('var = value1')
-      tree.comparison.value.text_value.should eq 'value1'
-    end
-
-    it 'With uppercase' do
-      tree = parser.parse('var = valueDummy')
-      tree.comparison.value.text_value.should eq 'valueDummy'
-    end
-
-    it 'With dot' do
-      tree = parser.parse('var = value.dummy')
-      tree.comparison.value.text_value.should eq 'value.dummy'
-    end
-
-
-    it 'With utf8 chars and symbols' do
-      utf8_symbols = "\u00c1\u00c0\u00c9\u00c8\u00cd\u00cc\u00d3\u00d2\u00da\u00d9\u00dc\u00d1\u00c7\u00e1\u00e0\u00e9\u00e8\u00ed\u00ec\u00f3\u00f2\u00fa\u00f9\u00fc\u00f1\u00e7"
-      tree = parser.parse("var = .#+-#{utf8_symbols}")
-      tree.comparison.value.text_value.should eq ".#+-#{utf8_symbols}"
-    end
-
-    it 'With spaces' do
-      tree = parser.parse('var = value 123')
-      tree.comparison.value.text_value.should eq 'value 123'
-    end
-
-    it 'With comparators, symbols and spaces' do
-      tree = parser.parse('var = value1 > value2 ! value3')
-      tree.comparison.value.text_value.should eq 'value1 > value2 ! value3'
-    end
-
-  end
-
-end
+# encoding: UTF-8
+require 'spec_helper'
+
+describe NQL::SyntaxParser, '-> Comparison' do
+
+  let(:parser) { NQL::SyntaxParser.new }
+
+  context 'Structure and comparators' do
+
+    it 'Equals' do
+      tree = parser.parse('var = value')
+
+      tree.comparison.variable.text_value.should eq 'var'
+      tree.comparison.comparator.text_value.should eq '='
+      tree.comparison.value.text_value.should eq 'value'
+    end
+
+    it 'Not equals' do
+      tree = parser.parse('var != value')
+
+      tree.comparison.variable.text_value.should eq 'var'
+      tree.comparison.comparator.text_value.should eq '!='
+      tree.comparison.value.text_value.should eq 'value'
+    end
+
+    it 'Greater than' do
+      tree = parser.parse('var > value')
+
+      tree.comparison.variable.text_value.should eq 'var'
+      tree.comparison.comparator.text_value.should eq '>'
+      tree.comparison.value.text_value.should eq 'value'
+    end
+
+    it 'Greater or equals than' do
+      tree = parser.parse('var >= value')
+
+      tree.comparison.variable.text_value.should eq 'var'
+      tree.comparison.comparator.text_value.should eq '>='
+      tree.comparison.value.text_value.should eq 'value'
+    end
+
+    it 'Less than' do
+      tree = parser.parse('var < value')
+
+      tree.comparison.variable.text_value.should eq 'var'
+      tree.comparison.comparator.text_value.should eq '<'
+      tree.comparison.value.text_value.should eq 'value'
+    end
+
+    it 'Less or equals than' do
+      tree = parser.parse('var <= value')
+
+      tree.comparison.variable.text_value.should eq 'var'
+      tree.comparison.comparator.text_value.should eq '<='
+      tree.comparison.value.text_value.should eq 'value'
+    end
+
+    it 'Contains' do
+      tree = parser.parse('var : value')
+
+      tree.comparison.variable.text_value.should eq 'var'
+      tree.comparison.comparator.text_value.should eq ':'
+      tree.comparison.value.text_value.should eq 'value'
+    end
+
+    it 'Not contains' do
+      tree = parser.parse('var !: value')
+
+      tree.comparison.variable.text_value.should eq 'var'
+      tree.comparison.comparator.text_value.should eq '!:'
+      tree.comparison.value.text_value.should eq 'value'
+    end
+
+    it 'Matches' do
+      tree = parser.parse('var ~ value')
+
+      tree.comparison.variable.text_value.should eq 'var'
+      tree.comparison.comparator.text_value.should eq '~'
+      tree.comparison.value.text_value.should eq 'value'
+    end
+
+  end
+
+  context 'Space separators' do
+
+    it 'Without spaces' do
+      tree = parser.parse('var=value')
+
+      tree.comparison.variable.text_value.should eq 'var'
+      tree.comparison.comparator.text_value.should eq '='
+      tree.comparison.value.text_value.should eq 'value'
+    end
+
+    it 'With many spaces' do
+      tree = parser.parse('var   =   value')
+
+      tree.comparison.variable.text_value.should eq 'var'
+      tree.comparison.comparator.text_value.should eq '='
+      tree.comparison.value.text_value.should eq 'value'
+    end
+
+  end
+
+  context 'Variable names' do
+
+    it 'With numbers' do
+      tree = parser.parse('var1 = value')
+      tree.comparison.variable.text_value.should eq 'var1'
+    end
+
+    it 'With uppercase' do
+      tree = parser.parse('varName = value')
+      tree.comparison.variable.text_value.should eq 'varName'
+    end
+
+    it 'With underscore' do
+      tree = parser.parse('var_name = value')
+      tree.comparison.variable.text_value.should eq 'var_name'
+    end
+
+    it 'With dot' do
+      tree = parser.parse('var.name = value')
+      tree.comparison.variable.text_value.should eq 'var.name'
+    end
+
+  end
+
+  context 'Values' do
+
+    it 'With numbers' do
+      tree = parser.parse('var = value1')
+      tree.comparison.value.text_value.should eq 'value1'
+    end
+
+    it 'With uppercase' do
+      tree = parser.parse('var = valueDummy')
+      tree.comparison.value.text_value.should eq 'valueDummy'
+    end
+
+    it 'With dot' do
+      tree = parser.parse('var = value.dummy')
+      tree.comparison.value.text_value.should eq 'value.dummy'
+    end
+
+
+    it 'With utf8 chars and symbols' do
+      utf8_symbols = "ÀÁÂÃÄÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜàáâãäçèéêëìíîïñòóôõöùúûü"
+      tree = parser.parse("var = .#+-#{utf8_symbols}")
+      tree.comparison.value.text_value.should eq ".#+-#{utf8_symbols}"
+    end
+
+    it 'With spaces' do
+      tree = parser.parse('var = value 123')
+      tree.comparison.value.text_value.should eq 'value 123'
+    end
+
+    it 'With comparators, symbols and spaces' do
+      tree = parser.parse('var = value1 > value2 ! value3')
+      tree.comparison.value.text_value.should eq 'value1 > value2 ! value3'
+    end
+
+  end
+
+end