scenic 1.6.0 → 1.8.0

data/spec/dummy/bin/rake

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require_relative '../config/boot'
-require 'rake'
+require_relative "../config/boot"
+require "rake"
 Rake.application.run

data/spec/dummy/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path("../config/environment", __FILE__)
 run Rails.application

data/spec/dummy/db/migrate/20220112154220_add_pg_stat_statements_extension.rb

@@ -1,5 +1,5 @@
 class AddPgStatStatementsExtension < ActiveRecord::Migration[6.1]
   def change
-    enable_extension 'pg_stat_statements'
+    enable_extension "pg_stat_statements"
   end
 end

data/spec/dummy/db/schema.rb

@@ -11,9 +11,7 @@
 # It's strongly recommended that you check this file into your version control system.
 
 ActiveRecord::Schema.define(version: 2022_01_12_154220) do
-
   # These are extensions that must be enabled in order to support this database
   enable_extension "pg_stat_statements"
   enable_extension "plpgsql"
-
 end

data/spec/generators/scenic/model/model_generator_spec.rb

@@ -6,7 +6,7 @@ module Scenic::Generators
     before do
       allow(ViewGenerator).to receive(:new)
         .and_return(
-          instance_double("Scenic::Generators::ViewGenerator").as_null_object,
+          instance_double("Scenic::Generators::ViewGenerator").as_null_object
         )
     end
 
@@ -32,5 +32,13 @@ module Scenic::Generators
       expect(model_definition).to contain("self.refresh")
       expect(model_definition).to have_correct_syntax
     end
+
+    it "adds a populated? method to materialized models" do
+      run_generator ["active_user", "--materialized"]
+      model_definition = file("app/models/active_user.rb")
+
+      expect(model_definition).to contain("self.populated?")
+      expect(model_definition).to have_correct_syntax
+    end
   end
 end

data/spec/generators/scenic/view/view_generator_spec.rb

@@ -31,12 +31,24 @@ describe Scenic::Generators::ViewGenerator, :generator do
 
       run_generator ["aired_episode", "--materialized"]
       migration = migration_file(
-        "db/migrate/update_aired_episodes_to_version_2.rb",
+        "db/migrate/update_aired_episodes_to_version_2.rb"
       )
       expect(migration).to contain "materialized: true"
     end
   end
 
+  it "uses 'replace_view' instead of 'update_view' if replace flag is set" do
+    with_view_definition("aired_episodes", 1, "hello") do
+      allow(Dir).to receive(:entries).and_return(["aired_episodes_v01.sql"])
+
+      run_generator ["aired_episode", "--replace"]
+      migration = migration_file(
+        "db/migrate/update_aired_episodes_to_version_2.rb"
+      )
+      expect(migration).to contain "replace_view"
+    end
+  end
+
   context "for views created in a schema other than 'public'" do
     it "creates a view definition" do
       view_definition = file("db/views/non_public_searches_v01.sql")

data/spec/integration/revert_spec.rb

@@ -61,7 +61,7 @@ describe "Reverting scenic schema statements", :db do
   end
 
   def run_migration(migration, directions)
-    silence_stream(STDOUT) do
+    silence_stream($stdout) do
       Array.wrap(directions).each do |direction|
         migration.migrate(direction)
       end

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

@@ -9,7 +9,7 @@ module Scenic
             base_response = double("response from base connection")
             base_connection = double(
               "Connection",
-              supports_materialized_views?: base_response,
+              supports_materialized_views?: base_response
             )
 
             connection = Postgres::Connection.new(base_connection)

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

@@ -9,27 +9,27 @@ module Scenic
         before do
           adapter.create_materialized_view(
             "first",
-            "SELECT text 'hi' AS greeting",
+            "SELECT text 'hi' AS greeting"
           )
           adapter.create_materialized_view(
             "second",
-            "SELECT * FROM first",
+            "SELECT * FROM first"
           )
           adapter.create_materialized_view(
             "third",
-            "SELECT * FROM first UNION SELECT * FROM second",
+            "SELECT * FROM first UNION SELECT * FROM second"
           )
           adapter.create_materialized_view(
             "fourth_1",
-            "SELECT * FROM third",
+            "SELECT * FROM third"
           )
           adapter.create_materialized_view(
             "x_fourth",
-            "SELECT * FROM fourth_1",
+            "SELECT * FROM fourth_1"
           )
           adapter.create_materialized_view(
             "fourth",
-            "SELECT * FROM fourth_1 UNION SELECT * FROM x_fourth",
+            "SELECT * FROM fourth_1 UNION SELECT * FROM x_fourth"
           )
 
           expect(adapter).to receive(:refresh_materialized_view)
@@ -49,7 +49,7 @@ module Scenic
             :fourth,
             adapter,
             ActiveRecord::Base.connection,
-            concurrently: true,
+            concurrently: true
           )
         end
 
@@ -58,7 +58,7 @@ module Scenic
             "public.fourth",
             adapter,
             ActiveRecord::Base.connection,
-            concurrently: true,
+            concurrently: true
           )
         end
       end
@@ -69,7 +69,7 @@ module Scenic
 
           adapter.create_materialized_view(
             "first",
-            "SELECT text 'hi' AS greeting",
+            "SELECT text 'hi' AS greeting"
           )
 
           expect {

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
 
@@ -179,7 +179,7 @@ module Scenic
             "parents",
             "children",
             "people",
-            "people_with_names",
+            "people_with_names"
           ]
         end
 
@@ -199,11 +199,57 @@ module Scenic
 
             expect(adapter.views.map(&:name)).to eq [
               "parents",
-              "scenic.parents",
+              "scenic.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
     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,7 +72,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.update_view(*args) } }
         .to raise_error(ActiveRecord::IrreversibleMigration)
@@ -81,7 +81,7 @@ describe Scenic::CommandRecorder do
 
   describe "#replace_view" do
     it "records the replaced view" do
-      args = [:users, { version: 2 }]
+      args = [:users, {version: 2}]
 
       recorder.replace_view(*args)
 
@@ -89,8 +89,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 +98,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

@@ -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
@@ -37,7 +37,7 @@ describe Scenic::SchemaDumper, :db do
     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
@@ -67,7 +67,7 @@ describe Scenic::SchemaDumper, :db do
       output = stream.string
       expect(output).to include 'create_view "scenic.searches",'
 
-      Search.connection.drop_view :'scenic.searches'
+      Search.connection.drop_view :"scenic.searches"
     end
   end
 
@@ -113,7 +113,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,7 +123,7 @@ 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
@@ -137,7 +137,7 @@ describe Scenic::SchemaDumper, :db do
 
       Search.connection.drop_view :'scenic."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

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)
@@ -137,7 +137,7 @@ 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)
@@ -147,7 +147,7 @@ module Scenic
       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,7 +156,7 @@ 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

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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scenic
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Derek Prior
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-13 00:00:00.000000000 Z
+date: 2024-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,6 +137,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -180,8 +194,6 @@ files:
 - ".devcontainer/docker-compose.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
-- ".hound.yml"
-- ".rubocop.yml"
 - ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -194,6 +206,7 @@ files:
 - bin/rake
 - bin/rspec
 - bin/setup
+- bin/standardrb
 - bin/yard
 - lib/generators/scenic/generators.rb
 - lib/generators/scenic/materializable.rb
@@ -277,42 +290,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Support for database views in Rails migrations
-test_files:
-- spec/acceptance/user_manages_views_spec.rb
-- spec/acceptance_helper.rb
-- spec/dummy/.gitignore
-- spec/dummy/Rakefile
-- spec/dummy/app/models/application_record.rb
-- spec/dummy/bin/bundle
-- spec/dummy/bin/rails
-- spec/dummy/bin/rake
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/db/migrate/.keep
-- spec/dummy/db/migrate/20220112154220_add_pg_stat_statements_extension.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/db/views/.keep
-- spec/generators/scenic/model/model_generator_spec.rb
-- spec/generators/scenic/view/view_generator_spec.rb
-- spec/integration/revert_spec.rb
-- spec/scenic/adapters/postgres/connection_spec.rb
-- spec/scenic/adapters/postgres/refresh_dependencies_spec.rb
-- spec/scenic/adapters/postgres/views_spec.rb
-- spec/scenic/adapters/postgres_spec.rb
-- spec/scenic/command_recorder/statement_arguments_spec.rb
-- spec/scenic/command_recorder_spec.rb
-- spec/scenic/configuration_spec.rb
-- spec/scenic/definition_spec.rb
-- spec/scenic/schema_dumper_spec.rb
-- spec/scenic/statements_spec.rb
-- spec/spec_helper.rb
-- spec/support/generator_spec_setup.rb
-- spec/support/rails_configuration_helpers.rb
-- spec/support/view_definition_helpers.rb
+test_files: []

data/.hound.yml

@@ -1,2 +0,0 @@
-rubocop:
-  config_file: .rubocop.yml