activerecord_views 0.0.20 → 0.1.3

data/spec/active_record_views_extension_spec.rb

@@ -2,6 +2,19 @@ require 'spec_helper'
 
 describe ActiveRecordViews::Extension do
   describe '.is_view' do
+    def registered_model_class_names
+      ActiveRecordViews.registered_views.map(&:model_class_name)
+    end
+
+    def view_exists?(name)
+      connection = ActiveRecord::Base.connection
+      if connection.respond_to?(:view_exists?)
+        connection.view_exists?(name)
+      else
+        connection.table_exists?(name)
+      end
+    end
+
     it 'creates database views from heredocs' do
       expect(ActiveRecordViews).to receive(:create_view).once.and_call_original
       expect(HeredocTestModel.first.name).to eq 'Here document'
@@ -19,43 +32,50 @@ describe ActiveRecordViews::Extension do
 
     it 'creates database views from external ERB files' do
       expect(ActiveRecordViews).to receive(:create_view).once.and_call_original
-      expect(ErbTestModel.first.name).to eq 'ERB file'
+      expect(ErbTestModel.first.name).to eq 'ERB method file'
     end
 
     it 'errors if external SQL file is missing' do
       expect {
-        MissingFileTestModel
+        class MissingFileTestModel < ActiveRecord::Base
+          is_view
+        end
       }.to raise_error RuntimeError, /could not find missing_file_test_model.sql/
     end
 
     it 'reloads the database view when external SQL file is modified' do
-      %w[foo bar baz].each do |sql|
-        expect(ActiveRecordViews).to receive(:create_view).with(
-          anything,
-          'modified_file_test_models',
-          'ModifiedFileTestModel',
-          sql,
-          {}
-        ).once.ordered
-      end
-
-      with_temp_sql_dir do |temp_dir|
-        sql_file = File.join(temp_dir, 'modified_file_test_model.sql')
-        update_file sql_file, 'foo'
+      sql_file = File.join(TEST_TEMP_MODEL_DIR, 'modified_file_test_model.sql')
+      update_file sql_file, "SELECT 'foo'::text AS test"
 
+      expect {
+        expect(ActiveRecordViews).to receive(:create_view).once.and_call_original
         class ModifiedFileTestModel < ActiveRecord::Base
           is_view
         end
+      }.to change { begin; ModifiedFileTestModel.take!.test; rescue NameError; end }.from(nil).to('foo')
+        .and change { registered_model_class_names.include?('ModifiedFileTestModel') }.from(false).to(true)
 
-        update_file sql_file, 'bar'
+      expect {
+        update_file sql_file, "SELECT 'bar'::text AS test, 42::integer AS test2"
+      }.to_not change { ModifiedFileTestModel.take!.test }
 
+      expect {
+        expect(ActiveRecordViews).to receive(:create_view).once.and_call_original
         test_request
         test_request # second request does not `create_view` again
+      }.to change { ModifiedFileTestModel.take!.test }.to('bar')
+        .and change { ModifiedFileTestModel.column_names }.from(%w[test]).to(%w[test test2])
 
-        update_file sql_file, 'baz'
+      expect {
+        update_file sql_file, "SELECT 'baz'::text AS test"
+      }.to_not change { ModifiedFileTestModel.take!.test }
 
+      expect {
+        expect(ActiveRecordViews).to receive(:create_view).once.and_call_original
         test_request
-      end
+      }.to change { ModifiedFileTestModel.take!.test }.to('baz')
+
+      File.unlink sql_file
       test_request # trigger cleanup
     end
 
@@ -70,40 +90,53 @@ describe ActiveRecordViews::Extension do
         ).once.ordered
       end
 
-      with_temp_sql_dir do |temp_dir|
-        sql_file = File.join(temp_dir, 'modified_erb_file_test_model.sql.erb')
-        update_file sql_file, 'foo <%= 2*3*7 %>'
+      sql_file = File.join(TEST_TEMP_MODEL_DIR, 'modified_erb_file_test_model.sql.erb')
+      update_file sql_file, 'foo <%= test_erb_method %>'
 
-        class ModifiedErbFileTestModel < ActiveRecord::Base
-          is_view
+      class ModifiedErbFileTestModel < ActiveRecord::Base
+        def self.test_erb_method
+          2 * 3 * 7
         end
 
-        update_file sql_file, 'bar <%= 2*3*7 %>'
-        test_request
+        is_view
       end
+
+      update_file sql_file, 'bar <%= test_erb_method %>'
+      test_request
+
+      File.unlink sql_file
       test_request # trigger cleanup
     end
 
     it 'drops the view if the external SQL file is deleted' do
-      with_temp_sql_dir do |temp_dir|
-        sql_file = File.join(temp_dir, 'deleted_file_test_model.sql')
-        File.write sql_file, "SELECT 1 AS id, 'delete test'::text AS name"
+      sql_file = File.join(TEST_TEMP_MODEL_DIR, 'deleted_file_test_model.sql')
+      File.write sql_file, "SELECT 1 AS id, 'delete test'::text AS name"
 
+      rb_file = 'spec/internal/app/models_temp/deleted_file_test_model.rb'
+      File.write rb_file, <<~RB
         class DeletedFileTestModel < ActiveRecord::Base
           is_view
         end
+      RB
 
+      with_reloader do
         expect(DeletedFileTestModel.first.name).to eq 'delete test'
+      end
 
-        File.unlink sql_file
+      File.unlink sql_file
+      File.unlink rb_file
 
-        expect(ActiveRecord::Base.connection).to receive(:execute).with(/\ADROP/).once.and_call_original
+      expect(ActiveRecord::Base.connection).to receive(:execute).with(/\ADROP/).once.and_call_original
+      expect {
         test_request
-        test_request # second request does not `drop_view` again
+      }.to change { registered_model_class_names.include?('DeletedFileTestModel') }.from(true).to(false)
+        .and change { view_exists?('deleted_file_test_models') }.from(true).to(false)
+      test_request # second request does not `drop_view` again
 
+      if Rails::VERSION::MAJOR >= 5
         expect {
           DeletedFileTestModel.first.name
-        }.to raise_error ActiveRecord::StatementInvalid, /relation "deleted_file_test_models" does not exist/
+        }.to raise_error NameError, 'uninitialized constant DeletedFileTestModel'
       end
     end
 
@@ -161,37 +194,34 @@ describe ActiveRecordViews::Extension do
     end
 
     it 'creates/refreshes/drops materialized views' do
-      with_temp_sql_dir do |temp_dir|
-        sql_file = File.join(temp_dir, 'materialized_view_test_model.sql')
-        File.write sql_file, 'SELECT 123 AS id;'
+      sql_file = File.join(TEST_TEMP_MODEL_DIR, 'materialized_view_test_model.sql')
+      File.write sql_file, 'SELECT 123 AS id;'
 
-        class MaterializedViewTestModel < ActiveRecord::Base
-          is_view materialized: true
-        end
+      class MaterializedViewTestModel < ActiveRecord::Base
+        is_view materialized: true
+      end
 
-        expect {
-          MaterializedViewTestModel.first!
-        }.to raise_error ActiveRecord::StatementInvalid, /materialized view "materialized_view_test_models" has not been populated/
+      expect {
+        MaterializedViewTestModel.first!
+      }.to raise_error ActiveRecord::StatementInvalid, /materialized view "materialized_view_test_models" has not been populated/
 
-        expect(MaterializedViewTestModel.view_populated?).to eq false
-        expect(MaterializedViewTestModel.refreshed_at).to eq nil
+      expect(MaterializedViewTestModel.view_populated?).to eq false
+      expect(MaterializedViewTestModel.refreshed_at).to eq nil
 
-        MaterializedViewTestModel.refresh_view!
+      MaterializedViewTestModel.refresh_view!
 
-        expect(MaterializedViewTestModel.view_populated?).to eq true
-        expect(MaterializedViewTestModel.refreshed_at).to be_a ActiveSupport::TimeWithZone
-        expect(MaterializedViewTestModel.refreshed_at.zone).to eq 'UTC'
-        expect(MaterializedViewTestModel.refreshed_at).to be_within(1.second).of Time.now
+      expect(MaterializedViewTestModel.view_populated?).to eq true
+      expect(MaterializedViewTestModel.refreshed_at).to be_a Time
+      expect(MaterializedViewTestModel.refreshed_at.zone).to eq 'UTC'
+      expect(MaterializedViewTestModel.refreshed_at).to be_within(1.second).of Time.now
 
-        expect(MaterializedViewTestModel.first!.id).to eq 123
+      expect(MaterializedViewTestModel.first!.id).to eq 123
 
-        File.unlink sql_file
-        test_request
+      File.unlink sql_file
 
-        expect {
-          MaterializedViewTestModel.first!
-        }.to raise_error ActiveRecord::StatementInvalid, /relation "materialized_view_test_models" does not exist/
-      end
+      expect {
+        test_request
+      }.to change { view_exists?('materialized_view_test_models') }.from(true).to(false)
     end
 
     it 'raises an error for `view_populated?` if view is not materialized' do
@@ -217,7 +247,7 @@ describe ActiveRecordViews::Extension do
         is_view "SELECT * FROM #{EnsurePopulatedBar.table_name}", dependencies: [EnsurePopulatedBar]
       end
 
-      expect(ActiveRecord::Base.connection).to receive(:execute).with(/^REFRESH MATERIALIZED VIEW/).once.and_call_original
+      expect(ActiveRecord::Base.connection).to receive(:execute).with('REFRESH MATERIALIZED VIEW "ensure_populated_foos";').once.and_call_original
       allow(ActiveRecord::Base.connection).to receive(:execute).and_call_original
 
       expect(EnsurePopulatedFoo.view_populated?).to eq false
@@ -227,6 +257,23 @@ describe ActiveRecordViews::Extension do
       expect(EnsurePopulatedFoo.view_populated?).to eq true
     end
 
+    it 'invalidates ActiveRecord query cache after populating' do
+      class EnsurePopulatedCache < ActiveRecord::Base
+        is_view 'SELECT 1 AS id;', materialized: true
+      end
+
+      expect(ActiveRecord::Base.connection).to receive(:execute).with('REFRESH MATERIALIZED VIEW "ensure_populated_caches";').once.and_call_original
+      allow(ActiveRecord::Base.connection).to receive(:execute).and_call_original
+
+      ActiveRecord::Base.connection.cache do
+        expect(EnsurePopulatedCache.view_populated?).to eq false
+        EnsurePopulatedCache.ensure_populated!
+        expect(EnsurePopulatedCache.view_populated?).to eq true
+        EnsurePopulatedCache.ensure_populated!
+        expect(EnsurePopulatedCache.view_populated?).to eq true
+      end
+    end
+
     it 'supports refreshing materialized views concurrently' do
       class MaterializedViewRefreshTestModel < ActiveRecord::Base
         is_view 'SELECT 1 AS id;', materialized: true
@@ -234,23 +281,50 @@ describe ActiveRecordViews::Extension do
       class MaterializedViewConcurrentRefreshTestModel < ActiveRecord::Base
         is_view 'SELECT 1 AS id;', materialized: true, unique_columns: [:id]
       end
+      MaterializedViewRefreshTestModel.refresh_view!
       MaterializedViewConcurrentRefreshTestModel.refresh_view!
 
-      [
+      sql_statements.clear
+
+      MaterializedViewRefreshTestModel.refresh_view!
+      MaterializedViewRefreshTestModel.refresh_view! concurrent: false
+      expect {
+        MaterializedViewRefreshTestModel.refresh_view! concurrent: true
+      }.to raise_error ActiveRecord::StatementInvalid, /^PG::ObjectNotInPrerequisiteState: ERROR: +cannot refresh/
+      MaterializedViewConcurrentRefreshTestModel.refresh_view!
+      MaterializedViewConcurrentRefreshTestModel.refresh_view! concurrent: false
+      MaterializedViewConcurrentRefreshTestModel.refresh_view! concurrent: true
+
+      expect(sql_statements.grep_v(/^SELECT/)).to eq [
         'BEGIN',
         'REFRESH MATERIALIZED VIEW "materialized_view_refresh_test_models";',
         "UPDATE active_record_views SET refreshed_at = current_timestamp AT TIME ZONE 'UTC' WHERE name = 'materialized_view_refresh_test_models';",
         'COMMIT',
+
+        'BEGIN',
+        'REFRESH MATERIALIZED VIEW "materialized_view_refresh_test_models";',
+        "UPDATE active_record_views SET refreshed_at = current_timestamp AT TIME ZONE 'UTC' WHERE name = 'materialized_view_refresh_test_models';",
+        'COMMIT',
+
+        'BEGIN',
+        'REFRESH MATERIALIZED VIEW CONCURRENTLY "materialized_view_refresh_test_models";',
+        'ROLLBACK',
+
         'BEGIN',
         'REFRESH MATERIALIZED VIEW CONCURRENTLY "materialized_view_concurrent_refresh_test_models";',
         "UPDATE active_record_views SET refreshed_at = current_timestamp AT TIME ZONE 'UTC' WHERE name = 'materialized_view_concurrent_refresh_test_models';",
         'COMMIT',
-      ].each do |sql|
-        expect(ActiveRecord::Base.connection).to receive(:execute).with(sql).once.and_call_original
-      end
 
-      MaterializedViewRefreshTestModel.refresh_view!
-      MaterializedViewConcurrentRefreshTestModel.refresh_view! concurrent: true
+        'BEGIN',
+        'REFRESH MATERIALIZED VIEW "materialized_view_concurrent_refresh_test_models";',
+        "UPDATE active_record_views SET refreshed_at = current_timestamp AT TIME ZONE 'UTC' WHERE name = 'materialized_view_concurrent_refresh_test_models';",
+        'COMMIT',
+
+        'BEGIN',
+        'REFRESH MATERIALIZED VIEW CONCURRENTLY "materialized_view_concurrent_refresh_test_models";',
+        "UPDATE active_record_views SET refreshed_at = current_timestamp AT TIME ZONE 'UTC' WHERE name = 'materialized_view_concurrent_refresh_test_models';",
+        'COMMIT',
+      ]
     end
 
     it 'supports opportunistically refreshing materialized views concurrently' do
@@ -258,21 +332,28 @@ describe ActiveRecordViews::Extension do
         is_view 'SELECT 1 AS id;', materialized: true, unique_columns: [:id]
       end
 
-      [
+      sql_statements.clear
+
+      MaterializedViewAutoRefreshTestModel.refresh_view! concurrent: :auto
+      MaterializedViewAutoRefreshTestModel.refresh_view! concurrent: :auto
+      MaterializedViewAutoRefreshTestModel.refresh_view! concurrent: :auto
+
+      expect(sql_statements.grep_v(/^SELECT/)).to eq [
         'BEGIN',
         'REFRESH MATERIALIZED VIEW "materialized_view_auto_refresh_test_models";',
         "UPDATE active_record_views SET refreshed_at = current_timestamp AT TIME ZONE 'UTC' WHERE name = 'materialized_view_auto_refresh_test_models';",
         'COMMIT',
+
         'BEGIN',
         'REFRESH MATERIALIZED VIEW CONCURRENTLY "materialized_view_auto_refresh_test_models";',
         "UPDATE active_record_views SET refreshed_at = current_timestamp AT TIME ZONE 'UTC' WHERE name = 'materialized_view_auto_refresh_test_models';",
         'COMMIT',
-      ].each do |sql|
-        expect(ActiveRecord::Base.connection).to receive(:execute).with(sql).once.and_call_original
-      end
 
-      MaterializedViewAutoRefreshTestModel.refresh_view! concurrent: :auto
-      MaterializedViewAutoRefreshTestModel.refresh_view! concurrent: :auto
+        'BEGIN',
+        'REFRESH MATERIALIZED VIEW CONCURRENTLY "materialized_view_auto_refresh_test_models";',
+        "UPDATE active_record_views SET refreshed_at = current_timestamp AT TIME ZONE 'UTC' WHERE name = 'materialized_view_auto_refresh_test_models';",
+        'COMMIT',
+      ]
     end
 
     it 'raises an error when refreshing materialized views with invalid concurrent option' do

data/spec/active_record_views_spec.rb

@@ -20,6 +20,28 @@ describe ActiveRecordViews do
       SQL
     end
 
+    def test_view_populated?
+      value = connection.select_value(<<~SQL)
+        SELECT ispopulated
+        FROM pg_matviews
+        WHERE schemaname = 'public' AND matviewname = 'test'
+      SQL
+
+      if Rails::VERSION::MAJOR < 5
+        value = ActiveRecord::ConnectionAdapters::Column::TRUE_VALUES.include?(value)
+      end
+
+      value
+    end
+
+    def test_view_refreshed_at
+      connection.select_value(<<~SQL)
+        SELECT refreshed_at
+        FROM active_record_views
+        WHERE name = 'test'
+      SQL
+    end
+
     def test_materialized_view_sql
       connection.select_value(<<-SQL.squish).try(&:squish)
         SELECT definition
@@ -228,6 +250,28 @@ describe ActiveRecordViews do
         create_test_view 'select 1 as foo, 2 as bar, 3 as baz', materialized: false, unique_columns: [:foo, 'bar']
       }.to raise_error ArgumentError, 'unique_columns option requires view to be materialized'
     end
+
+    it 'supports resetting all materialised views' do
+      class ResetMaterializeViewTestModel < ActiveRecord::Base
+        self.table_name = 'test'
+        is_view 'select 123 as id', materialized: true
+      end
+      ResetMaterializeViewTestModel.refresh_view!
+
+      expect {
+        ActiveRecordViews.reset_materialized_views
+      }.to change { test_view_populated? }.to(false)
+        .and change { test_view_refreshed_at }.to(nil)
+    end
+  end
+
+  describe '.drop_all_views' do
+    let(:connection) { ActiveRecord::Base.connection }
+
+    it 'does nothing when no views have been defined' do
+      ActiveRecordViews.drop_all_views connection
+      expect(view_names).to match_array %w[]
+    end
   end
 
   describe '.without_transaction' do
@@ -289,5 +333,16 @@ describe ActiveRecordViews do
         original_connection.pool.checkin original_connection_2
       end
     end
+
+    it 'does not attempt to checkin when checkout fails' do
+      expect(original_connection.pool).to receive(:checkout).and_raise PG::ConnectionBad
+      expect(original_connection.pool).to_not receive(:checkin)
+
+      expect {
+        original_connection.transaction do
+          ActiveRecordViews.without_transaction(original_connection) { }
+        end
+      }.to raise_error PG::ConnectionBad
+    end
   end
 end

data/spec/internal/Rakefile

@@ -1,4 +1,5 @@
 require 'bundler/setup'
+require './spec/support/silence_warnings.rb'
 require 'combustion'
 
 Combustion::Database.instance_eval do
@@ -10,6 +11,10 @@ end
 Combustion.initialize! :active_record, :action_controller do
   config.cache_classes = false
   config.log_level = :debug
+  config.active_record.schema_format = ENV.fetch('SCHEMA_FORMAT', 'sql').to_sym
+  if ENV['SKIP_MODEL_EAGER_LOAD']
+    config.eager_load_paths -= Rails.application.config.paths['app/models'].to_a
+  end
 end
 
 load 'active_record/railties/databases.rake'

data/spec/internal/app/models/erb_test_model.rb

@@ -1,3 +1,7 @@
 class ErbTestModel < ActiveRecord::Base
+  def self.test_erb_method
+    'ERB method'
+  end
+
   is_view
 end

data/spec/internal/app/models/erb_test_model.sql.erb

@@ -1 +1 @@
-SELECT 1 AS id, '<%= "ERB" %> file'::text AS name;
+SELECT 1 AS id, '<%= test_erb_method %> file'::text AS name;

data/spec/internal/config/database.yml

@@ -2,6 +2,7 @@ test: &test
   adapter: postgresql
   database: activerecord_views_test
   min_messages: warning
+  advisory_locks: <%= !Rails.version.start_with?('6.0.') %>
 development:
   <<: *test
 production:

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  root to: -> (env) { [204, {}, []] }
+end

data/spec/spec_helper.rb

@@ -4,21 +4,52 @@ Bundler.setup
 require 'rails/version'
 $VERBOSE = true
 
+require './spec/support/silence_warnings.rb'
+
 require 'combustion'
 require 'active_record_views'
 
 FileUtils.mkdir_p 'spec/internal/db'
 File.write 'spec/internal/db/schema.rb', ''
 
+TEST_TEMP_MODEL_DIR = Rails.root + 'spec/internal/app/models_temp'
+FileUtils.mkdir_p TEST_TEMP_MODEL_DIR
+Rails.application.config.paths['app/models'] << 'app/models_temp'
+
 Combustion.initialize! :active_record, :action_controller do
   config.cache_classes = false
 end
 require 'rspec/rails'
+require 'super_diff/rspec-rails'
+
+RSpec.shared_context 'sql_statements' do
+  let(:sql_statements) { [] }
+
+  let!(:sql_statements_subscription) do
+    ActiveSupport::Notifications.subscribe('sql.active_record') do |_, _, _, _, details|
+      sql_statements << details.fetch(:sql)
+    end
+  end
+
+  after do
+    ActiveSupport::Notifications.unsubscribe sql_statements_subscription
+  end
+end
 
 RSpec.configure do |config|
   config.use_transactional_fixtures = false
+  config.filter_run_when_matching focus: true
+  config.filter_run_excluding skip: true
+  config.example_status_persistence_file_path = 'tmp/examples.txt'
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_doubled_constant_names = true
+    mocks.verify_partial_doubles = true
+  end
 
   config.before do
+    FileUtils.rm_rf Dir["spec/internal/app/models_temp/*"]
+
     if Rails::VERSION::MAJOR >= 5
       Rails.application.reloader.reload!
     else
@@ -48,24 +79,27 @@ RSpec.configure do |config|
       connection.execute "DROP MATERIALIZED VIEW IF EXISTS #{connection.quote_table_name view_name} CASCADE"
     end
   end
+
+  config.include_context 'sql_statements'
 end
 
-def test_request
-  begin
-    Rails.application.call({'REQUEST_METHOD' => 'GET', 'PATH_INFO' => '/'})
-  rescue ActionController::RoutingError
+def with_reloader(&block)
+  if Rails.application.respond_to?(:reloader)
+    Rails.application.reloader.wrap(&block)
+  else
+    block.call
   end
 end
 
-def with_temp_sql_dir
-  Dir.mktmpdir do |temp_dir|
-    begin
-      old_sql_load_path = ActiveRecordViews.sql_load_path
-      ActiveRecordViews.sql_load_path = [temp_dir] + old_sql_load_path
-      yield temp_dir
-    ensure
-      ActiveRecordViews.sql_load_path = old_sql_load_path
-    end
+def test_request
+  with_reloader do
+    status, headers, body = Rails.application.call(
+      'REQUEST_METHOD' => 'GET',
+      'PATH_INFO' => '/',
+      'rack.input' => StringIO.new,
+    )
+    expect(status).to eq 204
+    body.close
   end
 end
 

data/spec/support/silence_warnings.rb

@@ -0,0 +1,23 @@
+require 'warning'
+require 'rails/version'
+
+case Rails::VERSION::STRING
+when /^4\.2\./
+  Warning.ignore(%r{lib/(active_support/core_ext|action_dispatch/middleware)/.+: warning: (method redefined|previous definition)})
+  Warning.ignore(%r{lib/active_support/core_ext/.+: warning: BigDecimal.new is deprecated})
+  Warning.ignore(%r{lib/arel/visitors/informix.rb:\d+: warning: assigned but unused variable})
+  Warning.ignore(%r{lib/active_record/connection_adapters/.+: warning: deprecated Object#=~ is called on Integer})
+  Warning.ignore(%r{Inheriting from Rack::Session::Abstract::ID is deprecated})
+when /^5\.0\./
+  Warning.ignore(%r{lib/(active_support/core_ext|action_view)/.+: warning: (method redefined|previous definition)})
+  Warning.ignore(%r{lib/arel/visitors/informix.rb:\d+: warning: assigned but unused variable})
+  Warning.ignore(%r{lib/action_view/.+: warning: `\*' interpreted as argument prefix})
+when /^5\.1\./
+  Warning.ignore(%r{lib/(active_support/core_ext)/.+: warning: (method redefined|previous definition)})
+  Warning.ignore(%r{lib/arel/visitors/informix.rb:\d+: warning: assigned but unused variable})
+  Warning.ignore(%r{lib/active_record/.+/schema_statements.rb:\d+: (warning: in `drop_table': the last argument was passed as a single Hash|warning: although a splat keyword arguments here)})
+end
+
+Warning.process do |_warning|
+  :raise
+end