pg_delta 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abb741a6c13dd86274ea00b2562b4330f31266fcf2fd24277b4929783f559bae
+  data.tar.gz: 397cbd53124f61b8fc3e73a7611f5a540659b41b1034632be66a8674613d6a2b
+SHA512:
+  metadata.gz: f21a6fded139dbb9bede777f208ad3b0d3ec96424ece0e2c58be801815a9b8ec565e611beb506f5bca8ccd6e25eb84a5a60e0cd55c8ee2bb2b8fee5da34899fb
+  data.tar.gz: 687b9381f42f15e1d0ca61b1114d0e2f8677d7a520ecea214ef05cbf374fc92731c00e8ab713ea5443109d2e75000c12906de4286b65ebb21928bd4a6c879b94

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-08-05
+
+- 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. 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) 2023 rhizomic
+
+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,192 @@
+# PgDelta
+
+`pg_delta` provides an easy way to obtain information about a PostgreSQL query.
+Here's a motivating example.
+
+Given a file `/tmp/a.sql`:
+
+
+```sql
+update users
+  set name = 'Unknown'
+  where name is null;
+
+alter table users
+  alter column name
+  set not null;
+
+truncate table passwords;
+```
+
+Running `pg_delta` will then yield the following JSON:
+
+```sh
+$ exe/pg_delta -f /tmp/a.sql
+[
+  {
+    "mutation": "update_data",
+    "type": "data",
+    "details": {
+      "table_name": "users",
+      "column_names": [
+        "name"
+      ]
+    }
+  },
+  {
+    "mutation": "alter_table_set_not_null",
+    "type": "column",
+    "details": {
+      "table_name": "users",
+      "column_name": "name"
+    }
+  },
+  {
+    "mutation": "truncate_table",
+    "type": "table",
+    "details": {
+      "table_names": [
+        "passwords"
+      ]
+    }
+  }
+]
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add pg_delta
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install pg_delta
+
+## Usage
+
+```
+Usage: pg_delta -f FILES
+
+Example:
+  $ pg_delta -f 1.sql 2.sql 3.sql
+
+Options:
+    -v, --version                    Print the version
+    -f, --files FILES                The files to parse
+    -h, --help                       Show this message
+```
+
+### Types of Changes
+
+The `type`s of changes are as follows:
+
+```
+:column
+:domain
+:enum
+:function
+:table
+:trigger
+:data
+:index
+:type
+:view
+:constraint
+:unknown
+```
+
+### Mutations
+
+The following `mutation`s are identified:
+
+```
+# :column
+:alter_table_add_column
+:alter_table_set_column_default
+:alter_table_drop_column_default
+:alter_table_drop_column
+:alter_table_drop_not_null
+:alter_table_set_not_null
+:alter_table_rename_column
+
+# :domain
+:alter_domain
+:create_domain
+:drop_domain
+
+# :enum
+:alter_enum
+:create_enum
+
+# :function
+:create_function
+:drop_function
+:rename_function
+
+# :table
+:create_table
+:create_table_as
+:drop_table
+:rename_table
+:truncate_table
+
+# :trigger
+:create_trigger
+:drop_trigger
+:disable_trigger
+:enable_trigger
+:rename_trigger
+
+# :data
+:delete_data
+:insert_data
+:update_data
+
+# :index
+:create_index
+:drop_index
+:rename_index
+
+# :type
+:alter_table_alter_column_type
+:drop_type
+:rename_type
+
+# :view
+:create_view
+:drop_materialized_view
+:drop_view
+
+# :constraint
+:alter_table_add_constraint
+:alter_table_drop_constraint
+:alter_table_validate_constraint
+:alter_table_rename_constraint
+
+# :unknown
+:unknown
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/rhizomic/pg_delta. 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/rhizomic/pg_delta/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).

data/Rakefile

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

data/exe/pg_delta

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(__dir__ + "/../lib")
+
+require "pg_delta"
+require "pg_delta/version"
+
+require "json"
+require "optparse"
+
+class CLI
+  def self.parse_options(args)
+    options = {
+      files: []
+    }
+
+    option_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: pg_delta -f FILES"
+
+      opts.separator ""
+
+      opts.separator "Example:"
+      opts.separator "  $ pg_delta -f 1.sql 2.sql 3.sql"
+
+      opts.separator ""
+
+      opts.separator "Options:"
+
+      opts.on("-v", "--version", "Print the version") do |v|
+        puts "pg_delta v#{PgDelta::Version::VERSION}"
+        exit
+      end
+
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+
+      opts.on("-f", "--files FILES", Array, "The files to parse") do |files|
+        options[:files] |= [*files]
+      end
+    end
+
+    option_parser.parse!(args)
+
+    options
+  end
+end
+
+ARGV << "-h" if ARGV.empty? && $stdin.tty?
+cli_options = CLI.parse_options ARGV
+
+# Workaround to get multiple files passed to :files without needing to resort
+# to commas.
+# See: https://stackoverflow.com/a/29938935
+cli_options[:files] |= ARGV
+
+file_contents = cli_options[:files].map do |file|
+  file = File.expand_path file
+  File.read file
+end.join ";"
+
+statements = PgDelta.split_statements file_contents
+
+results = statements.map do |statement|
+  PgDelta.parse_statement statement
+end
+
+puts JSON.pretty_generate(results)

data/lib/pg_delta/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PgDelta
+  module Version
+    VERSION = "0.1.0"
+  end
+end

data/lib/pg_delta.rb

@@ -0,0 +1,655 @@
+# frozen_string_literal: true
+
+require "pg_query"
+
+require_relative "pg_delta/version"
+
+module PgDelta
+  class Error < StandardError; end
+
+  # Parses the provided queries and returns a PgQuery statement for each query.
+  # Returns an empty list if the queries cannot be parsed.
+  #
+  # @param queries [String] The queries
+  # @return [Array<PgQuery::Node>] The info about the parsed query
+  def self.split_statements(queries)
+    parsed_query = PgQuery.parse queries
+    parsed_query.tree.stmts.map(&:stmt)
+  rescue
+    []
+  end
+
+  # Parses a single query and its corresponding PgQuery statement.
+  # Returns an empty hash if the query cannot be parsed.
+  #
+  # @param query [String] The query
+  # @return [Hash] The info about the parsed query
+  def self.parse_query(query)
+    parsed_query = PgQuery.parse query
+    statement = parsed_query.tree.stmts.first.stmt
+    parse_statement statement
+  rescue
+    {}
+  end
+
+  # Returns information about the supplied statement.
+  #
+  # @param statement [PgQuery::Node] The statement
+  # @return [Hash] The info about the statement
+  def self.parse_statement(statement)
+    case statement.node
+    when :alter_domain_stmt
+      alter_domain statement.alter_domain_stmt
+    when :alter_enum_stmt
+      alter_enum statement.alter_enum_stmt
+    when :alter_table_stmt
+      case statement.alter_table_stmt.cmds[0].alter_table_cmd.subtype
+      when :AT_SetNotNull
+        alter_table_set_not_null statement.alter_table_stmt
+      when :AT_AddColumn
+        alter_table_add_column statement.alter_table_stmt
+      when :AT_DropColumn
+        alter_table_drop_column statement.alter_table_stmt
+      when :AT_AddConstraint
+        alter_table_add_constraint statement.alter_table_stmt
+      when :AT_DropConstraint
+        alter_table_drop_constraint statement.alter_table_stmt
+      when :AT_ValidateConstraint
+        alter_table_validate_constraint statement.alter_table_stmt
+      when :AT_DropNotNull
+        alter_table_drop_not_null statement.alter_table_stmt
+      when :AT_ColumnDefault
+        alter_table_column_default statement.alter_table_stmt
+      when :AT_AlterColumnType
+        alter_table_alter_column_type statement.alter_table_stmt
+      when :AT_DisableTrig
+        alter_table_disable_trigger statement.alter_table_stmt
+      when :AT_SetRelOptions
+        # Don't return anything for now.
+        {}
+      when :AT_EnableTrig
+        alter_table_enable_trigger statement.alter_table_stmt
+      else
+        unknown statement
+      end
+    when :create_domain_stmt
+      create_domain statement.create_domain_stmt
+    when :create_enum_stmt
+      create_enum statement.create_enum_stmt
+    when :create_extension_stmt
+      # Don't return anything for now.
+      {}
+    when :create_function_stmt
+      create_function statement.create_function_stmt
+    when :create_stmt
+      create_table statement.create_stmt
+    when :create_table_as_stmt
+      create_table_as statement.create_table_as_stmt
+    when :create_trig_stmt
+      create_trigger statement.create_trig_stmt
+    when :delete_stmt
+      delete statement.delete_stmt
+    when :drop_stmt
+      case statement.drop_stmt.remove_type
+      when :OBJECT_INDEX
+        drop_index statement.drop_stmt
+      when :OBJECT_TABLE
+        drop_table statement.drop_stmt
+      when :OBJECT_TYPE
+        drop_type statement.drop_stmt
+      when :OBJECT_TRIGGER
+        drop_trigger statement.drop_stmt
+      when :OBJECT_FUNCTION
+        drop_function statement.drop_stmt
+      when :OBJECT_VIEW
+        drop_view statement.drop_stmt
+      when :OBJECT_DOMAIN
+        drop_domain statement.drop_stmt
+      when :OBJECT_MATVIEW
+        drop_materialized_view statement.drop_stmt
+      else
+        unknown statement
+      end
+    when :index_stmt
+      create_index statement.index_stmt
+    when :insert_stmt
+      insert statement.insert_stmt
+    when :rename_stmt
+      case statement.rename_stmt.rename_type
+      when :OBJECT_TABCONSTRAINT
+        rename_constraint statement.rename_stmt
+      when :OBJECT_TABLE
+        rename_table statement.rename_stmt
+      when :OBJECT_COLUMN
+        rename_column statement.rename_stmt
+      when :OBJECT_FUNCTION
+        rename_function statement.rename_stmt
+      when :OBJECT_TRIGGER
+        rename_trigger statement.rename_stmt
+      when :OBJECT_INDEX
+        rename_index statement.rename_stmt
+      when :OBJECT_TYPE
+        rename_type statement.rename_stmt
+      else
+        unknown statement
+      end
+    when :truncate_stmt
+      truncate statement.truncate_stmt
+    when :update_stmt
+      update statement.update_stmt
+    when :view_stmt
+      view statement.view_stmt
+    when :select_stmt
+      # TODO: This is tricky, because this could call a function which might
+      # alter the schema.
+      # Don't return anything for now.
+      {}
+    when :create_seq_stmt
+      # Don't return anything for now.
+      {}
+    when :create_stats_stmt
+      # Don't return anything for now.
+      {}
+    when :define_stmt
+      # Don't return anything for now.
+      {}
+    when :alter_seq_stmt
+      # Don't return anything for now.
+      {}
+    when :comment_stmt
+      # Don't return anything for now.
+      {}
+    when :lock_stmt
+      # Don't return anything for now.
+      {}
+    when :variable_set_stmt
+      # Don't return anything for now.
+      {}
+    when :transaction_stmt
+      # "begin;" and "commit;" are parsed as :transaction_stmt.
+      # Don't return anything for now.
+      {}
+    when :do_stmt
+      # Don't return anything for now.
+      {}
+    else
+      unknown statement
+    end
+  end
+
+  # Column mutations
+
+  def self.alter_table_add_column(statement)
+    {
+      mutation: :alter_table_add_column,
+      type: :column,
+      details: {
+        table_name: statement.relation.relname,
+        column_name: statement.cmds.first.alter_table_cmd.def.column_def.colname,
+        column_type: statement.cmds.first.alter_table_cmd.def.column_def.type_name.names.last.string.sval
+      }
+    }
+  end
+
+  def self.alter_table_column_default(statement)
+    # PgQuery sadly doesn't differentiate between adding and dropping
+    # column defaults at the node level, so we have to do it here.
+    if statement.cmds.first.alter_table_cmd.def
+      # The query is setting a default.
+      {
+        mutation: :alter_table_set_column_default,
+        type: :column,
+        details: {
+          table_name: statement.relation.relname,
+          column_name: statement.cmds.first.alter_table_cmd.name
+        }
+      }
+    else
+      {
+        mutation: :alter_table_drop_column_default,
+        type: :column,
+        details: {
+          table_name: statement.relation.relname,
+          column_name: statement.cmds.first.alter_table_cmd.name
+        }
+      }
+    end
+  end
+
+  def self.alter_table_drop_column(statement)
+    {
+      mutation: :alter_table_drop_column,
+      type: :column,
+      details: {
+        table_name: statement.relation.relname,
+        column_name: statement.cmds.first.alter_table_cmd.name
+      }
+    }
+  end
+
+  def self.alter_table_drop_not_null(statement)
+    {
+      mutation: :alter_table_drop_not_null,
+      type: :column,
+      details: {
+        table_name: statement.relation.relname,
+        column_name: statement.cmds.first.alter_table_cmd.name
+      }
+    }
+  end
+
+  def self.alter_table_set_not_null(statement)
+    {
+      mutation: :alter_table_set_not_null,
+      type: :column,
+      details: {
+        table_name: statement.relation.relname,
+        column_name: statement.cmds.first.alter_table_cmd.name
+      }
+    }
+  end
+
+  def self.rename_column(statement)
+    {
+      mutation: :alter_table_rename_column,
+      type: :column,
+      details: {
+        table_name: statement.relation.relname,
+        old_column_name: statement.subname,
+        new_column_name: statement.newname
+      }
+    }
+  end
+
+  # Domain mutations
+
+  def self.alter_domain(statement)
+    {
+      mutation: :alter_domain,
+      type: :domain,
+      details: {
+        domain_name: statement.type_name.first.string.sval
+      }
+    }
+  end
+
+  def self.create_domain(statement)
+    {
+      mutation: :create_domain,
+      type: :domain,
+      details: {
+        domain_name: statement.domainname.first.string.sval
+      }
+    }
+  end
+
+  def self.drop_domain(statement)
+    {
+      mutation: :drop_domain,
+      type: :domain,
+      details: {
+        domain_name: statement.objects.first.type_name.names.first.string.sval
+      }
+    }
+  end
+
+  # Enum mutations
+
+  def self.alter_enum(statement)
+    {
+      mutation: :alter_enum,
+      type: :enum,
+      details: {
+        enum_name: statement.type_name.first.string.sval
+      }
+    }
+  end
+
+  def self.create_enum(statement)
+    {
+      mutation: :create_enum,
+      type: :enum,
+      details: {
+        enum_name: statement.type_name.first.string.sval
+      }
+    }
+  end
+
+  # Function mutations
+
+  def self.create_function(statement)
+    {
+      mutation: :create_function,
+      type: :function,
+      details: {
+        function_name: statement.funcname.first.string.sval
+      }
+    }
+  end
+
+  def self.drop_function(statement)
+    {
+      mutation: :drop_function,
+      type: :function,
+      details: {
+        function_name: statement.objects.first.object_with_args.objname.first.string.sval
+      }
+    }
+  end
+
+  def self.rename_function(statement)
+    {
+      mutation: :rename_function,
+      type: :function,
+      details: {
+        old_function_name: statement.object.object_with_args.objname.first.string.sval,
+        new_function_name: statement.newname
+      }
+    }
+  end
+
+  # Table mutations
+
+  def self.create_table(statement)
+    {
+      mutation: :create_table,
+      type: :table,
+      details: {
+        table_name: statement.relation.relname
+      }
+    }
+  end
+
+  def self.create_table_as(statement)
+    {
+      mutation: :create_table_as,
+      type: :table,
+      details: {
+        table_name: statement.into.rel.relname
+      }
+    }
+  end
+
+  def self.drop_table(statement)
+    {
+      mutation: :drop_table,
+      type: :table,
+      details: {
+        table_name: statement.objects.first.list.items.first.string.sval
+      }
+    }
+  end
+
+  def self.rename_table(statement)
+    {
+      mutation: :rename_table,
+      type: :table,
+      details: {
+        old_table_name: statement.relation.relname,
+        new_table_name: statement.newname
+      }
+    }
+  end
+
+  def self.truncate(statement)
+    {
+      mutation: :truncate_table,
+      type: :table,
+      details: {
+        table_names: statement.relations.map(&:range_var).map(&:relname)
+      }
+    }
+  end
+
+  # Trigger mutations
+
+  def self.create_trigger(statement)
+    {
+      mutation: :create_trigger,
+      type: :trigger,
+      details: {
+        trigger_name: statement.trigname,
+        table_name: statement.relation.relname
+      }
+    }
+  end
+
+  def self.drop_trigger(statement)
+    items = statement.objects.first.list.items
+    {
+      mutation: :drop_trigger,
+      type: :trigger,
+      details: {
+        trigger_name: items.last.string.sval,
+        table_name: items.first.string.sval
+      }
+    }
+  end
+
+  def self.alter_table_disable_trigger(statement)
+    {
+      mutation: :disable_trigger,
+      type: :trigger,
+      details: {
+        table_name: statement.relation.relname,
+        trigger_name: statement.cmds.first.alter_table_cmd.name
+      }
+    }
+  end
+
+  def self.alter_table_enable_trigger(statement)
+    {
+      mutation: :enable_trigger,
+      type: :trigger,
+      details: {
+        table_name: statement.relation.relname,
+        trigger_name: statement.cmds.first.alter_table_cmd.name
+      }
+    }
+  end
+
+  def self.rename_trigger(statement)
+    {
+      mutation: :rename_trigger,
+      type: :trigger,
+      details: {
+        table_name: statement.relation.relname,
+        old_trigger_name: statement.subname,
+        new_trigger_name: statement.newname
+      }
+    }
+  end
+
+  # Data mutations
+
+  def self.delete(statement)
+    {
+      mutation: :delete_data,
+      type: :data,
+      details: {
+        table_name: statement.relation.relname
+      }
+    }
+  end
+
+  def self.insert(statement)
+    {
+      mutation: :insert_data,
+      type: :data,
+      details: {
+        table_name: statement.relation.relname
+      }
+    }
+  end
+
+  def self.update(statement)
+    {
+      mutation: :update_data,
+      type: :data,
+      details: {
+        table_name: statement.relation.relname,
+        column_names: statement.target_list.map(&:res_target).map(&:name)
+      }
+    }
+  end
+
+  # Index mutations
+
+  def self.create_index(statement)
+    {
+      mutation: :create_index,
+      type: :index,
+      details: {
+        table_name: statement.relation.relname,
+        column_names: statement.index_params.map(&:index_elem).map(&:name)
+      }
+    }
+  end
+
+  def self.drop_index(statement)
+    {
+      mutation: :drop_index,
+      type: :index,
+      details: {
+        index_name: statement.objects.first.list.items.first.string.sval
+      }
+    }
+  end
+
+  def self.rename_index(statement)
+    {
+      mutation: :rename_index,
+      type: :index,
+      details: {
+        old_index_name: statement.relation.relname,
+        new_index_name: statement.newname
+      }
+    }
+  end
+
+  # Type mutations
+  #
+  def self.alter_table_alter_column_type(statement)
+    {
+      mutation: :alter_table_alter_column_type,
+      type: :column,
+      details: {
+        table_name: statement.relation.relname,
+        column_name: statement.cmds.first.alter_table_cmd.name,
+        new_type_name: statement.cmds.first.alter_table_cmd.def.column_def.type_name.names.last.string.sval
+      }
+    }
+  end
+
+  def self.drop_type(statement)
+    {
+      mutation: :drop_type,
+      type: :type,
+      details: {
+        type_name: statement.objects.first.type_name.names.first.string.sval
+      }
+    }
+  end
+
+  def self.rename_type(statement)
+    {
+      mutation: :rename_type,
+      type: :type,
+      details: {
+        old_type_name: statement.object.list.items.first.string.sval,
+        new_type_name: statement.newname
+      }
+    }
+  end
+
+  # View mutations
+
+  def self.view(statement)
+    {
+      mutation: :create_view,
+      type: :view,
+      details: {
+        view_name: statement.view.relname
+      }
+    }
+  end
+
+  def self.drop_materialized_view(statement)
+    {
+      mutation: :drop_materialized_view,
+      type: :view,
+      details: {
+        view_name: statement.objects.first.list.items.first.string.sval
+      }
+    }
+  end
+
+  def self.drop_view(statement)
+    {
+      mutation: :drop_view,
+      type: :view,
+      details: {
+        view_name: statement.objects.first.list.items.first.string.sval
+      }
+    }
+  end
+
+  # Constraint mutations
+
+  def self.alter_table_add_constraint(statement)
+    {
+      mutation: :alter_table_add_constraint,
+      type: :constraint,
+      details: {
+        table_name: statement.relation.relname,
+        constraint_name: statement.cmds.first.alter_table_cmd.def.constraint.conname
+      }
+    }
+  end
+
+  def self.alter_table_drop_constraint(statement)
+    {
+      mutation: :alter_table_drop_constraint,
+      type: :constraint,
+      details: {
+        table_name: statement.relation.relname,
+        constraint_name: statement.cmds.first.alter_table_cmd.name
+      }
+    }
+  end
+
+  def self.alter_table_validate_constraint(statement)
+    {
+      mutation: :alter_table_validate_constraint,
+      type: :constraint,
+      details: {
+        table_name: statement.relation.relname,
+        constraint_name: statement.cmds.first.alter_table_cmd.name
+      }
+    }
+  end
+
+  def self.rename_constraint(statement)
+    {
+      mutation: :alter_table_rename_constraint,
+      type: :constraint,
+      details: {
+        table_name: statement.relation.relname,
+        old_constraint_name: statement.subname,
+        new_constraint_name: statement.newname
+      }
+    }
+  end
+
+  # Unknown mutations
+
+  def self.unknown(statement)
+    {
+      mutation: :unknown,
+      type: :unknown,
+      details: {
+        statement: statement.to_s
+      }
+    }
+  end
+end

data/sig/pg_delta.rbs

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

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: pg_delta
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rhizomic
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.19.0
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.30.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.30.1
+- !ruby/object:Gem::Dependency
+  name: pg_query
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+description: pg_delta concisely summarizes the changes made by PostgreSQL migrations.
+email:
+executables:
+- pg_delta
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/pg_delta
+- lib/pg_delta.rb
+- lib/pg_delta/version.rb
+- sig/pg_delta.rbs
+homepage:
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/rhizomic/pg_delta
+  changelog_uri: https://github.com/rhizomic/pg_delta/blob/master/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.4.10
+signing_key:
+specification_version: 4
+summary: Summarizes the changes made by PostgreSQL migrations.
+test_files: []