scenic 1.4.1 → 1.5.4

data/CONTRIBUTING.md

@@ -1,24 +1,22 @@
 # Contributing
 
 We love contributions from everyone.  By participating in this project, you
-agree to abide by the thoughtbot [code of conduct].
+agree to abide by our [code of conduct].
 
-[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
-
-We expect everyone to follow the code of conduct anywhere in thoughtbot's
-project codebases, issue trackers, chatrooms, and mailing lists.
+[code of conduct]: CODE_OF_CONDUCT.md
 
 ## Contributing Code
 
 1. Fork the repository.
 2. Run `bin/setup`, which will install dependencies and create the dummy
    application database.
-3. Run `bin/appraisal rake` to verify that the tests pass against all
-   supported versions of Rails.
-4. Make your change with new passing tests, following the [style guide].
+3. Run `rake` to verify that the tests pass against the version of Rails you are
+   running locally.
+4. Make your change with new passing tests, following existing style.
 5. Write a [good commit message], push your fork, and submit a pull request.
+6. CI will run the test suite on all configured versions of Ruby and Rails.
+   Address any failures.
 
-[style guide]: https://github.com/thoughtbot/guides/tree/master/style
 [good commit message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
 
 Others will give constructive feedback.  This is a time for discussion and

data/Gemfile

@@ -1,4 +1,16 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in scenic.gemspec
 gemspec
+
+rails_version = ENV.fetch("RAILS_VERSION", "6.0")
+
+if rails_version == "master"
+  rails_constraint = { github: "rails/rails" }
+else
+  rails_constraint = "~> #{rails_version}.0"
+end
+
+gem "rails", rails_constraint
+gem "sprockets", "< 4.0.0"
+gem "pg", "~> 1.1"

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2016 Derek Prior, Caleb Thompson, and thoughtbot.
+Copyright (c) 2014-2020 Derek Prior, Caleb Hearth, and thoughtbot.
 
 MIT License
 

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/workflows/CI/badge.svg)](https://github.com/scenic-views/scenic/actions?query=workflow%3ACI+branch%3Amaster)
+[![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
@@ -88,7 +94,7 @@ 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:
+See Postgres 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:
@@ -129,7 +135,7 @@ 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
 
   # this isn't strictly necessary, but it will prevent
@@ -212,7 +218,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
 ```
@@ -247,21 +253,17 @@ We are aware of the following existing adapter libraries for Scenic which may
 meet your needs:
 
 * [scenic_sqlite_adapter](https://github.com/pdebelak/scenic_sqlite_adapter)
-* [scenic-mysql_adapter](https://github.com/EmpaticoOrg/scenic-mysql_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)
+
+Please note that the maintainers of Scenic make no assertions about the
+quality or security of the above adapters.
 
 ## About
 
-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 is maintained by [Derek Prior], [Caleb Hearth], and you, our
+contributors.
 
 [Derek Prior]: http://prioritized.net
-[Caleb Thompson]: http://calebthompson.io
-
-![thoughtbot](http://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg)
-
-We love open source software!  See [our other projects][community] or [hire
-us][hire] to help build your product.
-
-[community]: https://thoughtbot.com/community?utm_source=github
-[hire]: https://thoughtbot.com/hire-us?utm_source=github
+[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,11 @@ 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
       end
 
       private
@@ -17,6 +22,10 @@ module Scenic
       def materialized?
         options[:materialized]
       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,7 +35,7 @@ module Scenic
 
       def evaluate_template(source)
         source  = File.expand_path(find_in_source_paths(source.to_s))
-        context = instance_eval("binding")
+        context = instance_eval("binding", __FILE__, __LINE__)
         ERB.new(
           ::File.binread(source),
           nil,

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

@@ -4,7 +4,7 @@ class <%= migration_class_name %> < <%= activerecord_migration_class %>
     update_view <%= 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 %>
   <%- 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
@@ -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.rb

@@ -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/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