scenic-cascade 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d210342197b949abc4156e8fcdc63ad74b04f1fde40fb207e35dc15b13e1efd
-  data.tar.gz: 60c19c6113bc29ebc57c068ef16d744661f33f9bdd06a763807b807e41d3f66f
+  metadata.gz: 29ecc270cd637c5654557c3d349c43a59483476d7a0758a3988136d4c3fa4a28
+  data.tar.gz: b53b4f0a78d929753627aabcab2dbf75c6e6aad79fe5ee6a77b5a1b45b9b9af0
 SHA512:
-  metadata.gz: 9040765c0fdadb9778139f634883a09466ddf80d8b63bf28c8b358150e0d4e6eb45556bb3d926c9e458c7e3fd8bf9deb7b8863d6a80694163f6b73643654ee09
-  data.tar.gz: 05ea8516e444b9c07cba0a8813af3985295897ce11c90790ca407eb5aa81d5d250e937d334269f5b87c797ee932a2ae7e1e09cff92d82c9a7041f89c35cbd06e
+  metadata.gz: 642f9d3a40bf02b8da393a10e645c7609e5562652654c016ad27a6806b86d8bbf4f98ffd4e1554ef4fca5a60dab878badf298bbc0200b38ae1aa16c0baccddf3
+  data.tar.gz: b95a92d620f673192b07e82de00151e4e251e1ecaeb13c24df4c6fa85670a71093b04a2d0d44dde9b86bf7e066dc112689292b808eabe27e3549dddea849c134

data/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.ht
 
 ## [Unreleased]
 
+## [0.1.3] - 2026-11-01
+
+### Fixed
+
+- Recreate dependent views when generating a migration with a Rails table name prefix.
+- Discover and recreate dependent views across PostgreSQL schemas without mixing identically named views or their SQL definitions.
+- Remove generated view definitions and partial migrations when migration generation fails, so retries use the correct version.
+- Apply `--replace` and supported `--side-by-side` options when generating view update migrations.
+- Avoid leaving an orphan SQL definition when `--skip` skips a conflicting migration.
+
 ## [0.1.2] - 2026-11-01
 
 ### Fixed
@@ -27,7 +37,8 @@ and this project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.ht
 
 - Initial release of the cascading Scenic view migration generator.
 
-[Unreleased]: https://github.com/akiomik/scenic-cascade/compare/v0.1.2...HEAD
+[Unreleased]: https://github.com/akiomik/scenic-cascade/compare/v0.1.3...HEAD
+[0.1.3]: https://github.com/akiomik/scenic-cascade/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/akiomik/scenic-cascade/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/akiomik/scenic-cascade/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/akiomik/scenic-cascade/releases/tag/v0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scenic-cascade (0.1.2)
+    scenic-cascade (0.1.3)
       scenic (~> 1.0)
 
 GEM

data/README.md

@@ -37,6 +37,12 @@ $ bin/rails generate scenic:view:cascade search_results
       create db/migrate/20220714233704_create_search_results.rb
 ```
 
+For a schema-qualified view, pass its database relation name, such as `reporting.orders`.
+If Rails uses a table name prefix, include it after the schema name (for example, `reporting.app_orders`).
+For unqualified names, pass the name without the prefix; Rails applies it in the migration.
+If another schema precedes `public` in PostgreSQL's `search_path` and contains a view with the same name,
+use a schema-qualified Scenic definition for the public dependent view (for example, `public_reports_v01.sql`).
+
 ## How it works
 
 Consider a situation where the following three views exist:

data/codecov.yml

@@ -0,0 +1,3 @@
+# Release version changes are metadata and do not exercise application behavior.
+ignore:
+  - '^lib/scenic/cascade/version\.rb$'

data/lib/generators/scenic/view/cascade/cascade_generator.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'erb'
 require 'generators/scenic/view/view_generator'
 require 'scenic/cascade'
 require 'scenic/cascade/view_with_version'
@@ -12,27 +13,83 @@ module Scenic
         source_root File.expand_path('templates', __dir__ || '.')
 
         def create_view_definition
+          @definition_path = @original_definition = nil
+          validate_update_options! unless destroying? || creating_new_view?
           dependents unless destroying? || creating_new_view?
+          path = Scenic::Definition.new(plural_file_name, version).full_path.to_s
+          @definition_path = path
+          @original_definition = File.binread(path) if File.file?(path)
           super
+        rescue StandardError
+          restore_definition
+          raise
         end
 
         def create_migration_file
-          if creating_new_view? || destroying_initial_view?
-            migration_template('db/migrate/create_view.rb.erb',
-                               "db/migrate/create_#{plural_file_name}.rb")
-          else
-            migration_template('db/migrate/update_view.rb.erb',
-                               "db/migrate/update_#{plural_file_name}_to_version_#{version}.rb")
-          end
+          template, destination = migration_template_details
+          pattern = File.join(destination_root, 'db/migrate', "[0-9]*_#{File.basename(destination)}")
+          original_migrations = Dir.glob(pattern).to_h { |path| [path, File.binread(path)] }
+          migration_template(template, destination)
+          # Thor returns normally for --skip even though it did not create a migration.
+          restore_definition if options[:skip] && skipped_migration?(template, pattern, original_migrations)
+        rescue StandardError
+          restore_migrations(pattern, original_migrations) if pattern && original_migrations
+          restore_definition
+          raise
         end
 
         private
 
+        def validate_update_options!
+          raise ArgumentError, '--replace cannot update a materialized view' if options[:replace] && materialized?
+
+          validate_side_by_side_option! if options[:side_by_side]
+        end
+
+        def validate_side_by_side_option!
+          raise ArgumentError, '--side-by-side requires --materialized' unless materialized?
+          raise ArgumentError, '--side-by-side cannot update schema-qualified views' if plural_name.include?('.')
+
+          raise ArgumentError, '--side-by-side cannot be combined with --no-data' if options[:no_data]
+        end
+
+        def migration_template_details
+          return ['db/migrate/create_view.rb.erb', "db/migrate/create_#{plural_file_name}.rb"] if
+            creating_new_view? || destroying_initial_view?
+
+          ['db/migrate/update_view.rb.erb', "db/migrate/update_#{plural_file_name}_to_version_#{version}.rb"]
+        end
+
+        def restore_definition
+          return unless (path = @definition_path)
+
+          if (original = @original_definition)
+            restore_file(path, original)
+          elsif File.file?(path)
+            File.delete(path)
+          end
+        end
+
+        def restore_migrations(pattern, originals)
+          (Dir.glob(pattern) - originals.keys).each { |path| File.delete(path) }
+          originals.each { |path, content| restore_file(path, content) }
+        end
+
+        def restore_file(path, content)
+          File.binwrite(path, content) unless File.file?(path) && File.binread(path) == content
+        end
+
+        def skipped_migration?(template, pattern, originals)
+          return false unless Dir.glob(pattern).to_h { |path| [path, File.binread(path)] } == originals
+
+          originals.values.first != ERB.new(File.read(find_in_source_paths(template)), trim_mode: '-').result(binding).b
+        end
+
         def dependents
           cached_dependents = @dependents
           return cached_dependents unless cached_dependents.nil?
 
-          deps = Scenic::Cascade.view_dependents_of(plural_name, recursive: true)
+          deps = Scenic::Cascade.view_dependents_of(database_view_name, recursive: true)
           views = deps.map { |dep| view_with_version_for(dep) }
           # The last visit follows every prerequisite, even when names sort in the opposite order.
           @dependents = views.reverse.uniq { |view| [view.name, view.version, view.materialized?] }.reverse
@@ -40,11 +97,48 @@ module Scenic
 
         def view_with_version_for(dep)
           name = dep.from.name
-          definition = Scenic::Cascade.find_definitions_of(name).last
+          definition_name = definition_name_for(name)
+          definition = Scenic::Cascade.find_definitions_of(definition_name).last
           raise ArgumentError, "Dependent view #{name} has no Scenic definition file" if definition.nil?
 
-          version = definition.version.to_i
-          Scenic::Cascade::ViewWithVersion.new(name: name, version: version, materialized: dep.from.materialized?)
+          Scenic::Cascade::ViewWithVersion.new(
+            name: definition_name, version: definition.version.to_i,
+            materialized: dep.from.materialized?, database_name: qualified_name(name)
+          )
+        end
+
+        def definition_name_for(name)
+          return name if name.include?('.')
+
+          qualified = qualified_name(name)
+          qualified_definitions = Scenic::Cascade.find_definitions_of(qualified)
+          bare_definitions = Scenic::Cascade.find_definitions_of(name)
+
+          if qualified_definitions.any? && bare_definitions.any?
+            raise ArgumentError, "Dependent view #{name} has ambiguous Scenic definitions: #{name} and #{qualified}"
+          end
+
+          return qualified if qualified_definitions.any?
+          return name if bare_definitions.empty? || bare_name_resolves_to_public?(name)
+
+          raise ArgumentError, "Dependent view #{name} has no unambiguous Scenic definition file for #{qualified}"
+        end
+
+        def bare_name_resolves_to_public?(name)
+          connection = ActiveRecord::Base.connection
+          bare = connection.quote(connection.quote_table_name(name))
+          qualified = connection.quote(connection.quote_table_name(qualified_name(name)))
+          connection.select_value("SELECT to_regclass(#{bare}) = to_regclass(#{qualified})")
+        end
+
+        def qualified_name(name)
+          name.include?('.') ? name : "public.#{name}"
+        end
+
+        def database_view_name
+          return plural_name if plural_name.include?('.')
+
+          "#{ActiveRecord::Base.table_name_prefix}#{plural_name}#{ActiveRecord::Base.table_name_suffix}"
         end
       end
     end

data/lib/generators/scenic/view/cascade/templates/db/migrate/update_view.rb.erb

@@ -1,26 +1,64 @@
 # frozen_string_literal: true
 
 class <%= migration_class_name %> < <%= activerecord_migration_class %>
+  <%- if dependents.any? || plural_name.include?('.') -%>
+  class ExactViewName < String
+    alias table_name to_s
+  end
+
+  <%- end -%>
+  <%- target_name = plural_name.include?('.') ? "ExactViewName.new(#{plural_name.inspect})" : formatted_plural_name -%>
+  <%- update_method = options[:replace] ? 'replace_view' : 'update_view' -%>
+  <%- materialized_flags = [] -%>
+  <%- materialized_flags << 'no_data: true' if options[:no_data] -%>
+  <%- materialized_flags << 'side_by_side: true' if options[:side_by_side] -%>
+  <%- materialized_options = materialized_flags.empty? ? 'true' : "{ #{materialized_flags.join(', ')} }" -%>
   def change
   <%- dependents.reverse_each do |dep| -%>
-    drop_view <%= dep.formatted_name %>,
+  <%- if dep.database_name == dep.name -%>
+    drop_view ExactViewName.new(<%= dep.database_name.inspect %>),
               revert_to_version: <%= dep.version %>,
               materialized: <%= dep.materialized? %>
+  <%- else -%>
+    reversible do |direction|
+      direction.up do
+        drop_view ExactViewName.new(<%= dep.database_name.inspect %>), materialized: <%= dep.materialized? %>
+      end
+      direction.down do
+        create_view ExactViewName.new(<%= dep.database_name.inspect %>),
+                    sql_definition: Scenic::Definition.new(<%= dep.name.inspect %>, <%= dep.version %>).to_sql,
+                    materialized: <%= dep.materialized? %>
+      end
+    end
+  <%- end -%>
   <%- end -%>
 
   <%- if materialized? -%>
-    update_view <%= formatted_plural_name %>,
+    <%= update_method %> <%= target_name %>,
       version: <%= version %>,
       revert_to_version: <%= previous_version %>,
-      materialized: <%= no_data? ? "{ no_data: true }" : true %>
+      materialized: <%= materialized_options %>
   <%- else -%>
-    update_view <%= formatted_plural_name %>, version: <%= version %>, revert_to_version: <%= previous_version %>
+    <%= update_method %> <%= target_name %>, version: <%= version %>, revert_to_version: <%= previous_version %>
   <%- end -%>
 
   <%- dependents.each do |dep| -%>
-    create_view <%= dep.formatted_name %>,
+  <%- if dep.database_name == dep.name -%>
+    create_view ExactViewName.new(<%= dep.database_name.inspect %>),
                 version: <%= dep.version %>,
                 materialized: <%= dep.materialized? %>
+  <%- else -%>
+    reversible do |direction|
+      direction.up do
+        create_view ExactViewName.new(<%= dep.database_name.inspect %>),
+                    sql_definition: Scenic::Definition.new(<%= dep.name.inspect %>, <%= dep.version %>).to_sql,
+                    materialized: <%= dep.materialized? %>
+      end
+      direction.down do
+        drop_view ExactViewName.new(<%= dep.database_name.inspect %>), materialized: <%= dep.materialized? %>
+      end
+    end
+  <%- end -%>
   <%- end -%>
   end
 end

data/lib/scenic/cascade/dependency_finder.rb

@@ -14,21 +14,28 @@ module Scenic
       module ClassMethods
         DEPENDENCY_SQL = <<-SQL
              SELECT DISTINCT
-                    dependee.relname AS to
+                    CASE WHEN dependee_ns.nspname = 'public' THEN dependee.relname
+                         ELSE dependee_ns.nspname || '.' || dependee.relname END AS to
                   , dependee.relkind = 'm' AS to_materialized
-                  , depender.relname AS from
+                  , CASE WHEN depender_ns.nspname = 'public' THEN depender.relname
+                         ELSE depender_ns.nspname || '.' || depender.relname END AS from
                   , depender.relkind = 'm' AS from_materialized
+                  , format('%I.%I', dependee_ns.nspname, dependee.relname) AS to_lookup
                FROM pg_depend d
                JOIN pg_rewrite r
                  ON d.objid = r.oid
                JOIN pg_class AS dependee
                  ON d.refobjid = dependee.oid
+               JOIN pg_namespace AS dependee_ns
+                 ON dependee.relnamespace = dependee_ns.oid
                JOIN pg_class AS depender
                  ON r.ev_class = depender.oid
-              WHERE depender.relname = ?
-                AND dependee.relname != depender.relname
+               JOIN pg_namespace AS depender_ns
+                 ON depender.relnamespace = depender_ns.oid
+              WHERE depender.oid = to_regclass(?)
+                AND dependee.oid != depender.oid
                 AND dependee.relkind in ('m', 'v')
-           ORDER BY dependee.relname;
+           ORDER BY to_lookup;
         SQL
 
         private_constant :DEPENDENCY_SQL
@@ -41,8 +48,8 @@ module Scenic
           return [] if dependencies.empty?
           return dependencies unless recursive
 
-          dependencies.flat_map do |dependency|
-            [dependency, *view_dependencies_of(dependency.to.name, recursive: true)]
+          raw_dependencies.zip(dependencies).flat_map do |row, dependency|
+            [dependency, *view_dependencies_of(row.fetch('to_lookup'), recursive: true)]
           end
         end
       end

data/lib/scenic/cascade/dependent_finder.rb

@@ -14,21 +14,28 @@ module Scenic
       module ClassMethods
         DEPENDANT_SQL = <<-SQL
              SELECT DISTINCT
-                    dependee.relname AS to
+                    CASE WHEN dependee_ns.nspname = 'public' THEN dependee.relname
+                         ELSE dependee_ns.nspname || '.' || dependee.relname END AS to
                   , dependee.relkind = 'm' AS to_materialized
-                  , depender.relname AS from
+                  , CASE WHEN depender_ns.nspname = 'public' THEN depender.relname
+                         ELSE depender_ns.nspname || '.' || depender.relname END AS from
                   , depender.relkind = 'm' AS from_materialized
+                  , format('%I.%I', depender_ns.nspname, depender.relname) AS from_lookup
                FROM pg_depend d
                JOIN pg_rewrite r
                  ON d.objid = r.oid
                JOIN pg_class AS dependee
                  ON d.refobjid = dependee.oid
+               JOIN pg_namespace AS dependee_ns
+                 ON dependee.relnamespace = dependee_ns.oid
                JOIN pg_class AS depender
                  ON r.ev_class = depender.oid
-              WHERE dependee.relname = ?
-                AND depender.relname != dependee.relname
+               JOIN pg_namespace AS depender_ns
+                 ON depender.relnamespace = depender_ns.oid
+              WHERE dependee.oid = to_regclass(?)
+                AND depender.oid != dependee.oid
                 AND depender.relkind in ('m', 'v')
-           ORDER BY depender.relname;
+           ORDER BY from_lookup;
         SQL
 
         private_constant :DEPENDANT_SQL
@@ -41,8 +48,8 @@ module Scenic
           return [] if dependencies.empty?
           return dependencies unless recursive
 
-          dependencies.flat_map do |dependency|
-            [dependency, *view_dependents_of(dependency.from.name, recursive: true)]
+          raw_dependencies.zip(dependencies).flat_map do |row, dependency|
+            [dependency, *view_dependents_of(row.fetch('from_lookup'), recursive: true)]
           end
         end
 

data/lib/scenic/cascade/version.rb

@@ -2,6 +2,6 @@
 
 module Scenic
   module Cascade
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

data/lib/scenic/cascade/view_with_version.rb

@@ -6,14 +6,16 @@ module Scenic
   module Cascade
     # Represents a view with version
     class ViewWithVersion < Scenic::Cascade::View
-      attr_reader :version
+      attr_reader :version, :database_name
 
-      def initialize(name:, version:, materialized:)
+      def initialize(name:, version:, materialized:, database_name: name)
         super(name: name, materialized: materialized)
 
         raise TypeError unless version.is_a?(Integer)
+        raise TypeError unless database_name.is_a?(String)
 
         @version = version
+        @database_name = database_name
       end
 
       def ==(other)

data/sig/generators/scenic/view/cascade/cascade_generator.rbs

@@ -3,14 +3,27 @@ module Scenic
     module View
       class CascadeGenerator < Scenic::Generators::ViewGenerator
         @dependents: Array[Scenic::Cascade::ViewWithVersion]?
+        @definition_path: String?
+        @original_definition: String?
 
         def create_view_definition: -> void
         def create_migration_file: -> void
 
         private
 
+        def validate_update_options!: -> void
+        def validate_side_by_side_option!: -> void
         def dependents: -> Array[Scenic::Cascade::ViewWithVersion]
+        def migration_template_details: -> [String, String]
+        def restore_definition: -> void
+        def restore_migrations: (String, Hash[String, String]) -> void
+        def restore_file: (String, String) -> void
+        def skipped_migration?: (String, String, Hash[String, String]) -> bool
         def view_with_version_for: (Scenic::Cascade::Dependency) -> Scenic::Cascade::ViewWithVersion
+        def database_view_name: -> String
+        def definition_name_for: (String) -> String
+        def bare_name_resolves_to_public?: (String) -> bool
+        def qualified_name: (String) -> String
       end
     end
   end

data/sig/generators/scenic/view/view_generator.rbs

@@ -3,12 +3,16 @@ module Scenic
     class ViewGenerator
       def self.source_root: (String?) -> void
       def migration_template: (String, String) -> void
+      def destination_root: -> String
+      def find_in_source_paths: (String) -> String
+      def options: -> Hash[Symbol, untyped]
 
       def create_view_definition: -> void
       def version: -> Integer
 
       private
 
+      def materialized?: -> bool
       def plural_name: -> String
       def plural_file_name: -> String
       def creating_new_view?: -> bool

data/sig/scenic/cascade/view_with_version.rbs

@@ -8,8 +8,9 @@ module Scenic
 
     class ViewWithVersion < Scenic::Cascade::View
       attr_reader version: Integer
+      attr_reader database_name: String
 
-      def initialize: (name: String, version: Integer, materialized: bool) -> void
+      def initialize: (name: String, version: Integer, materialized: bool, ?database_name: String) -> void
 
       def ==: (_ViewWithVersionLike) -> bool
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scenic-cascade
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Akiomi Kamakura
@@ -44,6 +44,7 @@ files:
 - README.md
 - Rakefile
 - Steepfile
+- codecov.yml
 - docker-compose.yml
 - lib/generators/scenic/view/cascade/USAGE
 - lib/generators/scenic/view/cascade/cascade_generator.rb