schema_plus_views 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7fc4b60cc9309357c2da20cbc1f47c1f70a84b7b
-  data.tar.gz: 373a4c477a67f60bf0eabe36c0091dcdb395123d
+SHA256:
+  metadata.gz: 4ff5c6a7f05fbebbb07b6b84ec71761cc533640f3affe94d3e3153645a5599cc
+  data.tar.gz: 8f79673795c32b02c6ca0ff80495e115cdd3c9caf24e73c8fcf7c4ade95b4923
 SHA512:
-  metadata.gz: bc62d9dcaf074c67a6c8541a1e148b9a0c1ae52ef364521f53ece17c872ebb65d5cc6ea8e4a3035ba7d9018d0854e0ba1f1c71924e4c3059f18d56f06244d746
-  data.tar.gz: ae3921d2c5749cbdc8d298729b9973cc3dd4fcebcebd15e03fb54e7c8b2d1fffeb4fa40957ec57415ce15c06bad0ac7dd20983e588a9d77a064fd8acb78a3eec
+  metadata.gz: 928a52a3e5e42e5e745754a35ad03244dba6fadb7d8681dc48b20643aaaa34675ce0e9befd4d58a6a3139bdaafab132cc5815d4f7be021f78a77eddbf8486ab8
+  data.tar.gz: 674f0f9bcb0d7cbda52e9d32a2b21d67e3a095f9c2970a34b55db9146d8bee78379fe4e83c37f951b8aacf8c838d11159a35af12169f27bedf97b1ef6ea4adb2

data/.travis.yml

@@ -3,16 +3,87 @@
 # Please do not edit this file; any changes will be overwritten next time
 # schema_dev gets run.
 ---
-sudo: false
 rvm:
-- 2.1.5
+- 2.5.9
+- 2.7.3
 gemfile:
-- gemfiles/activerecord-4.2/Gemfile.mysql2
-- gemfiles/activerecord-4.2/Gemfile.postgresql
-- gemfiles/activerecord-4.2/Gemfile.sqlite3
-env: POSTGRESQL_DB_USER=postgres MYSQL_DB_USER=travis
-addons:
-  postgresql: '9.4'
+- gemfiles/activerecord-5.2/Gemfile.sqlite3
 before_script: bundle exec rake create_databases
 after_script: bundle exec rake drop_databases
 script: bundle exec rake travis
+jobs:
+  include:
+  - gemfile: gemfiles/activerecord-5.2/Gemfile.mysql2
+    rvm: 2.5.9
+    services:
+    - mysql
+    env: MYSQL_DB_USER=travis
+  - gemfile: gemfiles/activerecord-5.2/Gemfile.postgresql
+    rvm: 2.5.9
+    addons:
+      postgresql: '10'
+      apt:
+        packages:
+        - postgresql-10
+        - postgresql-client-10
+    env: POSTGRESQL_DB_USER=postgres
+  - gemfile: gemfiles/activerecord-5.2/Gemfile.postgresql
+    rvm: 2.5.9
+    addons:
+      postgresql: '11'
+      apt:
+        packages:
+        - postgresql-11
+        - postgresql-client-11
+    env: POSTGRESQL_DB_USER=travis PGPORT=5433
+  - gemfile: gemfiles/activerecord-5.2/Gemfile.postgresql
+    rvm: 2.5.9
+    addons:
+      postgresql: '12'
+      apt:
+        packages:
+        - postgresql-12
+        - postgresql-client-12
+    env: POSTGRESQL_DB_USER=travis PGPORT=5433
+  - gemfile: gemfiles/activerecord-5.2/Gemfile.postgresql
+    rvm: 2.5.9
+    addons:
+      postgresql: '9.6'
+    env: POSTGRESQL_DB_USER=postgres
+  - gemfile: gemfiles/activerecord-5.2/Gemfile.mysql2
+    rvm: 2.7.3
+    services:
+    - mysql
+    env: MYSQL_DB_USER=travis
+  - gemfile: gemfiles/activerecord-5.2/Gemfile.postgresql
+    rvm: 2.7.3
+    addons:
+      postgresql: '11'
+      apt:
+        packages:
+        - postgresql-11
+        - postgresql-client-11
+    env: POSTGRESQL_DB_USER=travis PGPORT=5433
+  - gemfile: gemfiles/activerecord-5.2/Gemfile.postgresql
+    rvm: 2.7.3
+    addons:
+      postgresql: '12'
+      apt:
+        packages:
+        - postgresql-12
+        - postgresql-client-12
+    env: POSTGRESQL_DB_USER=travis PGPORT=5433
+  - gemfile: gemfiles/activerecord-5.2/Gemfile.postgresql
+    rvm: 2.7.3
+    addons:
+      postgresql: '10'
+      apt:
+        packages:
+        - postgresql-10
+        - postgresql-client-10
+    env: POSTGRESQL_DB_USER=postgres
+  - gemfile: gemfiles/activerecord-5.2/Gemfile.postgresql
+    rvm: 2.7.3
+    addons:
+      postgresql: '9.6'
+    env: POSTGRESQL_DB_USER=postgres

data/README.md

@@ -28,7 +28,8 @@ SchemaPlus::Views is tested on:
 
 <!-- SCHEMA_DEV: MATRIX - begin -->
 <!-- These lines are auto-generated by schema_dev based on schema_dev.yml -->
-* ruby **2.1.5** with activerecord **4.2**, using **mysql2**, **sqlite3** or **postgresql**
+* ruby **2.5.9** with activerecord **5.2**, using **mysql2**, **sqlite3** or **postgresql**
+* ruby **2.7.3** with activerecord **5.2**, using **mysql2**, **sqlite3** or **postgresql**
 
 <!-- SCHEMA_DEV: MATRIX - end -->
 
@@ -56,9 +57,30 @@ Additional options can be provided:
 
 * `:allow_replace => true` will use the command "CREATE OR REPLACE" when creating the view, for seamlessly redefining the view even if other views depend on it.  It's only supported by MySQL and PostgreSQL, and each has some limitations on when a view can be replaced; see their docs for details.
 
+* `:materialized => true` will create a materialized view instead of a standard view.  This view caches its contents on disk and must be refreshed to update its contents.  It is only supported on PostgreSQL. Further, allow_replace is not supported on materialized views.
 
 SchemaPlus::Views also arranges to include the `create_view` statements (with literal SQL) in the schema dump.
 
+#### Materialized views
+
+Materialized views persist their data when created and must be manually refreshed to see new data.
+Further materialized views can have indexes defined on them.
+
+```ruby
+create_view :posts_commented_by_staff, <<~SQL, materialized: true
+SELECT * FROM posts LEFT OUTER JOIN comments ON comments.post_id = posts.id WHERE comments.id IS NULL
+SQL
+
+add_index :posts_commented_by_staff, :category
+add_index :posts_commented_by_staff, :token, unique: true
+```
+
+To refresh a materialized view run the refresh_view connection command.
+
+```ruby
+ActiveRecord::Base.connection.refresh_view('posts_commented_by_staff')
+```
+
 ### Dropping views
 
 In a migration:
@@ -66,6 +88,10 @@ In a migration:
 ```ruby
 drop_view :posts_commented_by_staff
 drop_view :uncommented_posts, :if_exists => true
+
+# materialized views
+drop_view :posts_commented_by_staff, materialized: true
+drop_view :uncommented_posts, :if_exists => true, materialized: true
 ```
 
 ### Using views
@@ -87,14 +113,16 @@ You can look up the defined views analogously to looking up tables:
 
 ```ruby
 connection.tables # => array of table names [method provided by ActiveRecord]
-connection.views  # => array of view names [method provided by SchemaPlus::Views]
+connection.views  # => array of view names [method overridden by SchemaPlus::Views for postgres]
 ```
 
 Notes:
 
-1. For Mysql and SQLite3, ActiveRecord's `connection.tables` method would return views as well as tables; SchemaPlus::Views normalizes them to return only tables.
-
-2. For PostgreSQL, `connection.views` suppresses views prefixed with `pg_` as those are presumed to be internal.
+1. For PostgreSQL, `connection.views` suppresses views prefixed with `pg_` as those are presumed to be internal. Also it suppresses the "postgis" specifically named tables
+   - geography_columns
+   - geometry_columns
+   - raster_columns
+   - raster_overviews 
 
 ### Querying view definitions
 
@@ -106,9 +134,67 @@ connection.view_definition(view_name) # => returns SQL string
 
 This returns just the body of the definition, i.e. the part after the `CREATE VIEW 'name' AS` command.
 
+You can also lookup the type of view (regular or materialized) using
+
+```ruby
+connection.view_type(view_name) # => returns a Symbol, either :view or :materialized
+```
+
+## Customization API: Middleware Stacks
+
+All the methods defined by SchemaPlus::Views provide middleware stacks, in case you need to do any custom filtering, rewriting, triggering, or whatever.  For info on how to use middleware stacks, see the READMEs of [schema_monkey](https://github.com/SchemaPlus/schema_monkey) and [schema_plus_core](https://github.com/SchemaPlus/schema_plus_core).
+
+### `Schema::ViewDefinition` stack
+
+Wraps the `connection.view_full_definition` method.  Env contains:
+
+Env Field    | Description | Initialized
+--- | --- | ---
+`:connection` | The current ActiveRecord connection | *context*
+`:view_name`  | The view to look up | *arg*
+`:query_name` | Optional label for ActiveRecord logging | *arg*
+`:definition` | The view definition SQL | `nil`
+`:view_type`  | The view type symbol. | :view`
+
+The base implementation looks up the definition of the view named
+`env.view_name` and assigns the result to `env.definition`
+
+### `Migration::CreateView` stack
+
+Wraps the `migration.create_view` method.  Env contains:
+
+Env Field    | Description | Initialized
+--- | --- | ---
+`:connection` | The current ActiveRecord connection | *context*
+`:view_name`  | The view name | *arg*
+`:definition` | The view definition SQL | *arg*
+`:options` | Create view options | *arg*
+
+The base implementation creates the view named `env.view_name` using the
+definition in `env.definition` with options in `env.options`
+
+### `Migration::DropView` stack
+
+Wraps the `migration.drop_view` method.  Env contains:
+
+Env Field    | Description | Initialized
+--- | --- | ---
+`:connection` | The current ActiveRecord connection | *context*
+`:view_name`  | The view name | *arg*
+`:options` | Drop view options | *arg*
+
+The base implementation drops the view named `env.view_name` using the
+options in `env.options`
+
 
 ## History
 
+* 0.4.0 - Added support for Rails 5.2 and materialized views in PostgreSQL
+* 0.3.1 - Upgrade schema_plus_core and schema_dev dependencies
+* 0.3.0
+  - Added middleware stacks
+  - Bug fix: view_definition: strip white space from result (postgresql)
+* 0.2.3 - Remove unnecessary escaping in dump; use single-quote heredoc
 * 0.2.2 - Prettier dumps: use heredoc for definition string
 * 0.2.1 - Fix db:rollback
 * 0.2.0 - Added :allow_replace option (thanks to [@hcarver](https://github.com/hcarver))

data/gemfiles/Gemfile.base

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
-gemspec :path => File.expand_path('..', __FILE__)
+gemspec path: File.expand_path('..', __FILE__)
 
 File.exist?(gemfile_local = File.expand_path('../Gemfile.local', __FILE__)) and eval File.read(gemfile_local), binding, gemfile_local

data/gemfiles/activerecord-5.2/Gemfile.base

@@ -0,0 +1,4 @@
+base_gemfile = File.expand_path('../../Gemfile.base', __FILE__)
+eval File.read(base_gemfile)
+
+gem "activerecord", ">= 5.2.0.beta0", "< 5.3"

data/gemfiles/activerecord-5.2/Gemfile.mysql2

@@ -0,0 +1,10 @@
+base_gemfile = File.expand_path('../Gemfile.base', __FILE__)
+eval File.read(base_gemfile), binding, base_gemfile
+
+platform :ruby do
+  gem "mysql2"
+end
+
+platform :jruby do
+  gem 'activerecord-jdbcmysql-adapter'
+end

data/gemfiles/activerecord-5.2/Gemfile.postgresql

@@ -0,0 +1,10 @@
+base_gemfile = File.expand_path('../Gemfile.base', __FILE__)
+eval File.read(base_gemfile), binding, base_gemfile
+
+platform :ruby do
+  gem "pg"
+end
+
+platform :jruby do
+  gem 'activerecord-jdbcpostgresql-adapter'
+end

data/gemfiles/{activerecord-4.2 → activerecord-5.2}/Gemfile.sqlite3

@@ -1,5 +1,5 @@
-require "pathname"
-eval(Pathname.new(__FILE__).dirname.join("Gemfile.base").read, binding)
+base_gemfile = File.expand_path('../Gemfile.base', __FILE__)
+eval File.read(base_gemfile), binding, base_gemfile
 
 platform :ruby do
   gem "sqlite3"
@@ -7,4 +7,4 @@ end
 
 platform :jruby do
   gem 'activerecord-jdbcsqlite3-adapter', '>=1.3.0.beta2'
-end
+end

data/lib/schema_plus/views/active_record/connection_adapters/abstract_adapter.rb

@@ -5,27 +5,50 @@ module SchemaPlus::Views
         # Create a view given the SQL definition.  Specify :force => true
         # to first drop the view if it already exists.
         def create_view(view_name, definition, options={})
-          definition = definition.to_sql if definition.respond_to? :to_sql
-          if options[:force]
-            drop_view(view_name, if_exists: true)
-          end
+          SchemaMonkey::Middleware::Migration::CreateView.start(connection: self, view_name: view_name, definition: definition, options: options) do |env|
+            raise ArgumentError, 'Materialized views are not implemented or supported on this database' if options[:materialized]
+            definition = env.definition
+            view_name = env.view_name
+            options = env.options
+            definition = definition.to_sql if definition.respond_to? :to_sql
+            if options[:force]
+              drop_view(view_name, if_exists: true)
+            end
 
-          command = if options[:allow_replace]
-            "CREATE OR REPLACE"
-          else
-            "CREATE"
-          end
+            command = if options[:allow_replace]
+                        "CREATE OR REPLACE"
+                      else
+                        "CREATE"
+                      end
 
-          execute "#{command} VIEW #{quote_table_name(view_name)} AS #{definition}"
+            execute "#{command} VIEW #{quote_table_name(view_name)} AS #{definition}"
+          end
         end
 
         # Drop the named view.  Specify :if_exists => true
         # to fail silently if the view doesn't exist.
         def drop_view(view_name, options = {})
-          sql = "DROP VIEW"
-          sql += " IF EXISTS" if options[:if_exists]
-          sql += " #{quote_table_name(view_name)}"
-          execute sql
+          SchemaMonkey::Middleware::Migration::DropView.start(connection: self, view_name: view_name, options: options) do |env|
+            raise ArgumentError, 'Materialized views are not implemented or supported on this database' if options[:materialized]
+            view_name = env.view_name
+            options = env.options
+            sql = "DROP VIEW"
+            sql += " IF EXISTS" if options[:if_exists]
+            sql += " #{quote_table_name(view_name)}"
+            execute sql
+          end
+        end
+
+        # Returns the SQL definition of a given view.  This is
+        # the literal SQL would come after 'CREATVE VIEW viewname AS ' in
+        # the SQL statement to create a view.
+        def view_definition(view_name, name = nil)
+          view_full_definition(view_name, name).first
+        end
+
+        # Returns the view type of a given view.  This is either :view or :materialized
+        def view_type(view_name, name = nil)
+          view_full_definition(view_name, name).second
         end
 
         #####################################################################
@@ -34,13 +57,13 @@ module SchemaPlus::Views
         # define them all. Defining them here only for reference.
         #
 
-        # (abstract) Returns the names of all views, as an array of strings
-        def views(name = nil) raise "Internal Error: Connection adapter didn't override abstract function"; [] end
+        # (abstract) Refreshes the given materialized view.
+        def refresh_view(view_name, name = nil) raise "Internal Error: Connection adapter didn't override abstract function"; end
 
-        # (abstract) Returns the SQL definition of a given view.  This is
+        # (abstract) Returns the SQL definition and type of a given view.  This is
         # the literal SQL would come after 'CREATVE VIEW viewname AS ' in
-        # the SQL statement to create a view.
-        def view_definition(view_name, name = nil) raise "Internal Error: Connection adapter didn't override abstract function"; end
+        # the SQL statement to create a view. The type is either :view, or :materialized
+        def view_full_definition(view_name, name = nil) raise "Internal Error: Connection adapter didn't override abstract function"; end
       end
     end
   end

data/lib/schema_plus/views/active_record/connection_adapters/mysql2_adapter.rb

@@ -3,25 +3,22 @@ module SchemaPlus::Views
     module ConnectionAdapters
       module Mysql2Adapter
 
-        def views(name = nil)
-          views = []
-          select_all("SELECT table_name FROM information_schema.views WHERE table_schema = SCHEMA()", name).each do |row|
-            views << row["table_name"]
-          end
-          views
-        end
+        def view_full_definition(view_name, name = nil)
+          data = SchemaMonkey::Middleware::Schema::ViewDefinition.start(connection: self, view_name: view_name, query_name: name, view_type: :view) { |env|
+            results = select_all("SELECT view_definition, check_option FROM information_schema.views WHERE table_schema = SCHEMA() AND table_name = #{quote(view_name)}", name)
+            if  results.any?
+              row = results.first
+              sql = row["view_definition"]
+              sql.gsub!(%r{#{quote_table_name(current_database)}[.]}, '')
+              case row["check_option"]
+              when "CASCADED" then sql += " WITH CASCADED CHECK OPTION"
+              when "LOCAL" then sql += " WITH LOCAL CHECK OPTION"
+              end
+              env.definition = sql
+            end
+          }
 
-        def view_definition(view_name, name = nil)
-          results = select_all("SELECT view_definition, check_option FROM information_schema.views WHERE table_schema = SCHEMA() AND table_name = #{quote(view_name)}", name)
-          return nil unless results.any?
-          row = results.first
-          sql = row["view_definition"]
-          sql.gsub!(%r{#{quote_table_name(current_database)}[.]}, '')
-          case row["check_option"]
-          when "CASCADED" then sql += " WITH CASCADED CHECK OPTION"
-          when "LOCAL" then sql += " WITH LOCAL CHECK OPTION"
-          end
-          sql
+          [data.definition, data.view_type]
         end
 
       end

data/lib/schema_plus/views/active_record/connection_adapters/postgresql_adapter.rb

@@ -2,27 +2,88 @@ module SchemaPlus::Views
   module ActiveRecord
     module ConnectionAdapters
       module PostgresqlAdapter
+        POSTGIS_VIEWS = %W[
+          geography_columns
+          geometry_columns
+          raster_columns
+          raster_overviews
+        ].freeze
 
-        def views(name = nil) #:nodoc:
-          sql = <<-SQL
-            SELECT viewname
-              FROM pg_views
-            WHERE schemaname = ANY (current_schemas(false))
-            AND viewname NOT LIKE 'pg\_%'
-          SQL
-          sql += " AND schemaname != 'postgis'" if adapter_name == 'PostGIS'
-          query(sql, name).map { |row| row[0] }
+        # Create a view given the SQL definition.  Specify :force => true
+        # to first drop the view if it already exists.
+        def create_view(view_name, definition, options={})
+          SchemaMonkey::Middleware::Migration::CreateView.start(connection: self, view_name: view_name, definition: definition, options: options) do |env|
+            definition = env.definition
+            view_name = env.view_name
+            options = env.options
+            definition = definition.to_sql if definition.respond_to? :to_sql
+
+            if options[:materialized] && options[:allow_replace]
+              raise ArgumentError, 'allow_replace is not supported for materialized views'
+            end
+
+            if options[:force]
+              drop_view(view_name, {if_exists: true}.merge(options.slice(:materialized)))
+            end
+
+            command = if options[:materialized]
+                        "CREATE MATERIALIZED"
+                      elsif options[:allow_replace]
+                        "CREATE OR REPLACE"
+                      else
+                        "CREATE"
+                      end
+
+            execute "#{command} VIEW #{quote_table_name(view_name)} AS #{definition}"
+          end
+        end
+
+        # Drop the named view.  Specify :if_exists => true
+        # to fail silently if the view doesn't exist.
+        def drop_view(view_name, options = {})
+          SchemaMonkey::Middleware::Migration::DropView.start(connection: self, view_name: view_name, options: options) do |env|
+            view_name = env.view_name
+            options = env.options
+            materialized = options[:materialized] ? 'MATERIALIZED' : ''
+            sql = "DROP #{materialized} VIEW"
+            sql += " IF EXISTS" if options[:if_exists]
+            sql += " #{quote_table_name(view_name)}"
+            execute sql
+          end
         end
 
-        def view_definition(view_name, name = nil) #:nodoc:
-          result = query(<<-SQL, name)
-        SELECT pg_get_viewdef(oid)
-          FROM pg_class
-         WHERE relkind = 'v'
-           AND relname = '#{view_name}'
-          SQL
-          row = result.first
-          row.first.chomp(';') unless row.nil?
+        # Refresh a materialized view.
+        def refresh_view(view_name, options = {})
+          SchemaMonkey::Middleware::Migration::RefreshView.start(connection: self, view_name: view_name, options: options) do |env|
+            view_name = env.view_name
+            sql = "REFRESH MATERIALIZED VIEW #{quote_table_name(view_name)}"
+            execute sql
+          end
+        end
+
+        def views #:nodoc:
+          # Filter out any view that begins with "pg_"
+          super.reject do |c|
+            c.start_with?("pg_") || POSTGIS_VIEWS.include?(c)
+          end
+        end
+
+        def view_full_definition(view_name, name = nil) #:nodoc:
+          data = SchemaMonkey::Middleware::Schema::ViewDefinition.start(connection: self, view_name: view_name, query_name: name, view_type: :view) { |env|
+              result = env.connection.query(<<-SQL, name)
+                SELECT pg_get_viewdef(oid), relkind
+                  FROM pg_class
+                WHERE relkind in ('v', 'm')
+                  AND relname = '#{env.view_name}'
+              SQL
+              row = result.first
+              unless row.nil?
+                env.definition = row.first.chomp(';').strip
+                env.view_type = :materialized if row.second == 'm'
+              end
+          }
+
+          [data.definition, data.view_type]
         end
 
       end

data/lib/schema_plus/views/active_record/connection_adapters/sqlite3_adapter.rb

@@ -3,13 +3,14 @@ module SchemaPlus::Views
     module ConnectionAdapters
       module Sqlite3Adapter
 
-        def views(name = nil)
-          execute("SELECT name FROM sqlite_master WHERE type='view'", name).collect{|row| row["name"]}
-        end
+        def view_full_definition(view_name, name = nil)
+          data = SchemaMonkey::Middleware::Schema::ViewDefinition.start(connection: self, view_name: view_name, query_name: name, view_type: :view) { |env|
+            sql = env.connection.execute("SELECT sql FROM sqlite_master WHERE type='view' AND name=#{quote(env.view_name)}", env.query_name).collect{|row| row["sql"]}.first
+            sql.sub!(/^CREATE VIEW \S* AS\s+/im, '') unless sql.nil?
+            env.definition = sql
+          }
 
-        def view_definition(view_name, name = nil)
-          sql = execute("SELECT sql FROM sqlite_master WHERE type='view' AND name=#{quote(view_name)}", name).collect{|row| row["sql"]}.first
-          sql.sub(/^CREATE VIEW \S* AS\s+/im, '') unless sql.nil?
+          [data.definition, data.view_type]
         end
 
       end

data/lib/schema_plus/views/active_record/migration/command_recorder.rb

@@ -11,7 +11,9 @@ module SchemaPlus::Views
         end
 
         def invert_create_view(args)
-          [ :drop_view, [args.first] ]
+          options = {}
+          options[:materialized] = args[2][:materialized] if args[2].has_key?(:materialized)
+          [ :drop_view, [args.first, options] ]
         end
 
       end