filter_lexer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4eb20adfd043c015d21dbc1639c4669945131cef
-  data.tar.gz: a0f2855582ae1094e6ef329b82d04f4b8b03fcec
+  metadata.gz: 47fbb2acdc5535e2e74b0355dbb042e289de54b1
+  data.tar.gz: 4be18e0e750a3b298e4572e175e2b2e43fbeea3e
 SHA512:
-  metadata.gz: ccc25baabaa2ca2af95d5b7653dd996ab674c6822708bef2ff92db4fd26d6c7b25dad79c1c2fd0e71cd472763c05abbf78c2af6b5f7c8693b0837e325c7c9d65
-  data.tar.gz: 71f924d03e1af187be0e270c0ceab349f092cb02cb8ff0fcdcfe3ba09864f82c693595ddd4b01c82fb821e5a7a1e2ec6755558a31a0699eeff14f065b12330a8
+  metadata.gz: 9e83318063753adab91aeddb75fbe34f3405a35f47b82dd01eed69a9276b5b97e9110a830da5f981a1a8d633159da158ce38a636562ce82d0da591a48c8e4503
+  data.tar.gz: a7ff4f435b9ab633daf95f8b31c1a98b5c001b8b86cd82dfcfaf69749b4e2b61bcbbfffb4f8ff020af0f2cee9d081297d12060c9b2a6008b2628a3599829c513

data/.codeclimate.yml

@@ -0,0 +1,11 @@
+---
+engines:
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/**/*

data/.inch.yml

@@ -0,0 +1,6 @@
+files:
+   included:
+      - lib/**/.rb
+   excluded:
+      - lib/filter_lexer/formatters/**/*.rb
+

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/LineLength:
+  Max: 120
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: 'case'
+  IndentOneStep: true
+
+Style/IndentHash:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FirstParameterIndentation:
+  Enabled: false
+
+Style/IndentationWidth:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: 'indented'
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma

data/README.md

@@ -1,4 +1,4 @@
-# FilterLexer
+# FilterLexer [![Dependency Status](https://gemnasium.com/MaienM/FilterLexer.svg)](https://gemnasium.com/MaienM/FilterLexer) [![Code Climate](https://codeclimate.com/github/MaienM/FilterLexer/badges/gpa.svg)](https://codeclimate.com/github/MaienM/FilterLexer) [![Inline docs](http://inch-ci.org/github/MaienM/FilterLexer.svg?branch=master)](http://inch-ci.org/github/MaienM/FilterLexer)
 
 This is a simple treetop implementation for a basic SQL-like filtering syntax.
 

data/Rakefile

@@ -1 +1,44 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop, [:options]) do |task|
+	task.options.push '--cache=false'
+end
+module RuboCop
+	# We use tabs for indentation, not spaces. As many of the RuboCop cops seem
+	# to depend on two spaces being used for indentation, we pretend this is
+	# what we do. To allow us to still check indentation for correctness, we
+	# also change two spaces into tabs, so RuboCop can detect it as invalid
+	# indentation.
+	class File < ::File
+		SPACES = '  '
+		TABS = "\t"
+		PLACEHOLDER = "\0"
+
+		def self.read(*args)
+			source = super(*args)
+			source = swap_indents(source)
+			return source
+		end
+
+		def write(source, *args)
+			source = self.class.swap_indents(source)
+			return super(source, *args)
+		end
+
+		class << self
+			def swap_indents(source)
+				source = change_to(source, SPACES, PLACEHOLDER)
+				source = change_to(source, TABS, SPACES)
+				source = change_to(source, PLACEHOLDER, TABS)
+				return source
+			end
+
+			private
+
+			def change_to(source, from, to)
+				return source.gsub(/^((#{from})+)/) { |m| to * (m.size / from.size).to_i }
+			end
+		end
+	end
+end

data/filter_lexer.gemspec

@@ -9,15 +9,15 @@ Gem::Specification.new do |spec|
 	spec.authors       = ['Michon van Dooren']
 	spec.email         = ['michon1992@gmail.com']
 
-	spec.summary       = %q{A basic lexer that supports basic sql-like filtering logic.}
-	spec.description   = %q{Simple treetop lexer that supports writing filters in an SQL-like manner.}
+	spec.summary       = 'A basic lexer that supports basic sql-like filtering logic.'
+	spec.description   = 'Simple treetop lexer that supports writing filters in an SQL-like manner.'
 	spec.homepage      = 'http://github.com/MaienM/FilterLexer'
 	spec.license       = 'MIT'
 
 	if spec.respond_to?(:metadata)
 		spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 	else
-		raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+		fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
 	end
 
 	spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -28,5 +28,7 @@ Gem::Specification.new do |spec|
 	spec.add_development_dependency 'bundler', '~> 1.10'
 	spec.add_development_dependency 'rake', '~> 10.0'
 	spec.add_development_dependency 'rspec'
+	spec.add_development_dependency 'rubocop'
+	spec.add_development_dependency 'pry'
 	spec.add_dependency 'treetop', '~> 1.6'
 end

data/lib/filter_lexer.rb

@@ -1,24 +1,30 @@
 require 'treetop'
 
-require "filter_lexer/version"
-require "filter_lexer/exceptions"
-require "filter_lexer/nodes"
+require 'filter_lexer/version'
+require 'filter_lexer/exceptions'
+require 'filter_lexer/nodes'
 require 'filter_lexer/syntax.treetop'
 
 module FilterLexer
+	# The parser is your main entrypoint for the lexer
+	#
+	# You never instantiate it, you just use it's static methods
 	class Parser
-		@@parser = FilterLexerParser.new
+		@parser = FilterLexerParser.new
 
 		class << self
+			# The bread and butter of the entire thing: parsing, and it's pretty simple
+			#
+			# Just pass in a string, and out comes a parsed tree, or an exception
+			#
+			# The parsed tree will always be an FilterLexer::Expression object
+			# The exception will always be an FilterLexer::ParseException object
 			def parse(data)
 				# Pass the data over to the parser instance
-				tree = @@parser.parse(data)
+				tree = @parser.parse(data)
 
 				# If the AST is nil then there was an error during parsing
-				# we need to report a simple error message to help the user
-				if tree.nil?
-					raise ParseException, @@parser
-				end
+				fail ParseException, @parser if tree.nil?
 
 				# Cleanup the tree
 				clean_tree(tree)
@@ -26,6 +32,10 @@ module FilterLexer
 				return tree
 			end
 
+			# When using the lexer, it may be useful to have a visual representation of the tree
+			#
+			# Just pass the tree (or any node in it, if you're only interested in that part) to this function, and a visual
+			# representation of the tree will magically appear in stdout
 			def output_tree(element, indent = '')
 				puts "#{indent}#{element.class}: #{element.text_value}"
 				(element.elements || []).each do |e|
@@ -35,7 +45,7 @@ module FilterLexer
 
 			private
 
-			def is_syn(node)
+			def syn?(node)
 				return node.class.name == 'Treetop::Runtime::SyntaxNode'
 			end
 
@@ -48,9 +58,9 @@ module FilterLexer
 				# Clean child elements
 				root_node.elements.each { |node| clean_tree(node) }
 				# Remove empty syntax elements
-				root_node.elements.reject! { |node| node_elem(node).empty? && is_syn(node) }
+				root_node.elements.reject! { |node| node_elem(node).empty? && syn?(node) }
 				# Replace syntax elements with just one child with that child
-				root_node.elements.map! { |node| (node_elem(node).size == 1 && is_syn(node)) ? node.elements.first : node }
+				root_node.elements.map! { |node| (node_elem(node).size == 1 && syn?(node)) ? node.elements.first : node }
 			end
 		end
 	end

data/lib/filter_lexer/exceptions.rb

@@ -10,19 +10,18 @@ module FilterLexer
 		end
 
 		def context
-			i1 = @index - 40
-			i1 = 0 if i1 < 0
-			i2 = @index + 40
-			i2 = @input.size if i2 > @input.size
+			size = @input.size
+			i1 = [0, @index - 40].max
+			i2 = [size, @index + 40].min
 
 			context = @input.slice(i1..i2)
-			if i1 > 0
-				context = "...#{context}"
-				i1 -= 3
-			end
-			context = "#{context}..." if i2 < @input.size 
+			context = "...#{context}" if i1 > 0
+			context = "#{context}..." if i2 < size
 
-			return context + "\r\n" + ' ' * (@index - i1) + '^'
+			relpos = @index - i1
+			relpos += 1 if i1 > 0
+
+			return context + "\r\n" + ' ' * relpos + '^'
 		end
 	end
 end

data/lib/filter_lexer/formatters/sql.rb

@@ -5,40 +5,46 @@ module FilterLexer
 		end
 
 		def query_string
-			return self.elements.map { |e| e.query_string }.join(' ')
+			return elements.map(&:query_string).join(' ')
 		end
 
 		def query_variables
-			return self.elements.map { |e| e.query_variables }.flatten
+			return elements.map(&:query_variables).flatten
 		end
 	end
 
 	class Group
 		def query_string
-			return "(#{self.elements.first.query_string})"
+			return "(#{elements.first.query_string})"
 		end
 
 		def query_variables
-			return self.elements.first.query_variables
+			return elements.first.query_variables
 		end
 	end
 
 	class Filter
 		def query_string
-			return "#{elements[0].sql} #{elements[1].sql} ?"
+			return "#{identifier.sql} #{operator.sql} ?"
 		end
 
-		def query_variables 
-			return [elements[2].sql]
+		def query_variables
+			return [data.sql]
 		end
 	end
 
-	class Operator
+	class Identifier
+		def sql
+			return "`#{text_value}`"
+		end
+	end
+
+	class LogicOperator
 		def query_string
-			return self.sql
+			return sql
 		end
 
-		def query_variables 
+		def query_variables
 			return []
 		end
 	end
@@ -55,16 +61,26 @@ module FilterLexer
 		end
 	end
 
+	class Operator
+		def query_string
+			return sql
+		end
+
+		def query_variables
+			return []
+		end
+	end
+
 	class EQOperator
 		def sql
-			return 'IS' if parent.value_class < ValueSpecial
+			return 'IS' if parent.data.is_a?(ValueSpecial)
 			return '='
 		end
 	end
 
 	class NEQOperator
 		def sql
-			return 'IS NOT' if parent.value_class < ValueSpecial
+			return 'IS NOT' if parent.data.is_a?(ValueSpecial)
 			return '<>'
 		end
 	end
@@ -125,19 +141,13 @@ module FilterLexer
 
 	class StringLiteral
 		def sql
-			return self.text_value
+			return text_value
 		end
 	end
 
 	class NumberLiteral
 		def sql
-			return self.text_value
-		end
-	end
-
-	class Identifier
-		def sql
-			return self.text_value
+			return text_value
 		end
 	end
 end

data/lib/filter_lexer/nodes.rb

@@ -1,37 +1,52 @@
 module FilterLexer
+	# The root element, expression is a collection of other expressions and and/or operators
 	class Expression < Treetop::Runtime::SyntaxNode
 	end
 
+	# A group is simply an expression in parenthesis
 	class Group < Treetop::Runtime::SyntaxNode
 	end
 
+	# A filter is the core object of the lexer: an indentifier, an operator and a data
 	class Filter < Treetop::Runtime::SyntaxNode
+		# The identifier element
+		#
+		# Of type FilterLexer::Identifier
 		def identifier
-			return elements[0].sql
+			return elements[0]
 		end
 
+		# The operator element
+		#
+		# Subclass of FilterLexer::Operator
 		def operator
-			return elements[1].sql
+			return elements[1]
 		end
 
-		def value
-			return elements[2].sql
+		# The value element
+		#
+		# Subclass of FilterLexer::Value
+		def data
+			return elements[2]
 		end
+	end
 
-		def value_class
-			return elements[2].class
-		end
+	# An logic operator is the glue between filters
+	class LogicOperator < Treetop::Runtime::SyntaxNode
 	end
 
-	# Operators
+	class OrOperator < LogicOperator
+	end
 
-	class Operator < Treetop::Runtime::SyntaxNode
+	class AndOperator < LogicOperator
 	end
 
-	class OrOperator < Operator
+	# An identifier is the target (variable) of the filter
+	class Identifier < Treetop::Runtime::SyntaxNode
 	end
 
-	class AndOperator < Operator
+	# An operator is the type (function) of the filter
+	class Operator < Treetop::Runtime::SyntaxNode
 	end
 
 	class EQOperator < Operator
@@ -58,8 +73,7 @@ module FilterLexer
 	class LikeOperator < Operator
 	end
 
-	# Values
-
+	# A value is the data of the filter
 	class Value < Treetop::Runtime::SyntaxNode
 	end
 
@@ -83,10 +97,4 @@ module FilterLexer
 
 	class NumberLiteral < ValueScalar
 	end
-
-	# Identifier
-
-	class Identifier < Treetop::Runtime::SyntaxNode
-	end
 end
-

data/lib/filter_lexer/version.rb

@@ -1,3 +1,3 @@
 module FilterLexer
-	VERSION = "0.1.0"
+	VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filter_lexer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michon van Dooren
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: treetop
   requirement: !ruby/object:Gem::Requirement
@@ -73,7 +101,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
+- ".inch.yml"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE