scenic 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23461e20bd94ffe9d2466098b04141ef8b8256d83f6c05cf5c5d9f26cca08231
-  data.tar.gz: 6c331ddfc7c4d658b342367e2f2fcf703bf2b376314c32520d55afdbc05e936a
+  metadata.gz: a9085d1f24783682a52d5874ce82bf44543b2a60d6edbfd72b026bf84b4bc0ab
+  data.tar.gz: fd7efd82eb88c0550c410f50e363db99eaf3e7fc6b5e3ac4eb374bd681afd7cd
 SHA512:
-  metadata.gz: 23e1ab6998fb898eebdc91691684bffc694fe51001ada435593cb9e6a3857074e13e6d1ba90333acf3a76069f2e687c129595389ce60ac7790bbb82cdfdd68c2
-  data.tar.gz: 2d91d5a48e68ef856ea9ffb14c3abb503fcaa1c588e17f55775ef32d2ae5f4f2862fd68aa53a99b2c666a0a81d88cba026fa21cdf2f4cc5b5e8a3f8062eb4779
+  metadata.gz: d0c624619ae62c1c9e8186b8cde870e81dde6f47c8eacc93faad863c38d8fc57c3f15b81c0f1a515bad57318d2bef56f8a57b83934346542e4fbe9bbc6315209
+  data.tar.gz: 6a4e9ae269ee6ffb86a4e23fa1d0e741ee2b3ed12fabca23696d2d462c4359d9fceea53ffbf696f72357bfa10a4abf66ede72b1bfa1a37ce7fcf5fdc5f6aeca7

data/.github/workflows/ci.yml

@@ -7,15 +7,35 @@ on:
     branches: "*"
 
 jobs:
+  standard:
+    name: Lint with Standard
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Run standardrb
+        uses: standardrb/standard-ruby-action@f533e61f461ccb766b2d9c235abf59be02aea793
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    permissions:
+      checks: write
+      contents: read
+
   build:
     name: Ruby ${{ matrix.ruby }}, Rails ${{ matrix.rails }}
 
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0", "3.1"]
-        rails: ["6.1", "7.0", "master"]
+        ruby: ["2.7", "3.0", "3.1", "3.2"]
+        rails: ["6.1", "7.0"]
         continue-on-error: [false]
+        exclude:
+          - ruby: "3.2"
+            rails: "6.1"
 
     runs-on: ubuntu-latest
 
@@ -40,7 +60,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
@@ -54,7 +74,7 @@ jobs:
         run: bundle lock
 
       - name: Cache dependencies
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         with:
           path: vendor/bundle
           key: bundle-${{ hashFiles('Gemfile.lock') }}

data/CHANGELOG.md

@@ -5,21 +5,38 @@ changelog, see the [commits] for each version via the version links.
 
 [commits]: https://github.com/scenic-views/scenic/commits/master
 
-## [1.6.0] - February 13, 2021
+## [1.8.0] - March 28, 2024
 
-### Fixed
+[1.8.0]: https://github.com/scenic-views/scenic/compare/v1.7.0...v1.8.0
+
+### Added
 
-* Exclude pg_stat_statements_info (#349) 76bface
+* Added `#populated?` to check the state of materialized views - *Daisuke
+  Fujimura*, *Dr Nic Williams*
 
-  *Caleb Hearth*
+## [1.7.0] - December 8, 2022
 
-* Fix serialization of views with backslashes c625d1b
+[1.7.0]: https://github.com/scenic-views/scenic/compare/v1.6.0...v1.7.0
 
-  *Ben Sheldon*
+### Added
+
+* Added the `--replace` CLI flag to generate a migration that uses the
+  `replace_view` schema statement - *Dan Hixon*
 
-* Handle ActiveRecord table name prefix and suffix b1544dc
+### Fixed
+
+* Fixed deprecation notice from newer versions of ERB when using scenic
+  generators - *Ali Ismayilov*
+
+## [1.6.0] - February 13, 2022
+
+[1.6.0]: https://github.com/scenic-views/scenic/compare/v1.5.5...v1.6.0
+
+### Fixed
 
-  *Derek Prior*
+* Exclude pg_stat_statements_info (#349) 76bface - *Caleb Hearth*
+* Fix serialization of views with backslashes c625d1b - *Ben Sheldon*
+* Handle ActiveRecord table name prefix and suffix b1544dc - *Derek Prior*
 
 ## [1.5.5] - December 15, 2021
 

data/CONTRIBUTING.md

@@ -13,6 +13,7 @@ agree to abide by our [code of conduct].
 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. Run `standardrb --fix` to ensure your code is formatted correctly.
 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.

data/Gemfile

@@ -5,10 +5,10 @@ gemspec
 
 rails_version = ENV.fetch("RAILS_VERSION", "6.1")
 
-if rails_version == "master"
-  rails_constraint = { github: "rails/rails" }
+rails_constraint = if rails_version == "master"
+  {github: "rails/rails"}
 else
-  rails_constraint = "~> #{rails_version}.0"
+  "~> #{rails_version}.0"
 end
 
 gem "rails", rails_constraint

data/README.md

@@ -4,7 +4,6 @@
 
 [![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.
@@ -86,36 +85,24 @@ schema in the new definition and run the `update_view` migration.
 
 ## What if I want to change a view without dropping it?
 
-The `update_view` statement used by default will drop your view then create
-a new version of it.
+The `update_view` statement used by default will drop your view then create a
+new version of it. This may not be desirable when you have complicated
+hierarchies of dependent views.
 
-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.
+Scenic offers a `replace_view` schema statement, resulting in a `CREATE OR
+REPLACE VIEW` SQL query which will update the supplied view in place, retaining
+all dependencies. Materialized views cannot be replaced in this fashion.
 
-You can use `replace_view` to generate a CREATE OR REPLACE VIEW SQL statement.
-
-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:
+You can generate a migration that uses the `replace_view` schema statement by
+passing the `--replace` option to the `scenic:view` generator:
 
 ```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
-```
-
-Update it to use replace view:
+The migration will look something like this:
 
 ```ruby
 class UpdateSearchResultsToVersion2 < ActiveRecord::Migration
@@ -125,8 +112,6 @@ class UpdateSearchResultsToVersion2 < ActiveRecord::Migration
 end
 ```
 
-Now you can run the migration like normal.
-
 ## Can I use this view to back a model?
 
 You bet! Using view-backed models can help promote concepts hidden in your
@@ -138,6 +123,11 @@ no different than a table.
 class SearchResult < ApplicationRecord
   belongs_to :searchable, polymorphic: true
 
+  # If you want to be able to call +Model.find+, you
+  # must declare the primary key. It can not be
+  # inferred from column information.
+  # self.primary_key = :id
+
   # this isn't strictly necessary, but it will prevent
   # rails from calling save, which would fail anyway.
   def readonly?
@@ -252,16 +242,26 @@ accommodate adapter gems.
 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-sqlserver-adapter](https://github.com/ClickMechanic/scenic_sqlserver_adapter)
-* [scenic-oracle_adapter](https://github.com/cdinger/scenic-oracle_adapter)
+* [`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>)
 
 Please note that the maintainers of Scenic make no assertions about the
 quality or security of the above adapters.
 
+**Related projects**
+
+- [`fx`](<https://github.com/teoljungberg/fx>) Versioned database functions and
+  triggers for Rails
+
 ## About
 
+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/>).
+
 Scenic is maintained by [Derek Prior], [Caleb Hearth], and you, our
 contributors.
 

data/Rakefile

@@ -26,4 +26,4 @@ RSpec::Core::RakeTask.new("spec:acceptance") do |task|
 end
 
 desc "Run the specs and acceptance tests"
-task default: %w(spec spec:acceptance)
+task default: %w[spec spec:acceptance]

data/bin/standardrb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'standardrb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("standard", "standardrb")

data/lib/generators/scenic/materializable.rb

@@ -15,6 +15,11 @@ module Scenic
           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
@@ -23,6 +28,10 @@ module Scenic
         options[:materialized]
       end
 
+      def replace_view?
+        options[:replace]
+      end
+
       def no_data?
         options[:no_data]
       end

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

@@ -15,7 +15,7 @@ module Scenic
           [file_path.singularize],
           options.merge(
             fixture_replacement: false,
-            migration: false,
+            migration: false
           )
       end
 
@@ -34,14 +34,16 @@ module Scenic
       private
 
       def evaluate_template(source)
-        source  = File.expand_path(find_in_source_paths(source.to_s))
+        source = File.expand_path(find_in_source_paths(source.to_s))
         context = instance_eval("binding", __FILE__, __LINE__)
-        ERB.new(
+
+        erb = ERB.new(
           ::File.binread(source),
-          nil,
-          "-",
-          "@output_buffer",
-        ).result(context)
+          trim_mode: "-",
+          eoutvar: "@output_buffer"
+        )
+
+        erb.result(context)
       end
 
       def generating?

data/lib/generators/scenic/model/templates/model.erb

@@ -1,3 +1,7 @@
   def self.refresh
     Scenic.database.refresh_materialized_view(table_name, concurrently: false, cascade: false)
   end
+
+  def self.populated?
+    Scenic.database.populated?(table_name)
+  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: <%= 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

@@ -28,12 +28,12 @@ module Scenic
         if creating_new_view? || destroying_initial_view?
           migration_template(
             "db/migrate/create_view.erb",
-            "db/migrate/create_#{plural_file_name}.rb",
+            "db/migrate/create_#{plural_file_name}.rb"
           )
         else
           migration_template(
             "db/migrate/update_view.erb",
-            "db/migrate/update_#{plural_file_name}_to_version_#{version}.rb",
+            "db/migrate/update_#{plural_file_name}_to_version_#{version}.rb"
           )
         end
       end
@@ -56,7 +56,7 @@ module Scenic
 
         def migration_class_name
           if creating_new_view?
-            "Create#{class_name.tr('.', '').pluralize}"
+            "Create#{class_name.tr(".", "").pluralize}"
           else
             "Update#{class_name.pluralize}ToVersion#{version}"
           end
@@ -73,7 +73,7 @@ module Scenic
 
       private
 
-      alias singular_name file_name
+      alias_method :singular_name, :file_name
 
       def file_name
         super.tr(".", "_")
@@ -113,7 +113,7 @@ module Scenic
 
       def create_view_options
         if materialized?
-          ", materialized: #{no_data? ? '{ no_data: true }' : true}"
+          ", materialized: #{no_data? ? "{ no_data: true }" : true}"
         else
           ""
         end

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

@@ -44,7 +44,7 @@ module Scenic
           Scenic::Index.new(
             object_name: result["object_name"],
             index_name: result["index_name"],
-            definition: result["definition"],
+            definition: result["definition"]
           )
         end
       end

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

@@ -17,7 +17,7 @@ module Scenic
           dependencies.each do |dependency|
             adapter.refresh_materialized_view(
               dependency,
-              concurrently: concurrently,
+              concurrently: concurrently
             )
           end
         end
@@ -103,8 +103,8 @@ module Scenic
           ORDER BY class_for_rewrite.relname;
         SQL
 
-        private_constant "DependencyParser"
-        private_constant "DEPENDENCY_SQL"
+        private_constant :DependencyParser
+        private_constant :DEPENDENCY_SQL
 
         def dependencies
           raw_dependency_info = connection.select_rows(DEPENDENCY_SQL)

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

@@ -43,21 +43,21 @@ module Scenic
         def to_scenic_view(result)
           namespace, viewname = result.values_at "namespace", "viewname"
 
-          if namespace != "public"
-            namespaced_viewname = "#{pg_identifier(namespace)}.#{pg_identifier(viewname)}"
+          namespaced_viewname = if namespace != "public"
+            "#{pg_identifier(namespace)}.#{pg_identifier(viewname)}"
           else
-            namespaced_viewname = pg_identifier(viewname)
+            pg_identifier(viewname)
           end
 
           Scenic::View.new(
             name: namespaced_viewname,
             definition: result["definition"].strip,
-            materialized: result["kind"] == "m",
+            materialized: result["kind"] == "m"
           )
         end
 
         def pg_identifier(name)
-          return name if name =~ /^[a-zA-Z_][a-zA-Z0-9_]*$/
+          return name if /^[a-zA-Z_][a-zA-Z0-9_]*$/.match?(name)
 
           pgconn.quote_ident(name)
         end

data/lib/scenic/adapters/postgres.rb

@@ -137,8 +137,8 @@ module Scenic
 
         execute <<-SQL
   CREATE MATERIALIZED VIEW #{quote_table_name(name)} AS
-  #{sql_definition.rstrip.chomp(';')}
-  #{'WITH NO DATA' if no_data};
+  #{sql_definition.rstrip.chomp(";")}
+  #{"WITH NO DATA" if no_data};
         SQL
       end
 
@@ -222,6 +222,31 @@ module Scenic
         end
       end
 
+      # True if supplied relation name is populated. Useful for checking the
+      # state of materialized views which may error if created `WITH NO DATA`
+      # and used before they are refreshed. True for all other relation types.
+      #
+      # @param name The name of the relation
+      #
+      # @raise [MaterializedViewsNotSupportedError] if the version of Postgres
+      #   in use does not support materialized views.
+      #
+      # @return [boolean]
+      def populated?(name)
+        raise_unless_materialized_views_supported
+
+        schemaless_name = name.split(".").last
+
+        sql = "SELECT relispopulated FROM pg_class WHERE relname = '#{schemaless_name}'"
+        relations = execute(sql)
+
+        if relations.count.positive?
+          relations.first["relispopulated"].in?(["t", true])
+        else
+          false
+        end
+      end
+
       private
 
       attr_reader :connectable
@@ -248,7 +273,7 @@ module Scenic
           name,
           self,
           connection,
-          concurrently: concurrently,
+          concurrently: concurrently
         )
       end
     end

data/lib/scenic/definition.rb

@@ -31,7 +31,7 @@ module Scenic
     attr_reader :name
 
     def filename
-      "#{UnaffixedName.for(name).tr('.', '_')}_v#{version}.sql"
+      "#{UnaffixedName.for(name).tr(".", "_")}_v#{version}.sql"
     end
   end
 end

data/lib/scenic/statements.rb

@@ -26,7 +26,7 @@ module Scenic
       if version.present? && sql_definition.present?
         raise(
           ArgumentError,
-          "sql_definition and version cannot both be set",
+          "sql_definition and version cannot both be set"
         )
       end
 
@@ -40,7 +40,7 @@ module Scenic
         Scenic.database.create_materialized_view(
           name,
           sql_definition,
-          no_data: no_data(materialized),
+          no_data: no_data(materialized)
         )
       else
         Scenic.database.create_view(name, sql_definition)
@@ -92,14 +92,14 @@ module Scenic
       if version.blank? && sql_definition.blank?
         raise(
           ArgumentError,
-          "sql_definition or version must be specified",
+          "sql_definition or version must be specified"
         )
       end
 
       if version.present? && sql_definition.present?
         raise(
           ArgumentError,
-          "sql_definition and version cannot both be set",
+          "sql_definition and version cannot both be set"
         )
       end
 
@@ -109,7 +109,7 @@ module Scenic
         Scenic.database.update_materialized_view(
           name,
           sql_definition,
-          no_data: no_data(materialized),
+          no_data: no_data(materialized)
         )
       else
         Scenic.database.update_view(name, sql_definition)

data/lib/scenic/version.rb

@@ -1,3 +1,3 @@
 module Scenic
-  VERSION = "1.6.0".freeze
+  VERSION = "1.8.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

data/scenic.gemspec

@@ -3,20 +3,19 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "scenic/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "scenic"
-  spec.version       = Scenic::VERSION
-  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
+  spec.name = "scenic"
+  spec.version = Scenic::VERSION
+  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/scenic-views/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.files = `git ls-files -z`.split("\x0")
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", ">= 1.5"
@@ -28,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "ammeter", ">= 1.1.3"
   spec.add_development_dependency "yard"
   spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "standard"
 
   spec.add_dependency "activerecord", ">= 4.0.0"
   spec.add_dependency "railties", ">= 4.0.0"

data/spec/dummy/Rakefile

@@ -1,13 +1,13 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require File.expand_path("../config/application", __FILE__)
 
 Rails.application.load_tasks
 
-unless Rake::Task.task_defined?('db:environment:set')
-  desc 'dummy task for rails versions where this task does not exist'
-  task 'db:environment:set' do
-    #no op
+unless Rake::Task.task_defined?("db:environment:set")
+  desc "dummy task for rails versions where this task does not exist"
+  task "db:environment:set" do
+    # no op
   end
 end

data/spec/dummy/bin/bundle

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-load Gem.bin_path('bundler', 'bundle')
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+load Gem.bin_path("bundler", "bundle")

data/spec/dummy/bin/rails

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
-require_relative '../config/boot'
-require 'rails/commands'
+APP_PATH = File.expand_path("../../config/application", __FILE__)
+require_relative "../config/boot"
+require "rails/commands"