viewy 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1796596ee3676d14308739bce83b2578bf45c96
-  data.tar.gz: 4f2a4a1c577ca5e08dd0f79aacdbdcb34c09c221
+  metadata.gz: f7fd8d70558ffa6fe9bc84f9350d7920caf13d96
+  data.tar.gz: c2a3c6b8a585610a7fd02b638a559ef93b75b689
 SHA512:
-  metadata.gz: 6c98415f23bbbf74f7235b97fcf906a0d2c9e9196f4e410a4be84052879ef651e287eab3743589159460c9f6591b06527bb9b4e99be444f5d5dca4230dd6d90b
-  data.tar.gz: 32b3c33a89c6e462d65a9b131f9bb8bccab58b82f21e55bdf118b08ea82defce73b4e6eaced63855bbc498eea4f1a3450363d4d00f793b44571a7ff83ef8c726
+  metadata.gz: 09cc98dd4ca4bcd07a3218c21444e2c86ba60977f3f8043992130506d7a778770ee2b0484a2cf6ebd2c43752df4ca2a3813dbf35318e1996eb76c0ff2eb1447b
+  data.tar.gz: 2a74e4c34a3131aa729e170ea07f352f5d15ef3b667445f2cf3a20b275f70a330d45f7e70d0e8e01c14c69df67bde13df6622813ff480e2214f82973e087f923

data/lib/viewy.rb

@@ -2,6 +2,7 @@ require 'viewy/engine'
 require 'viewy/models'
 require 'viewy/acts_as_view'
 require 'viewy/acts_as_materialized_view'
+require 'viewy/dependency_management'
 require 'viewy/dependency_manager'
 
 module Viewy

data/lib/viewy/acts_as_materialized_view.rb

@@ -14,7 +14,7 @@ module Viewy
       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}")
+          ActiveRecord::Base.connection.execute("REFRESH MATERIALIZED VIEW #{view_dependency}")
         end
         refresh_without_dependencies!
       end
@@ -25,7 +25,7 @@ module Viewy
       #
       # @return [PG::Result] the result of the refresh statement on the materialized view
       def refresh_without_dependencies!
-        connection.execute("REFRESH MATERIALIZED VIEW #{table_name}")
+        ActiveRecord::Base.connection.execute("REFRESH MATERIALIZED VIEW #{table_name}")
       end
     end
   end

data/lib/viewy/acts_as_view.rb

@@ -14,7 +14,7 @@ module Viewy
       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}")
+          ActiveRecord::Base.connection.execute("REFRESH MATERIALIZED VIEW #{view_dependency}")
         end
       end
     end

data/lib/viewy/dependency_management.rb

@@ -0,0 +1,7 @@
+require_relative 'dependency_management/view_refresher'
+
+module Viewy
+  module DependencyManagement
+
+  end
+end

data/lib/viewy/dependency_management/view_refresher.rb

@@ -0,0 +1,72 @@
+require 'tsort'
+
+module Viewy
+  module DependencyManagement
+    # Provides a means of refreshing materialized views in the order in which they were created
+    #
+    # @!attribute connection [r]
+    #   @return [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] the underlying Postgres connection
+    class ViewRefresher
+      include TSort
+
+      attr_reader :connection
+
+      alias_method :ordered_views, :tsort
+      private :tsort, :ordered_views
+
+      # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] An ActiveRecord connection
+      #   to a Postgres Database
+      def initialize(connection)
+        @connection = connection
+      end
+
+      # This method will refresh all materialized views in order of dependency
+      def refresh_all_materialized_views
+        ordered_views.each do |view_name|
+          refresh_materialized_view(view_name)
+        end
+      end
+
+      # Refreshes a single materialized view
+      #
+      # @param view_name [String] the name of a materialized view
+      def refresh_materialized_view(view_name)
+        connection.execute(refresh_sql(view_name))
+      end
+
+      # Note: this method memoizes the result of the first call
+      #
+      # @return [Hash] a hash with materialized view names as keys and their dependencies as an array of names
+      private def views
+        @views ||= generate_view_hash
+      end
+
+      # @return [Hash] a hash with materialized view names as keys and their dependencies as an array of names
+      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
+
+      # @param name [String] the name of a materialized view
+      private def tsort_each_child(view, &block)
+        views[view].each(&block)
+      end
+
+      # @param name [String] the name of a materialized view
+      # @return [String] the SQL statement needed to refresh the passed view
+      def refresh_sql(name)
+        <<-SQL.strip
+          REFRESH MATERIALIZED VIEW #{name}
+        SQL
+      end
+    end
+  end
+end

data/lib/viewy/dependency_manager.rb

@@ -1,50 +1,50 @@
-require 'tsort'
-
 module Viewy
+  # Provides an interface for managing the dependencies of views within the application.
+  #
+  # NOTE: the dependencies view is refreshed when an instance is initialized and this can take a little while to run.
   class DependencyManager
-    include TSort
-
+    # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] An ActiveRecord connection
+    #   to a Postgres Database
     def initialize
-      connection.execute(refresh_sql('materialized_view_dependencies'))
-    end
-
-    def connection
-      ActiveRecord::Base.connection
+      view_refresher.refresh_materialized_view('materialized_view_dependencies')
     end
 
+    # This method will refresh all materialized views in order of dependency
+    #
+    # @raise [ActiveRecord::StatementInvalidError] raised if a view is somehow not refreshed correctly
     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
+      view_refresher.refresh_all_materialized_views
+    end
+
+    # Replaces the named view (or materialized view) with the new definition SQL.
+    # This will do the following
+    #
+    #   1. drop all view which depend on the view being replaced
+    #   2. drop the view being replaced
+    #   3. recreate the view with the passed sql
+    #   4. re-create all of the views which depended on the replaced view
+    #
+    # NOTE: this is provided as a convenience for managing dependencies, and the user should not expect that the
+    # re-created views will function if they rely on parts of the replaced view that are removed.
+    #
+    # @param view_name [String] the name of the view being replaced
+    # @param new_definition_sql [String] the SQL definition of the new view
+    #
+    # @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 replace_view(view_name, new_definition_sql)
+      connection.execute("SELECT replace_view('#{view_name}', $$#{new_definition_sql}$$)")
+    end
+
+    # @return [Viewy::DependencyManagement::ViewRefresher] a memoized view refresher object
+    private def view_refresher
+      @view_refresher ||= Viewy::DependencyManagement::ViewRefresher.new(connection)
+    end
+
+    # @return [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] An ActiveRecord connection
+    #   to a Postgres Database
+    private def connection
+      ActiveRecord::Base.connection
     end
-
-    alias_method :ordered_views, :tsort
   end
 end

data/lib/viewy/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: viewy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Emerson Huitt
@@ -83,6 +83,8 @@ files:
 - lib/viewy.rb
 - lib/viewy/acts_as_materialized_view.rb
 - lib/viewy/acts_as_view.rb
+- lib/viewy/dependency_management.rb
+- lib/viewy/dependency_management/view_refresher.rb
 - lib/viewy/dependency_manager.rb
 - lib/viewy/engine.rb
 - lib/viewy/materialized_views.rb