scenic 1.5.5 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4da3d3cd88cae9dfaee68959a899fddbe617a1c711fa03ec36fc40cefba90315
-  data.tar.gz: 74b8894aee096545789a61bbd6d2dcbc276949d7f6d5fe62b06128a9751df49f
+  metadata.gz: 23461e20bd94ffe9d2466098b04141ef8b8256d83f6c05cf5c5d9f26cca08231
+  data.tar.gz: 6c331ddfc7c4d658b342367e2f2fcf703bf2b376314c32520d55afdbc05e936a
 SHA512:
-  metadata.gz: 886b10ebffb2a4a612bdb68ca519c38f0e5114d14850cfe7f3d4e985209f69530c18249bab750f4fe6b9b8fee98adc4675cb08f14cd56e1faf2693f1910d38fb
-  data.tar.gz: faa4bfbf6812f81ad9efc27a70e79ccb66e1679db69824a551f7494c11482361660aa9780900aa45ad3609ab37074ac83aea85a5cf62dcc4808772259a2a37cb
+  metadata.gz: 23e1ab6998fb898eebdc91691684bffc694fe51001ada435593cb9e6a3857074e13e6d1ba90333acf3a76069f2e687c129595389ce60ac7790bbb82cdfdd68c2
+  data.tar.gz: 2d91d5a48e68ef856ea9ffb14c3abb503fcaa1c588e17f55775ef32d2ae5f4f2862fd68aa53a99b2c666a0a81d88cba026fa21cdf2f4cc5b5e8a3f8062eb4779

data/.devcontainer/Dockerfile

@@ -0,0 +1,6 @@
+ARG VARIANT=2-bullseye
+FROM mcr.microsoft.com/vscode/devcontainers/ruby:0-${VARIANT}
+
+ENV RAILS_DEVELOPMENT_HOSTS=".githubpreview.dev"
+ENV POSTGRES_USER="postgres"
+ENV POSTGRES_PASSWORD="postgres"

data/.devcontainer/devcontainer.json

@@ -0,0 +1,11 @@
+{
+  "name": "Scenic Development",
+  "dockerComposeFile": "docker-compose.yml",
+  "service": "app",
+  "workspaceFolder": "/workspace",
+  "settings": { },
+  "extensions": ["rebornix.Ruby"],
+  "postCreateCommand": "bin/setup",
+  "remoteUser": "vscode",
+  "features": { "github-cli": "latest" }
+}

data/.devcontainer/docker-compose.yml

@@ -0,0 +1,24 @@
+version: '3'
+
+services:
+  app:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+      args:
+        VARIANT: "3"
+    volumes:
+      - ..:/workspace:cached
+    command: sleep infinity
+    network_mode: service:db
+  db:
+    image: postgres:latest
+    restart: unless-stopped
+    volumes:
+      - postgres-data:/var/lib/postgresql/data
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: postgres
+      POSTGRES_PASSWORD: postgres
+volumes:
+  postgres-data: null

data/.github/workflows/ci.yml

@@ -13,8 +13,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0"]
-        rails: ["6.0", "6.1", "master"]
+        ruby: ["2.7", "3.0", "3.1"]
+        rails: ["6.1", "7.0", "master"]
         continue-on-error: [false]
 
     runs-on: ubuntu-latest
@@ -43,7 +43,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Install Ruby ${{ matrix.ruby }}
-        uses: ruby/setup-ruby@v1.61.1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
 

data/CHANGELOG.md

@@ -5,6 +5,22 @@ 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
+
+### Fixed
+
+* 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
 
 ### Fixed

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

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.to_s.tr('.', '_')}_v#{version}.sql"
+      "#{UnaffixedName.for(name).tr('.', '_')}_v#{version}.sql"
     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.5.5".freeze
+  VERSION = "1.6.0".freeze
 end

data/lib/scenic/view.rb

@@ -45,10 +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/spec/dummy/config/database.yml

@@ -4,7 +4,7 @@ development: &default
   encoding: unicode
   host: localhost
   pool: 5
-  <% if ENV.fetch("GITHUB_ACTIONS", false) %>
+  <% if ENV.fetch("GITHUB_ACTIONS", false) || ENV.fetch("CODESPACES", false) %>
   username: <%= ENV.fetch("POSTGRES_USER") %>
   password: <%= ENV.fetch("POSTGRES_PASSWORD") %>
   <% end %>

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/scenic/definition_spec.rb

@@ -35,6 +35,14 @@ module Scenic
 
         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

@@ -26,6 +26,22 @@ 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
@@ -55,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
@@ -65,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
 

data/spec/spec_helper.rb

@@ -2,12 +2,14 @@ ENV["RAILS_ENV"] = "test"
 require "database_cleaner"
 
 require File.expand_path("dummy/config/environment", __dir__)
+require "support/rails_configuration_helpers"
 require "support/generator_spec_setup"
 require "support/view_definition_helpers"
 
 RSpec.configure do |config|
   config.order = "random"
   config.include ViewDefinitionHelpers
+  config.include RailsConfigurationHelpers
   DatabaseCleaner.strategy = :transaction
 
   config.around(:each, db: true) do |example|

data/spec/support/rails_configuration_helpers.rb

@@ -0,0 +1,10 @@
+module RailsConfigurationHelpers
+  def with_affixed_tables(prefix: "", suffix: "")
+    ActiveRecord::Base.table_name_prefix = prefix
+    ActiveRecord::Base.table_name_suffix = suffix
+    yield
+  ensure
+    ActiveRecord::Base.table_name_prefix = ""
+    ActiveRecord::Base.table_name_suffix = ""
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scenic
 version: !ruby/object:Gem::Version
-  version: 1.5.5
+  version: 1.6.0
 platform: ruby
 authors:
 - Derek Prior
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2022-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -175,6 +175,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".devcontainer/docker-compose.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".hound.yml"
@@ -217,6 +220,7 @@ files:
 - lib/scenic/railtie.rb
 - lib/scenic/schema_dumper.rb
 - lib/scenic/statements.rb
+- lib/scenic/unaffixed_name.rb
 - lib/scenic/version.rb
 - lib/scenic/view.rb
 - scenic.gemspec
@@ -234,6 +238,8 @@ files:
 - spec/dummy/config/database.yml
 - spec/dummy/config/environment.rb
 - spec/dummy/db/migrate/.keep
+- spec/dummy/db/migrate/20220112154220_add_pg_stat_statements_extension.rb
+- spec/dummy/db/schema.rb
 - spec/dummy/db/views/.keep
 - spec/generators/scenic/model/model_generator_spec.rb
 - spec/generators/scenic/view/view_generator_spec.rb
@@ -250,6 +256,7 @@ files:
 - spec/scenic/statements_spec.rb
 - spec/spec_helper.rb
 - spec/support/generator_spec_setup.rb
+- spec/support/rails_configuration_helpers.rb
 - spec/support/view_definition_helpers.rb
 homepage: https://github.com/scenic-views/scenic
 licenses:
@@ -270,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Support for database views in Rails migrations
@@ -289,6 +296,8 @@ test_files:
 - spec/dummy/config/database.yml
 - spec/dummy/config/environment.rb
 - spec/dummy/db/migrate/.keep
+- spec/dummy/db/migrate/20220112154220_add_pg_stat_statements_extension.rb
+- spec/dummy/db/schema.rb
 - spec/dummy/db/views/.keep
 - spec/generators/scenic/model/model_generator_spec.rb
 - spec/generators/scenic/view/view_generator_spec.rb
@@ -305,4 +314,5 @@ test_files:
 - spec/scenic/statements_spec.rb
 - spec/spec_helper.rb
 - spec/support/generator_spec_setup.rb
+- spec/support/rails_configuration_helpers.rb
 - spec/support/view_definition_helpers.rb