schema_plus_views 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bd09e6485e8794d0454b7d3b6f9e79107f134d2
-  data.tar.gz: a5ccbf2996d268630f616dded120613df7f9596a
+  metadata.gz: b52a3bd48e7f5213ce4cf51909573fd2d02a0fe8
+  data.tar.gz: 768b79ea664fa768a68dcec297044845a1ec116d
 SHA512:
-  metadata.gz: 04ad39d4d0c9a6cdc8b2624326ff1fd3aac5e8ee3a95ef0fa3d84e17c0573494e2ffbe7de62f46f90bdac073278f9bbc0fd02b2d10db4bb493370f6e43caa2ed
-  data.tar.gz: dbe18499e3d0108003110873f3738f99c0350870da6e5c7e338935b2a1f509a336554df69328f476348b10771cdd53a114865ca82c9e9d457f32d1da0e50b794
+  metadata.gz: 5f1571bf1b1ba2a42dd6f9829711865a436bab9531f8a8b9154e9194481bb2c2c699afec992128e97c5b890d89bb6012da5ebb330e1b41dd1cc78da8a3fd6dbe
+  data.tar.gz: 63ae45c9d04e7939aa3ec5d8cae671b7b9bb0acfb87895d912e85943d076a0479d3325579f35f2c8027db10a75f49bf3477184b7d39c666ef8064cf1b8f97d59

data/README.md

@@ -56,7 +56,6 @@ 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.
 
-
 SchemaPlus::Views also arranges to include the `create_view` statements (with literal SQL) in the schema dump.
 
 ### Dropping views
@@ -106,9 +105,70 @@ 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.
 
+## 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://SchemaPlus/schema_monkey) and [schema_plus_core](https://SchemaPlus/schema_plus_core).
+
+
+### `Schema::Views` stack
+
+Wraps the `connection.views` method.  Env contains:
+
+Env Field    | Description | Initialized
+--- | --- | ---
+`:views`     | The result of the lookup | `[]`
+`:connection` | The current ActiveRecord connection | *context*
+`:query_name` | Optional label for ActiveRecord logging | *arg*
+
+The base implementation appends its results to `env.views`
+
+### `Schema::ViewDefinition` stack
+
+Wraps the `connection.view_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`
+
+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.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

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

@@ -5,27 +5,36 @@ 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|
+            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|
+            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
 
         #####################################################################

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

@@ -4,24 +4,27 @@ module SchemaPlus::Views
       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
+          SchemaMonkey::Middleware::Schema::Views.start(connection: self, query_name: name, views: []) { |env|
+            select_all("SELECT table_name FROM information_schema.views WHERE table_schema = SCHEMA()", env.query_name).each do |row|
+              env.views << row["table_name"]
+            end
+          }.views
         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
+          SchemaMonkey::Middleware::Schema::ViewDefinition.start(connection: self, view_name: view_name, query_name: name) { |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
+          }.definition
         end
 
       end

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

@@ -4,25 +4,29 @@ module SchemaPlus::Views
       module PostgresqlAdapter
 
         def views(name = nil) #:nodoc:
-          sql = <<-SQL
+          SchemaMonkey::Middleware::Schema::Views.start(connection: self, query_name: name, views: []) { |env|
+            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] }
+            SQL
+            sql += " AND schemaname != 'postgis'" if adapter_name == 'PostGIS'
+            env.views += env.connection.query(sql, env.query_name).map { |row| row[0] }
+          }.views
         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?
+          SchemaMonkey::Middleware::Schema::ViewDefinition.start(connection: self, view_name: view_name, query_name: name) { |env|
+              result = env.connection.query(<<-SQL, name)
+                SELECT pg_get_viewdef(oid)
+                  FROM pg_class
+                WHERE relkind = 'v'
+                  AND relname = '#{env.view_name}'
+              SQL
+              row = result.first
+              env.definition = row.first.chomp(';').strip unless row.nil?
+          }.definition
         end
 
       end

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

@@ -4,12 +4,17 @@ module SchemaPlus::Views
       module Sqlite3Adapter
 
         def views(name = nil)
-          execute("SELECT name FROM sqlite_master WHERE type='view'", name).collect{|row| row["name"]}
+          SchemaMonkey::Middleware::Schema::Views.start(connection: self, query_name: name, views: []) { |env|
+            env.views += env.connection.execute("SELECT name FROM sqlite_master WHERE type='view'", env.query_name).collect{|row| row["name"]}
+          }.views
         end
 
         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?
+          SchemaMonkey::Middleware::Schema::ViewDefinition.start(connection: self, view_name: view_name, query_name: name) { |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
+          }.definition
         end
 
       end

data/lib/schema_plus/views/middleware.rb

@@ -50,6 +50,28 @@ module SchemaPlus::Views
         end
       end
     end
+
+    #
+    # Define new middleware stacks patterned on SchemaPlus::Core's naming
+    # for tables
+
+    module Schema
+      module Views
+        ENV = [:connection, :query_name, :views]
+      end
+      module ViewDefinition
+        ENV = [:connection, :view_name, :query_name, :definition]
+      end
+    end
+
+    module Migration
+      module CreateView
+        ENV = [:connection, :view_name, :definition, :options]
+      end
+      module DropView
+        ENV = [:connection, :view_name, :options]
+      end
+    end
   end
 
 end

data/lib/schema_plus/views/version.rb

@@ -1,5 +1,5 @@
 module SchemaPlus
   module Views
-    VERSION = "0.2.3"
+    VERSION = "0.3.0"
   end
 end

data/spec/dumper_spec.rb

@@ -16,7 +16,6 @@ describe "Dumper" do
   end
 
   it "should include view definitions" do
-    puts dump
     expect(dump).to match(view_re("a_ones", /SELECT .*b.*,.*s.* FROM .*items.* WHERE \(?.*a.* = 1\)?/mi))
     expect(dump).to match(view_re("ab_ones", /SELECT .*s.* FROM .*a_ones.* WHERE \(?.*b.* = 1\)?/mi))
   end

data/spec/introspection_spec.rb

@@ -17,8 +17,8 @@ describe "Introspection" do
 
   it "should list all views" do
     expect(connection.views.sort).to eq(%W[a_ones ab_ones])
-    expect(connection.view_definition('a_ones')).to match(%r{^ ?SELECT .*b.*,.*s.* FROM .*items.* WHERE .*a.* = 1}mi)
-    expect(connection.view_definition('ab_ones')).to match(%r{^ ?SELECT .*s.* FROM .*a_ones.* WHERE .*b.* = 1}mi)
+    expect(connection.view_definition('a_ones')).to match(%r{^SELECT .*b.*,.*s.* FROM .*items.* WHERE .*a.* = 1}mi)
+    expect(connection.view_definition('ab_ones')).to match(%r{^SELECT .*s.* FROM .*a_ones.* WHERE .*b.* = 1}mi)
   end
 
   it "should ignore views named pg_*", postgresql: :only do
@@ -36,8 +36,8 @@ describe "Introspection" do
   end
 
   it "should introspect definition" do
-    expect(connection.view_definition('a_ones')).to match(%r{^ ?SELECT .*b.*,.*s.* FROM .*items.* WHERE .*a.* = 1}mi)
-    expect(connection.view_definition('ab_ones')).to match(%r{^ ?SELECT .*s.* FROM .*a_ones.* WHERE .*b.* = 1}mi)
+    expect(connection.view_definition('a_ones')).to match(%r{^SELECT .*b.*,.*s.* FROM .*items.* WHERE .*a.* = 1}mi)
+    expect(connection.view_definition('ab_ones')).to match(%r{^SELECT .*s.* FROM .*a_ones.* WHERE .*b.* = 1}mi)
   end
 
   context "in mysql", :mysql => :only do

data/spec/middleware_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+module TestMiddleware
+  module Middleware
+
+    module Schema
+      module Views
+        SPY = []
+        def after(env)
+          SPY << env.to_hash.except(:connection)
+        end
+      end
+      module ViewDefinition
+        SPY = []
+        def after(env)
+          SPY << env.to_hash.except(:connection)
+        end
+      end
+    end
+
+    module Migration
+      module CreateView
+        SPY = []
+        def after(env)
+          SPY << env.to_hash.except(:connection)
+        end
+      end
+      module DropView
+        SPY = []
+        def after(env)
+          SPY << env.to_hash.except(:connection)
+        end
+      end
+    end
+
+  end
+end
+
+SchemaMonkey.register TestMiddleware
+
+context SchemaPlus::Views::Middleware do
+
+  let(:schema) { ActiveRecord::Schema }
+  let(:migration) { ActiveRecord::Migration }
+  let(:connection) { ActiveRecord::Base.connection }
+
+  before(:each) do
+    schema.define do
+      create_table :items, force: true do |t|
+        t.integer :a
+      end
+      create_view 'a_view', "select a from items"
+    end
+  end
+
+  context TestMiddleware::Middleware::Schema::Views do
+    it "calls middleware" do
+      expect(spy_on {connection.views 'qn'}).to eq({
+        #connection: connection,
+        views: ['a_view'],
+        query_name: 'qn'
+      })
+    end
+  end
+
+  context TestMiddleware::Middleware::Schema::ViewDefinition do
+    it "calls middleware" do
+      spied = spy_on {connection.view_definition('a_view', 'qn')}
+      expect(spied[:view_name]).to eq('a_view')
+      expect(spied[:definition]).to match(%r{SELECT .*a.* FROM .*items.*}mi)
+      expect(spied[:query_name]).to eq('qn')
+    end
+  end
+
+  context TestMiddleware::Middleware::Migration::CreateView do
+    it "calls middleware" do
+      expect(spy_on {migration.create_view('newview', 'select a from items', force: true)}).to eq({
+        #connection: connection,
+        view_name: 'newview',
+        definition: 'select a from items',
+        options: { force: true }
+      })
+    end
+  end
+
+  context TestMiddleware::Middleware::Migration::DropView do
+    it "calls middleware" do
+      expect(spy_on {migration.drop_view('a_items', if_exists: true)}).to eq({
+        #connection: connection,
+        view_name: 'a_items',
+        options: { if_exists: true }
+      })
+    end
+  end
+
+
+  private
+
+  def spy_on 
+    spy = described_class.const_get :SPY
+    spy.clear
+    yield
+    spy.first
+  end
+
+end

data/spec/spec_helper.rb

@@ -21,6 +21,9 @@ RSpec.configure do |config|
       ActiveRecord::Base.connection.tables.each do |table|
         ActiveRecord::Migration.drop_table table, force: :cascade
       end
+      ActiveRecord::Base.connection.views.each do |view|
+        ActiveRecord::Migration.drop_view view, force: :cascade
+      end
       example.run
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_plus_views
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - ronen barzel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-25 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -153,6 +153,7 @@ files:
 - schema_plus_views.gemspec
 - spec/dumper_spec.rb
 - spec/introspection_spec.rb
+- spec/middleware_spec.rb
 - spec/migration_spec.rb
 - spec/named_schemas_spec.rb
 - spec/sanity_spec.rb
@@ -184,6 +185,7 @@ summary: Adds support for views to ActiveRecord
 test_files:
 - spec/dumper_spec.rb
 - spec/introspection_spec.rb
+- spec/middleware_spec.rb
 - spec/migration_spec.rb
 - spec/named_schemas_spec.rb
 - spec/sanity_spec.rb