scenic 1.7.0 → 1.9.0

data/spec/scenic/adapters/postgres_spec.rb

@@ -19,7 +19,7 @@ module Scenic
 
           adapter.create_materialized_view(
             "greetings",
-            "SELECT text 'hi' AS greeting",
+            "SELECT text 'hi' AS greeting"
           )
 
           view = adapter.views.first
@@ -33,7 +33,7 @@ module Scenic
           adapter.create_materialized_view(
             "greetings",
             "SELECT text 'hi' AS greeting; \n",
-            no_data: true,
+            no_data: true
           )
 
           view = adapter.views.first
@@ -85,7 +85,7 @@ module Scenic
 
           adapter.create_materialized_view(
             "greetings",
-            "SELECT text 'hi' AS greeting",
+            "SELECT text 'hi' AS greeting"
           )
           adapter.drop_materialized_view("greetings")
 
@@ -125,7 +125,7 @@ module Scenic
           adapter.refresh_materialized_view(
             :tests,
             cascade: true,
-            concurrently: true,
+            concurrently: true
           )
         end
 
@@ -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,10 +184,10 @@ module Scenic
           SQL
 
           expect(adapter.views.map(&:name)).to eq [
-            "parents",
             "children",
+            "parents",
             "people",
-            "people_with_names",
+            "people_with_names"
           ]
         end
 
@@ -193,17 +201,96 @@ 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
       end
+
+      describe "#populated?" do
+        it "returns false if a materialized view is not populated" do
+          adapter = Postgres.new
+
+          ActiveRecord::Base.connection.execute <<-SQL
+            CREATE MATERIALIZED VIEW greetings AS
+            SELECT text 'hi' AS greeting
+            WITH NO DATA
+          SQL
+
+          expect(adapter.populated?("greetings")).to be false
+        end
+
+        it "returns true if a materialized view is populated" do
+          adapter = Postgres.new
+
+          ActiveRecord::Base.connection.execute <<-SQL
+            CREATE MATERIALIZED VIEW greetings AS
+            SELECT text 'hi' AS greeting
+          SQL
+
+          expect(adapter.populated?("greetings")).to be true
+        end
+
+        it "strips out the schema from table_name" do
+          adapter = Postgres.new
+
+          ActiveRecord::Base.connection.execute <<-SQL
+            CREATE MATERIALIZED VIEW greetings AS
+            SELECT text 'hi' AS greeting
+            WITH NO DATA
+          SQL
+
+          expect(adapter.populated?("public.greetings")).to be false
+        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)
+          err = Scenic::Adapters::Postgres::MaterializedViewsNotSupportedError
+
+          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/statement_arguments_spec.rb

@@ -4,7 +4,7 @@ module Scenic::CommandRecorder
   describe StatementArguments do
     describe "#view" do
       it "is the view name" do
-        raw_args = [:spaceships, { foo: :bar }]
+        raw_args = [:spaceships, {foo: :bar}]
         args = StatementArguments.new(raw_args)
 
         expect(args.view).to eq :spaceships
@@ -13,14 +13,14 @@ module Scenic::CommandRecorder
 
     describe "#revert_to_version" do
       it "is the revert_to_version from the keyword arguments" do
-        raw_args = [:spaceships, { revert_to_version: 42 }]
+        raw_args = [:spaceships, {revert_to_version: 42}]
         args = StatementArguments.new(raw_args)
 
         expect(args.revert_to_version).to eq 42
       end
 
       it "is nil if the revert_to_version was not supplied" do
-        raw_args = [:spaceships, { foo: :bar }]
+        raw_args = [:spaceships, {foo: :bar}]
         args = StatementArguments.new(raw_args)
 
         expect(args.revert_to_version).to be nil
@@ -29,7 +29,7 @@ module Scenic::CommandRecorder
 
     describe "#invert_version" do
       it "returns object with version set to revert_to_version" do
-        raw_args = [:meatballs, { version: 42, revert_to_version: 15 }]
+        raw_args = [:meatballs, {version: 42, revert_to_version: 15}]
 
         inverted_args = StatementArguments.new(raw_args).invert_version
 

data/spec/scenic/command_recorder_spec.rb

@@ -24,7 +24,7 @@ describe Scenic::CommandRecorder do
       recorder.revert { recorder.create_view :greetings, materialized: true }
 
       expect(recorder.commands).to eq [
-        [:drop_view, [:greetings, materialized: true]],
+        [:drop_view, [:greetings, materialized: true]]
       ]
     end
   end
@@ -37,8 +37,8 @@ describe Scenic::CommandRecorder do
     end
 
     it "reverts to create_view with specified revert_to_version" do
-      args = [:users, { revert_to_version: 3 }]
-      revert_args = [:users, { version: 3 }]
+      args = [:users, {revert_to_version: 3}]
+      revert_args = [:users, {version: 3}]
 
       recorder.revert { recorder.drop_view(*args) }
 
@@ -46,7 +46,7 @@ describe Scenic::CommandRecorder do
     end
 
     it "raises when reverting without revert_to_version set" do
-      args = [:users, { another_argument: 1 }]
+      args = [:users, {another_argument: 1}]
 
       expect { recorder.revert { recorder.drop_view(*args) } }
         .to raise_error(ActiveRecord::IrreversibleMigration)
@@ -55,7 +55,7 @@ describe Scenic::CommandRecorder do
 
   describe "#update_view" do
     it "records the updated view" do
-      args = [:users, { version: 2 }]
+      args = [:users, {version: 2}]
 
       recorder.update_view(*args)
 
@@ -63,8 +63,8 @@ describe Scenic::CommandRecorder do
     end
 
     it "reverts to update_view with the specified revert_to_version" do
-      args = [:users, { version: 2, revert_to_version: 1 }]
-      revert_args = [:users, { version: 1 }]
+      args = [:users, {version: 2, revert_to_version: 1}]
+      revert_args = [:users, {version: 1}]
 
       recorder.revert { recorder.update_view(*args) }
 
@@ -72,16 +72,34 @@ describe Scenic::CommandRecorder do
     end
 
     it "raises when reverting without revert_to_version set" do
-      args = [:users, { version: 42, another_argument: 1 }]
+      args = [:users, {version: 42, another_argument: 1}]
 
       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
     it "records the replaced view" do
-      args = [:users, { version: 2 }]
+      args = [:users, {version: 2}]
 
       recorder.replace_view(*args)
 
@@ -89,8 +107,8 @@ describe Scenic::CommandRecorder do
     end
 
     it "reverts to replace_view with the specified revert_to_version" do
-      args = [:users, { version: 2, revert_to_version: 1 }]
-      revert_args = [:users, { version: 1 }]
+      args = [:users, {version: 2, revert_to_version: 1}]
+      revert_args = [:users, {version: 1}]
 
       recorder.revert { recorder.replace_view(*args) }
 
@@ -98,7 +116,7 @@ describe Scenic::CommandRecorder do
     end
 
     it "raises when reverting without revert_to_version set" do
-      args = [:users, { version: 42, another_argument: 1 }]
+      args = [:users, {version: 42, another_argument: 1}]
 
       expect { recorder.revert { recorder.replace_view(*args) } }
         .to raise_error(ActiveRecord::IrreversibleMigration)

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
 
@@ -21,7 +21,7 @@ describe Scenic::SchemaDumper, :db do
 
     Search.connection.drop_view :searches
 
-    silence_stream(STDOUT) { eval(output) }
+    silence_stream($stdout) { eval(output) } # standard:disable Security/Eval
 
     expect(Search.first.haystack).to eq "needle"
   end
@@ -31,13 +31,13 @@ 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"
 
     Search.connection.drop_view :searches
-    silence_stream(STDOUT) { eval(output) }
+    silence_stream($stdout) { eval(output) } # standard:disable Security/Eval
 
     expect(Search.first.haystack).to eq "needle"
   end
@@ -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,12 +62,28 @@ 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'
+      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
 
@@ -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\"",'
@@ -113,7 +129,7 @@ describe Scenic::SchemaDumper, :db do
 
       Search.connection.drop_view :'"search in a haystack"'
 
-      silence_stream(STDOUT) { eval(output) }
+      silence_stream($stdout) { eval(output) } # standard:disable Security/Eval
 
       expect(SearchInAHaystack.take.haystack).to eq "needle"
     end
@@ -123,13 +139,13 @@ describe Scenic::SchemaDumper, :db do
     it "dumps a create_view for a view in the database" do
       view_definition = "SELECT 'needle'::text AS haystack"
       Search.connection.execute(
-        "CREATE SCHEMA scenic; SET search_path TO scenic, public",
+        "CREATE SCHEMA scenic; SET search_path TO scenic, public"
       )
       Search.connection.create_view 'scenic."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 "scenic.\"search in a haystack\"",'
@@ -137,7 +153,12 @@ describe Scenic::SchemaDumper, :db do
 
       Search.connection.drop_view :'scenic."search in a haystack"'
 
-      silence_stream(STDOUT) { eval(output) }
+      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"
     end

data/spec/scenic/statements_spec.rb

@@ -70,7 +70,7 @@ module Scenic
         connection.create_view(
           :views,
           version: 1,
-          materialized: { no_data: true },
+          materialized: {no_data: true}
         )
 
         expect(Scenic.database).to have_received(:create_materialized_view)
@@ -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
@@ -137,17 +137,33 @@ module Scenic
         connection.update_view(
           :name,
           version: 3,
-          materialized: { no_data: true },
+          materialized: {no_data: true}
         )
 
         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
         expect { connection.update_view :views }.to raise_error(
           ArgumentError,
-          /sql_definition or version must be specified/,
+          /sql_definition or version must be specified/
         )
       end
 
@@ -156,10 +172,40 @@ module Scenic
           connection.update_view(
             :views,
             version: 1,
-            sql_definition: "a defintion",
+            sql_definition: "a defintion"
           )
         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

data/spec/support/generator_spec_setup.rb

@@ -1,6 +1,6 @@
 require "rspec/rails"
-require "ammeter/rspec/generator/example.rb"
-require "ammeter/rspec/generator/matchers.rb"
+require "ammeter/rspec/generator/example"
+require "ammeter/rspec/generator/matchers"
 require "ammeter/init"
 
 RSpec.configure do |config|

data/spec/support/view_definition_helpers.rb

@@ -2,7 +2,7 @@ module ViewDefinitionHelpers
   def with_view_definition(name, version, schema)
     definition = Scenic::Definition.new(name, version)
     FileUtils.mkdir_p(File.dirname(definition.full_path))
-    File.open(definition.full_path, "w") { |f| f.write(schema) }
+    File.write(definition.full_path, schema)
     yield
   ensure
     FileUtils.rm_f(definition.full_path)