pg_assets 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8cba0b518d1da36d660f56d1a21fc6e28f7b7a68
+  data.tar.gz: 3fb8db5ba3b1bd95d6768375eebc72b1bfe43f29
+SHA512:
+  metadata.gz: 03554c5b57a795eb147f83e74b727ff52230ba36d200f4ea5126dfc6207be5075753e2ebe8bb96cb5819110eae5ef6470e31e1e275782768cd8ac38b80433190
+  data.tar.gz: bfa495c49572b603a05b83cda31b9127c85e5a6c43348025731862be459a575b664cbc6e26ce0298da38bc257a512b27b7903a7a8080f450ef027df140a2748b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PgAssets'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/pg_assets/helpers/views_migration_helper.rb

@@ -0,0 +1,59 @@
+# This is to help you migrate things where there is a db dependency.
+#
+# Just include it in your migration, then pass your migration changes to it
+# in a block, like this:
+# in your migration like this
+#
+#
+#     class BringThePain < ActiveRecord::Migration
+#       include PGAssets::ViewsMigrationHelper
+#
+#       def change
+#         touching_view :a_view do
+#           change_column :sweet_table, :column_1, :text, :null => false
+#         end
+#       end
+#     end
+#
+# You may also want to re-define the view if, for instance, you drop a column
+#
+#     class BringThePain < ActiveRecord::Migration
+#       include PGAssets::ViewsMigrationHelper
+#
+#       def change
+#         new_defn = 'SELECT id, column_1, column_3 FROM sweet_table'
+#
+#         touching_view :a_view, new_defn do
+#           remove_column :sweet_table, :column_2
+#         end
+#       end
+#     end
+module PGAssets
+  module ViewsMigrationHelper
+    def touching_view(view_name, new_defn=nil, &proc)
+      view = ::PGAssets::Services::PGAssetManager.specific_view(view_name.to_sym)
+      view.remove
+
+      proc.call
+
+      if new_defn.nil?
+        view.reinstall
+      else
+        view.reinstall(defn=new_defn)
+      end
+    end
+
+    def touching_materialized_view(view_name, new_defn=nil, &proc)
+      matview = ::PGAssets::Services::PGAssetManager.specific_matview(view_name.to_sym)
+      matview.remove
+
+      proc.call
+
+      if new_defn.nil?
+        matview.reinstall
+      else
+        matview.reinstall(defn=new_defn)
+      end
+    end
+  end
+end

data/lib/pg_assets/models/concerns/loadable_asset.rb

@@ -0,0 +1,28 @@
+module PGAssets
+  module LoadableAsset
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :cached_defn
+
+      def self.readonly?
+        true
+      end
+
+      def remove
+        ActiveRecord::Base.connection.execute sql_for_remove
+      end
+
+      def reinstall(defn=sql_for_reinstall)
+        ActiveRecord::Base.connection.execute defn
+      end
+
+      private
+
+      def get_attribute_from_sql(sql, attribute)
+        res = ActiveRecord::Base.connection.execute sql
+        res.first[attribute.to_s]
+      end
+    end
+  end
+end

data/lib/pg_assets/models/pg_constraint.rb

@@ -0,0 +1,46 @@
+module PGAssets
+  class PGConstraint < ActiveRecord::Base
+    include LoadableAsset
+
+    self.table_name = 'pg_catalog.pg_constraint'
+
+    after_find do
+      self.cached_defn = get_constraint_defn
+    end
+
+    scope :ours, -> {
+      joins('JOIN pg_catalog.pg_namespace ON (pg_constraint.connamespace = pg_namespace.oid)').
+      where('pg_namespace.nspname NOT IN (?)', ['pg_catalog', 'information_schema']).
+      where('conrelid != 0')  #exclude non-table constraints.  Not sure what to do with domain constraints yet
+    }
+
+    def identity
+      "#{conname} on #{get_table_name}"
+    end
+
+    def sql_for_remove
+      sql = "ALTER TABLE #{get_table_name} DROP CONSTRAINT IF EXISTS #{conname}"
+    end
+
+    def sql_for_reinstall
+      sql = "ALTER TABLE #{get_table_name} ADD CONSTRAINT #{conname} #{cached_defn}"
+    end
+
+    private
+
+    def get_oid
+      sql = "SELECT oid FROM pg_catalog.pg_constraint WHERE conname = '#{conname}' AND connamespace = '#{connamespace}'"
+      get_attribute_from_sql sql, :oid
+    end
+
+    def get_table_name
+      sql = "SELECT relname FROM pg_catalog.pg_class WHERE oid = #{conrelid}"
+      get_attribute_from_sql sql, :relname
+    end
+
+    def get_constraint_defn
+      sql = "SELECT pg_get_constraintdef(#{get_oid}, true) AS constraintdef"
+      get_attribute_from_sql sql, :constraintdef
+    end
+  end
+end

data/lib/pg_assets/models/pg_function.rb

@@ -0,0 +1,46 @@
+module PGAssets
+  class PGFunction < ActiveRecord::Base
+    include LoadableAsset
+
+    self.table_name = 'pg_catalog.pg_proc'
+
+    after_find do
+      self.cached_defn = get_function_defn
+    end
+
+    scope :ours, -> {
+      joins('JOIN pg_catalog.pg_namespace ON (pg_proc.pronamespace = pg_namespace.oid)').
+      where('pg_namespace.nspname NOT IN (?)', ['pg_catalog', 'information_schema'])
+    }
+
+    def identity
+      proname
+    end
+
+    # TODO get this to work with bomboclaat schemas
+    def sql_for_remove
+      sql = "DROP FUNCTION IF EXISTS #{proname}(#{get_function_args})"
+    end
+
+    def sql_for_reinstall
+      cached_defn
+    end
+
+    private
+
+    def get_oid
+      sql = "SELECT oid FROM pg_catalog.pg_proc WHERE proname = '#{proname}' AND pronamespace = '#{pronamespace}'"
+      get_attribute_from_sql sql, :oid
+    end
+
+    def get_function_defn
+      sql = "SELECT pg_get_functiondef(#{get_oid}) AS functiondef"
+      get_attribute_from_sql sql, :functiondef
+    end
+
+    def get_function_args
+      sql = "SELECT pg_get_function_identity_arguments(#{get_oid}) AS functionargs"
+      get_attribute_from_sql sql, :functionargs
+    end
+  end
+end

data/lib/pg_assets/models/pg_mat_view.rb

@@ -0,0 +1,29 @@
+module PGAssets
+  class PGMatView < ActiveRecord::Base
+    include LoadableAsset
+
+    self.table_name = 'pg_catalog.pg_matviews'
+
+    after_find do
+      self.cached_defn = definition
+    end
+
+    scope :ours, -> { where.not(schemaname: ['pg_catalog', 'information_schema']) }
+
+    def self.by_name(name)
+      where(matviewname: name.to_s)
+    end
+
+    def identity
+      schemaname + '.' + matviewname
+    end
+
+    def sql_for_remove
+      sql = "DROP MATERIALIZED VIEW IF EXISTS #{schemaname}.#{matviewname}"
+    end
+
+    def sql_for_reinstall(defn=cached_defn)
+      sql = "CREATE MATERIALIZED VIEW #{schemaname}.#{matviewname} AS #{defn}"
+    end
+  end
+end

data/lib/pg_assets/models/pg_trigger.rb

@@ -0,0 +1,46 @@
+module PGAssets
+  class PGTrigger < ActiveRecord::Base
+    include LoadableAsset
+
+    attr_accessor :trigger_table_name
+
+    self.table_name = 'pg_catalog.pg_trigger'
+
+    after_find do
+      self.cached_defn = get_trigger_defn
+    end
+
+    # this is wrong.  this should join on pg_class to get the table, and then
+    # pg_schema to get the schema, and then exclude those other schemas
+    scope :ours, -> { where(tgisinternal: false) }
+
+    def identity
+      "#{tgname} ON #{get_trigger_table_name}"
+    end
+
+    def sql_for_remove
+      sql = "DROP TRIGGER IF EXISTS #{tgname} ON #{get_trigger_table_name}"
+    end
+
+    def sql_for_reinstall
+      sql = cached_defn
+    end
+
+    private
+
+    def get_trigger_table_name
+      sql = "SELECT relname AS name FROM pg_class WHERE oid = #{tgrelid}"
+      get_attribute_from_sql sql, :name
+    end
+
+    def get_oid
+      sql = "SELECT oid FROM pg_catalog.pg_trigger WHERE tgrelid = #{tgrelid} AND tgname = '#{tgname}'"
+      get_attribute_from_sql sql, :oid
+    end
+
+    def get_trigger_defn
+      sql = "SELECT pg_get_triggerdef(#{get_oid}, true) AS triggerdef"
+      get_attribute_from_sql sql, :triggerdef
+    end
+  end
+end

data/lib/pg_assets/models/pg_view.rb

@@ -0,0 +1,29 @@
+module PGAssets
+  class PGView < ActiveRecord::Base
+    include LoadableAsset
+
+    self.table_name = 'pg_catalog.pg_views'
+
+    after_find do
+      self.cached_defn = definition
+    end
+
+    scope :ours, -> { where.not(schemaname: ['pg_catalog', 'information_schema']) }
+
+    def self.by_name(name)
+      where(viewname: name.to_s)
+    end
+
+    def identity
+      schemaname + '.' + viewname
+    end
+
+    def sql_for_remove
+      sql = "DROP VIEW IF EXISTS #{schemaname}.#{viewname}"
+    end
+
+    def sql_for_reinstall(defn=cached_defn)
+      sql = "CREATE OR REPLACE VIEW #{schemaname}.#{viewname} AS #{defn}"
+    end
+  end
+end

data/lib/pg_assets/railtie.rb

@@ -0,0 +1,29 @@
+require 'pg_assets'
+require 'rails'
+
+module PgAssets
+  class Railtie < Rails::Railtie
+    railtie_name :pg_assets
+
+    UNREGISTERED_TYPES = {
+      regproc: 'text',
+      pg_node_tree: 'text',
+      aclitem: 'text'
+    }
+
+    rake_tasks do
+      load '../../tasks/pg_assets.rake'
+    end
+
+    # some of the column types in the pg_catalog views are not registered.
+    # We don't really need them, but we'll register them so we don't get ugly
+    # error messages
+    initializer 'pg_assets.register_types' do
+      UNREGISTERED_TYPES.each_pair do |pgtype, aliastype|
+        unless ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::OID.registered_type?(pgtype)
+          ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::OID.alias_type(pgtype.to_s, aliastype)
+        end
+      end
+    end
+  end
+end

data/lib/pg_assets/services/pg_asset_manager.rb

@@ -0,0 +1,100 @@
+module PGAssets
+  module Services
+    class PGAssetManager
+
+      def self.views
+        PGView.ours.to_a.sort_by { |v| v.identity }
+      end
+
+      def self.specific_view(name)
+        PGView.ours.by_name(name).first
+      end
+
+      def self.matviews
+        PGMatView.ours.to_a.sort_by { |v| v.identity }
+      end
+
+      def self.specific_matview(name)
+        PGMatView.ours.by_name(name).first
+      end
+
+      def self.triggers
+        PGTrigger.ours.to_a.sort_by { |t| t.identity }
+      end
+
+      def self.functions
+        PGFunction.ours.to_a.sort_by { |f| f.identity }
+      end
+
+      def self.constraints
+        PGConstraint.ours.to_a.sort_by { |f| f.identity }
+      end
+
+      def self.assets_dump
+        newline = "\n"
+        assets = ''
+
+        assets << '------------------------------ PG ASSETS ------------------------------' + newline
+        assets << '--  BRO, DON\'T MODIFY THIS DIRECTLY' + newline
+        assets << '--  IF YOU MODIFY THIS DIRECTLY,' + newline
+        assets << '--  YOU\'RE GONNA HAVE A BAD TIME' + newline
+        assets << '-----------------------------------------------------------------------' + newline
+
+        views.each do |v|
+          assets << newline
+          assets << newline
+          assets << '-----------------------------------------------------------------------' + newline
+          assets << '---------- VIEW: ' + v.identity + newline
+          assets << '-----------------------------------------------------------------------' + newline
+          assets << v.sql_for_reinstall
+        end
+
+        matviews.each do |mv|
+          assets << newline
+          assets << newline
+          assets << '-----------------------------------------------------------------------' + newline
+          assets << '---------- MATERIALIZED VIEW: ' + mv.identity + newline
+          assets << '-----------------------------------------------------------------------' + newline
+          assets << mv.sql_for_reinstall
+        end
+
+        functions.each do |f|
+          assets << newline
+          assets << newline
+          assets << '-----------------------------------------------------------------------' + newline
+          assets << '---------- FUNCTION: ' + f.identity + newline
+          assets << '-----------------------------------------------------------------------' + newline
+          assets << f.sql_for_reinstall + ';' + newline
+        end
+
+        triggers.each do |t|
+          assets << newline
+          assets << newline
+          assets << '-----------------------------------------------------------------------' + newline
+          assets << '---------- TRIGGER: ' + t.identity + newline
+          assets << '-----------------------------------------------------------------------' + newline
+          assets << t.sql_for_remove + ';' + newline
+          assets << newline
+          assets << t.sql_for_reinstall + ';' + newline
+        end
+
+        constraints.each do |c|
+          assets << newline
+          assets << newline
+          assets << '-----------------------------------------------------------------------' + newline
+          assets << '---------- CONSTRAINT: ' + c.identity + newline
+          assets << '-----------------------------------------------------------------------' + newline
+          assets << c.sql_for_reinstall + ';' + newline
+        end
+
+        assets
+      end
+
+      def self.assets_load(assets)
+        ActiveRecord::Base.transaction do
+          ActiveRecord::Base.connection.execute assets
+        end
+      end
+    end
+  end
+end

data/lib/pg_assets/version.rb

@@ -0,0 +1,3 @@
+module PgAssets
+  VERSION = "1.0"
+end

data/lib/pg_assets.rb

@@ -0,0 +1,15 @@
+require 'pg'
+
+require File.expand_path('../pg_assets/models/concerns/loadable_asset', __FILE__)
+require File.expand_path('../pg_assets/models/pg_constraint', __FILE__)
+require File.expand_path('../pg_assets/models/pg_trigger', __FILE__)
+require File.expand_path('../pg_assets/models/pg_mat_view', __FILE__)
+require File.expand_path('../pg_assets/models/pg_view', __FILE__)
+require File.expand_path('../pg_assets/models/pg_function', __FILE__)
+require File.expand_path('../pg_assets/services/pg_asset_manager', __FILE__)
+require File.expand_path('../pg_assets/helpers/views_migration_helper', __FILE__)
+require File.expand_path('../pg_assets/version', __FILE__)
+
+module PgAssets
+  require 'pg_assets/railtie' if defined?(Rails)
+end

data/test/assets/constraint_check.sql

@@ -0,0 +1,4 @@
+CREATE TABLE table_with_check_constraint (
+  test integer CHECK (test > 0),
+  test2 text
+);

data/test/assets/constraint_multiple.sql

@@ -0,0 +1,5 @@
+CREATE TABLE table_with_multiple_constraint (
+  test integer CHECK (test > 1),
+    CHECK (test < 2),
+  test2 text UNIQUE NOT NULL
+);

data/test/assets/constraint_unique.sql

@@ -0,0 +1,4 @@
+CREATE TABLE table_with_unique_constraint (
+  test integer UNIQUE,
+  test2 text
+);

data/test/assets/function1.sql

@@ -0,0 +1,5 @@
+CREATE OR REPLACE FUNCTION function1() RETURNS text AS $$
+        BEGIN
+                RETURN 'so simple';
+        END;
+$$ LANGUAGE plpgsql;

data/test/assets/function2.sql

@@ -0,0 +1,5 @@
+CREATE OR REPLACE FUNCTION function2(integer, text, integer) RETURNS text AS $$
+        BEGIN
+                RETURN 'not so simple';
+        END;
+$$ LANGUAGE plpgsql;

data/test/assets/materialized_view_with_table.sql

@@ -0,0 +1,7 @@
+CREATE TABLE table_for_view (
+  test integer,
+  test2 text
+);
+
+CREATE MATERIALIZED VIEW matview_from_table AS
+  SELECT test, test2 FROM table_for_view;

data/test/assets/matview1.sql

@@ -0,0 +1,2 @@
+CREATE MATERIALIZED VIEW matview1 AS
+  SELECT 1;

data/test/assets/matview2.sql

@@ -0,0 +1,2 @@
+CREATE MATERIALIZED VIEW matview2 AS
+  SELECT 1;

data/test/assets/trigger1.sql

@@ -0,0 +1,12 @@
+CREATE TABLE test (
+  test text
+);
+
+CREATE OR REPLACE FUNCTION womp() RETURNS trigger AS $$
+        BEGIN
+                RETURN NEW;
+        END;
+$$ LANGUAGE plpgsql;
+
+CREATE TRIGGER trigger1 BEFORE INSERT OR UPDATE ON test
+    FOR EACH ROW EXECUTE PROCEDURE womp();

data/test/assets/trigger2.sql

@@ -0,0 +1,12 @@
+CREATE TABLE test2 (
+  test text
+);
+
+CREATE OR REPLACE FUNCTION womp2() RETURNS trigger AS $$
+        BEGIN
+                RETURN NEW;
+        END;
+$$ LANGUAGE plpgsql;
+
+CREATE TRIGGER trigger2 BEFORE INSERT OR UPDATE ON test2
+    FOR EACH ROW EXECUTE PROCEDURE womp2();

data/test/assets/view1.sql

@@ -0,0 +1,2 @@
+CREATE OR REPLACE VIEW view1 AS
+  SELECT 1;

data/test/assets/view2.sql

@@ -0,0 +1,2 @@
+CREATE OR REPLACE VIEW view2 AS
+  SELECT 1;

data/test/assets/view_with_table.sql

@@ -0,0 +1,7 @@
+CREATE TABLE table_for_view (
+  test integer,
+  test2 text
+);
+
+CREATE OR REPLACE VIEW view_from_table AS
+  SELECT test, test2 FROM table_for_view;

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end