scenic 1.4.0 → 1.7.0

data/README.md

@@ -1,10 +1,10 @@
 # Scenic
 
-![Scenic Landscape](https://images.thoughtbot.com/announcing-scenic--versioned-database-views-for-rails/MRUcPsxrTGCeWKyE59Zg_landscape.png)
+![Scenic Landscape](https://user-images.githubusercontent.com/152152/49344534-a8817480-f646-11e8-8431-3d95d349c070.png)
 
-[![Build Status](https://travis-ci.org/thoughtbot/scenic.svg)](https://travis-ci.org/thoughtbot/scenic)
-[![Code Climate](https://codeclimate.com/repos/53c9736269568066a3000c35/badges/85aa9b19f3037252c55d/gpa.svg)](https://codeclimate.com/repos/53c9736269568066a3000c35/feed)
-[![Documentation Quality](http://inch-ci.org/github/thoughtbot/scenic.svg?branch=master)](http://inch-ci.org/github/thoughtbot/scenic)
+[![Build Status](https://github.com/scenic-views/scenic/actions/workflows/ci.yml/badge.svg)](https://github.com/scenic-views/scenic/actions/workflows/ci.yml)
+[![Documentation Quality](http://inch-ci.org/github/scenic-views/scenic.svg?branch=master)](http://inch-ci.org/github/scenic-views/scenic)
+[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
 
 Scenic adds methods to `ActiveRecord::Migration` to create and manage database
 views in Rails.
@@ -21,6 +21,12 @@ Scenic ships with support for PostgreSQL. The adapter is configurable (see
 `Scenic::Configuration`) and has a minimal interface (see
 `Scenic::Adapters::Postgres`) that other gems can provide.
 
+## So how do I install this?
+
+If you're using Postgres, Add `gem "scenic"` to your Gemfile and run `bundle
+install`. If you're using something other than Postgres, check out the available
+[third party adapters](https://github.com/scenic-views/scenic#faqs).
+
 ## Great, how do I create a view?
 
 You've got this great idea for a view you'd like to call `search_results`. You
@@ -86,30 +92,19 @@ a new version of it.
 This is not desirable when you have complicated hierarchies of views, especially
 when some of those views may be materialized and take a long time to recreate.
 
-You can use `replace_view` to generate a CREATE OR REPLACE VIEW SQL statement.
-
-See postgresql documentation on how this works:
-http://www.postgresql.org/docs/current/static/sql-createview.html
-
-To start replacing a view run the generator like for a regular change:
+You can use `replace_view` to generate a CREATE OR REPLACE VIEW SQL statement
+instead by adding the `--replace` option to the generate command:
 
 ```sh
-$ rails generate scenic:view search_results
+$ rails generate scenic:view search_results --replace
       create  db/views/search_results_v02.sql
       create  db/migrate/[TIMESTAMP]_update_search_results_to_version_2.rb
 ```
 
-Now, edit the migration. It should look something like:
-
-```ruby
-class UpdateSearchResultsToVersion2 < ActiveRecord::Migration
-  def change
-    update_view :search_results, version: 2, revert_to_version: 1
-  end
-end
-```
+See Postgres documentation on how this works:
+http://www.postgresql.org/docs/current/static/sql-createview.html
 
-Update it to use replace view:
+The migration will look something like this:
 
 ```ruby
 class UpdateSearchResultsToVersion2 < ActiveRecord::Migration
@@ -119,7 +114,7 @@ class UpdateSearchResultsToVersion2 < ActiveRecord::Migration
 end
 ```
 
-Now you can run the migration like normal.
+You can run the migration and the view will be replaced instead.
 
 ## Can I use this view to back a model?
 
@@ -129,11 +124,9 @@ ActiveRecord or ARel queries. As far as ActiveRecord is concerned, a view is
 no different than a table.
 
 ```ruby
-class SearchResult < ActiveRecord::Base
+class SearchResult < ApplicationRecord
   belongs_to :searchable, polymorphic: true
 
-  private
-
   # this isn't strictly necessary, but it will prevent
   # rails from calling save, which would fail anyway.
   def readonly?
@@ -198,6 +191,7 @@ Scenic gives you `drop_view` too:
 ```ruby
 def change
   drop_view :search_results, revert_to_version: 2
+  drop_view :materialized_admin_reports, revert_to_version: 3, materialized: true
 end
 ```
 
@@ -213,7 +207,7 @@ You can get around these issues by setting the primary key column on your Rails
 model like so:
 
 ```ruby
-class People < ActiveRecord::Base
+class People < ApplicationRecord
   self.primary_key = :my_unique_identifier_field
 end
 ```
@@ -231,31 +225,39 @@ add_column :posts, :title, :string
 update_view :posts_with_aggregate_data, version: 2, revert_to_version: 2
 ```
 
-**When will you support MySQL?**
+**When will you support MySQL, SQLite, or other databases?**
 
-We have no plans to add first-party support for MySQL at this time because we
-(the maintainers) do not currently have a use for it. It's our experience that
-maintaining a library effectively requires regular use of its features. We're
-not in a good position to support MySQL users.
+We have no plans to add first-party adapters for other relational databases at
+this time because we (the maintainers) do not currently have a use for them.
+It's our experience that maintaining a library effectively requires regular use
+of its features. We're not in a good position to support MySQL, SQLite or other
+database users.
 
 Scenic *does* support configuring different database adapters and should be
 extendable with adapter libraries. If you implement such an adapter, we're happy
 to review and link to it. We're also happy to make changes that would better
 accommodate adapter gems.
 
-## About
+We are aware of the following existing adapter libraries for Scenic which may
+meet your needs:
 
-Scenic is maintained by [Derek Prior] and [Caleb Thompson], funded by
-thoughtbot, inc. The names and logos for thoughtbot are trademarks of
-thoughtbot, inc.
+* [`scenic_sqlite_adapter`](<https://github.com/pdebelak/scenic_sqlite_adapter>)
+* [`scenic-mysql_adapter`](<https://github.com/EmpaticoOrg/scenic-mysql_adapter>)
+* [`scenic-sqlserver-adapter`](<https://github.com/ClickMechanic/scenic_sqlserver_adapter>)
+* [`scenic-oracle_adapter`](<https://github.com/cdinger/scenic-oracle_adapter>)
 
-[Derek Prior]: http://prioritized.net
-[Caleb Thompson]: http://calebthompson.io
+Please note that the maintainers of Scenic make no assertions about the
+quality or security of the above adapters.
 
-![thoughtbot](http://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg)
+## About
 
-We love open source software!  See [our other projects][community] or [hire
-us][hire] to help build your product.
+Scenic is used by some popular open source Rails apps:
+[Mastodon](<https://github.com/mastodon/mastodon/>),
+[Code.org](<https://github.com/code-dot-org/code-dot-org>), and
+[Lobste.rs](<https://github.com/lobsters/lobsters/>).
 
-[community]: https://thoughtbot.com/community?utm_source=github
-[hire]: https://thoughtbot.com/hire-us?utm_source=github
+Scenic is maintained by [Derek Prior], [Caleb Hearth], and you, our
+contributors.
+
+[Derek Prior]: http://prioritized.net
+[Caleb Hearth]: http://calebhearth.com

data/Rakefile

@@ -1,5 +1,5 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+Scenic maintainenance is a volunteer effort. We will do our best to fix
+forward but do not offer backported fixes. As such, the only "supported" version of Scenic is whichever was most recently released.
+
+## Reporting a Vulnerability
+
+Please report any discovered security vulnerabilities to Scenic's primary
+volunteer maintainers, derekprior@gmail.com and caleb@calebhearth.com.
+
+We will respond as soon as possible with any follow-up questions or details
+on how we plan to handle the issue.

data/bin/setup

@@ -2,12 +2,17 @@
 
 set -e
 
+# CI-specific setup
+if [ -n "$GITHUB_ACTIONS" ]; then
+  bundle config path vendor/bundle
+  bundle config jobs 4
+  bundle config retry 3
+  git config --global user.name 'GitHub Actions'
+  git config --global user.email 'github-actions@example.com'
+fi
+
 gem install bundler --conservative
 bundle check || bundle install
 
-if [ -z "$CI" ]; then
-  bundle exec appraisal install
-fi
-
 bundle exec rake dummy:db:drop
 bundle exec rake dummy:db:create

data/lib/generators/scenic/materializable.rb

@@ -10,6 +10,16 @@ module Scenic
           required: false,
           desc: "Makes the view materialized",
           default: false
+        class_option :no_data,
+          type: :boolean,
+          required: false,
+          desc: "Adds WITH NO DATA when materialized view creates/updates",
+          default: false
+        class_option :replace,
+          type: :boolean,
+          required: false,
+          desc: "Uses replace_view instead of update_view",
+          default: false
       end
 
       private
@@ -17,6 +27,14 @@ module Scenic
       def materialized?
         options[:materialized]
       end
+
+      def replace_view?
+        options[:replace]
+      end
+
+      def no_data?
+        options[:no_data]
+      end
     end
   end
 end

data/lib/generators/scenic/model/model_generator.rb

@@ -8,7 +8,7 @@ module Scenic
     # @api private
     class ModelGenerator < Rails::Generators::NamedBase
       include Scenic::Generators::Materializable
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("templates", __dir__)
 
       def invoke_rails_model_generator
         invoke "model",
@@ -35,13 +35,24 @@ module Scenic
 
       def evaluate_template(source)
         source  = File.expand_path(find_in_source_paths(source.to_s))
-        context = instance_eval("binding")
-        ERB.new(
-          ::File.binread(source),
-          nil,
-          "-",
-          "@output_buffer",
-        ).result(context)
+        context = instance_eval("binding", __FILE__, __LINE__)
+
+        if ERB.instance_method(:initialize).parameters.assoc(:key) # Ruby 2.6+
+          erb = ERB.new(
+            ::File.binread(source),
+            trim_mode: "-",
+            eoutvar: "@output_buffer",
+          )
+        else
+          erb = ERB.new(
+            ::File.binread(source),
+            nil,
+            "-",
+            "@output_buffer",
+          )
+        end
+
+        erb.result(context)
       end
 
       def generating?

data/lib/generators/scenic/view/USAGE

@@ -6,6 +6,7 @@ Description:
   and a migration to replace the old version with the new.
 
   To create a materialized view, pass the '--materialized' option.
+  To create a materialized view with NO DATA, pass '--no-data' option.
 
 Examples:
     rails generate scenic:view searches

data/lib/generators/scenic/view/templates/db/migrate/create_view.erb

@@ -1,5 +1,5 @@
 class <%= migration_class_name %> < <%= activerecord_migration_class %>
   def change
-    create_view <%= formatted_plural_name %><%= ", materialized: true" if materialized? %>
+    create_view <%= formatted_plural_name %><%= create_view_options %>
   end
 end

data/lib/generators/scenic/view/templates/db/migrate/update_view.erb

@@ -1,12 +1,13 @@
 class <%= migration_class_name %> < <%= activerecord_migration_class %>
   def change
+  <% method_name = replace_view? ? 'replace_view' : 'update_view' %>
   <%- if materialized? -%>
-    update_view <%= formatted_plural_name %>,
+    <%= method_name %> <%= formatted_plural_name %>,
       version: <%= version %>,
       revert_to_version: <%= previous_version %>,
-      materialized: true
+      materialized: <%= no_data? ? "{ no_data: true }" : true %>
   <%- else -%>
-    update_view <%= formatted_plural_name %>, version: <%= version %>, revert_to_version: <%= previous_version %>
+    <%= method_name %> <%= formatted_plural_name %>, version: <%= version %>, revert_to_version: <%= previous_version %>
   <%- end -%>
   end
 end

data/lib/generators/scenic/view/view_generator.rb

@@ -8,7 +8,7 @@ module Scenic
     class ViewGenerator < Rails::Generators::NamedBase
       include Rails::Generators::Migration
       include Scenic::Generators::Materializable
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("templates", __dir__)
 
       def create_views_directory
         unless views_directory_path.exist?
@@ -56,7 +56,7 @@ module Scenic
 
         def migration_class_name
           if creating_new_view?
-            "Create#{class_name.gsub('.', '').pluralize}"
+            "Create#{class_name.tr('.', '').pluralize}"
           else
             "Update#{class_name.pluralize}ToVersion#{version}"
           end
@@ -64,7 +64,7 @@ module Scenic
 
         def activerecord_migration_class
           if ActiveRecord::Migration.respond_to?(:current_version)
-            "ActiveRecord::Migration[5.0]"
+            "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
           else
             "ActiveRecord::Migration"
           end
@@ -73,8 +73,14 @@ module Scenic
 
       private
 
+      alias singular_name file_name
+
+      def file_name
+        super.tr(".", "_")
+      end
+
       def views_directory_path
-        @views_directory_path ||= Rails.root.join(*%w(db views))
+        @views_directory_path ||= Rails.root.join("db", "views")
       end
 
       def version_regex
@@ -82,7 +88,7 @@ module Scenic
       end
 
       def creating_new_view?
-        previous_version == 0
+        previous_version.zero?
       end
 
       def definition
@@ -93,10 +99,6 @@ module Scenic
         Scenic::Definition.new(plural_file_name, previous_version)
       end
 
-      def plural_file_name
-        @plural_file_name ||= file_name.pluralize.gsub(".", "_")
-      end
-
       def destroying?
         behavior == :revoke
       end
@@ -109,6 +111,14 @@ module Scenic
         end
       end
 
+      def create_view_options
+        if materialized?
+          ", materialized: #{no_data? ? '{ no_data: true }' : true}"
+        else
+          ""
+        end
+      end
+
       def destroying_initial_view?
         destroying? && version == 1
       end

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

@@ -13,7 +13,7 @@ module Scenic
         # @param connection [Connection] The connection to execute SQL against.
         # @param speaker [#say] (ActiveRecord::Migration) The object used for
         #   logging the results of reapplying indexes.
-        def initialize(connection:, speaker: ActiveRecord::Migration)
+        def initialize(connection:, speaker: ActiveRecord::Migration.new)
           @connection = connection
           @speaker = speaker
         end

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

@@ -2,25 +2,29 @@ module Scenic
   module Adapters
     class Postgres
       class RefreshDependencies
-        def self.call(name, adapter, connection)
-          new(name, adapter, connection).call
+        def self.call(name, adapter, connection, concurrently: false)
+          new(name, adapter, connection, concurrently: concurrently).call
         end
 
-        def initialize(name, adapter, connection)
+        def initialize(name, adapter, connection, concurrently:)
           @name = name
           @adapter = adapter
           @connection = connection
+          @concurrently = concurrently
         end
 
         def call
           dependencies.each do |dependency|
-            adapter.refresh_materialized_view(dependency)
+            adapter.refresh_materialized_view(
+              dependency,
+              concurrently: concurrently,
+            )
           end
         end
 
         private
 
-        attr_reader :name, :adapter, :connection
+        attr_reader :name, :adapter, :connection, :concurrently
 
         class DependencyParser
           def initialize(raw_dependencies, view_to_refresh)
@@ -46,10 +50,20 @@ module Scenic
           def to_sorted_array
             dependency_hash = parse_to_hash(raw_dependencies)
             sorted_arr = tsort(dependency_hash)
+
             idx = sorted_arr.find_index do |dep|
-              dep.include?(view_to_refresh.to_s)
+              if view_to_refresh.to_s.include?(".")
+                dep == view_to_refresh.to_s
+              else
+                dep.ends_with?(".#{view_to_refresh}")
+              end
+            end
+
+            if idx.present?
+              sorted_arr[0...idx]
+            else
+              []
             end
-            sorted_arr[0...idx]
           end
 
           private

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

@@ -34,6 +34,7 @@ module Scenic
             WHERE
               c.relkind IN ('m', 'v')
               AND c.relname NOT IN (SELECT extname FROM pg_extension)
+              AND c.relname != 'pg_stat_statements_info'
               AND n.nspname = ANY (current_schemas(false))
             ORDER BY c.oid
           SQL
@@ -57,7 +58,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/adapters/postgres.rb

@@ -33,7 +33,7 @@ module Scenic
       #
       # @example
       #  Scenic.configure do |config|
-      #    config.adapter = Scenic::Adapters::Postgres.new
+      #    config.database = Scenic::Adapters::Postgres.new
       #  end
       def initialize(connectable = ActiveRecord::Base)
         @connectable = connectable
@@ -122,6 +122,9 @@ module Scenic
       #
       # @param name The name of the materialized view to create
       # @param sql_definition The SQL schema that defines the materialized view.
+      # @param no_data [Boolean] Default: false. Set to true to create
+      #   materialized view without running the associated query. You will need
+      #   to perform a non-concurrent refresh to populate with data.
       #
       # This is typically called in a migration via {Statements#create_view}.
       #
@@ -129,9 +132,14 @@ module Scenic
       #   in use does not support materialized views.
       #
       # @return [void]
-      def create_materialized_view(name, sql_definition)
+      def create_materialized_view(name, sql_definition, no_data: false)
         raise_unless_materialized_views_supported
-        execute "CREATE MATERIALIZED VIEW #{quote_table_name(name)} AS #{sql_definition};"
+
+        execute <<-SQL
+  CREATE MATERIALIZED VIEW #{quote_table_name(name)} AS
+  #{sql_definition.rstrip.chomp(';')}
+  #{'WITH NO DATA' if no_data};
+        SQL
       end
 
       # Updates a materialized view in the database.
@@ -144,17 +152,20 @@ module Scenic
       #
       # @param name The name of the view to update
       # @param sql_definition The SQL schema for the updated view.
+      # @param no_data [Boolean] Default: false. Set to true to create
+      #   materialized view without running the associated query. You will need
+      #   to perform a non-concurrent refresh to populate with data.
       #
       # @raise [MaterializedViewsNotSupportedError] if the version of Postgres
       #   in use does not support materialized views.
       #
       # @return [void]
-      def update_materialized_view(name, sql_definition)
+      def update_materialized_view(name, sql_definition, no_data: false)
         raise_unless_materialized_views_supported
 
         IndexReapplication.new(connection: connection).on(name) do
           drop_materialized_view(name)
-          create_materialized_view(name, sql_definition)
+          create_materialized_view(name, sql_definition, no_data: no_data)
         end
       end
 
@@ -198,8 +209,9 @@ module Scenic
       # @return [void]
       def refresh_materialized_view(name, concurrently: false, cascade: false)
         raise_unless_materialized_views_supported
+
         if cascade
-          refresh_dependencies_for(name)
+          refresh_dependencies_for(name, concurrently: concurrently)
         end
 
         if concurrently
@@ -231,11 +243,12 @@ module Scenic
         end
       end
 
-      def refresh_dependencies_for(name)
+      def refresh_dependencies_for(name, concurrently: false)
         Scenic::Adapters::Postgres::RefreshDependencies.call(
           name,
           self,
           connection,
+          concurrently: concurrently,
         )
       end
     end

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
@@ -32,11 +36,25 @@ module Scenic
         @options ||= @args[1] || {}
       end
 
+      def keyword_hash(hash)
+        if Hash.respond_to? :ruby2_keywords_hash
+          Hash.ruby2_keywords_hash(hash)
+        else
+          hash
+        end
+      end
+
       def options_for_revert
-        options.clone.tap do |revert_options|
+        opts = options.clone.tap do |revert_options|
           revert_options[:version] = revert_to_version
           revert_options.delete(:revert_to_version)
         end
+
+        keyword_hash(opts)
+      end
+
+      def options_without_version
+        keyword_hash(options.except(:version))
       end
     end
   end

data/lib/scenic/command_recorder.rb

@@ -6,21 +6,26 @@ module Scenic
     def create_view(*args)
       record(:create_view, args)
     end
+    ruby2_keywords :create_view if respond_to?(:ruby2_keywords, true)
 
     def drop_view(*args)
       record(:drop_view, args)
     end
+    ruby2_keywords :drop_view if respond_to?(:ruby2_keywords, true)
 
     def update_view(*args)
       record(:update_view, args)
     end
+    ruby2_keywords :update_view if respond_to?(:ruby2_keywords, true)
 
     def replace_view(*args)
       record(:replace_view, args)
     end
+    ruby2_keywords :replace_view if respond_to?(:ruby2_keywords, true)
 
     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/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

@@ -2,7 +2,7 @@ module Scenic
   # @api private
   class Definition
     def initialize(name, version)
-      @name = name
+      @name = name.to_s
       @version = version.to_i
     end
 
@@ -28,8 +28,10 @@ module Scenic
 
     private
 
+    attr_reader :name
+
     def filename
-      "#{@name}_v#{version}.sql"
+      "#{UnaffixedName.for(name).tr('.', '_')}_v#{version}.sql"
     end
   end
 end