scenic 1.8.0 → 1.9.0

data/spec/scenic/adapters/postgres/index_migration_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+module Scenic
+  module Adapters
+    describe Postgres::IndexMigration, :db, :silence do
+      it "moves indexes from the old view to the new view" do
+        create_materialized_view("hi", "SELECT 'hi' AS greeting")
+        create_materialized_view("hi_temp", "SELECT 'hi' AS greeting")
+        add_index(:hi, :greeting, name: "hi_greeting_idx")
+
+        Postgres::IndexMigration
+          .new(connection: ActiveRecord::Base.connection)
+          .migrate(from: "hi", to: "hi_temp")
+        indexes_for_original = indexes_for("hi")
+        indexes_for_temporary = indexes_for("hi_temp")
+
+        expect(indexes_for_original.length).to eq 1
+        expect(indexes_for_original.first.index_name).not_to eq "hi_greeting_idx"
+        expect(indexes_for_temporary.length).to eq 1
+        expect(indexes_for_temporary.first.index_name).to eq "hi_greeting_idx"
+      end
+    end
+  end
+end

data/spec/scenic/adapters/postgres/side_by_side_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+module Scenic
+  module Adapters
+    describe Postgres::SideBySide, :db, :silence do
+      it "updates the materialized view to the new version" do
+        adapter = Postgres.new
+        create_materialized_view("hi", "SELECT 'hi' AS greeting")
+        add_index(:hi, :greeting, name: "hi_greeting_idx")
+        new_definition = "SELECT 'hola' AS greeting"
+
+        Postgres::SideBySide
+          .new(adapter: adapter, name: "hi", definition: new_definition)
+          .update
+        result = ar_connection.execute("SELECT * FROM hi").first["greeting"]
+        indexes = indexes_for("hi")
+
+        expect(result).to eq "hola"
+        expect(indexes.length).to eq 1
+        expect(indexes.first.index_name).to eq "hi_greeting_idx"
+      end
+    end
+  end
+end

data/spec/scenic/adapters/postgres/temporary_name_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+module Scenic
+  module Adapters
+    describe Postgres::TemporaryName do
+      it "generates a temporary name based on a SHA1 hash of the original" do
+        name = "my_materialized_view"
+
+        temporary_name = Postgres::TemporaryName.new(name).to_s
+
+        expect(temporary_name).to match(/_scenic_sbs_[0-9a-f]{40}/)
+      end
+
+      it "does not overflow the 63 character limit for object names" do
+        name = "long_view_name_" * 10
+
+        temporary_name = Postgres::TemporaryName.new(name).to_s
+
+        expect(temporary_name.length).to eq 52
+      end
+    end
+  end
+end

data/spec/scenic/adapters/postgres_spec.rb

@@ -149,6 +149,14 @@ module Scenic
               adapter.refresh_materialized_view(:tests, concurrently: true)
             }.to raise_error e
           end
+
+          it "falls back to non-concurrent refresh if not populated" do
+            adapter = Postgres.new
+            adapter.create_materialized_view(:testing, "SELECT unnest('{1, 2}'::int[])", no_data: true)
+
+            expect { adapter.refresh_materialized_view(:testing, concurrently: true) }
+              .not_to raise_error
+          end
         end
       end
 
@@ -176,8 +184,8 @@ module Scenic
           SQL
 
           expect(adapter.views.map(&:name)).to eq [
-            "parents",
             "children",
+            "parents",
             "people",
             "people_with_names"
           ]
@@ -193,13 +201,13 @@ module Scenic
 
             ActiveRecord::Base.connection.execute <<-SQL
               CREATE SCHEMA scenic;
-              CREATE VIEW scenic.parents AS SELECT text 'Maarten' AS name;
+              CREATE VIEW scenic.more_parents AS SELECT text 'Maarten' AS name;
               SET search_path TO scenic, public;
             SQL
 
             expect(adapter.views.map(&:name)).to eq [
               "parents",
-              "scenic.parents"
+              "scenic.more_parents"
             ]
           end
         end
@@ -250,6 +258,39 @@ module Scenic
           expect { adapter.populated?("greetings") }.to raise_error err
         end
       end
+
+      describe "#update_materialized_view" do
+        it "updates the definition of a materialized view in place" do
+          adapter = Postgres.new
+          create_materialized_view("hi", "SELECT 'hi' AS greeting")
+          new_definition = "SELECT 'hello' AS greeting"
+
+          adapter.update_materialized_view("hi", new_definition)
+          result = adapter.connection.execute("SELECT * FROM hi").first["greeting"]
+
+          expect(result).to eq "hello"
+        end
+
+        it "updates the definition of a materialized view side by side", :silence do
+          adapter = Postgres.new
+          create_materialized_view("hi", "SELECT 'hi' AS greeting")
+          new_definition = "SELECT 'hello' AS greeting"
+
+          adapter.update_materialized_view("hi", new_definition, side_by_side: true)
+          result = adapter.connection.execute("SELECT * FROM hi").first["greeting"]
+
+          expect(result).to eq "hello"
+        end
+
+        it "raises an exception if the version of PostgreSQL is too old" do
+          connection = double("Connection", supports_materialized_views?: false)
+          connectable = double("Connectable", connection: connection)
+          adapter = Postgres.new(connectable)
+
+          expect { adapter.create_materialized_view("greetings", "select 1") }
+            .to raise_error Postgres::MaterializedViewsNotSupportedError
+        end
+      end
     end
   end
 end

data/spec/scenic/command_recorder_spec.rb

@@ -77,6 +77,24 @@ describe Scenic::CommandRecorder do
       expect { recorder.revert { recorder.update_view(*args) } }
         .to raise_error(ActiveRecord::IrreversibleMigration)
     end
+
+    it "reverts materialized views with no_data option appropriately" do
+      args = [:users, {version: 2, revert_to_version: 1, materialized: {no_data: true}}]
+      revert_args = [:users, {version: 1, materialized: {no_data: true}}]
+
+      recorder.revert { recorder.update_view(*args) }
+
+      expect(recorder.commands).to eq [[:update_view, revert_args]]
+    end
+
+    it "reverts materialized views with side_by_side option appropriately" do
+      args = [:users, {version: 2, revert_to_version: 1, materialized: {side_by_side: true}}]
+      revert_args = [:users, {version: 1, materialized: {side_by_side: true}}]
+
+      recorder.revert { recorder.update_view(*args) }
+
+      expect(recorder.commands).to eq [[:update_view, revert_args]]
+    end
   end
 
   describe "#replace_view" do

data/spec/scenic/schema_dumper_spec.rb

@@ -12,7 +12,7 @@ describe Scenic::SchemaDumper, :db do
     Search.connection.create_view :searches, sql_definition: view_definition
     stream = StringIO.new
 
-    ActiveRecord::SchemaDumper.dump(Search.connection, stream)
+    dump_schema(stream)
 
     output = stream.string
 
@@ -31,7 +31,7 @@ describe Scenic::SchemaDumper, :db do
     Search.connection.create_view :searches, sql_definition: view_definition
     stream = StringIO.new
 
-    ActiveRecord::SchemaDumper.dump(Search.connection, stream)
+    dump_schema(stream)
 
     output = stream.string
     expect(output).to include "~ '\\\\d+'::text"
@@ -47,7 +47,7 @@ describe Scenic::SchemaDumper, :db do
     Search.connection.create_view :searches, materialized: true, sql_definition: view_definition
     stream = StringIO.new
 
-    ActiveRecord::SchemaDumper.dump(Search.connection, stream)
+    dump_schema(stream)
 
     output = stream.string
 
@@ -62,13 +62,29 @@ describe Scenic::SchemaDumper, :db do
       Search.connection.create_view :"scenic.searches", sql_definition: view_definition
       stream = StringIO.new
 
-      ActiveRecord::SchemaDumper.dump(Search.connection, stream)
+      dump_schema(stream)
 
       output = stream.string
       expect(output).to include 'create_view "scenic.searches",'
 
       Search.connection.drop_view :"scenic.searches"
     end
+
+    it "sorts dependency order when views exist in a non-public schema" do
+      Search.connection.execute("CREATE SCHEMA IF NOT EXISTS scenic; SET search_path TO public, scenic")
+      Search.connection.execute("CREATE VIEW scenic.apples AS SELECT 1;")
+      Search.connection.execute("CREATE VIEW scenic.bananas AS SELECT 2;")
+      Search.connection.execute("CREATE OR REPLACE VIEW scenic.apples AS SELECT * FROM scenic.bananas;")
+      stream = StringIO.new
+
+      dump_schema(stream)
+      views = stream.string.lines.grep(/create_view/).map do |view_line|
+        view_line.match('create_view "(?<name>.*)"')[:name]
+      end
+      expect(views).to eq(%w[scenic.bananas scenic.apples])
+
+      Search.connection.execute("DROP SCHEMA IF EXISTS scenic CASCADE; SET search_path TO public")
+    end
   end
 
   it "handles active record table name prefixes and suffixes" do
@@ -77,7 +93,7 @@ describe Scenic::SchemaDumper, :db do
       Search.connection.create_view :a_searches_z, sql_definition: view_definition
       stream = StringIO.new
 
-      ActiveRecord::SchemaDumper.dump(Search.connection, stream)
+      dump_schema(stream)
 
       output = stream.string
 
@@ -90,7 +106,7 @@ describe Scenic::SchemaDumper, :db do
     Search.connection.create_view :searches, sql_definition: view_definition
     stream = StringIO.new
 
-    ActiveRecord::SchemaDumper.dump(Search.connection, stream)
+    dump_schema(stream)
 
     output = stream.string
 
@@ -105,7 +121,7 @@ describe Scenic::SchemaDumper, :db do
       Search.connection.create_view '"search in a haystack"', sql_definition: view_definition
       stream = StringIO.new
 
-      ActiveRecord::SchemaDumper.dump(Search.connection, stream)
+      dump_schema(stream)
 
       output = stream.string
       expect(output).to include 'create_view "\"search in a haystack\"",'
@@ -129,7 +145,7 @@ describe Scenic::SchemaDumper, :db do
         sql_definition: view_definition
       stream = StringIO.new
 
-      ActiveRecord::SchemaDumper.dump(Search.connection, stream)
+      dump_schema(stream)
 
       output = stream.string
       expect(output).to include 'create_view "scenic.\"search in a haystack\"",'
@@ -137,6 +153,11 @@ describe Scenic::SchemaDumper, :db do
 
       Search.connection.drop_view :'scenic."search in a haystack"'
 
+      case ActiveRecord.gem_version
+      when Gem::Requirement.new(">= 7.1")
+        Search.connection.drop_schema "scenic"
+      end
+
       silence_stream($stdout) { eval(output) } # standard:disable Security/Eval
 
       expect(SearchInAHaystack.take.haystack).to eq "needle"

data/spec/scenic/statements_spec.rb

@@ -125,7 +125,7 @@ module Scenic
         connection.update_view(:name, version: 3, materialized: true)
 
         expect(Scenic.database).to have_received(:update_materialized_view)
-          .with(:name, definition.to_sql, no_data: false)
+          .with(:name, definition.to_sql, no_data: false, side_by_side: false)
       end
 
       it "updates the materialized view in the database with NO DATA" do
@@ -141,7 +141,23 @@ module Scenic
         )
 
         expect(Scenic.database).to have_received(:update_materialized_view)
-          .with(:name, definition.to_sql, no_data: true)
+          .with(:name, definition.to_sql, no_data: true, side_by_side: false)
+      end
+
+      it "updates the materialized view with side-by-side mode" do
+        definition = instance_double("Definition", to_sql: "definition")
+        allow(Definition).to receive(:new)
+          .with(:name, 3)
+          .and_return(definition)
+
+        connection.update_view(
+          :name,
+          version: 3,
+          materialized: {side_by_side: true}
+        )
+
+        expect(Scenic.database).to have_received(:update_materialized_view)
+          .with(:name, definition.to_sql, no_data: false, side_by_side: true)
       end
 
       it "raises an error if not supplied a version or sql_defintion" do
@@ -160,6 +176,36 @@ module Scenic
           )
         end.to raise_error ArgumentError, /cannot both be set/
       end
+
+      it "raises an error is no_data and side_by_side are both set" do
+        definition = instance_double("Definition", to_sql: "definition")
+        allow(Definition).to receive(:new)
+          .with(:name, 3)
+          .and_return(definition)
+
+        expect do
+          connection.update_view(
+            :name,
+            version: 3,
+            materialized: {no_data: true, side_by_side: true}
+          )
+        end.to raise_error ArgumentError, /cannot be combined/
+      end
+
+      it "raises an error if not in a transaction" do
+        definition = instance_double("Definition", to_sql: "definition")
+        allow(Definition).to receive(:new)
+          .with(:name, 3)
+          .and_return(definition)
+
+        expect do
+          connection(transactions_enabled: false).update_view(
+            :name,
+            version: 3,
+            materialized: {side_by_side: true}
+          )
+        end.to raise_error RuntimeError, /transaction is required/
+      end
     end
 
     describe "replace_view" do
@@ -192,8 +238,20 @@ module Scenic
       end
     end
 
-    def connection
-      Class.new { extend Statements }
+    def connection(transactions_enabled: true)
+      DummyConnection.new(transactions_enabled: transactions_enabled)
+    end
+  end
+
+  class DummyConnection
+    include Statements
+
+    def initialize(transactions_enabled:)
+      @transactions_enabled = transactions_enabled
+    end
+
+    def transaction_open?
+      @transactions_enabled
     end
   end
 end

data/spec/spec_helper.rb

@@ -2,24 +2,39 @@ ENV["RAILS_ENV"] = "test"
 require "database_cleaner"
 
 require File.expand_path("dummy/config/environment", __dir__)
-require "support/rails_configuration_helpers"
-require "support/generator_spec_setup"
-require "support/view_definition_helpers"
+
+Dir.glob("#{__dir__}/support/**/*.rb").each { |f| require f }
 
 RSpec.configure do |config|
   config.order = "random"
+  config.include DatabaseSchemaHelpers
   config.include ViewDefinitionHelpers
   config.include RailsConfigurationHelpers
   DatabaseCleaner.strategy = :transaction
 
   config.around(:each, db: true) do |example|
-    ActiveRecord::SchemaMigration.create_table
+    case ActiveRecord.gem_version
+    when Gem::Requirement.new(">= 7.2")
+      ActiveRecord::SchemaMigration
+        .new(ActiveRecord::Tasks::DatabaseTasks.migration_connection_pool)
+        .create_table
+    when Gem::Requirement.new("~> 7.1.0")
+      ActiveRecord::SchemaMigration
+        .new(ActiveRecord::Tasks::DatabaseTasks.migration_connection)
+        .create_table
+    when Gem::Requirement.new("< 7.1")
+      ActiveRecord::SchemaMigration.create_table
+    end
 
     DatabaseCleaner.start
     example.run
     DatabaseCleaner.clean
   end
 
+  config.before(:each, silence: true) do |example|
+    allow_any_instance_of(ActiveRecord::Migration).to receive(:say)
+  end
+
   if defined? ActiveSupport::Testing::Stream
     config.include ActiveSupport::Testing::Stream
   end

data/spec/support/database_schema_helpers.rb

@@ -0,0 +1,28 @@
+module DatabaseSchemaHelpers
+  def dump_schema(stream)
+    case ActiveRecord.gem_version
+    when Gem::Requirement.new(">= 7.2")
+      ActiveRecord::SchemaDumper.dump(Search.connection_pool, stream)
+    else
+      ActiveRecord::SchemaDumper.dump(Search.connection, stream)
+    end
+  end
+
+  def ar_connection
+    ActiveRecord::Base.connection
+  end
+
+  def create_materialized_view(name, sql)
+    ar_connection.execute("CREATE MATERIALIZED VIEW #{name} AS #{sql}")
+  end
+
+  def add_index(view, columns, name: nil)
+    ar_connection.add_index(view, columns, name: name)
+  end
+
+  def indexes_for(view_name)
+    Scenic::Adapters::Postgres::Indexes
+      .new(connection: ar_connection)
+      .on(view_name)
+  end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scenic
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Derek Prior
 - Caleb Hearth
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-28 00:00:00.000000000 Z
+date: 2025-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,16 +70,16 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +197,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- FUNDING.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -221,9 +221,13 @@ files:
 - lib/scenic/adapters/postgres.rb
 - lib/scenic/adapters/postgres/connection.rb
 - lib/scenic/adapters/postgres/errors.rb
+- lib/scenic/adapters/postgres/index_creation.rb
+- lib/scenic/adapters/postgres/index_migration.rb
 - lib/scenic/adapters/postgres/index_reapplication.rb
 - lib/scenic/adapters/postgres/indexes.rb
 - lib/scenic/adapters/postgres/refresh_dependencies.rb
+- lib/scenic/adapters/postgres/side_by_side.rb
+- lib/scenic/adapters/postgres/temporary_name.rb
 - lib/scenic/adapters/postgres/views.rb
 - lib/scenic/command_recorder.rb
 - lib/scenic/command_recorder/statement_arguments.rb
@@ -258,7 +262,11 @@ files:
 - spec/generators/scenic/view/view_generator_spec.rb
 - spec/integration/revert_spec.rb
 - spec/scenic/adapters/postgres/connection_spec.rb
+- spec/scenic/adapters/postgres/index_creation_spec.rb
+- spec/scenic/adapters/postgres/index_migration_spec.rb
 - spec/scenic/adapters/postgres/refresh_dependencies_spec.rb
+- spec/scenic/adapters/postgres/side_by_side_spec.rb
+- spec/scenic/adapters/postgres/temporary_name_spec.rb
 - spec/scenic/adapters/postgres/views_spec.rb
 - spec/scenic/adapters/postgres_spec.rb
 - spec/scenic/command_recorder/statement_arguments_spec.rb
@@ -268,14 +276,15 @@ files:
 - spec/scenic/schema_dumper_spec.rb
 - spec/scenic/statements_spec.rb
 - spec/spec_helper.rb
+- spec/support/database_schema_helpers.rb
 - spec/support/generator_spec_setup.rb
 - spec/support/rails_configuration_helpers.rb
 - spec/support/view_definition_helpers.rb
 homepage: https://github.com/scenic-views/scenic
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  funding-uri: https://github.com/scenic-views/scenic
 rdoc_options: []
 require_paths:
 - lib
@@ -290,8 +299,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Support for database views in Rails migrations
 test_files: []