sql_tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b2ba309601d1b52dd6da36b4a8bb360a36d626887c422670c8ab9baeac3613b1
+  data.tar.gz: aed2136db1548ecebf953dade273f0827eaebc5f9669b3739fae7a4f243e53f3
+SHA512:
+  metadata.gz: 5659b85ea66765857217a48c74c115e24e30a57d292fa035c45f51565b7a0a478ce76e7750785ad11b1643eda23a40a05f683a83051b105eeaab14dbc133927d
+  data.tar.gz: 12b1b67b6273fb448ed28eeb74d4a755cab78edaa026cefe617426367b1a53657cc355dbbee1c012febded7c2b562879e01e5ef482e8620ab279053090604c73

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 derek.stride@shopify.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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 derekstride
+
+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.md

@@ -0,0 +1,52 @@
+# SqlTools
+
+SqlTools is a collection of tools for working with SQL ASTs. It's the intersection of
+[ruby_tree_sitter](https://github.com/faveod/ruby-tree-sitter/) &
+[tree-sitter-sql](https://github.com/derekstride/tree-sitter-sql), letting you parse SQL queries and transform them into
+semantic Ruby objects.
+
+## Installation
+
+If you're having trouble installing `ruby_tree_sitter` try installing the libraries for the latest supported version of
+libtree-sitter.
+
+```bash
+git clone https://github.com/tree-sitter/tree-sitter
+cd tree-sitter
+git checkout tags/v0.22.6
+make
+sudo make install
+```
+
+To install the SQL parser run the rake task.
+
+```bash
+bundle exec rake treesitter:install
+```
+
+## Usage
+
+```ruby
+SqlTools.query_from_sql(<<~SQL)
+  SELECT id, name
+  FROM table_a
+  WHERE id > 10
+    AND id < 20
+SQL
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DerekStride/sql_tools. 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/DerekStride/sql_tools/blob/main/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 SqlTools project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/DerekStride/sql_tools/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "debug"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.deps << "treesitter:install"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+
+task default: %i[test]

data/exe/install_tree_sitter_sql

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require "fileutils"
+require "optparse"
+require "pathname"
+
+app_root = if File.basename(__dir__) == "exe"
+  File.expand_path("..", __dir__)
+else
+  File.expand_path(__dir__)
+end
+out = File.join(app_root, "treesitter")
+
+options = {
+  revision: "cdb7cde9bf70b194ab8beb5069fbbc3c9640284e",
+  out:,
+}
+
+OptionParser.new do |o|
+  HELP = o
+  o.banner = "usage: install_tree_sitter_sql [options]"
+  o.on("--revision SHA", "The version of the repo to clone")
+  o.on("-o OUTDIR", "--out OUTDIR", "The destination directory for the parser library") do |dir|
+    Pathname.new(File.expand_path(dir))
+  end
+  o.on_tail("-h", "--help") { puts o; exit(1) }
+end.parse!(ARGV, into: options)
+
+target = if RbConfig::CONFIG["host_os"] =~ /mac|darwin/
+  File.join(options[:out], "sql.dylib")
+else
+  File.join(options[:out], "sql.so")
+end
+
+return if File.exist?(target)
+
+# Create the target directory if it doesn't exist
+FileUtils.mkdir_p(options[:out]) unless File.exist?(options[:out])
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==\n#{HELP}")
+end
+
+FileUtils.chdir(File.join("/", "tmp")) do
+  repo_dir = "tree-sitter-sql-#{options[:revision]}"
+  unless File.exist?(repo_dir)
+    system! "git clone --depth=1 https://github.com/derekstride/tree-sitter-sql.git #{repo_dir}"
+  end
+
+  FileUtils.chdir(repo_dir) do
+    unless File.exist?("parser.so")
+      system! "git fetch origin #{options[:revision]}"
+      system! "git checkout #{options[:revision]}"
+
+      puts "Compiling..."
+      system! "cc -shared -fPIC -I./src src/parser.c src/scanner.c -o parser.so"
+    end
+
+    return if File.exist?(target)
+
+    puts "Copying parser.so to #{target}"
+    FileUtils.cp("parser.so", target)
+  end
+end

data/lib/sql_tools/common_table_expression.rb

@@ -0,0 +1,17 @@
+module SqlTools
+  class CommonTableExpression
+    attr_reader :node
+
+    def initialize(node)
+      @node = node
+    end
+
+    def name = node.children.first.text.delete('`')
+
+    def view
+      @view ||= ViewVisitor.new(node.children[-2]).visit.view
+    end
+
+    def inspect = "#<class CommonTableExpression name=#{name.inspect}>"
+  end
+end

data/lib/sql_tools/inner_join.rb

@@ -0,0 +1,3 @@
+module SqlTools
+  InnerJoin = Data.define(:object, :predicate)
+end

data/lib/sql_tools/left_join.rb

@@ -0,0 +1,3 @@
+module SqlTools
+  LeftJoin = Data.define(:object, :predicate)
+end

data/lib/sql_tools/predicate.rb

@@ -0,0 +1,45 @@
+module SqlTools
+  class Predicate
+    Binary = Struct.new(:left, :operator, :right) do
+      def to_s = "(#{left} #{operator} #{right})"
+      def inspect = to_s
+    end
+
+    class Builder
+      def initialize(query)
+        @query = query
+      end
+
+      def build(predicate)
+        case predicate
+        when Predicate::Binary
+          predicate.left = build(predicate.left)
+          predicate.right = build(predicate.right)
+          predicate
+        when TreeStand::Node
+          type_from_node(predicate)
+        else
+          raise "Unknown predicate: #{predicate}"
+        end
+      end
+
+      private
+
+      def type_from_node(node)
+        case node.type
+        when :field
+          table = if table_alias = node.find_node("(field (object_reference name: (identifier) @table_alias))")&.text
+            @query.object_alias_map.fetch(table_alias)
+          elsif @query.objects.size == 1
+            @query.objects.first
+          end
+          Column.new(table, node.name.text)
+        when :literal
+          node.text
+        else
+          raise "Unknown node type: #{node.type}"
+        end
+      end
+    end
+  end
+end

data/lib/sql_tools/predicate_filter.rb

@@ -0,0 +1,35 @@
+module SqlTools
+  class PredicateFilter
+    def initialize(query)
+      @query = query
+    end
+
+    def filter(object)
+      @stack = []
+      filter_recursive(object, @query.predicate)
+
+      right = @stack.pop
+
+      while left = @stack.pop
+        predicate = Predicate::Binary.new(left, "AND", right)
+        right = predicate
+      end
+
+      right
+    end
+
+    private
+
+    def filter_recursive(object, predicate)
+      case predicate
+      when Predicate::Binary
+        @stack << predicate if filter_recursive(object, predicate.left) || filter_recursive(object, predicate.right)
+        false
+      when SqlTools::Column
+        predicate.table == object
+      else
+        raise "Unknown predicate type: #{predicate}"
+      end
+    end
+  end
+end

data/lib/sql_tools/predicate_visitor.rb

@@ -0,0 +1,26 @@
+module SqlTools
+  class PredicateVisitor < TreeStand::Visitor
+    attr_reader :stack
+    def initialize(node)
+      super(node)
+      @stack = []
+    end
+
+    def around_binary_expression(node)
+      @stack << Predicate::Binary.new(nil, node.operator.text, nil)
+      yield
+      @stack[-3].right = @stack.pop
+      @stack[-2].left = @stack.pop
+    end
+
+    def on_field(node)
+      parent = node.parent
+      # Case JOIN ON v.is_not_deleted
+      @stack << node if parent.type == :join || parent.type == :where
+      # Case JOIN ON _ AND v.is_not_deleted
+      @stack << node if parent.type == :binary_expression
+    end
+
+    def on_literal(node) = on_field(node)
+  end
+end

data/lib/sql_tools/query.rb

@@ -0,0 +1,123 @@
+module SqlTools
+  class Query
+    attr_accessor :select, :from, :join_nodes
+    attr_reader :common_table_expressions
+
+    def initialize
+      @common_table_expressions = {}
+      @join_nodes = []
+    end
+
+    def selections
+      terms = select.query(<<~QUERY)
+        (select_expression
+          (term
+            value: [
+              (field
+                (object_reference name: (identifier) @table_alias)?
+                name: (identifier) @column_name)
+              (invocation) @invocation
+              (all_fields
+                (object_reference name: (identifier) @table_alias)?) @all_fields
+            ]
+            alias: (identifier)? @selection_name))
+      QUERY
+      terms.map! do |captures|
+        selection_name = captures["selection_name"]&.text || captures["column_name"]&.text
+
+        if captures["all_fields"]
+          table = if table_alias = captures["table_alias"]
+            object_alias_map[table_alias.text]
+          elsif objects.size == 1
+            objects.first
+          end
+          Selection::AllFields.new(table)
+        elsif table_alias = captures["table_alias"]
+          table = object_alias_map[table_alias.text]
+          column_name = captures["column_name"].text
+          Selection::Column.new(selection_name, Column.new(table, column_name))
+        elsif (column_name = captures["column_name"]&.text) && objects.size == 1
+          table = objects.first
+          Selection::Column.new(selection_name, Column.new(table, column_name))
+        elsif invocation = captures["invocation"]
+          Selection::Invocation.new(selection_name, invocation)
+        else
+          raise "Unknown selection type"
+        end
+      end
+    end
+
+    def joins
+      join_nodes.map do |join_node|
+        object_name = join_node.find_node(<<~QUERY).text
+          (join
+            (relation
+             (object_reference name: (identifier) @object_name)))
+        QUERY
+
+        filter = PredicateFilter.new(self)
+        object = object_alias_map[object_name]
+        predicate = filter.filter(object)
+
+        if join_node.children.any? { |child| child.type == :keyword_left }
+          LeftJoin.new(object, predicate)
+        else
+          InnerJoin.new(object, predicate)
+        end
+      end
+    end
+
+    def relations
+      objects.each_with_object({}) do |object, map|
+        map[object] ||= []
+        map[object] << predicates.select do |p|
+          (p.left.is_a?(Column) && p.left.table == object) ||
+            (p.right.is_a?(Column) && p.right.table == object)
+        end
+      end
+    end
+
+    def predicate
+      @predicate ||= begin
+        nodes = from.query(<<~QUERY).map { |captures| captures["predicate"] }
+          (from
+            (join
+              predicate: (_) @predicate))
+            (where
+              predicate: (_) @predicate)
+        QUERY
+
+        builder = Predicate::Builder.new(self)
+        predicates = nodes.flat_map do |predicate|
+          visitor = PredicateVisitor.new(predicate).visit
+          binding.b unless visitor.stack.size == 1
+          builder.build(visitor.stack.last)
+        end
+
+        right = predicates.pop
+
+        # This needs to pluck the left & right from binary expressions & rebuild the tree.
+        # TODO: maybe this is the rotate algorithm, TBD
+        while left = predicates.pop
+          predicate = Predicate::Binary.new(left, "AND", right)
+          right = predicate
+        end
+
+        right
+      end
+    end
+
+    def objects = object_alias_map.values.to_set
+
+    def object_alias_map
+      @table_alias_map ||= @from.query("(relation) @relation").each_with_object({}) do |captures, map|
+        relation = captures["relation"]
+        relation_name = relation.children.first.name.text
+        relation_alias = relation.respond_to?(:alias) ? relation.alias.text : relation_name
+
+        map[relation_alias] = common_table_expressions[relation_name] || Table.new(relation_name, relation_alias)
+        map[relation_name] = map[relation_alias]
+      end
+    end
+  end
+end

data/lib/sql_tools/query_visitor.rb

@@ -0,0 +1,28 @@
+module SqlTools
+  class QueryVisitor < TreeStand::Visitor
+    attr_reader :query
+
+    def initialize(node)
+      super(node)
+      @ctes = {}
+      @query = Query.new
+    end
+
+    def on_cte(node)
+      cte = CommonTableExpression.new(node)
+      @query.common_table_expressions[cte.name] = cte
+    end
+
+    def on_select(node)
+      @query.select = node
+    end
+
+    def on_from(node)
+      @query.from = node
+    end
+
+    def on_join(node)
+      @query.join_nodes << node
+    end
+  end
+end

data/lib/sql_tools/relation.rb

@@ -0,0 +1,7 @@
+module SqlTools
+  class Relation
+    def initialize(node)
+      @node = node
+    end
+  end
+end

data/lib/sql_tools/selection.rb

@@ -0,0 +1,7 @@
+module SqlTools
+  module Selection
+    Column = Data.define(:name, :column)
+    Invocation = Data.define(:name, :invocation)
+    AllFields = Data.define(:table)
+  end
+end

data/lib/sql_tools/version.rb

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

data/lib/sql_tools.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "tree_stand"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module SqlTools
+  class Error < StandardError; end
+
+  class << self
+    def query_from_sql(sql) = query_from_tree(tree_from_sql(sql))
+    def query_from_tree(tree) = SqlTools::QueryVisitor.new(tree.root_node).visit.query
+    def tree_from_sql(sql) = parser.parse_string(sql)
+    def parser = @parser ||= TreeStand::Parser.new("sql")
+  end
+
+  Table = Data.define(:name, :alias)
+  Column = Data.define(:table, :name) do
+    def to_s = "#{table.name}.#{name}"
+    def inspect = to_s
+  end
+end

data/rakelib/treesitter.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+namespace :treesitter do
+  task :install do
+    app_root = File.expand_path("..", __dir__)
+    exe = File.join(app_root, "exe", "install_tree_sitter_sql")
+    system(exe) || abort("\n== Command #{exe} failed ==")
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: sql_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- derekstride
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_tree_sitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- derek@stride.host
+executables:
+- install_tree_sitter_sql
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/install_tree_sitter_sql
+- lib/sql_tools.rb
+- lib/sql_tools/common_table_expression.rb
+- lib/sql_tools/inner_join.rb
+- lib/sql_tools/left_join.rb
+- lib/sql_tools/predicate.rb
+- lib/sql_tools/predicate_filter.rb
+- lib/sql_tools/predicate_visitor.rb
+- lib/sql_tools/query.rb
+- lib/sql_tools/query_visitor.rb
+- lib/sql_tools/relation.rb
+- lib/sql_tools/selection.rb
+- lib/sql_tools/version.rb
+- rakelib/treesitter.rake
+homepage: https://github.com/derekstride/sql_tools
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/derekstride/sql_tools
+  source_code_uri: https://github.com/derekstride/sql_tools
+  changelog_uri: https://github.com/derekstride/sql_tools
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Collection of tools for working with SQL ASTs.
+test_files: []