spectacles 2.0.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c759a317da5654cfbfb8aadbabe40a10122b75fa2cd0a569b9d7cb6792b490a
-  data.tar.gz: a76b8d1e07255df03cfed644e868cc7bd4f153ce189e8e457fd2e155f09b5398
+  metadata.gz: 3828ebda72819be07a7e380017782c6ce623c556b7a55a66b0817c8274bc5699
+  data.tar.gz: c8202a385e3fef197c8db980ee53f0f104c3310608a46c60cb5756aa2526ed9c
 SHA512:
-  metadata.gz: 25f113ee6cfc34e1989378d3710c899a340271a37879be95aea22817fbb86ad09c14fb978c90b20a0dd5476f895739fdc902d97b6b5a288a9ae012291736b2dd
-  data.tar.gz: d372e0d4dae6f83b2396f582012de107a39cdfd0d57acfb77974aa9d5b9297972eb111b6eb07862c0d34241075392daddc6ef3fdd47224b8b2b9f85035a5723a
+  metadata.gz: 0204f98f169707aee585e76e7b3f61fff5639e42bb3b7655e0a2c2c0c54a4dea2891c8edcd5c85a498f1dce4c4e169c0ab9793c145f7be4e2960e90973307550
+  data.tar.gz: a8f20c62cca8e1c8868d12522f9e37ac5826fd9e1f5b25357929be2f256a020f913a227563f81d0203ec3e2b866c61639a255dde24fd450f8d3a3e7b864b5d48

data/.rubocop.yml

@@ -0,0 +1,3 @@
+---
+inherit_gem:
+  standard: config/ruby-2.7.yml

data/.standard.yml

@@ -0,0 +1,4 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 2.7 # default: RUBY_VERSION
+format: progress # default: Standard::Formatter

data/CHANGELOG.md

@@ -0,0 +1,54 @@
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [7.0.0] – 2024-11-26
+
+- Add support for dumping views from multiple schemas in Postgres ([#32](https://github.com/liveh2o/spectacles/pull/32))
+- Require Ruby 2.7+
+- Require Rails 7.0
+
+## [6.0.0] – 2022-02-21
+
+- Add Rails 6.0 support
+
+## [2.0.0] – 2019-12-17
+
+- Add support for materialized views
+- Drop support for the the mysql gem
+- Require Ruby 2.2+
+
+## [1.2.0] – 2017-07-21
+
+- Add support for skipping views when dumping the schema
+
+## [1.1.0] – 2016-01-15
+
+## [1.0.1] – 2015-09-29
+
+## [1.0.0] – 2015-09-28
+
+## [0.5.3] – 2015-03-16
+
+## [0.5.2] – 2014-12-05
+
+## [0.5.1] – 2014-02-07
+
+## [0.5.0] – 2014-01-03
+
+## [0.4.1] – 2013-11-14
+
+## [0.4.0] – 2013-10-10
+
+## [0.3.1] – 2013-10-04
+
+## [0.3.0] – 2013-09-27
+
+## [0.2.0] – 2013-04-22
+
+## [0.1.0] – 2013-01-14
+
+## [0.0.2] – 2012-02-10

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2012-2024 Adam Hutchison, Brandon Dewitt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,136 @@
+[![CI](https://github.com/liveh2o/spectacles/actions/workflows/main.yml/badge.svg)](https://github.com/liveh2o/spectacles/actions)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/standardrb/standard)
+[![Gem Version](https://badge.fury.io/rb/spectacles.svg)](https://badge.fury.io/rb/spectacles)
+
+# Spectacles
+
+Spectacles adds database view functionality to ActiveRecord. It is heavily inspired by Rails SQL Views (created by https://github.com/aeden but no longer maintained) and built from the ground up to work with Rails.
+
+Spectacles provides the ability to create views in migrations using a similar format to creating tables. It also provides an abstract view class that inherits from `ActiveRecord::Base` that can be used to create view-backed models.
+
+It currently works with the SQLite, MySQL2, PostgreSQL, and Vertica drivers.
+
+# Using Spectacles
+
+Install it
+
+```shell
+$ gem install spectacles # => OR include it in your Gemfile
+```
+
+## Migrations
+
+Create a migration from an query string:
+
+```ruby
+create_view :product_users do
+  "SELECT name AS product_name, first_name AS username FROM products JOIN users ON users.id = products.user_id"
+end
+```
+
+Create a migration from an ARel object:
+
+```ruby
+create_view :product_users do
+  Product.select("products.name AS product_name).select("users.first_name AS username").join(:users)
+end
+```
+
+## Models
+
+```ruby
+class ProductUser < Spectacles::View # Add relationships
+  # Use scopes
+
+  # Your fancy methods
+end
+```
+
+## Materialized Views
+
+_This feature is only supported for PostgreSQL backends._
+
+These are essentially views that cache their result set. In this way they are kind of a cross between tables (which persist data) and views
+(which are windows onto other tables).
+
+```ruby
+create_materialized_view :product_users do
+  <<-SQL.squish
+    SELECT name AS product_name, first_name AS username
+    FROM products
+    JOIN users ON users.id = products.user_id
+  SQL
+end
+
+class ProductUser < Spectacles::MaterializedView # just like Spectacles::View
+end
+```
+
+Because materialized views cache a snapshot of the data as it exists at a point in time (typically when the view was created), you
+need to manually _refresh_ the view when new data is added to the original tables. You can do this with the `#refresh!` method on
+the `Spectacles::MaterializedView` subclass:
+
+```ruby
+User.create(first_name: "Bob", email: "bob@example.com")
+ProductUser.refresh!
+```
+
+Also, you can specify a few different options to `create_materialized_view` to affect how the new view is created:
+
+- `:force` - if `false` (the default), the create will fail if a
+  materialized view with the given name already exists. If `true`,
+  any materialized view with that name will be dropped before the
+  create runs.
+
+  ```ruby
+  create_materialized_view :product_users, force: true do
+    # ...
+  end
+  ```
+
+- `:data` - if `true` (the default), the view is immediately populated
+  with the corresponding data. If `false`, the view will be empty initially,
+  and must be populated by invoking the `#refresh!` method.
+
+  ```ruby
+  create_materialized_view :product_users, data: false do
+    # ...
+  end
+  ```
+
+- `:columns` - an optional array of names to give the columns in the view.
+  By default, columns in the view will use the names given in the query.
+
+  ```ruby
+  create_materialized_view :product_users, columns: %i(product_name username) do
+    <<-SQL.squish
+    SELECT products.name, users.first_name
+    FROM products
+    JOIN users ON users.id = products.user_id
+    SQL
+  end
+  ```
+
+- `:tablespace` - an optional identifier (string or symbol) indicating
+  which namespace the materialized view ought to be created in.
+
+  ```ruby
+  create_materialized_view :product_users, tablespace: "awesomesauce" do
+    # ...
+  end
+  ```
+
+- `:storage` - an optional hash of (database-specific) storage parameters to
+  optimize how the materialized view is stored. (See
+  http://www.postgresql.org/docs/9.4/static/sql-createtable.html#SQL-CREATETABLE-STORAGE-PARAMETERS
+  for details.)
+
+  ```ruby
+  create_materialized_view :product_users, storage: { fillfactor: 70 } do
+    # ...
+  end
+  ```
+
+# License
+
+Spectacles is licensed under MIT license (Read the LICENSE file for full license)

data/Rakefile

@@ -1,25 +1,25 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-require 'rake/testtask'
+require "minitest/test_task"
 
 namespace :test do
-  adapters = [ :mysql2, :postgresql, :sqlite3 ]
-  task :all => [ :spectacles ] + adapters
+  Minitest::TestTask.create :spectacles do |t|
+    t.test_globs = ["test/spectacles/**/*_test.rb"]
+    t.warning = false
+  end
 
+  adapters = %i[mysql2 postgresql sqlite3]
   adapters.each do |adapter|
-    Rake::TestTask.new(adapter) do |t|
-      t.libs.push "lib"
-      t.libs.push "specs"
-      t.pattern = "specs/adapters/#{t.name}*_spec.rb"
-      t.verbose = true
+    Minitest::TestTask.create adapter do |t|
+      t.test_globs = ["test/adapters/#{t.name}*_test.rb"]
+      t.warning = false
     end
   end
 
-  Rake::TestTask.new(:spectacles) do |t|
-    t.libs.push "lib"
-    t.libs.push "specs"
-    t.pattern = "specs/spectacles/**/*_spec.rb"
-    t.verbose = true
-  end
+  task all: %i[spectacles] + adapters
 end
 
-task :default => 'test:all'
+require "standard/rake"
+
+task default: %i[test:all standard:fix]

data/lib/spectacles/abstract_adapter_override.rb

@@ -2,9 +2,9 @@ ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
   class << self
     alias_method(:_spectacles_orig_inherited, :inherited) if method_defined?(:inherited)
 
-    def inherited(_subclass)
-      ::Spectacles::load_adapters
-      _spectacles_orig_inherited(_subclass) if methods.include?(:_spectacles_orig_inherited)
+    def inherited(klass)
+      ::Spectacles.load_adapters
+      _spectacles_orig_inherited(klass) if methods.include?(:_spectacles_orig_inherited)
     end
   end
 end

data/lib/spectacles/materialized_view.rb

@@ -7,14 +7,14 @@ module Spectacles
     end
 
     def self.materialized_view_exists?
-      self.connection.materialized_view_exists?(self.view_name)
+      connection.materialized_view_exists?(view_name)
     end
 
     def self.refresh!(concurrently: false)
       if concurrently
-        self.connection.refresh_materialized_view_concurrently(self.view_name)
+        connection.refresh_materialized_view_concurrently(view_name)
       else
-        self.connection.refresh_materialized_view(self.view_name)
+        connection.refresh_materialized_view(view_name)
       end
     end
 
@@ -27,11 +27,11 @@ module Spectacles
       alias_method :view_name, :table_name
     end
 
-    def ==(comparison_object)
+    def ==(other)
       super ||
-        comparison_object.instance_of?(self.class) &&
-        attributes.present? &&
-        comparison_object.attributes == attributes
+        other.instance_of?(self.class) &&
+          attributes.present? &&
+          other.attributes == attributes
     end
 
     def persisted?

data/lib/spectacles/railtie.rb

@@ -1,11 +1,11 @@
-require 'spectacles'
-require 'rails'
+require "spectacles"
+require "rails"
 
 module Spectacles
   class Railtie < ::Rails::Railtie
     config.spectacles = ::ActiveSupport::OrderedOptions.new
 
-    initializer 'spectacles.configure' do |app|
+    initializer "spectacles.configure" do |app|
       Spectacles.configure do |config|
         if app.config.spectacles.key?(:enable_schema_dump)
           config.enable_schema_dump = app.config.spectacles[:enable_schema_dump]

data/lib/spectacles/schema_dumper.rb

@@ -48,7 +48,7 @@ module Spectacles
     def self.format_option_hash(hash)
       hash.map do |key, value|
         "#{key}: #{format_option_value(value)}"
-      end.join(', ')
+      end.join(", ")
     end
 
     def self.format_option_value(value)

data/lib/spectacles/schema_statements/abstract_adapter.rb

@@ -15,14 +15,20 @@ module Spectacles
         end
 
         query = create_view_statement(view_name, build_query)
-        execute(query)
+        if defined?(ActiveRecord::Base.connection_handler) && ActiveRecord.respond_to?(:legacy_connection_handling) && ActiveRecord.legacy_connection_handling
+          ActiveRecord::Base.connection_handler.while_preventing_writes(false) do
+            execute(query)
+          end
+        else
+          execute(query)
+        end
       end
 
       def create_view_statement(view_name, create_query)
-        #query = "CREATE VIEW ? AS #{create_query}"
-        #query_array = [query, view_name.to_s]
+        # query = "CREATE VIEW ? AS #{create_query}"
+        # query_array = [query, view_name.to_s]
 
-        #return ActiveRecord::Base.__send__(:sanitize_sql_array, query_array)
+        # return ActiveRecord::Base.__send__(:sanitize_sql_array, query_array)
         "CREATE VIEW #{view_name} AS #{create_query}"
       end
 
@@ -32,15 +38,15 @@ module Spectacles
       end
 
       def drop_view_statement(view_name)
-        #query = "DROP VIEW IF EXISTS ? "
-        #query_array = [query, view_name.to_s]
+        # query = "DROP VIEW IF EXISTS ? "
+        # query_array = [query, view_name.to_s]
 
-        #return ActiveRecord::Base.__send__(:sanitize_sql_array, query_array)
+        # return ActiveRecord::Base.__send__(:sanitize_sql_array, query_array)
         "DROP VIEW IF EXISTS #{view_name} "
       end
 
       def view_exists?(name)
-        return views.include?(name.to_s)
+        views.include?(name.to_s)
       end
 
       def views
@@ -52,7 +58,7 @@ module Spectacles
       end
 
       def materialized_view_exists?(name)
-        return materialized_views.include?(name.to_s)
+        materialized_views.include?(name.to_s)
       end
 
       def materialized_views

data/lib/spectacles/schema_statements/mysql2_adapter.rb

@@ -17,12 +17,12 @@ module Spectacles
              #{by_name}
         SQL
 
-        execute_and_free(sql, 'SCHEMA') do |result|
+        execute_and_free(sql, "SCHEMA") do |result|
           rows_from(result).map(&:first)
         end
       end
 
-      def views(name = nil) #:nodoc:
+      def views(name = nil) # :nodoc:
         result = execute("SHOW FULL TABLES WHERE TABLE_TYPE='VIEW'")
 
         rows_from(result).map(&:first)
@@ -37,7 +37,7 @@ module Spectacles
         raise "No view called #{view} found, #{e}"
       end
 
-    private
+      private
 
       def rows_from(result)
         result.respond_to?(:rows) ? result.rows : result