scenic 1.4.1 → 1.5.4

data/lib/scenic/adapters/postgres/views.rb

@@ -57,7 +57,16 @@ module Scenic
 
         def pg_identifier(name)
           return name if name =~ /^[a-zA-Z_][a-zA-Z0-9_]*$/
-          PGconn.quote_ident(name)
+
+          pgconn.quote_ident(name)
+        end
+
+        def pgconn
+          if defined?(PG::Connection)
+            PG::Connection
+          else
+            PGconn
+          end
         end
       end
     end

data/lib/scenic/command_recorder.rb

@@ -20,7 +20,8 @@ module Scenic
     end
 
     def invert_create_view(args)
-      [:drop_view, args]
+      drop_view_args = StatementArguments.new(args).remove_version.to_a
+      [:drop_view, drop_view_args]
     end
 
     def invert_drop_view(args)

data/lib/scenic/command_recorder/statement_arguments.rb

@@ -22,8 +22,12 @@ module Scenic
         StatementArguments.new([view, options_for_revert])
       end
 
+      def remove_version
+        StatementArguments.new([view, options_without_version])
+      end
+
       def to_a
-        @args.to_a
+        @args.to_a.dup.delete_if(&:empty?)
       end
 
       private
@@ -38,6 +42,10 @@ module Scenic
           revert_options.delete(:revert_to_version)
         end
       end
+
+      def options_without_version
+        options.except(:version)
+      end
     end
   end
 end

data/lib/scenic/configuration.rb

@@ -2,7 +2,7 @@ module Scenic
   class Configuration
     # The Scenic database adapter instance to use when executing SQL.
     #
-    # Defualts to an instance of {Adapters::Postgres}
+    # Defaults to an instance of {Adapters::Postgres}
     # @return Scenic adapter
     attr_accessor :database
 

data/lib/scenic/definition.rb

@@ -29,7 +29,7 @@ module Scenic
     private
 
     def filename
-      "#{@name}_v#{version}.sql"
+      "#{@name.to_s.tr('.', '_')}_v#{version}.sql"
     end
   end
 end

data/lib/scenic/schema_dumper.rb

@@ -32,8 +32,8 @@ module Scenic
       def ignored?(table_name)
         ["schema_migrations", ignore_tables].flatten.any? do |ignored|
           case ignored
-          when String; remove_prefix_and_suffix(table_name) == ignored
-          when Regexp; remove_prefix_and_suffix(table_name) =~ ignored
+          when String then remove_prefix_and_suffix(table_name) == ignored
+          when Regexp then remove_prefix_and_suffix(table_name) =~ ignored
           else
             raise StandardError, "ActiveRecord::SchemaDumper.ignore_tables accepts an array of String and / or Regexp values."
           end

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/version.rb

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

data/lib/scenic/view.rb

@@ -45,10 +45,9 @@ module Scenic
       materialized_option = materialized ? "materialized: true, " : ""
 
       <<-DEFINITION
-  create_view #{name.inspect}, #{materialized_option} sql_definition: <<-\SQL
+  create_view #{name.inspect}, #{materialized_option}sql_definition: <<-\SQL
     #{definition.indent(2)}
   SQL
-
       DEFINITION
     end
   end

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) %>
+  username: <%= ENV.fetch("POSTGRES_USER") %>
+  password: <%= ENV.fetch("POSTGRES_PASSWORD") %>
+  <% end %>
 
 test:
   <<: *default

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,27 @@ 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
 
   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