synchronize_postgres_stored_procedures 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6ec8b192e24ff9c917d2c4b84134b9e3e96761ecfb9e28f9580cf823841b2e5
+  data.tar.gz: 5bcf3109c9e8705ae89462949d57515d6847490b660f3873a578061c36461e84
+SHA512:
+  metadata.gz: 1f00c03b6cd4bf26f315250d038ca94156b4ec99f45f38d96a38200f90ebaa1e40dfc225b1547fe696214608f0c2a209a0cce851721c3110a7e43c670bf5fe74
+  data.tar.gz: fb6df392af325d116ba44134c398e0506cc557ff57a928b58a5093a765a29686ab8027be4a409090829fa71b279c87f26439991892e3c20f588f41e4130ce391

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 rob mathews
+
+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,65 @@
+# SynchronizePostgresStoredProcedures
+
+Don't want to track down multiple versions of a stored procedure across
+multiple migrations to find the current source? Want to just edit a file
+and have the stored procedure (or function) be automatically updated
+in your database as part of the db:migrate step? Then this gem is
+for you.
+
+Given a directory of stored procedures, it will add, update, and drop the sp's in the database to match the directory on disk.
+
+## The Rules
+The rules are simple:
+
+* install the gem as directed below
+* put each stored procedure in it's own file (see below for example) in the db/sp directory.
+* all your stored procedures must start with the name 'sp_'. This is to prevent conflict with existing postgres stored procedures.
+* the stored procedures will be installed alphabetically, so if you have one sp that depends on another sp, be sure the other sp comes first alphabetically.
+
+### Example
+
+Say you have this function, called 'sp_unaccent', as below:
+```sql
+CREATE OR REPLACE FUNCTION sp_unaccent(text)
+  RETURNS text AS
+$func$
+SELECT public.unaccent('public.unaccent', $1)  -- schema-qualify function and dictionary. Modifies public version to be IMMUTABLE so it can be indexed.
+$func$  LANGUAGE sql IMMUTABLE;
+```
+Place that text in the file db/sp/sp_unaccent.sql, and this gem will ensure that the sp is up to date in any database that the migrations are applied to.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'synchronize_postgres_stored_procedures'
+```
+Execute
+```sh
+ bundle install
+```
+## Usage
+Require the gem in your Capfile:
+
+```ruby
+require 'synchronize_postgres_stored_procedures'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/synchronize_postgres_stored_procedures. 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]/synchronize_postgres_stored_procedures/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 SynchronizePostgresStoredProcedures project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/synchronize_postgres_stored_procedures/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/synchronize_postgres_stored_procedures/stored_procedures/pg.rb

@@ -0,0 +1,49 @@
+module SynchronizePostgresStoredProcedures
+  module StoredProcedures
+    class Pg
+      cattr_accessor :logger
+      delegate :logger, :to => :class
+
+      def initialize(connection = ActiveRecord::Base.connection)
+        @connection = connection
+
+        major,minor,point = get_version
+
+        if (major < 9 || major > 16)
+          raise "Unsupported postgres version #{get_version}"
+        end
+
+        @synchronizer = (
+          case major
+          when 12,13,14,15,16 then Pg12
+          when 11 then Pg11
+          else Pg9
+          end
+        ).new(@connection)
+
+        # We want to write logs to the rails default logger and stdout
+        loggers = [Logger.new(STDOUT)]
+        loggers.append(Rails.logger) if Rails.logger
+        self.logger = ActiveSupport::BroadcastLogger.new(*loggers)
+      end
+
+      def synchronize(directory = "db/sp")
+        logger.info("Synchronizing stored procedures")
+
+        dir = Dir.new(directory)
+        stored_procedures = dir.entries.select {|f| f =~ /\.sql$/}
+
+        @synchronizer.synchronize_all(stored_procedures.sort.map {|filename|
+          [File.open(File.join(dir, filename)) { |f| f.read }, File.basename(filename, ".sql")]
+        })
+      end
+
+      private
+      def get_version
+        version = @connection.select_one("SHOW server_version")['server_version']
+        version.split('.').map(&:to_i)
+      end
+    end
+  end
+end
+

data/lib/synchronize_postgres_stored_procedures/stored_procedures/pg_11.rb

@@ -0,0 +1,34 @@
+module SynchronizePostgresStoredProcedures
+  module StoredProcedures
+    class Pg11 < Synchronizer
+      def self.pg_proc_columns
+        [
+          "proowner",
+          "prolang",
+          "procost",
+          "prorows",
+          "provariadic",
+          "protransform",
+          "prokind",
+          "prosecdef",
+          "proleakproof",
+          "proisstrict",
+          "proretset",
+          "provolatile",
+          "pronargs",
+          "pronargdefaults",
+          "prorettype",
+          "proargtypes",
+          "proallargtypes",
+          "proargmodes",
+          "proargnames",
+          "proargdefaults",
+          "probin",
+          "proconfig",
+          "proacl"
+        ]
+      end
+    end
+  end
+end
+

data/lib/synchronize_postgres_stored_procedures/stored_procedures/pg_12.rb

@@ -0,0 +1,34 @@
+module SynchronizePostgresStoredProcedures
+  module StoredProcedures
+    class Pg12 < Synchronizer
+      def self.pg_proc_columns
+        [
+          "proowner",
+          "prolang",
+          "procost",
+          "prorows",
+          "provariadic",
+          "prosupport",
+          "prokind",
+          "prosecdef",
+          "proleakproof",
+          "proisstrict",
+          "proretset",
+          "provolatile",
+          "pronargs",
+          "pronargdefaults",
+          "prorettype",
+          "proargtypes",
+          "proallargtypes",
+          "proargmodes",
+          "proargnames",
+          "proargdefaults",
+          "probin",
+          "proconfig",
+          "proacl"
+        ]
+      end
+    end
+  end
+end
+

data/lib/synchronize_postgres_stored_procedures/stored_procedures/pg_9.rb

@@ -0,0 +1,34 @@
+module SynchronizePostgresStoredProcedures
+  module StoredProcedures
+    class Pg9 < Synchronizer
+      def self.pg_proc_columns
+        [
+          "proowner",
+          "prolang",
+          "procost",
+          "prorows",
+          "provariadic",
+          "protransform",
+          "proisagg",
+          "proiswindow",
+          "prosecdef",
+          "proleakproof",
+          "proisstrict",
+          "proretset",
+          "provolatile",
+          "pronargs",
+          "pronargdefaults",
+          "prorettype",
+          "proargtypes",
+          "proallargtypes",
+          "proargmodes",
+          "proargnames",
+          "proargdefaults",
+          "probin",
+          "proconfig",
+          "proacl"
+        ]
+      end
+    end
+  end
+end

data/lib/synchronize_postgres_stored_procedures/stored_procedures/synchronizer.rb

@@ -0,0 +1,108 @@
+module SynchronizePostgresStoredProcedures
+  module StoredProcedures
+    class Synchronizer
+      def initialize(connection)
+        @connection = connection
+      end
+
+      delegate :select_one, :select_all, :execute, :select_value, :to => :@connection
+      delegate :logger, :to => Pg
+      delegate :pg_proc_columns, :to => :class
+
+      def synchronize_all(procedures)
+        procedures.sort_by(&:last).each do |source, name|
+          synchronize(source, name)
+        end
+        sp_clean(procedures.map(&:last))
+      end
+
+      protected
+      def synchronize(source, name)
+        if(!(exists = sp_exists?(name)) || !sp_equal?(source, name))
+          if exists
+            logger.info "\t UPDATING: #{name}"
+          else
+            logger.info "\t CREATING: #{name}"
+          end
+          sp_drop(name)
+          sp_create(name,source)
+        else
+          logger.info "\tunchanged: #{name} "
+        end
+      end
+
+      protected
+      def convert_arg(val)
+        # select * from pg_type where typnamespace = 11 order by typname
+        # look at typelem and typarray
+        case val.to_i
+        when 23 then 'integer'
+        when 1007 then 'integer[]'
+        when 25 then 'text'
+        when 1043 then 'varchar(255)'
+        when 1082 then 'date'
+        when 1114 then 'timestamp'
+        when 1184 then 'timestamptz'
+        when 700 then 'pg_catalog.float4'
+        when 701 then 'pg_catalog.float8'
+        when 20 then 'bigint'
+        when 1016 then 'bigint[]'
+        when 16 then 'boolean'
+        when 1186 then 'interval'
+        else
+          raise ArgumentError, "unknown argument type(#{val})"
+        end
+      end
+
+      def temp_namespace_oid
+        @temp_namespace_oid||=select_value("select oid from pg_namespace where nspname='temp'")
+      end
+
+      def namespace_for_oid(oid)
+        select_value("select nspname from pg_namespace where oid=#{oid}")
+      end
+
+      def sp_create(name, source)
+        execute(source)
+        raise ::PG::Error, "failed to create stored procedure #{name} (check if the filename matches the function name) " if !sp_exists?(name)
+      end
+
+      def sp_equal?(source_string, name)
+        sp_drop(name,temp_namespace_oid)
+        sp_create(name, source_string.sub(/(.*CREATE(?: +OR +REPLACE)? +FUNCTION +)(\w+)(.*)/mi,"\\1temp.\\2\\3"))
+        !select_one(%Q{select p1.proname from pg_proc p1, pg_proc p2
+        where p1.proname = '#{name}' AND p1.pronamespace <> p2.pronamespace
+              AND p2.proname = '#{name}' AND p2.pronamespace = #{temp_namespace_oid}
+              AND regexp_replace(p1.prosrc,'\t','','g') = regexp_replace(p2.prosrc,'\t','','g')
+              AND #{compare_columns_sql}}).nil?
+      end
+
+      def sp_exists?(name)
+        select_one("select proname, pronamespace, proowner, proargtypes, prosrc from pg_proc where pronamespace = 2200 and proname='#{name}'").present?
+      end
+
+      # drops all functions of that name, even if they are overloaded.
+      def sp_drop(name,oid=2200)
+        select_all("select proname, pronamespace, proargtypes from pg_proc where pronamespace = #{oid} and proname='#{name}'").each do |hash|
+          argtypes = hash["proargtypes"].split(' ').map {|val|convert_arg(val)}.join(",")
+          name_with_schema="#{namespace_for_oid(oid)}.#{name}"
+          execute("DROP FUNCTION IF EXISTS #{name_with_schema}(#{argtypes}) CASCADE")
+        end
+      end
+
+      def sp_clean(stored_procedures)
+        select_all("select proname, pronamespace, proowner, proargtypes, prosrc from pg_proc where proname like 'sp_%' and pronamespace = 2200").each do |results|
+          unless stored_procedures.include?( results['proname'] )
+            logger.info("\t DROPPING: #{results['proname']}")
+            sp_drop( results['proname'] )
+          end
+        end
+      end
+
+      def compare_columns_sql
+        pg_proc_columns.map {|col| "p1.#{col} IS NOT DISTINCT FROM p2.#{col}"}.join(" AND ")
+      end
+
+    end
+  end
+end

data/lib/synchronize_postgres_stored_procedures/stored_procedures.rb

@@ -0,0 +1,9 @@
+module SynchronizePostgresStoredProcedures
+  module StoredProcedures
+    require_relative 'stored_procedures/pg.rb'
+    require_relative 'stored_procedures/synchronizer.rb'
+    Dir[File.join(__dir__, 'stored_procedures', 'pg_*.rb')].each do |file|
+      require file
+    end
+  end
+end

data/lib/synchronize_postgres_stored_procedures/version.rb

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

data/lib/synchronize_postgres_stored_procedures.rb

@@ -0,0 +1,7 @@
+module SynchronizePostgresStoredProcedures
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks.rb"
+    end
+  end
+end

data/lib/tasks.rb

@@ -0,0 +1,12 @@
+require "synchronize_postgres_stored_procedures/version"
+require "synchronize_postgres_stored_procedures/stored_procedures.rb"
+
+namespace :db do
+  task :after_migrate do
+    SynchronizePostgresStoredProcedures::StoredProcedures::Pg.new.synchronize
+  end
+
+  Rake::Task["db:migrate"].enhance do
+    Rake::Task["db:after_migrate"].invoke
+  end
+end

data/sig/synchronize_postgres_stored_procedures.rbs

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

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: synchronize_postgres_stored_procedures
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rob mathews
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- rob@justsoftwareconsulting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/synchronize_postgres_stored_procedures.rb
+- lib/synchronize_postgres_stored_procedures/stored_procedures.rb
+- lib/synchronize_postgres_stored_procedures/stored_procedures/pg.rb
+- lib/synchronize_postgres_stored_procedures/stored_procedures/pg_11.rb
+- lib/synchronize_postgres_stored_procedures/stored_procedures/pg_12.rb
+- lib/synchronize_postgres_stored_procedures/stored_procedures/pg_9.rb
+- lib/synchronize_postgres_stored_procedures/stored_procedures/synchronizer.rb
+- lib/synchronize_postgres_stored_procedures/version.rb
+- lib/tasks.rb
+- sig/synchronize_postgres_stored_procedures.rbs
+homepage: https://github.com/robmathews/synchronize_postgres_stored_procedures
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/robmathews/synchronize_postgres_stored_procedures
+  source_code_uri: https://github.com/robmathews/synchronize_postgres_stored_procedures
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.10
+signing_key:
+specification_version: 4
+summary: Maintain your stored procedures in a single file per procedure, not spread
+  across multiple migrations
+test_files: []