parse_my_sql 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem "treetop"
+
+group :development, :test do
+  gem "rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    polyglot (0.3.1)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  treetop

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Leonardo Bessa
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,22 @@
+= parse_my_sql
+
+Transforms sql query strings in a parse tree.
+
+== Credits
+
+This source code and grammar are based on sql_parser project from privotalrb. 
+More info at http://pivotalrb.rubyforge.org/svn/sql_parser and http://pivotalrb.rubyforge.org/ .
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Leonardo Bessa. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "parse_my_sql"
+    gem.summary = %Q{SQL parser}
+    gem.description = %Q{Transforms sql query strings in a parse tree}
+    gem.email = "leobessa@gmail.com"
+    gem.homepage = "http://github.com/leobessa/parse_my_sql"
+    gem.authors = ["Leonardo Bessa"]
+    gem.add_development_dependency "rspec", ">= 2.0.1"
+    gem.add_runtime_dependency "treetop", ">= 1.4.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+  t.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "parse_my_sql #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/parse_my_sql.rb

@@ -0,0 +1,2 @@
+require "treetop"
+require "sql_parser"

data/lib/sql_parser.rb

@@ -0,0 +1,17 @@
+Treetop.load File.join(File.dirname(__FILE__), 'sql_parser.treetop')
+
+class SqlParser::ItemsNode < Treetop::Runtime::SyntaxNode
+  def values
+    items.values.unshift(item.value)
+  end
+end
+
+class SqlParser::ItemNode < Treetop::Runtime::SyntaxNode
+  def values
+    [value]
+  end
+  
+  def value
+    text_value.to_sym
+  end
+end

data/lib/sql_parser.treetop

@@ -0,0 +1,183 @@
+grammar Sql
+  rule statement
+    select from where {
+      def tree
+        {
+          :operator => operator,
+          :set_quantifier => set_quantifier,
+          :fields => fields,
+          :tables => tables,
+          :conditions => conditions
+        }
+      end
+
+      def operator
+        :select
+      end
+
+      def set_quantifier
+        select.set_quantifier
+      end
+
+      def fields
+        select.fields
+      end
+
+      def tables
+        from.tables
+      end
+
+      def conditions
+        where.conditions
+      end
+    }
+  end
+
+  rule select
+    "select" quantifier:set_quantifier items {
+      def fields
+        items.values
+      end
+
+      def set_quantifier
+        quantifier.value
+      end
+    }
+  end
+
+  rule set_quantifier
+    (
+      required_space 'distinct' required_space
+      /
+      required_space 'all' required_space
+    ) {
+      def value
+        text_value.strip.downcase.to_sym
+      end
+    }
+    /
+    required_space {
+      def value
+        nil
+      end
+    }
+  end
+
+  rule from
+    required_space "from" required_space items {
+      def tables
+        items.values
+      end
+    }
+    /
+    space {
+      def tables
+        []
+      end
+    }
+  end
+
+  rule where
+    required_space "where" required_space conditional_items {
+      def conditions
+        conditional_items.node
+      end
+    }
+    /
+    space {
+      def conditions
+        []
+      end
+    }
+  end
+
+  rule conditional_items
+    conditional_item required_space boolean_join required_space conditional_items {
+      def node
+        all_nodes = []
+        all_nodes.concat(conditional_item.node)
+        all_nodes << {:operator => boolean_join.operator}
+        all_nodes.concat(conditional_items.node)
+        all_nodes
+      end
+    }
+    /
+    conditional_item
+  end
+
+  rule boolean_join
+    ('and' / 'or') {
+      def operator
+        text_value.to_sym
+      end
+    }
+  end
+
+  rule conditional_item
+    assignment_field space conditional_operator space assignment_value {
+      def node
+        [{
+          :operator => conditional_operator.value,
+          :field => assignment_field.text_value.to_sym,
+          :value => assignment_value.value
+        }]
+      end
+    }
+  end
+
+  rule conditional_operator
+    ('<>' / '>=' / '<=' / '=' / '>' / '<') {
+      def value
+        text_value.to_sym
+      end
+    }
+  end
+
+  rule assignment_field
+    !keyword [a-zA-Z_] [a-zA-Z0-9_]*
+  end
+
+  rule assignment_value
+    string_assignment_value
+    /
+    numeric_assignment_value
+  end
+
+  rule string_assignment_value
+    "'" [^']* "'" {
+      def value
+        text_value[1..-2]
+      end
+    }
+  end
+
+  rule numeric_assignment_value
+    !keyword [0-9]+ {
+      def value
+        Integer(text_value)
+      end
+    }
+  end
+
+  rule items
+    item space [,]+ space items <SqlParser::ItemsNode>
+    /
+    item
+  end
+
+  rule item
+    !keyword [a-z_0-9*]+ <SqlParser::ItemNode>
+  end
+
+  rule keyword
+    'select' / 'from'
+  end
+
+  rule required_space
+    ' '+
+  end
+
+  rule space
+    ' '*
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'parse_my_sql'

data/spec/sql_parser_spec.rb

@@ -0,0 +1,206 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe SqlParser do 
+
+  context "when conditions are not joined with an :and or :or," do
+    it "does not succeed" do
+      subject.parse("select first_name from users where first_name='joe' last_name='bob'").should be_nil
+    end
+  end
+
+  context "#tree when parsing select statement" do
+    it "parses a multi field, table, and where clause statement" do
+      subject.parse("select distinct *, first_name, last_name, middle_name from users, accounts, logins where first_name='joe' and last_name='bob' or age > 25").tree.should == {
+        :operator => :select,
+        :set_quantifier => :distinct,
+        :fields => [:'*', :first_name, :last_name, :middle_name],
+        :tables => [:users, :accounts, :logins],
+        :conditions => [
+          {:operator => :'=', :field => :first_name, :value => 'joe'},
+          {:operator => :and},
+          {:operator => :'=', :field => :last_name, :value => 'bob'},
+          {:operator => :or},
+          {:operator => :'>', :field => :age, :value => 25}
+        ]
+      }
+    end
+  end
+
+  context "#operator when parsing select statement" do
+    it "returns :select" do
+      subject.parse("select first_name").operator.should == :select
+    end
+  end
+
+  context "#set_quantifier when parsing select statement" do
+
+    it "when parsing distinct, returns :distinct" do
+      subject.parse("select distinct first_name").set_quantifier.should == :distinct
+    end
+
+    it "when parsing all, returns :all" do
+      subject.parse("select all first_name").set_quantifier.should == :all
+    end
+
+  end
+
+  context "#fields when parsing select statement" do
+
+    it "returns the fields in the statement" do
+      subject.parse("select first_name").fields.should == [:first_name]
+      subject.parse("select first_name, last_name, middle_name").fields.should == [
+        :first_name, :last_name, :middle_name
+      ]
+    end
+
+    it "when receiving *, returns * in the fields list" do
+      subject.parse("select *").fields.should == [:'*']
+    end
+  end
+
+  context "#tables when parsing select statement" do
+
+    it "returns tables from the statement" do
+      subject.parse("select first_name from users").tables.should == [:users]
+      subject.parse("select first_name from users, accounts, logins").tables.should == [
+        :users, :accounts, :logins
+      ]
+    end
+  end
+
+  context "#conditions when parsing select statement" do
+
+    it "when no where conditions, returns empty hash" do
+      subject.parse("select first_name from users").conditions.should == []
+    end
+
+    it "returns equality conditions from the statement" do
+      subject.parse("select first_name from users where id=3").conditions.should == [
+        { :operator => :'=', :field => :id, :value => 3 }
+      ]
+      subject.parse("select first_name from users where first_name='joe'").conditions.should == [
+        { :operator => :'=', :field => :first_name, :value => 'joe' }
+      ]
+      subject.parse("select first_name from users where first_name='joe' and last_name='bob'").conditions.should == [
+        {:operator => :'=', :field => :first_name, :value => 'joe'},
+        {:operator => :and},
+        {:operator => :'=', :field => :last_name, :value => 'bob'}
+      ]
+    end
+
+    it "returns greater than conditions from the statement" do
+      subject.parse("select first_name from users where id>3").conditions.should == [
+        { :operator => :'>', :field => :id, :value => 3 }
+      ]
+
+      subject.parse("select first_name from users where id>3 and age>25").conditions.should == [
+        {:operator => :'>', :field => :id, :value => 3},
+        {:operator => :and},
+        {:operator => :'>', :field => :age, :value => 25}
+      ]
+    end
+
+    it "returns less than conditions from the statement" do
+      subject.parse("select first_name from users where id<3").conditions.should == [
+        { :operator => :'<', :field => :id, :value => 3 }
+      ]
+
+      subject.parse("select first_name from users where id<3 and age<25").conditions.should == [
+        {:operator => :'<', :field => :id, :value => 3},
+        {:operator => :and},
+        {:operator => :'<', :field => :age, :value => 25}
+      ]
+    end
+
+    it "returns greater than or equal to conditions from the statement" do
+      subject.parse("select first_name from users where id>=3").conditions.should == [
+        { :operator => :'>=', :field => :id, :value => 3 }
+      ]
+
+      subject.parse("select first_name from users where id>=3 and age>=25").conditions.should == [
+        {:operator => :'>=', :field => :id, :value => 3},
+        {:operator => :and},
+        {:operator => :'>=', :field => :age, :value => 25}
+      ]
+    end
+
+    it "returns less than or equal to conditions from the statement" do
+      subject.parse("select first_name from users where id<=3").conditions.should == [
+        { :operator => :'<=', :field => :id, :value => 3 }
+      ]
+
+      subject.parse("select first_name from users where id<=3 and age<=25").conditions.should == [
+        {:operator => :'<=', :field => :id, :value => 3},
+        {:operator => :and},
+        {:operator => :'<=', :field => :age, :value => 25}
+      ]
+    end
+
+    it "returns not equal to conditions from the statement" do
+      subject.parse("select first_name from users where id<>3").conditions.should == [
+        { :operator => :'<>', :field => :id, :value => 3 }
+      ]
+
+      subject.parse("select first_name from users where id<>3 and age<>25").conditions.should == [
+        {:operator => :'<>', :field => :id, :value => 3},
+        {:operator => :and},
+        {:operator => :'<>', :field => :age, :value => 25}
+      ]
+    end
+  end
+
+  context "#conditions when parsing select statement with :and operators" do
+
+    it "returns single level :and operation" do
+      subject.parse("select first_name from users where first_name='joe' and last_name='bob'").conditions.should == [
+        {:operator => :'=', :field => :first_name, :value => 'joe'},
+        {:operator => :and},
+        {:operator => :'=', :field => :last_name, :value => 'bob'}
+      ]
+    end
+
+    it "returns nested :and operations from the statement" do
+      subject.parse("select first_name from users where first_name='joe' and last_name='bob' and middle_name='pat'").conditions.should == [
+        {:operator => :'=', :field => :first_name, :value => 'joe'},
+        {:operator => :and},
+        {:operator => :'=', :field => :last_name, :value => 'bob'},
+        {:operator => :and},
+        {:operator => :'=', :field => :middle_name, :value => 'pat'}
+      ]
+    end
+  end
+
+  context "#conditions when parsing select statement with :or operators" do
+
+    it "returns single level :and operation" do
+      subject.parse("select first_name from users where first_name='joe' or last_name='bob'").conditions.should == [
+        {:operator => :'=', :field => :first_name, :value => 'joe'},
+        {:operator => :or},
+        {:operator => :'=', :field => :last_name, :value => 'bob'}
+      ]
+    end
+
+    it "returns nested :or operations from the statement" do
+      subject.parse("select first_name from users where first_name='joe' or last_name='bob' or middle_name='pat'").conditions.should == [
+        {:operator => :'=', :field => :first_name, :value => 'joe'},
+        {:operator => :or},
+        {:operator => :'=', :field => :last_name, :value => 'bob'},
+        {:operator => :or},
+        {:operator => :'=', :field => :middle_name, :value => 'pat'}
+      ]
+    end
+  end
+
+  context "#conditions when parsing select statement with :and and :or operators" do
+    it "returns :and having precedence over :or" do
+      subject.parse("select first_name from users where age > 25 and first_name='joe' or last_name='bob'").conditions.should == [
+        {:operator => :'>', :field => :age, :value => 25},
+        {:operator => :and},
+        {:operator => :'=', :field => :first_name, :value => 'joe'},
+        {:operator => :or},
+        {:operator => :'=', :field => :last_name, :value => 'bob'}
+      ]
+    end
+  end
+
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: parse_my_sql
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Leonardo Bessa
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-21 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: treetop
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 4
+        - 8
+        version: 1.4.8
+  type: :runtime
+  version_requirements: *id002
+description: Transforms sql query strings in a parse tree
+email: leobessa@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/parse_my_sql.rb
+- lib/sql_parser.rb
+- lib/sql_parser.treetop
+- spec/spec_helper.rb
+- spec/sql_parser_spec.rb
+has_rdoc: true
+homepage: http://github.com/leobessa/parse_my_sql
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: SQL parser
+test_files: 
+- spec/spec_helper.rb
+- spec/sql_parser_spec.rb