scenic 1.4.1 → 1.7.0

data/lib/scenic/statements.rb

@@ -9,8 +9,9 @@ module Scenic
     # @param sql_definition [String] The SQL query for the view schema. An error
     #   will be raised if `sql_definition` and `version` are both set,
     #   as they are mutually exclusive.
-    # @param materialized [Boolean] Set to true to create a materialized view.
-    #   Defaults to false.
+    # @param materialized [Boolean, Hash] Set to true to create a materialized
+    #   view. Set to { no_data: true } to create materialized view without
+    #   loading data. Defaults to false.
     # @return The database response from executing the create statement.
     #
     # @example Create from `db/views/searches_v02.sql`
@@ -36,7 +37,11 @@ module Scenic
       sql_definition ||= definition(name, version)
 
       if materialized
-        Scenic.database.create_materialized_view(name, sql_definition)
+        Scenic.database.create_materialized_view(
+          name,
+          sql_definition,
+          no_data: no_data(materialized),
+        )
       else
         Scenic.database.create_view(name, sql_definition)
       end
@@ -75,8 +80,9 @@ module Scenic
     #   as they are mutually exclusive.
     # @param revert_to_version [Fixnum] The version number to rollback to on
     #   `rake db rollback`
-    # @param materialized [Boolean] True if updating a materialized view.
-    #   Defaults to false.
+    # @param materialized [Boolean, Hash] True if updating a materialized view.
+    #   Set to { no_data: true } to update materialized view without loading
+    #   data. Defaults to false.
     # @return The database response from executing the create statement.
     #
     # @example
@@ -100,7 +106,11 @@ module Scenic
       sql_definition ||= definition(name, version)
 
       if materialized
-        Scenic.database.update_materialized_view(name, sql_definition)
+        Scenic.database.update_materialized_view(
+          name,
+          sql_definition,
+          no_data: no_data(materialized),
+        )
       else
         Scenic.database.update_view(name, sql_definition)
       end
@@ -141,5 +151,13 @@ module Scenic
     def definition(name, version)
       Scenic::Definition.new(name, version).to_sql
     end
+
+    def no_data(materialized)
+      if materialized.is_a?(Hash)
+        materialized.fetch(:no_data, false)
+      else
+        false
+      end
+    end
   end
 end

data/lib/scenic/unaffixed_name.rb

@@ -0,0 +1,31 @@
+module Scenic
+  # The name of a view or table according to rails.
+  #
+  # This removes any table name prefix or suffix that is configured via
+  # ActiveRecord. This allows, for example, the SchemaDumper to dump a view with
+  # its unaffixed name, consistent with how rails handles table dumping.
+  class UnaffixedName
+    # Gets the unaffixed name for the provided string
+    # @return [String]
+    #
+    # @param name [String] The (potentially) affixed view name
+    def self.for(name)
+      new(name, config: ActiveRecord::Base).call
+    end
+
+    def initialize(name, config:)
+      @name = name
+      @config = config
+    end
+
+    def call
+      prefix = Regexp.escape(config.table_name_prefix)
+      suffix = Regexp.escape(config.table_name_suffix)
+      name.sub(/\A#{prefix}(.+)#{suffix}\z/, "\\1")
+    end
+
+    private
+
+    attr_reader :name, :config
+  end
+end

data/lib/scenic/version.rb

@@ -1,3 +1,3 @@
 module Scenic
-  VERSION = "1.4.1".freeze
+  VERSION = "1.7.0".freeze
 end

data/lib/scenic/view.rb

@@ -26,7 +26,7 @@ module Scenic
     #
     # @param name [String] The name of the view.
     # @param definition [String] The SQL for the query that defines the view.
-    # @param materialized [String] `true` if the view is materialized.
+    # @param materialized [Boolean] `true` if the view is materialized.
     def initialize(name:, definition:, materialized:)
       @name = name
       @definition = definition
@@ -45,11 +45,14 @@ module Scenic
       materialized_option = materialized ? "materialized: true, " : ""
 
       <<-DEFINITION
-  create_view #{name.inspect}, #{materialized_option} sql_definition: <<-\SQL
-    #{definition.indent(2)}
+  create_view #{UnaffixedName.for(name).inspect}, #{materialized_option}sql_definition: <<-\SQL
+    #{escaped_definition.indent(2)}
   SQL
-
       DEFINITION
     end
+
+    def escaped_definition
+      definition.gsub("\\", "\\\\\\")
+    end
   end
 end

data/lib/scenic.rb

@@ -5,6 +5,7 @@ require "scenic/definition"
 require "scenic/railtie"
 require "scenic/schema_dumper"
 require "scenic/statements"
+require "scenic/unaffixed_name"
 require "scenic/version"
 require "scenic/view"
 require "scenic/index"

data/scenic.gemspec

@@ -1,38 +1,36 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'scenic/version'
+require "scenic/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'scenic'
+  spec.name          = "scenic"
   spec.version       = Scenic::VERSION
-  spec.authors       = ['Derek Prior', 'Caleb Thompson']
-  spec.email         = ['derekprior@gmail.com', 'caleb@calebthompson.io']
-  spec.summary       = %q{Support for database views in Rails migrations}
+  spec.authors       = ["Derek Prior", "Caleb Hearth"]
+  spec.email         = ["derekprior@gmail.com", "caleb@calebhearth.com"]
+  spec.summary       = "Support for database views in Rails migrations"
   spec.description   = <<-DESCRIPTION
     Adds methods to ActiveRecord::Migration to create and manage database views
     in Rails
   DESCRIPTION
-  spec.homepage      = 'https://github.com/thoughtbot/scenic'
-  spec.license       = 'MIT'
+  spec.homepage      = "https://github.com/scenic-views/scenic"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.test_files    = spec.files.grep(%r{^spec/})
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency 'bundler', '>= 1.5'
-  spec.add_development_dependency 'database_cleaner'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '>= 3.3'
-  spec.add_development_dependency 'pg'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'ammeter', '>= 1.1.3'
-  spec.add_development_dependency 'yard'
-  spec.add_development_dependency 'redcarpet'
+  spec.add_development_dependency "bundler", ">= 1.5"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.3"
+  spec.add_development_dependency "pg", "~> 0.19"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "ammeter", ">= 1.1.3"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "redcarpet"
 
-  spec.add_dependency 'activerecord', '>= 4.0.0'
-  spec.add_dependency 'railties', '>= 4.0.0'
+  spec.add_dependency "activerecord", ">= 4.0.0"
+  spec.add_dependency "railties", ">= 4.0.0"
 
-  spec.required_ruby_version = '~> 2.1'
+  spec.required_ruby_version = ">= 2.3.0"
 end

data/spec/acceptance/user_manages_views_spec.rb

@@ -1,4 +1,5 @@
 require "acceptance_helper"
+require "English"
 
 describe "User manages views" do
   it "handles simple views" do
@@ -56,7 +57,7 @@ describe "User manages views" do
 
   def successfully(command)
     `RAILS_ENV=test #{command}`
-    expect($?.exitstatus).to eq(0), "'#{command}' was unsuccessful"
+    expect($CHILD_STATUS.exitstatus).to eq(0), "'#{command}' was unsuccessful"
   end
 
   def write_definition(file, contents)

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,5 @@
+if Rails::VERSION::STRING >= "5.0.0"
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/spec/dummy/config/database.yml

@@ -2,7 +2,12 @@ development: &default
   adapter: postgresql
   database: dummy_development
   encoding: unicode
+  host: localhost
   pool: 5
+  <% if ENV.fetch("GITHUB_ACTIONS", false) || ENV.fetch("CODESPACES", false) %>
+  username: <%= ENV.fetch("POSTGRES_USER") %>
+  password: <%= ENV.fetch("POSTGRES_PASSWORD") %>
+  <% end %>
 
 test:
   <<: *default

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

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

data/spec/dummy/db/schema.rb

@@ -0,0 +1,19 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# 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
 

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

@@ -31,21 +31,39 @@ 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 view definition and migration files" do
-      migration = file("db/migrate/create_non_public_searches.rb")
+    it "creates a view definition" do
       view_definition = file("db/views/non_public_searches_v01.sql")
 
       run_generator ["non_public.search"]
 
-      expect(migration).to be_a_migration
       expect(view_definition).to exist
     end
+
+    it "creates a migration file" do
+      run_generator ["non_public.search"]
+
+      migration = migration_file("db/migrate/create_non_public_searches.rb")
+      expect(migration).to contain(/class CreateNonPublicSearches/)
+      expect(migration).to contain(/create_view "non_public.searches"/)
+    end
   end
 end

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

@@ -3,39 +3,79 @@ require "spec_helper"
 module Scenic
   module Adapters
     describe Postgres::RefreshDependencies, :db do
-      it "refreshes dependecies in the correct order" do
-        adapter = Postgres.new
+      context "view has dependencies" do
+        let(:adapter) { Postgres.new }
 
-        adapter.create_materialized_view(
-          "first",
-          "SELECT text 'hi' AS greeting",
-        )
+        before do
+          adapter.create_materialized_view(
+            "first",
+            "SELECT text 'hi' AS greeting",
+          )
+          adapter.create_materialized_view(
+            "second",
+            "SELECT * FROM first",
+          )
+          adapter.create_materialized_view(
+            "third",
+            "SELECT * FROM first UNION SELECT * FROM second",
+          )
+          adapter.create_materialized_view(
+            "fourth_1",
+            "SELECT * FROM third",
+          )
+          adapter.create_materialized_view(
+            "x_fourth",
+            "SELECT * FROM fourth_1",
+          )
+          adapter.create_materialized_view(
+            "fourth",
+            "SELECT * FROM fourth_1 UNION SELECT * FROM x_fourth",
+          )
 
-        adapter.create_materialized_view(
-          "second",
-          "SELECT * from first",
-        )
+          expect(adapter).to receive(:refresh_materialized_view)
+            .with("public.first", concurrently: true).ordered
+          expect(adapter).to receive(:refresh_materialized_view)
+            .with("public.second", concurrently: true).ordered
+          expect(adapter).to receive(:refresh_materialized_view)
+            .with("public.third", concurrently: true).ordered
+          expect(adapter).to receive(:refresh_materialized_view)
+            .with("public.fourth_1", concurrently: true).ordered
+          expect(adapter).to receive(:refresh_materialized_view)
+            .with("public.x_fourth", concurrently: true).ordered
+        end
 
-        adapter.create_materialized_view(
-          "third",
-          "SELECT * from first UNION SELECT * from second",
-        )
+        it "refreshes in the right order when called without namespace" do
+          described_class.call(
+            :fourth,
+            adapter,
+            ActiveRecord::Base.connection,
+            concurrently: true,
+          )
+        end
 
-        adapter.create_materialized_view(
-          "fourth",
-          "SELECT * from third",
-        )
-
-        expect(adapter).to receive(:refresh_materialized_view).
-          with("public.first").ordered
+        it "refreshes in the right order when called with namespace" do
+          described_class.call(
+            "public.fourth",
+            adapter,
+            ActiveRecord::Base.connection,
+            concurrently: true,
+          )
+        end
+      end
 
-        expect(adapter).to receive(:refresh_materialized_view).
-          with("public.second").ordered
+      context "view has no dependencies" do
+        it "does not raise an error" do
+          adapter = Postgres.new
 
-        expect(adapter).to receive(:refresh_materialized_view).
-          with("public.third").ordered
+          adapter.create_materialized_view(
+            "first",
+            "SELECT text 'hi' AS greeting",
+          )
 
-        described_class.call(:fourth, adapter, ActiveRecord::Base.connection)
+          expect {
+            described_class.call(:first, adapter, ActiveRecord::Base.connection)
+          }.not_to raise_error
+        end
       end
     end
   end

data/spec/scenic/adapters/postgres_spec.rb

@@ -27,6 +27,20 @@ module Scenic
           expect(view.materialized).to eq true
         end
 
+        it "handles semicolon in definition when using `with no data`" do
+          adapter = Postgres.new
+
+          adapter.create_materialized_view(
+            "greetings",
+            "SELECT text 'hi' AS greeting; \n",
+            no_data: true,
+          )
+
+          view = adapter.views.first
+          expect(view.name).to eq("greetings")
+          expect(view.materialized).to eq true
+        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)
@@ -104,9 +118,15 @@ module Scenic
           connection = double("Connection").as_null_object
           connectable = double("Connectable", connection: connection)
           adapter = Postgres.new(connectable)
-          expect(Scenic::Adapters::Postgres::RefreshDependencies).
-            to receive(:call).with(:tests, adapter, connection)
-          adapter.refresh_materialized_view(:tests, cascade: true)
+          expect(Scenic::Adapters::Postgres::RefreshDependencies)
+            .to receive(:call)
+            .with(:tests, adapter, connection, concurrently: true)
+
+          adapter.refresh_materialized_view(
+            :tests,
+            cascade: true,
+            concurrently: true,
+          )
         end
 
         context "refreshing concurrently" do

data/spec/scenic/command_recorder_spec.rb

@@ -8,11 +8,25 @@ describe Scenic::CommandRecorder do
       expect(recorder.commands).to eq [[:create_view, [:greetings], nil]]
     end
 
-    it "reverts to drop_view" do
+    it "reverts to drop_view when not passed a version" do
       recorder.revert { recorder.create_view :greetings }
 
       expect(recorder.commands).to eq [[:drop_view, [:greetings]]]
     end
+
+    it "reverts to drop_view when passed a version" do
+      recorder.revert { recorder.create_view :greetings, version: 2 }
+
+      expect(recorder.commands).to eq [[:drop_view, [:greetings]]]
+    end
+
+    it "reverts materialized views appropriately" do
+      recorder.revert { recorder.create_view :greetings, materialized: true }
+
+      expect(recorder.commands).to eq [
+        [:drop_view, [:greetings, materialized: true]],
+      ]
+    end
   end
 
   describe "#drop_view" do

data/spec/scenic/definition_spec.rb

@@ -22,13 +22,27 @@ module Scenic
     end
 
     describe "path" do
-      it "returns a sql file in db/views with padded version and view name"  do
+      it "returns a sql file in db/views with padded version and view name" do
         expected = "db/views/searches_v01.sql"
 
         definition = Definition.new("searches", 1)
 
         expect(definition.path).to eq expected
       end
+
+      it "handles schema qualified view names" do
+        definition = Definition.new("non_public.searches", 1)
+
+        expect(definition.path).to eq "db/views/non_public_searches_v01.sql"
+      end
+
+      it "handles active record view prefix and suffixing" do
+        with_affixed_tables(prefix: "foo_", suffix: "_bar") do
+          definition = Definition.new("foo_searches_bar", 1)
+
+          expect(definition.path).to eq "db/views/searches_v01.sql"
+        end
+      end
     end
 
     describe "full_path" do

data/spec/scenic/schema_dumper_spec.rb

@@ -15,7 +15,8 @@ describe Scenic::SchemaDumper, :db do
     ActiveRecord::SchemaDumper.dump(Search.connection, stream)
 
     output = stream.string
-    expect(output).to include 'create_view "searches"'
+
+    expect(output).to include 'create_view "searches", sql_definition: <<-SQL'
     expect(output).to include view_definition
 
     Search.connection.drop_view :searches
@@ -25,6 +26,35 @@ describe Scenic::SchemaDumper, :db do
     expect(Search.first.haystack).to eq "needle"
   end
 
+  it "accurately dumps create view statements with a regular expression" do
+    view_definition = "SELECT 'needle'::text AS haystack WHERE 'a2z' ~ '\\d+'"
+    Search.connection.create_view :searches, sql_definition: view_definition
+    stream = StringIO.new
+
+    ActiveRecord::SchemaDumper.dump(Search.connection, stream)
+
+    output = stream.string
+    expect(output).to include "~ '\\\\d+'::text"
+
+    Search.connection.drop_view :searches
+    silence_stream(STDOUT) { eval(output) }
+
+    expect(Search.first.haystack).to eq "needle"
+  end
+
+  it "dumps a create_view for a materialized view in the database" do
+    view_definition = "SELECT 'needle'::text AS haystack"
+    Search.connection.create_view :searches, materialized: true, sql_definition: view_definition
+    stream = StringIO.new
+
+    ActiveRecord::SchemaDumper.dump(Search.connection, stream)
+
+    output = stream.string
+
+    expect(output).to include 'create_view "searches", materialized: true, sql_definition: <<-SQL'
+    expect(output).to include view_definition
+  end
+
   context "with views in non public schemas" do
     it "dumps a create_view including namespace for a view in the database" do
       view_definition = "SELECT 'needle'::text AS haystack"
@@ -41,6 +71,20 @@ describe Scenic::SchemaDumper, :db do
     end
   end
 
+  it "handles active record table name prefixes and suffixes" do
+    with_affixed_tables(prefix: "a_", suffix: "_z") do
+      view_definition = "SELECT 'needle'::text AS haystack"
+      Search.connection.create_view :a_searches_z, sql_definition: view_definition
+      stream = StringIO.new
+
+      ActiveRecord::SchemaDumper.dump(Search.connection, stream)
+
+      output = stream.string
+
+      expect(output).to include 'create_view "searches"'
+    end
+  end
+
   it "ignores tables internal to Rails" do
     view_definition = "SELECT 'needle'::text AS haystack"
     Search.connection.create_view :searches, sql_definition: view_definition
@@ -51,7 +95,7 @@ describe Scenic::SchemaDumper, :db do
     output = stream.string
 
     expect(output).to include 'create_view "searches"'
-    expect(output).not_to include "ar_internal_metadata"
+    expect(output).not_to include "pg_stat_statements_info"
     expect(output).not_to include "schema_migrations"
   end
 
@@ -79,7 +123,8 @@ 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