viewy 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4edfe32f3664cfbed4af1113853229bdf49a4fe6
-  data.tar.gz: 059ab8cabc83a216c16d3a4448df2446da678b92
+  metadata.gz: c1796596ee3676d14308739bce83b2578bf45c96
+  data.tar.gz: 4f2a4a1c577ca5e08dd0f79aacdbdcb34c09c221
 SHA512:
-  metadata.gz: 3f69525541b993729623b09a2fa9b8173f905ab6877add2b46094ed5e6d780a083c5bc0477c41039c5e11b57a4fe697bbe6f226d0d6ad0cd08ec141487a59223
-  data.tar.gz: 08a5cf414e622398d2e6049e139971e885455acf0ca0db1980e6da555cc317b63d1a17b1ae2319a28b72763d9c80477d2ef0a4d449aa3c48dd3f07577657dcdb
+  metadata.gz: 6c98415f23bbbf74f7235b97fcf906a0d2c9e9196f4e410a4be84052879ef651e287eab3743589159460c9f6591b06527bb9b4e99be444f5d5dca4230dd6d90b
+  data.tar.gz: 32b3c33a89c6e462d65a9b131f9bb8bccab58b82f21e55bdf118b08ea82defce73b4e6eaced63855bbc498eea4f1a3450363d4d00f793b44571a7ff83ef8c726

data/Rakefile

@@ -18,6 +18,15 @@ APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
 
+load 'rails/tasks/statistics.rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
 
 Bundler::GemHelper.install_tasks
 

data/db/migrate/20150929144540_add_view_replace_function.rb

@@ -0,0 +1,75 @@
+class AddViewReplaceFunction < ActiveRecord::Migration
+  def up
+    function_sql = <<-SQL
+      CREATE OR REPLACE FUNCTION replace_view(view_name TEXT, new_sql TEXT) RETURNS VOID AS $$
+          DECLARE
+            ordered_oids INTEGER[] := ARRAY(
+              SELECT oid FROM
+              (
+                WITH RECURSIVE dependency_graph(oid, depth, path, cycle) AS (
+                  SELECT oid, 1, ARRAY[oid], FALSE
+                  FROM pg_class
+                  WHERE relname = view_name
+                UNION
+                  SELECT
+                    rewrites.ev_class,
+                    dg.depth + 1,
+                    dg.path || rewrites.ev_class,
+                    rewrites.ev_class = ANY(dg.path)
+                  FROM dependency_graph dg
+                    JOIN pg_depend dependents ON dependents.refobjid = dg.oid
+                    JOIN pg_rewrite rewrites ON rewrites.oid = dependents.objid
+                  WHERE NOT dg.cycle
+                )
+                SELECT dependency_graph.OID, MIN(depth) AS min_depth FROM dependency_graph GROUP BY dependency_graph.OID ORDER BY min_depth
+              ) ordered_dependents
+            );
+            create_statements TEXT[] := '{}';
+            current_statement TEXT;
+            view_drop_statement TEXT;
+            object_id INT;
+          BEGIN
+            FOREACH object_id IN ARRAY ordered_oids LOOP
+              SELECT
+                 (CASE
+                    WHEN (SELECT TRUE FROM pg_views WHERE viewname = relname) THEN
+                      'CREATE OR REPLACE VIEW ' || pg_class.relname || ' AS ' || pg_get_viewdef(oid)
+                    WHEN (SELECT TRUE FROM pg_matviews WHERE matviewname = relname) THEN
+                      'CREATE MATERIALIZED VIEW ' || pg_class.relname || ' AS ' || pg_get_viewdef(oid)
+                  END)
+              INTO current_statement
+              FROM pg_class
+              WHERE oid = object_id
+                    AND pg_class.relname != view_name;
+              IF current_statement IS NOT NULL THEN
+                create_statements = create_statements || current_statement;
+              END IF;
+            END LOOP;
+            SELECT
+              (
+                CASE
+                  WHEN (SELECT TRUE FROM pg_views WHERE viewname = view_name) THEN
+                    'DROP VIEW ' || view_name || ' CASCADE;'
+                  WHEN (SELECT TRUE FROM pg_matviews WHERE matviewname = view_name) THEN
+                    'DROP MATERIALIZED VIEW ' || view_name || ' CASCADE;'
+                END
+              )
+            INTO view_drop_statement;
+            EXECUTE view_drop_statement;
+            EXECUTE new_sql;
+            FOREACH current_statement IN ARRAY create_statements LOOP
+              EXECUTE current_statement;
+            END LOOP;
+          END;
+      $$ LANGUAGE plpgsql;
+    SQL
+    execute function_sql
+  end
+
+  def down
+    function_drop_sql = <<-SQL
+      DROP FUNCTION replace_view(view_name TEXT, new_sql TEXT);
+    SQL
+    execute function_drop_sql
+  end
+end

data/db/migrate/20150929205301_add_view_dependencies.rb

@@ -0,0 +1,80 @@
+class AddViewDependencies < ActiveRecord::Migration
+  def up
+    view_dependency_function_sql = <<-SQL
+      CREATE OR REPLACE FUNCTION view_dependencies(materialized_view NAME)
+        RETURNS NAME[]
+      AS $$
+        WITH RECURSIVE dependency_graph(oid, depth, path, cycle) AS (
+          SELECT oid, 1, ARRAY[oid], FALSE
+          FROM pg_class
+          WHERE relname = materialized_view
+          UNION
+          SELECT
+            dependents.refobjid,
+            dg.depth + 1,
+            dg.path || dependents.refobjid,
+            dependents.refobjid = ANY(dg.path)
+          FROM dependency_graph dg
+            JOIN pg_rewrite rewrites ON rewrites.ev_class = dg.oid
+            JOIN pg_depend dependents ON dependents.objid = rewrites.oid
+          WHERE NOT dg.cycle
+        ), dependencies AS(
+            SELECT
+              (SELECT relname FROM pg_class WHERE pg_class.OID = dependency_graph.oid) AS view_name,
+              dependency_graph.OID,
+              MIN(depth) AS min_depth
+            FROM dependency_graph
+            GROUP BY dependency_graph.OID ORDER BY min_depth
+        )
+        SELECT ARRAY(SELECT dependencies.view_name FROM
+          dependencies
+          JOIN pg_matviews ON pg_matviews.matviewname = dependencies.view_name
+        WHERE dependencies.view_name != materialized_view)
+        ;
+      $$ LANGUAGE SQL;
+    SQL
+    execute view_dependency_function_sql
+
+    dependency_sql = <<-SQL
+      CREATE MATERIALIZED VIEW materialized_view_dependencies AS
+        WITH normal_view_dependencies AS (
+          SELECT viewname AS view_name, view_dependencies(viewname) FROM pg_views
+        )
+          SELECT matviewname AS view_name, view_dependencies(matviewname), TRUE AS materialized_view FROM pg_matviews WHERE matviewname != 'materialized_view_dependencies'
+        UNION
+          SELECT normal_view_dependencies.*, FALSE AS materialized_view FROM normal_view_dependencies WHERE array_length(normal_view_dependencies.view_dependencies, 1) > 0;
+      ;
+    SQL
+    execute dependency_sql
+
+    trigger_sql = <<-SQL
+      CREATE OR REPLACE FUNCTION refresh_materialized_view_dependencies() RETURNS EVENT_TRIGGER AS $$
+        DECLARE
+          view_exists BOOLEAN := (SELECT TRUE FROM pg_class WHERE pg_class.relname = 'materialized_view_dependencies' AND pg_class.relkind = 'm');
+        BEGIN
+          RAISE NOTICE 'refreshing view dependency hierarchy';
+          IF view_exists THEN
+            REFRESH MATERIALIZED VIEW materialized_view_dependencies;
+          END IF;
+        END
+      $$ LANGUAGE  plpgsql;
+
+      CREATE EVENT TRIGGER view_dependencies_update
+        ON DDL_COMMAND_END
+        WHEN TAG IN ('DROP VIEW', 'DROP MATERIALIZED VIEW', 'CREATE VIEW', 'CREATE MATERIALIZED VIEW', 'ALTER VIEW', 'ALTER MATERIALIZED VIEW')
+        EXECUTE PROCEDURE refresh_materialized_view_dependencies();
+    SQL
+
+    execute trigger_sql
+  end
+
+  def down
+    down_sql = <<-SQL
+      DROP MATERIALIZED VIEW materialized_view_dependencies;
+      DROP FUNCTION view_dependencies(materialized_view NAME);
+      DROP EVENT TRIGGER view_dependencies_update;
+      DROP FUNCTION refresh_materialized_view_dependencies();
+    SQL
+    execute down_sql
+  end
+end

data/lib/viewy/acts_as_materialized_view.rb

@@ -0,0 +1,32 @@
+module Viewy
+  # Provides a wrapper for materialized views that allows them and their dependencies to be refreshed easily
+  module ActsAsMaterializedView
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Refreshes this view and all materialized views it depends on.
+      # NOTE: the look-up for dependencies can take a second to run.
+      #
+      # @raise [ActiveRecord::RecordNotFoundError] raised when the view #refresh! is called on does not exist
+      # @raise [ActiveRecord::StatementInvalidError] raised if a dependent view is somehow not refreshed correctly
+      #
+      # @return [PG::Result] the result of the refresh statement on the materialized view
+      def refresh!
+        view_dep = Viewy::Models::MaterializedViewDependency.find(table_name)
+        view_dep.view_dependencies.each do |view_dependency|
+          connection.execute("REFRESH MATERIALIZED VIEW #{view_dependency}")
+        end
+        refresh_without_dependencies!
+      end
+
+      # Refreshes this view without refreshing any dependencies
+      #
+      # @raise [ActiveRecord::StatementInvalidError] raised if a dependent view is somehow not refreshed correctly
+      #
+      # @return [PG::Result] the result of the refresh statement on the materialized view
+      def refresh_without_dependencies!
+        connection.execute("REFRESH MATERIALIZED VIEW #{table_name}")
+      end
+    end
+  end
+end

data/lib/viewy/acts_as_view.rb

@@ -0,0 +1,22 @@
+module Viewy
+  # Provides a wrapper for SQL views that allows them and their materialized dependencies to be refreshed easily
+  module ActsAsView
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Refreshes this view and all materialized views it depends on.
+      # NOTE: the look-up for dependencies can take a second to run.
+      #
+      # @raise [ActiveRecord::RecordNotFoundError] raised when the view #refresh! is called on does not exist
+      # @raise [ActiveRecord::StatementInvalidError] raised if a dependent view is somehow not refreshed correctly
+      #
+      # @return [nil]
+      def refresh!
+        view_dep = Viewy::Models::MaterializedViewDependency.find(table_name)
+        view_dep.view_dependencies.each do |view_dependency|
+          connection.execute("REFRESH MATERIALIZED VIEW #{view_dependency}")
+        end
+      end
+    end
+  end
+end

data/lib/viewy/dependency_manager.rb

@@ -0,0 +1,50 @@
+require 'tsort'
+
+module Viewy
+  class DependencyManager
+    include TSort
+
+    def initialize
+      connection.execute(refresh_sql('materialized_view_dependencies'))
+    end
+
+    def connection
+      ActiveRecord::Base.connection
+    end
+
+    def refresh_all_materialized_views
+      ordered_views.each do |view_name|
+        connection.execute(refresh_sql(view_name))
+      end
+    end
+
+    private def views
+      @views ||= generate_view_hash
+    end
+
+    private def generate_view_hash
+      views = Viewy::Models::MaterializedViewDependency.all.select(&:materialized_view).map do |dep|
+        [dep.view_name, dep.view_dependencies]
+      end
+      Hash[views]
+    end
+
+    private def tsort_each_node
+      views.each_key do |view|
+        yield view
+      end
+    end
+
+    private def tsort_each_child(view, &block)
+      views[view].each(&block)
+    end
+
+    private def refresh_sql(name)
+      <<-SQL.strip
+        REFRESH MATERIALIZED VIEW #{name}
+      SQL
+    end
+
+    alias_method :ordered_views, :tsort
+  end
+end

data/lib/viewy/engine.rb

@@ -1,5 +1,13 @@
 module Viewy
   class Engine < ::Rails::Engine
     isolate_namespace Viewy
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |path|
+          app.config.paths["db/migrate"] << path
+        end
+      end
+    end
   end
 end

data/lib/viewy/materialized_views.rb

@@ -0,0 +1,7 @@
+require_relative 'materialized_views/dependency_list'
+
+module Viewy
+  module MaterializedViews
+
+  end
+end

data/lib/viewy/models/materialized_view_dependency.rb

@@ -0,0 +1,11 @@
+module Viewy
+  module Models
+    # Provides a means of accessing information about view dependencies from within a Rails app.
+    # The foreign key of the dependency information table is the name of the view that a user needs
+    # dependency information about.
+    class MaterializedViewDependency < ActiveRecord::Base
+      self.table_name = 'materialized_view_dependencies'
+      self.primary_key = 'view_name'
+    end
+  end
+end

data/lib/viewy/models.rb

@@ -0,0 +1,7 @@
+require_relative 'models/materialized_view_dependency'
+
+module Viewy
+  # The models namespace for viewy
+  module Models
+  end
+end

data/lib/viewy/version.rb

@@ -1,3 +1,3 @@
 module Viewy
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/lib/viewy.rb

@@ -1,4 +1,8 @@
-require "viewy/engine"
+require 'viewy/engine'
+require 'viewy/models'
+require 'viewy/acts_as_view'
+require 'viewy/acts_as_materialized_view'
+require 'viewy/dependency_manager'
 
 module Viewy
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: viewy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Emerson Huitt
@@ -74,15 +74,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
 - README.rdoc
 - Rakefile
 - config/routes.rb
+- db/migrate/20150929144540_add_view_replace_function.rb
+- db/migrate/20150929205301_add_view_dependencies.rb
 - lib/tasks/viewy_tasks.rake
 - lib/viewy.rb
+- lib/viewy/acts_as_materialized_view.rb
+- lib/viewy/acts_as_view.rb
+- lib/viewy/dependency_manager.rb
 - lib/viewy/engine.rb
+- lib/viewy/materialized_views.rb
+- lib/viewy/models.rb
+- lib/viewy/models/materialized_view_dependency.rb
 - lib/viewy/version.rb
-homepage: https://github.com/SciMed/viewy
+homepage: http://www.scimedsolutions.com
 licenses:
 - MIT
 metadata: {}

data/LICENSE

@@ -1,20 +0,0 @@
-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.