schema_plus_views 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94cd524efd83a80577764570786aa30b828218b4
-  data.tar.gz: e86c50e980bd4e483caea91b6ab00f787a0f7425
+  metadata.gz: f120d0fd9e453a3e35a2ba8b71630edb81a93d96
+  data.tar.gz: 5b84b184193e12d27e883953d787d8f4b45f4743
 SHA512:
-  metadata.gz: 56febaf08947bed4af3cb7efd7c45a5ccd465f2c8204d71facd52ccea83147342a3ef62cd5cb7a491d9e33a8a7e6c363d6abd418c5513bb7e42f76289dc460ad
-  data.tar.gz: 562f3fbf5c349ee0373948e8e1186d713ef91c90754847ba162ed44d78d3bb0c753d47d747ca63851d51ce3582420c44e567d97da73a91e8fc39c8010a36927c
+  metadata.gz: db00fa4def6a06f90503c86bbbca407e9e61f911c9f7e3f2d99b6ab17d0ae57759f75aa880ce8f032093adf1ff569c2207600e8ff513bc255d5adb7890121b82
+  data.tar.gz: 5a993567b4ba203f891b8dd205640f41bc37aea6f74f90d27bca7caab7b8fa54f2051ce055b253e2f06b84559898ec6f8fedf8154d832fcd23e981ec111a8d8c

data/.travis.yml

@@ -12,7 +12,7 @@ gemfile:
 - gemfiles/activerecord-4.2/Gemfile.sqlite3
 env: POSTGRESQL_DB_USER=postgres MYSQL_DB_USER=travis
 addons:
-  postgresql: '9.3'
+  postgresql: '9.4'
 before_script: bundle exec rake create_databases
 after_script: bundle exec rake drop_databases
 script: bundle exec rake travis

data/README.md

@@ -20,14 +20,6 @@ gem "schema_plus_views"                # in a Gemfile
 gem.add_dependency "schema_plus_views" # in a .gemspec
 ```
 
-To use with a rails app, also include
-
-```ruby
-gem "schema_monkey_rails"
-```
-
-which creates a Railtie to that will insert SchemaPlus::Views appropriately into the rails stack. To use with Padrino, see [schema_monkey_padrino](https://github.com/SchemaPlus/schema_monkey_padrino).
-
 <!-- SCHEMA_DEV: TEMPLATE INSTALLATION - end -->
 
 ## Compatibility
@@ -44,10 +36,10 @@ SchemaPlus::Views is tested on:
 
 ### Creating views
 
-  In a migration, a view can be created using literal SQL: 
+In a migration, a view can be created using literal SQL:
 
 ```ruby
-create_view :uncommented_posts,        "SELECT * FROM posts LEFT OUTER JOIN comments ON comments.post_id = posts.id WHERE comments.id IS NULL"
+create_view :uncommented_posts, "SELECT * FROM posts LEFT OUTER JOIN comments ON comments.post_id = posts.id WHERE comments.id IS NULL"
 ```
 
 or using an object that responds to `:to_sql`, such as a relation:
@@ -56,7 +48,16 @@ or using an object that responds to `:to_sql`, such as a relation:
 create_view :posts_commented_by_staff,  Post.joins(comment: user).where(users: {role: 'staff'}).uniq
 ```
 
-(It's of course a questionable idea for your migrations to depend on your model definitions.  But you *can* if you want.)
+(It's of course a questionable idea for your migration files to depend on your model definitions.  But you *can* if you want.)
+
+Additional options can be provided:
+
+* `:force => true` if there's an existing view with the given name, deletes it first.  Note that this could fail if another view depends on it.
+
+* `: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
 
@@ -69,12 +70,12 @@ drop_view :uncommented_posts, :if_exists => true
 
 ### Using views
 
-ActiveRecord models can be use views the same as ordinary tables.  That is, for the above views you can define
+ActiveRecord models can be based on views the same as ordinary tables.  That is, for the above views you can define
 
 ```ruby
 class UncommentedPost < ActiveRecord::Base
 end
-    
+
 class PostCommentedByStaff < ActiveRecord::Base
   table_name = "posts_commented_by_staff"
 end
@@ -85,15 +86,15 @@ end
 You can look up the defined views analogously to looking up tables:
 
 ```ruby
-connection.tables # => array of table names (defined by ActiveRecord)
-connection.views  # => array of names of views (defined by SchemaPlus::Views)
+connection.tables # => array of table names [method provided by ActiveRecord]
+connection.views  # => array of view names [method provided by SchemaPlus::Views]
 ```
 
 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` does *not* return views prefixed with `pg_` as those are presumed to be internal.
+2. For PostgreSQL, `connection.views` suppresses views prefixed with `pg_` as those are presumed to be internal.
 
 ### Querying view definitions
 
@@ -108,13 +109,12 @@ This returns just the body of the definition, i.e. the part after the `CREATE VI
 
 ## History
 
+* 0.2.0 - Added :allow_replace option (thanks to [@hcarver](https://github.com/hcarver))
 * 0.1.0 - Initial release, extracted from schema_plus 1.x
 
 ## Development & Testing
 
-Are you interested in contributing to SchemaPlus::Views?  Thanks!  Please follow
-the standard protocol: fork, feature branch, develop, push, and issue pull
-request.
+Are you interested in contributing to SchemaPlus::Views?  Thanks!  Please follow the standard protocol: fork, feature branch, develop, push, and issue pull request.
 
 Some things to know about to help you develop and test:
 
@@ -144,8 +144,8 @@ Some things to know about to help you develop and test:
   provides middleware callback stacks to make it easy to extend
   ActiveRecord's behavior.  If that API is missing something you need for
   your contribution, please head over to
-  [schema_plus_core](https://github/SchemaPlus/schema_plus_core) and open
-  an issue or pull request.  
+  [schema_plus_core](https://github.com/SchemaPlus/schema_plus_core) and open
+  an issue or pull request.
 
 <!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_PLUS_CORE - end -->
 
@@ -155,6 +155,5 @@ Some things to know about to help you develop and test:
   [schema_monkey](https://github.com/SchemaPlus/schema_monkey) client,
   using [schema_monkey](https://github.com/SchemaPlus/schema_monkey)'s
   convention-based protocols for extending ActiveRecord and using middleware stacks.
-  For more information see [schema_monkey](https://github.com/SchemaPlus/schema_monkey)'s README.
 
 <!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_MONKEY - end -->

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

@@ -9,7 +9,14 @@ module SchemaPlus::Views
           if options[:force]
             drop_view(view_name, if_exists: true)
           end
-          execute "CREATE VIEW #{quote_table_name(view_name)} AS #{definition}"
+
+          command = if options[:allow_replace]
+            "CREATE OR REPLACE"
+          else
+            "CREATE"
+          end
+
+          execute "#{command} VIEW #{quote_table_name(view_name)} AS #{definition}"
         end
 
         # Drop the named view.  Specify :if_exists => true

data/lib/schema_plus/views/version.rb

@@ -1,5 +1,5 @@
 module SchemaPlus
   module Views
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/schema_plus_views.rb

@@ -1 +1 @@
-require_relative 'schema_plus/views.rb'
+require_relative 'schema_plus/views'

data/schema_plus_views.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "bundler", "~> 1.7"
   gem.add_development_dependency "rake", "~> 10.0"
   gem.add_development_dependency "rspec", "~> 3.0"
-  gem.add_development_dependency "schema_dev", "~> 3.2"
+  gem.add_development_dependency "schema_dev", "~> 3.3"
   gem.add_development_dependency "simplecov"
   gem.add_development_dependency "simplecov-gem-profile"
 end

data/spec/views_spec.rb

@@ -9,7 +9,7 @@ end
 class ABOnes < ActiveRecord::Base
 end
 
-describe ActiveRecord do
+describe "Views" do
 
   let(:schema) { ActiveRecord::Schema }
 
@@ -17,50 +17,67 @@ describe ActiveRecord do
 
   let(:connection) { ActiveRecord::Base.connection }
 
-  context "views" do
+  before(:each) do
+    define_schema_and_data
+  end
 
-    around(:each) do |example|
-      define_schema_and_data
-      example.run
-      drop_definitions
-    end
+  context "querys" do
 
     it "should query correctly" do
       expect(AOnes.all.collect(&:s)).to eq(%W[one_one one_two])
       expect(ABOnes.all.collect(&:s)).to eq(%W[one_one])
     end
 
-    it "should instrospect" do
-      # for postgresql, ignore views named pg_*
+  end
+
+  context "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)
     end
 
+    it "should ignore views named pg_*", postgresql: :only do
+      begin
+        migration.create_view :pg_dummy_internal, "select 1"
+        expect(connection.views.sort).to eq(%W[a_ones ab_ones])
+      ensure
+        migration.drop_view :pg_dummy_internal
+      end
+    end
+
     it "should not be listed as a table" do
       expect(connection.tables).not_to include('a_ones')
       expect(connection.tables).not_to include('ab_ones')
     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)
+    end
+  end
+
 
-    it "should be included in schema dump" do
+  context "dumper" do
+
+    it "should include view definitions" do
       expect(dump).to match(%r{create_view "a_ones", " ?SELECT .*b.*,.*s.* FROM .*items.* WHERE .*a.* = 1.*, :force => true}mi)
       expect(dump).to match(%r{create_view "ab_ones", " ?SELECT .*s.* FROM .*a_ones.* WHERE .*b.* = 1.*, :force => true}mi)
     end
 
-    it "should be included in schema dump in dependency order" do
+    it "should include views in dependency order" do
       expect(dump).to match(%r{create_table "items".*create_view "a_ones".*create_view "ab_ones"}m)
     end
 
-    it "should not be included in schema if listed in ignore_tables" do
+    it "should not include views listed in ignore_tables" do
       dump(ignore_tables: /b_/) do |dump|
         expect(dump).to match(%r{create_view "a_ones", " ?SELECT .*b.*,.*s.* FROM .*items.* WHERE .*a.* = 1.*, :force => true}mi)
         expect(dump).not_to match(%r{"ab_ones"})
       end
     end
 
-
-    it "dump should not reference current database" do
+    it "should not reference current database" do
       # why check this?  mysql default to providing the view definition
       # with tables explicitly scoped to the current database, which
       # resulted in the dump being bound to the current database.  this
@@ -71,115 +88,97 @@ describe ActiveRecord do
       db = connection.respond_to?(:current_database)? connection.current_database : SchemaDev::Rspec.db_configuration[:database]
       expect(dump).not_to match(%r{#{connection.quote_table_name(db)}[.]})
     end
+  end
 
-    context "duplicate view creation" do
-      around(:each) do |example|
-        migration.suppress_messages do
-          begin
-            migration.create_view('dupe_me', 'SELECT * FROM items WHERE (a=1)')
-            example.run
-          ensure
-            migration.drop_view('dupe_me')
-          end
-        end
-      end
-
+  context "duplicate creation" do
+    before(:each) do
+      migration.create_view('dupe_me', 'SELECT * FROM items WHERE (a=1)')
+    end
 
-      it "should raise an error by default" do
-        expect {migration.create_view('dupe_me', 'SELECT * FROM items WHERE (a=2)')}.to raise_error ActiveRecord::StatementInvalid
-      end
+    it "should raise an error by default" do
+      expect {migration.create_view('dupe_me', 'SELECT * FROM items WHERE (a=2)')}.to raise_error ActiveRecord::StatementInvalid
+    end
 
-      it "should override existing definition if :force true" do
-        migration.create_view('dupe_me', 'SELECT * FROM items WHERE (a=2)', :force => true)
+    it "should override existing definition if :force true" do
+      migration.create_view('dupe_me', 'SELECT * FROM items WHERE (a=2)', :force => true)
+      expect(connection.view_definition('dupe_me')).to match(%r{WHERE .*a.*=.*2}i)
+    end
+ 
+    context "Postgres and MySQL only", :sqlite3 => :skip do
+      it "should override existing definition if :allow_replace is true" do
+        migration.create_view('dupe_me', 'SELECT * FROM items WHERE (a=2)', :allow_replace => true)
         expect(connection.view_definition('dupe_me')).to match(%r{WHERE .*a.*=.*2}i)
       end
     end
+  end
 
-    context "dropping views" do
-      it "should raise an error if the view doesn't exist" do
-        expect { migration.drop_view('doesnt_exist') }.to raise_error ActiveRecord::StatementInvalid
-      end
+  context "dropping" do
+    it "should raise an error if the view doesn't exist" do
+      expect { migration.drop_view('doesnt_exist') }.to raise_error ActiveRecord::StatementInvalid
+    end
 
-      it "should fail silently when using if_exists option" do
-        expect { migration.drop_view('doesnt_exist', :if_exists => true) }.not_to raise_error
-      end
+    it "should fail silently when using if_exists option" do
+      expect { migration.drop_view('doesnt_exist', :if_exists => true) }.not_to raise_error
+    end
 
-      context "with a view that exists" do
-        before { migration.create_view('view_that_exists', 'SELECT * FROM items WHERE (a=1)') }
+    context "with a view that exists" do
+      before { migration.create_view('view_that_exists', 'SELECT * FROM items WHERE (a=1)') }
 
-        it "should succeed" do
-          migration.drop_view('view_that_exists')
-          expect(connection.views).not_to include('view_that_exists')
-        end
+      it "should succeed" do
+        migration.drop_view('view_that_exists')
+        expect(connection.views).not_to include('view_that_exists')
       end
     end
+  end
 
-    context "in mysql", :mysql => :only do
+  context "in mysql", :mysql => :only do
 
-      around(:each) do |example|
-        migration.suppress_messages do
-          begin
-            migration.drop_view :check if connection.views.include? 'check'
-            example.run
-          ensure
-            migration.drop_view :check if connection.views.include? 'check'
-          end
-        end
+    around(:each) do |example|
+      begin
+        migration.drop_view :check if connection.views.include? 'check'
+        example.run
+      ensure
+        migration.drop_view :check if connection.views.include? 'check'
       end
+    end
 
-      it "should introspect WITH CHECK OPTION" do
-        migration.create_view :check, 'SELECT * FROM items WHERE (a=2) WITH CHECK OPTION'
-        expect(connection.view_definition('check')).to match(%r{WITH CASCADED CHECK OPTION$})
-      end
+    it "should introspect WITH CHECK OPTION" do
+      migration.create_view :check, 'SELECT * FROM items WHERE (a=2) WITH CHECK OPTION'
+      expect(connection.view_definition('check')).to match(%r{WITH CASCADED CHECK OPTION$})
+    end
 
-      it "should introspect WITH CASCADED CHECK OPTION" do
-        migration.create_view :check, 'SELECT * FROM items WHERE (a=2) WITH CASCADED CHECK OPTION'
-        expect(connection.view_definition('check')).to match(%r{WITH CASCADED CHECK OPTION$})
-      end
+    it "should introspect WITH CASCADED CHECK OPTION" do
+      migration.create_view :check, 'SELECT * FROM items WHERE (a=2) WITH CASCADED CHECK OPTION'
+      expect(connection.view_definition('check')).to match(%r{WITH CASCADED CHECK OPTION$})
+    end
 
-      it "should introspect WITH LOCAL CHECK OPTION" do
-        migration.create_view :check, 'SELECT * FROM items WHERE (a=2) WITH LOCAL CHECK OPTION'
-        expect(connection.view_definition('check')).to match(%r{WITH LOCAL CHECK OPTION$})
-      end
+    it "should introspect WITH LOCAL CHECK OPTION" do
+      migration.create_view :check, 'SELECT * FROM items WHERE (a=2) WITH LOCAL CHECK OPTION'
+      expect(connection.view_definition('check')).to match(%r{WITH LOCAL CHECK OPTION$})
     end
   end
 
   protected
 
   def define_schema_and_data
-    migration.suppress_messages do
-      connection.views.each do |view| connection.drop_view view end
-      connection.tables.each do |table| connection.drop_table table, cascade: true end
+    connection.views.each do |view| connection.drop_view view end
+    connection.tables.each do |table| connection.drop_table table, cascade: true end
 
-      schema.define do
+    schema.define do
 
-        create_table :items, :force => true do |t|
-          t.integer :a
-          t.integer :b
-          t.string  :s
-        end
-
-        create_view :a_ones, Item.select('b, s').where(:a => 1)
-        create_view :ab_ones, "select s from a_ones where b = 1"
-        create_view :pg_dummy_internal, "select 1" if SchemaDev::Rspec::Helpers.postgresql?
+      create_table :items, :force => true do |t|
+        t.integer :a
+        t.integer :b
+        t.string  :s
       end
+
+      create_view :a_ones, Item.select('b, s').where(:a => 1)
+      create_view :ab_ones, "select s from a_ones where b = 1"
     end
     connection.execute "insert into items (a, b, s) values (1, 1, 'one_one')"
     connection.execute "insert into items (a, b, s) values (1, 2, 'one_two')"
     connection.execute "insert into items (a, b, s) values (2, 1, 'two_one')"
     connection.execute "insert into items (a, b, s) values (2, 2, 'two_two')"
-
-  end
-
-  def drop_definitions
-    migration.suppress_messages do
-      schema.define do
-        drop_view "ab_ones"
-        drop_view "a_ones"
-        drop_table "items"
-        drop_view :pg_dummy_internal if SchemaDev::Rspec::Helpers.postgresql?
-      end
-    end
   end
 
   def dump(opts={})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_plus_views
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ronen barzel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2015-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement