simplest_sql_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dee7f0482eb748f492eece192b3f3cc2d36b4a1122887482c3358c49c6ff0846
+  data.tar.gz: 393453ac8a26300b12fefdb307dc98f56825b6e5c605576c34ba933f60cc268b
+SHA512:
+  metadata.gz: 8d913cdd3c0cc486d02465818d570bf8859fb3d8d9dc9d0f0d14929c665d68ed530629c953c2ad9cff7190711a03e075a79e49b8479f2c1d46fbe448179dedc8
+  data.tar.gz: 9c05af53d6558d1eb3efe8cb9d60c17f9d776d43e2e46f53415d3b05c5250a810a5e74eb3e71f4669177f2cbb8d94cec2a6c0a5fa12c77d0a188332abc338302

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-06-21
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at heyjudejudejude1968@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simplest_sql_parser.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "rexical", "~> 1.0"
+
+gem "racc", "~> 1.7"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 kudojp
+
+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/Makefile

@@ -0,0 +1,12 @@
+.PHONY: spec
+spec: rex racc
+
+.PHONY: rex
+rex:
+	bundle exec rex lib/simplest_sql_parser/lexical_scanner.rex
+	bundle exec rspec spec/lexical_scanner_spec.rb
+
+.PHONY: racc
+racc:
+	bundle exec racc lib/simplest_sql_parser/parser.racc &&\
+	bundle exec rspec spec/parser_spec.rb

data/README.md

@@ -0,0 +1,60 @@
+# SimplestSqlParser
+
+SimplestSqlParser is a toy SQL parser written in Ruby.
+Currently it can parse queries composed only of `SELECT`, `FROM`, and `WHERE` clauses.
+
+- `SELECT name, address, age FROM table WHERE id = 12` (SELECT multiple columns)
+- `SELECT * FROM table WHERE id = 12` (SELECT all columns)
+- `SELECT COUNT(*) FROM table  WHERE id = 12` (COUNT function)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simplest_sql_parser'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install simplest_sql_parser
+```
+
+## Usage
+
+```rb
+ast = SimplestSqlParser.parse("Select name FROM table")
+# And do something creative with ast!
+```
+
+## Development
+
+To update the lex scanner `SimplestSQLParser::LexicalScanner`,
+1. Update `lib/simplest_sql_parser/lexical_scanner.rex`
+2. Run $`bundle exec rex lib/simplest_sql_parser/lexical_scanner.rex`
+3. Test your implementation with `bundle exec rspec spec/lexical_scanner_spec.rb`
+
+
+To update the parser `SimplestSQLParser::Parser`,
+1. Update `lib/simplest_sql_parser/parser.racc`
+2. Run $`bundle exec racc lib/simplest_sql_parser/parser.rex`
+3. Test your implementation with `bundle exec rspec spec/parser_spec.rb`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kudojp/simplest_sql_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/simplest_sql_parser/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SimplestSqlParser project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/simplest_sql_parser/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/simplest_sql_parser/ast/column_node.rb

@@ -0,0 +1,21 @@
+require_relative "node"
+
+module AST
+  class ColumnNode < Node
+    class UnsupportedTypeError < StandardError; end
+
+    TYPES = [:single_col, :asterisk].freeze
+    attr_reader :type, :name
+
+    def initialize(name:, type: :single_col)
+      raise UnsupportedTypeError unless TYPES.include? type
+
+      @type = type # single_col
+      @name = name # nil when type == :asterisk
+    end
+
+    def list_attributes_without_child
+      [:type, :name]
+    end
+  end
+end

data/lib/simplest_sql_parser/ast/condition_node.rb

@@ -0,0 +1,27 @@
+require_relative "node"
+
+module AST
+  class ConditionNode < Node
+    class UnsupportedOperatorError < StandardError; end
+
+    OPERATORS = [:equals, :larger_than].freeze # TODO: add more operators
+
+    attr_reader :operator, :left, :right
+
+    def initialize(operator:, left:, right:)
+      raise UnsupportedOperatorError unless OPERATORS.include? operator
+
+      @operator = operator
+      @left = left
+      @right = right
+    end
+
+    def list_attributes_without_child
+      [:operator]
+    end
+
+    def list_attributes_of_single_child_node
+      [:left, :right]
+    end
+  end
+end

data/lib/simplest_sql_parser/ast/expression_node.rb

@@ -0,0 +1,15 @@
+require_relative "node"
+
+module AST
+  class ExpressionNode < Node
+    attr_reader :value
+
+    def initialize(value:)
+      @value = value
+    end
+
+    def list_attributes_without_child
+      [:value]
+    end
+  end
+end

data/lib/simplest_sql_parser/ast/from_clause_node.rb

@@ -0,0 +1,15 @@
+require_relative "node"
+
+module AST
+  class FromClauseNode < Node
+    attr_reader :table
+
+    def initialize(table:)
+      @table = table
+    end
+
+    def list_attributes_of_single_child_node
+      [:table]
+    end
+  end
+end

data/lib/simplest_sql_parser/ast/function_node.rb

@@ -0,0 +1,25 @@
+require_relative "node"
+
+module AST
+  class FunctionNode < Node
+    class UnsupportedTypeError; end
+
+    TYPES = [:count] # TODO: add other types (:max, etc)
+    attr_reader :type, :args
+
+    def initialize(type:, args: [])
+      raise UnsupportedTypeError unless TYPES.include? type
+
+      @type = type
+      @args = args
+    end
+
+    def list_attributes_without_child
+      [:type]
+    end
+
+    def list_attributes_of_multiple_child_nodes
+      [:args]
+    end
+  end
+end

data/lib/simplest_sql_parser/ast/node.rb

@@ -0,0 +1,80 @@
+module AST
+  class Node # used as an abstract class
+    # This should be overwritten in each node if necessary.
+    def list_attributes_without_child
+      []
+      # ["attr1", "attr2"]
+    end
+
+    # This should be overwritten in each node if necessary.
+    def list_attributes_of_single_child_node
+      []
+      # [:attr3, attr4]
+    end
+
+    # This should be overwritten in each node if necessary.
+    def list_attributes_of_multiple_child_nodes
+      []
+      # [:attr5, attr6]
+    end
+
+    # used for debugging.
+    def self_and_descendants
+      attributes = list_attributes_without_child.map { |attr_sym| "#{attr_sym}=#{send(attr_sym)}" }.join ","
+
+      descendants = {}
+
+      list_attributes_of_single_child_node.each do |attr_sym|
+        descendants[attr_sym.to_s] = send(attr_sym)&.self_and_descendants
+      end
+
+      list_attributes_of_multiple_child_nodes.each do |attr_sym|
+        descendants[attr_sym.to_s] = send(attr_sym)&.map { |attribute| attribute.self_and_descendants }
+      end
+
+      { "#{self.class}(#{attributes})" => descendants }
+    end
+  end
+end
+
+=begin
+QueryNode.new
+  @select: SelectClauseNode.new
+    @columns: Array.new
+      - SelectedColumnNode.new   # name
+          @alias_name: String.new
+          @col_def: ColumnNode.new
+            @type: :single_col
+            @name: "name"
+      - SelectedColumnNode.new   # *
+          @alias_name: String.new
+          @col_def: ColumnNode.new
+            @type: :asterisk
+            @name: nil
+      - SelectedColumnNode.new   # COUNT(name)
+          @alias_name: String.new
+          @col_def: FunctionNode.new
+            @type: :count
+            @args: Array.new
+              - ColumnNode.new
+                @type: :single_col
+                @name: "name"
+  @from: FromClauseNode.new
+    @table: TableNode.new
+      @table_def: ExpressionNode.new
+      @alias_name: String.new
+ @where: WhereClauseNode.new
+    @predicate: Array.new
+      - ConditionNode.new
+          @operator: :equals
+          @left: ExpressionNode.new
+          @right: ExpressionNode.new
+      - EqualsConditionNode.new
+          @operator: :larger_than
+          @left: ExpressionNode.new
+          @right: ExpressionNode.new
+
+Maybe,,
+- I should create separate classes for each ExpressionNode depending on where it is used??
+- I should create a parent class `ClauseNode` for SelectClauseNode, FromClauseNode, and WhereClauseNode.
+=end

data/lib/simplest_sql_parser/ast/query_node.rb

@@ -0,0 +1,17 @@
+require_relative "node"
+
+module AST
+  class QueryNode < Node
+    attr_reader :select_clause, :from_clause, :where_clause
+
+    def initialize(select_clause: nil, from_clause: nil, where_clause: nil)
+      @select_clause = select_clause
+      @from_clause = from_clause
+      @where_clause = where_clause
+    end
+
+    def list_attributes_of_single_child_node
+      [:select_clause, :from_clause, :where_clause]
+    end
+  end
+end

data/lib/simplest_sql_parser/ast/select_clause_node.rb

@@ -0,0 +1,15 @@
+require_relative "node"
+
+module AST
+  class SelectClauseNode < Node
+    attr_reader :selected_columns
+
+    def initialize(selected_columns:)
+      @selected_columns = selected_columns # array of ColumnNode instances
+    end
+
+    def list_attributes_of_multiple_child_nodes
+      [:selected_columns]
+    end
+  end
+end

data/lib/simplest_sql_parser/ast/selected_column_node.rb

@@ -0,0 +1,20 @@
+require_relative "node"
+
+module AST
+  class SelectedColumnNode < Node
+    attr_reader :alias_name, :col_def
+
+    def initialize(col_def:, alias_name: nil)
+      @col_def = col_def
+      @alias_name = alias_name
+    end
+
+    def list_attributes_without_child
+      [:alias_name]
+    end
+
+    def list_attributes_of_single_child_node
+      [:col_def]
+    end
+  end
+end

data/lib/simplest_sql_parser/ast/table_node.rb

@@ -0,0 +1,20 @@
+require_relative "node"
+
+module AST
+  class TableNode < Node
+    attr_reader :table_def, :alias_name
+
+    def initialize(table_def:, alias_name: nil)
+      @table_def = table_def # For now, this is ExpressionNode
+      @alias_name = alias_name
+    end
+
+    def list_attributes_without_child
+      [:alias_name]
+    end
+
+    def list_attributes_of_single_child_node
+      [:table_def]
+    end
+  end
+end

data/lib/simplest_sql_parser/ast/where_clause_node.rb

@@ -0,0 +1,15 @@
+require_relative "node"
+
+module AST
+  class WhereClauseNode < Node
+    attr_reader :predicate
+
+    def initialize(predicate:)
+      @predicate = predicate # array of ConditionNode instances
+    end
+
+    def list_attributes_of_multiple_child_nodes
+      [:predicate]
+    end
+  end
+end

data/lib/simplest_sql_parser/lexical_scanner.rex

@@ -0,0 +1,37 @@
+# ref. https://github.com/tenderlove/rexical/blob/master/DOCUMENTATION.ja.rdoc
+
+class SimplestSqlParser::LexicalScanner
+option
+  ignorecase
+macro
+  BLANK \s+
+  WORD [a-zA-Z]\w*
+  NUMBER \d+(\.\d+)?
+
+rule
+  # Each line should be formatted as:
+  # `start_state pattern { action }
+  #
+  # - In action should return [:TOKEN_SYMBOL, value] (ref. https://docs.ruby-lang.org/en/3.2/Racc/Parser.html#method-i-next_token)
+
+  {BLANK}   # do nothing
+
+  # keywords
+  ## keyword of statements
+  SELECT { [:SELECT, text] }
+  FROM { [:FROM, text] }
+  WHERE { [:WHERE, text] }
+
+  ## keyword of functions
+  COUNT { [:COUNT, text] }
+
+  # tokens
+  ,   { [:COMMA, text] }
+  \*   { [:ASTERISK, text] }
+  =   {[:EQUALS, text]}
+  \(   {[:PARENTHESIS_LEFT, text]}
+  \)   {[:PARENTHESIS_RIGHT, text]}
+
+  # identifiers
+  {WORD} { [:IDENTIFIER, text] }
+  {NUMBER} {[:IDENTIFIER, text.to_f]}

data/lib/simplest_sql_parser/lexical_scanner.rex.rb

@@ -0,0 +1,110 @@
+#--
+# DO NOT MODIFY!!!!
+# This file is automatically generated by rex 1.0.7
+# from lexical definition file "lib/simplest_sql_parser/lexical_scanner.rex".
+#++
+
+require 'racc/parser'
+# ref. https://github.com/tenderlove/rexical/blob/master/DOCUMENTATION.ja.rdoc
+
+class SimplestSqlParser::LexicalScanner < Racc::Parser
+      require 'strscan'
+
+      class ScanError < StandardError ; end
+
+      attr_reader   :lineno
+      attr_reader   :filename
+      attr_accessor :state
+
+      def scan_setup(str)
+        @ss = StringScanner.new(str)
+        @lineno =  1
+        @state  = nil
+      end
+
+      def action
+        yield
+      end
+
+      def scan_str(str)
+        scan_setup(str)
+        do_parse
+      end
+      alias :scan :scan_str
+
+      def load_file( filename )
+        @filename = filename
+        File.open(filename, "r") do |f|
+          scan_setup(f.read)
+        end
+      end
+
+      def scan_file( filename )
+        load_file(filename)
+        do_parse
+      end
+
+
+        def next_token
+          return if @ss.eos?
+
+          # skips empty actions
+          until token = _next_token or @ss.eos?; end
+          token
+        end
+
+        def _next_token
+          text = @ss.peek(1)
+          @lineno  +=  1  if text == "\n"
+          token = case @state
+            when nil
+          case
+                  when (text = @ss.scan(/\s+/i))
+                    ;
+
+                  when (text = @ss.scan(/SELECT/i))
+                     action { [:SELECT, text] }
+
+                  when (text = @ss.scan(/FROM/i))
+                     action { [:FROM, text] }
+
+                  when (text = @ss.scan(/WHERE/i))
+                     action { [:WHERE, text] }
+
+                  when (text = @ss.scan(/COUNT/i))
+                     action { [:COUNT, text] }
+
+                  when (text = @ss.scan(/,/i))
+                     action { [:COMMA, text] }
+
+                  when (text = @ss.scan(/\*/i))
+                     action { [:ASTERISK, text] }
+
+                  when (text = @ss.scan(/=/i))
+                     action {[:EQUALS, text]}
+
+                  when (text = @ss.scan(/\(/i))
+                     action {[:PARENTHESIS_LEFT, text]}
+
+                  when (text = @ss.scan(/\)/i))
+                     action {[:PARENTHESIS_RIGHT, text]}
+
+                  when (text = @ss.scan(/[a-zA-Z]\w*/i))
+                     action { [:IDENTIFIER, text] }
+
+                  when (text = @ss.scan(/\d+(\.\d+)?/i))
+                     action {[:IDENTIFIER, text.to_f]}
+
+          
+          else
+            text = @ss.string[@ss.pos .. -1]
+            raise  ScanError, "can not match: '" + text + "'"
+          end  # if
+
+        else
+          raise  ScanError, "undefined state: '" + state.to_s + "'"
+        end  # case state
+          token
+        end  # def _next_token
+
+end # class

data/lib/simplest_sql_parser/parser.racc

@@ -0,0 +1,65 @@
+class SimplestSqlParser::Parser
+
+# ref. https://i.loveruby.net/ja/projects/racc/doc/grammar.html
+rule
+  # Each line should be formatted as:
+  # `target : pattern1 | pattern2 { action_block }`
+  #
+  # - pattern should be a composed of (`next_token[0]`, another target)
+  # - In action, substitute the generated AST node into `result` with `val[0] = next_token[1]`
+
+  # MEMO: The first line in the rule has a special meaning.only the program has to be finally reduced down into the first line.
+  # Every rule has to be reduced down to this target.
+  query : select_clause {result = AST::QueryNode.new(select_clause: val[0])}
+        | select_clause from_clause {result = AST::QueryNode.new(select_clause: val[0], from_clause: val[1])} # TODO: accept from, where, etc.
+        | select_clause from_clause where_clause {result = AST::QueryNode.new(select_clause: val[0], from_clause: val[1], where_clause: val[2])} # TODO: accept from, where, etc.
+
+  select_clause : SELECT selected_columns { result = AST::SelectClauseNode.new(selected_columns: val[1])} # TODO: accept multiple columns
+
+  selected_columns: selected_column { result = [val[0]] }
+                  | selected_columns COMMA selected_column { result = val[0] + [val[2]] }
+
+  selected_column : column_node { result = AST::SelectedColumnNode.new(col_def: val[0]) }
+                  | function_node { result = AST::SelectedColumnNode.new(col_def: val[0]) }
+
+  column_node : IDENTIFIER { result = AST::ColumnNode.new(type: :single_col, name: val[0])}
+              | ASTERISK { result = AST::ColumnNode.new(type: :asterisk, name: nil) }
+
+  function_node : COUNT PARENTHESIS_LEFT arg_node PARENTHESIS_RIGHT { result = AST::FunctionNode.new(type: :count, args: [val[2]])}
+  #           | MAX PARENTHESIS_LEFT IDENTIFIER PARENTHESIS_RIGHT {}
+
+  arg_node : column_node
+           | function_node
+
+  from_clause : FROM expression { result = AST::FromClauseNode.new(table: AST::TableNode.new(table_def: val[1])) }
+
+  where_clause : WHERE predicate { result = AST::WhereClauseNode.new(predicate: val[1])}
+
+  predicate : condition { result = [val[0]] }
+#             | predicate AND condition {}
+
+  condition : selected_column EQUALS expression { result = AST::ConditionNode.new(operator: :equals, left: val[0], right: val[2]) }
+#            | selected_column LARGER_THAN expression { result = AST::ConditionNode.new(operator: :equals, left: val[0], right: val[2]) }
+
+  expression : IDENTIFIER {result = AST::ExpressionNode.new(value: val[0])}
+
+---- header
+Dir[File.join(File.dirname(__FILE__), "ast/*.rb")].each {|file| require file }
+
+---- inner
+# innerの内容はそのまま生成されたparser.tab.rbファイル内のParserクラス内でmodule_evalされる。
+# ref. https://i.loveruby.net/ja/projects/racc/doc/parser.html#Racc%3a%3aParser-yyparse
+
+def initialize(query)
+  @scanner = SimplestSqlParser::LexicalScanner.new
+  @scanner.scan_setup(query)
+end
+
+# #next_token はここで必ず実装する必要がある。
+def next_token
+  @scanner.next_token
+end
+
+---- footer
+# footerの内容はそのまま生成されたparser.tab.rbファイルの下にコピーされる。
+# ruby parser.tab.rb で直にファイルを実行する際に Parserクラスを使って何かをするときなどに使える。

data/lib/simplest_sql_parser/parser.tab.rb

@@ -0,0 +1,289 @@
+#
+# DO NOT MODIFY!!!!
+# This file is automatically generated by Racc 1.7.1
+# from Racc grammar file "".
+#
+
+require 'racc/parser.rb'
+
+Dir[File.join(File.dirname(__FILE__), "ast/*.rb")].each {|file| require file }
+
+module SimplestSqlParser
+  class Parser < Racc::Parser
+
+module_eval(<<'...end parser.racc/module_eval...', 'parser.racc', 50)
+# innerの内容はそのまま生成されたparser.tab.rbファイル内のParserクラス内でmodule_evalされる。
+# ref. https://i.loveruby.net/ja/projects/racc/doc/parser.html#Racc%3a%3aParser-yyparse
+
+def initialize(query)
+  @scanner = SimplestSqlParser::LexicalScanner.new
+  @scanner.scan_setup(query)
+end
+
+# #next_token はここで必ず実装する必要がある。
+def next_token
+  @scanner.next_token
+end
+
+...end parser.racc/module_eval...
+##### State transition tables begin ###
+
+racc_action_table = [
+    11,    12,    13,    11,    12,    13,    11,    12,    13,    11,
+    12,    13,     3,     4,     6,    14,    16,    18,    19,    20,
+    28,    29,    18 ]
+
+racc_action_check = [
+     3,     3,     3,    16,    16,    16,    19,    19,    19,    20,
+    20,    20,     0,     1,     2,     4,     5,     6,     7,    13,
+    23,    25,    28 ]
+
+racc_action_pointer = [
+    10,    13,     5,    -4,    15,     6,    13,    15,   nil,   nil,
+   nil,   nil,   nil,    12,   nil,   nil,    -1,   nil,   nil,     2,
+     5,   nil,   nil,     9,   nil,    13,   nil,   nil,    18,   nil,
+   nil ]
+
+racc_action_default = [
+   -19,   -19,    -1,   -19,   -19,    -2,   -19,    -4,    -5,    -7,
+    -8,    -9,   -10,   -19,    31,    -3,   -19,   -14,   -18,   -19,
+   -19,   -15,   -16,   -19,    -6,   -19,   -12,   -13,   -19,   -11,
+   -17 ]
+
+racc_goto_table = [
+    17,     8,     1,     2,     5,    15,     7,    26,    27,    25,
+    21,    22,   nil,   nil,    23,   nil,   nil,    24,   nil,   nil,
+   nil,   nil,    30 ]
+
+racc_goto_check = [
+    10,     6,     1,     2,     3,     4,     5,     7,     8,     9,
+    11,    12,   nil,   nil,     6,   nil,   nil,     6,   nil,   nil,
+   nil,   nil,    10 ]
+
+racc_goto_pointer = [
+   nil,     2,     3,     2,     0,     3,    -2,   -13,   -12,   -11,
+    -6,    -6,    -5 ]
+
+racc_goto_default = [
+   nil,   nil,   nil,   nil,   nil,   nil,   nil,     9,    10,   nil,
+   nil,   nil,   nil ]
+
+racc_reduce_table = [
+  0, 0, :racc_error,
+  1, 13, :_reduce_1,
+  2, 13, :_reduce_2,
+  3, 13, :_reduce_3,
+  2, 14, :_reduce_4,
+  1, 17, :_reduce_5,
+  3, 17, :_reduce_6,
+  1, 18, :_reduce_7,
+  1, 18, :_reduce_8,
+  1, 19, :_reduce_9,
+  1, 19, :_reduce_10,
+  4, 20, :_reduce_11,
+  1, 21, :_reduce_none,
+  1, 21, :_reduce_none,
+  2, 15, :_reduce_14,
+  2, 16, :_reduce_15,
+  1, 23, :_reduce_16,
+  3, 24, :_reduce_17,
+  1, 22, :_reduce_18 ]
+
+racc_reduce_n = 19
+
+racc_shift_n = 31
+
+racc_token_table = {
+  false => 0,
+  :error => 1,
+  :SELECT => 2,
+  :COMMA => 3,
+  :IDENTIFIER => 4,
+  :ASTERISK => 5,
+  :COUNT => 6,
+  :PARENTHESIS_LEFT => 7,
+  :PARENTHESIS_RIGHT => 8,
+  :FROM => 9,
+  :WHERE => 10,
+  :EQUALS => 11 }
+
+racc_nt_base = 12
+
+racc_use_result_var = true
+
+Racc_arg = [
+  racc_action_table,
+  racc_action_check,
+  racc_action_default,
+  racc_action_pointer,
+  racc_goto_table,
+  racc_goto_check,
+  racc_goto_default,
+  racc_goto_pointer,
+  racc_nt_base,
+  racc_reduce_table,
+  racc_token_table,
+  racc_shift_n,
+  racc_reduce_n,
+  racc_use_result_var ]
+Ractor.make_shareable(Racc_arg) if defined?(Ractor)
+
+Racc_token_to_s_table = [
+  "$end",
+  "error",
+  "SELECT",
+  "COMMA",
+  "IDENTIFIER",
+  "ASTERISK",
+  "COUNT",
+  "PARENTHESIS_LEFT",
+  "PARENTHESIS_RIGHT",
+  "FROM",
+  "WHERE",
+  "EQUALS",
+  "$start",
+  "query",
+  "select_clause",
+  "from_clause",
+  "where_clause",
+  "selected_columns",
+  "selected_column",
+  "column_node",
+  "function_node",
+  "arg_node",
+  "expression",
+  "predicate",
+  "condition" ]
+Ractor.make_shareable(Racc_token_to_s_table) if defined?(Ractor)
+
+Racc_debug_parser = false
+
+##### State transition tables end #####
+
+# reduce 0 omitted
+
+module_eval(<<'.,.,', 'parser.racc', 12)
+  def _reduce_1(val, _values, result)
+    result = AST::QueryNode.new(select_clause: val[0])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 13)
+  def _reduce_2(val, _values, result)
+    result = AST::QueryNode.new(select_clause: val[0], from_clause: val[1])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 14)
+  def _reduce_3(val, _values, result)
+    result = AST::QueryNode.new(select_clause: val[0], from_clause: val[1], where_clause: val[2])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 16)
+  def _reduce_4(val, _values, result)
+     result = AST::SelectClauseNode.new(selected_columns: val[1])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 18)
+  def _reduce_5(val, _values, result)
+     result = [val[0]]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 19)
+  def _reduce_6(val, _values, result)
+     result = val[0] + [val[2]]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 21)
+  def _reduce_7(val, _values, result)
+     result = AST::SelectedColumnNode.new(col_def: val[0])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 22)
+  def _reduce_8(val, _values, result)
+     result = AST::SelectedColumnNode.new(col_def: val[0])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 24)
+  def _reduce_9(val, _values, result)
+     result = AST::ColumnNode.new(type: :single_col, name: val[0])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 25)
+  def _reduce_10(val, _values, result)
+     result = AST::ColumnNode.new(type: :asterisk, name: nil)
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 27)
+  def _reduce_11(val, _values, result)
+     result = AST::FunctionNode.new(type: :count, args: [val[2]])
+    result
+  end
+.,.,
+
+# reduce 12 omitted
+
+# reduce 13 omitted
+
+module_eval(<<'.,.,', 'parser.racc', 33)
+  def _reduce_14(val, _values, result)
+     result = AST::FromClauseNode.new(table: AST::TableNode.new(table_def: val[1]))
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 35)
+  def _reduce_15(val, _values, result)
+     result = AST::WhereClauseNode.new(predicate: val[1])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 37)
+  def _reduce_16(val, _values, result)
+     result = [val[0]]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 40)
+  def _reduce_17(val, _values, result)
+     result = AST::ConditionNode.new(operator: :equals, left: val[0], right: val[2])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 43)
+  def _reduce_18(val, _values, result)
+    result = AST::ExpressionNode.new(value: val[0])
+    result
+  end
+.,.,
+
+def _reduce_none(val, _values, result)
+  val[0]
+end
+
+  end   # class Parser
+end   # module SimplestSqlParser
+
+# footerの内容はそのまま生成されたparser.tab.rbファイルの下にコピーされる。
+# ruby parser.tab.rb で直にファイルを実行する際に Parserクラスを使って何かをするときなどに使える。

data/lib/simplest_sql_parser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimplestSqlParser
+  VERSION = "0.1.0"
+end

data/lib/simplest_sql_parser.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "simplest_sql_parser/version"
+require_relative "simplest_sql_parser/lexical_scanner.rex"
+require_relative "simplest_sql_parser/parser.tab"
+
+module SimplestSqlParser
+  class << self
+    def parse(query)
+      Parser.new(query).do_parse
+    end
+  end
+end

data/sig/simplest_sql_parser.rbs

@@ -0,0 +1,4 @@
+module SimplestSqlParser
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/simplest_sql_parser.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/simplest_sql_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "simplest_sql_parser"
+  spec.version = SimplestSqlParser::VERSION
+  spec.authors = ["kudojp"]
+  spec.email = ["heyjudejudejude1968@gmail.com"]
+
+  spec.summary = "My first SQL query parser"
+  spec.description = "This parser parses very simple SQL query and generates AST."
+  spec.homepage = "https://github.com/kudojp/simplest_sql_parser"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kudojp/simplest_sql_parser"
+  spec.metadata["changelog_uri"] = "https://github.com/kudojp/simplest_sql_parser/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: simplest_sql_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kudojp
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-23 00:00:00.000000000 Z
+dependencies: []
+description: This parser parses very simple SQL query and generates AST.
+email:
+- heyjudejudejude1968@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- lib/simplest_sql_parser.rb
+- lib/simplest_sql_parser/ast/column_node.rb
+- lib/simplest_sql_parser/ast/condition_node.rb
+- lib/simplest_sql_parser/ast/expression_node.rb
+- lib/simplest_sql_parser/ast/from_clause_node.rb
+- lib/simplest_sql_parser/ast/function_node.rb
+- lib/simplest_sql_parser/ast/node.rb
+- lib/simplest_sql_parser/ast/query_node.rb
+- lib/simplest_sql_parser/ast/select_clause_node.rb
+- lib/simplest_sql_parser/ast/selected_column_node.rb
+- lib/simplest_sql_parser/ast/table_node.rb
+- lib/simplest_sql_parser/ast/where_clause_node.rb
+- lib/simplest_sql_parser/lexical_scanner.rex
+- lib/simplest_sql_parser/lexical_scanner.rex.rb
+- lib/simplest_sql_parser/parser.racc
+- lib/simplest_sql_parser/parser.tab.rb
+- lib/simplest_sql_parser/version.rb
+- sig/simplest_sql_parser.rbs
+- simplest_sql_parser.gemspec
+homepage: https://github.com/kudojp/simplest_sql_parser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kudojp/simplest_sql_parser
+  source_code_uri: https://github.com/kudojp/simplest_sql_parser
+  changelog_uri: https://github.com/kudojp/simplest_sql_parser/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.8
+signing_key:
+specification_version: 4
+summary: My first SQL query parser
+test_files: []