activerecord_views 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3d25414ba7a2d31b49f8604f17f5c2d73824135
-  data.tar.gz: a68b23bae39199bfa2ae160dfc0bb0e091a2dc88
+  metadata.gz: 9f28ee79b39ed0d431534523ef129ba9e63e8aad
+  data.tar.gz: 39e683254984dff81f2fdf7e43a3b96588738612
 SHA512:
-  metadata.gz: e41efe797b61dc942ac41b595b39b0d3c651b2e2966132b313b58f0d342f06fbb170239fc7fe079b879a7a60ea60f02688ee861b6d96f620b745fd4e7bdf2efe
-  data.tar.gz: 090e0cef956babdaacb0fb71199aff94a5e38f04c8b68f1c8b885c99e18f09d80a31e9c145aa0cf2d0ac66e77fe95fc8d530136d7840f34a104b260721b91784
+  metadata.gz: 2654eb5b8107e4cac185668a89769569efae3a13d627029da037ad2a4b0faea6fbfeb9695f67453175300b7899de19aac21c911ea240f9be0c6dc72b54dcb3e9
+  data.tar.gz: c5c7685c4598c46c43230958fcac5336b906a43b77e15d0c34a5ab73b373d02d51d263e1b8f11ebb8ae35780f26124cd3776fbd497d9f2f9a27b74485d262c92

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format progress

data/Appraisals

@@ -5,3 +5,7 @@ end
 appraise 'rails4_0' do
   gem 'rails', '~> 4.0.0'
 end
+
+appraise 'rails4_1' do
+  gem 'rails', '~> 4.1.0'
+end

data/README.markdown

@@ -68,13 +68,45 @@ Account.includes(:account_balance).find_each do |account|
 end
 ```
 
+## Pre-populating views in Rails development mode
+
+Rails loads classes lazily in development mode by default.
+This means ActiveRecordViews models will not initialize and create/update database views until the model classes are accessed.
+If you're debugging in `psql` and want to ensure all views have been created, you can force Rails to load them by running the following in a `rails console`:
+
+```ruby
+Rails.application.eager_load!
+```
+
+## Handling renames/deletions
+
+ActiveRecordViews tracks database views by their name. When an ActiveRecordViews model is renamed or deleted, there is no longer a link between the model and the associated database table. This means an orphan view will be left in the database.
+
+In order to keep things tidy and to avoid accidentally referencing a stale view, you should remove the view and associated ActiveRecordViews metadata when renaming or deleting a model using ActiveRecordViews. This is best done with a database migration (use `rails generate migration`) containing the following:
+
+```ruby
+ActiveRecordViews.drop_view connection, 'account_balances'
+```
+
 ### Usage outside of Rails
 
+When included in a Ruby on Rails project, ActiveRecordViews will automatically detect `.sql` files alongside models in `app/models`.
+Outside of Rails, you will have to tell ActiveRecordViews where to find associated `.sql` files for models:
+
 ```ruby
 require 'active_record'
 require 'active_record_views'
-ActiveRecordViews.load_path = ['.']
+require 'pg'
+
+ActiveRecordViews.sql_load_path << '.' # load .sql files from current directory
 ActiveRecordViews.init!
+ActiveRecord::Base.establish_connection 'postgresql:///example'
+
+class Foo < ActiveRecord::Base
+  is_view
+end
+
+p Foo.all
 ```
 
 ## License

data/activerecord_views.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'activerecord', ['>= 3.1', '< 4.1']
+  gem.add_dependency 'activerecord', ['>= 3.1', '< 4.2']
 
   gem.add_development_dependency 'appraisal'
   gem.add_development_dependency 'rspec-rails', '>= 2.14'

data/gemfiles/rails3_2.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~> 3.2.0"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/gemfiles/rails4_0.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~> 4.0.0"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/gemfiles/rails4_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.0"
+
+gemspec :path => "../"

data/lib/active_record_views.rb

@@ -53,13 +53,11 @@ module ActiveRecordViews
       begin
         connection.execute "CREATE OR REPLACE VIEW #{connection.quote_table_name name} AS #{sql}"
       rescue ActiveRecord::StatementInvalid => original_exception
-        begin
-          connection.transaction :requires_new => true do
+        connection.transaction :requires_new => true do
+          without_dependencies connection, name do
             connection.execute "DROP VIEW #{connection.quote_table_name name}"
             connection.execute "CREATE VIEW #{connection.quote_table_name name} AS #{sql}"
           end
-        rescue
-          raise original_exception
         end
       end
 
@@ -75,6 +73,50 @@ module ActiveRecordViews
     end
   end
 
+  def self.get_view_dependencies(connection, name)
+    connection.select_rows <<-SQL
+      WITH RECURSIVE dependants AS (
+        SELECT
+          #{connection.quote name}::regclass::oid,
+          0 AS level
+
+        UNION ALL
+
+        SELECT
+          DISTINCT(pg_rewrite.ev_class) AS oid,
+          dependants.level + 1 AS level
+        FROM pg_depend dep
+        INNER JOIN pg_rewrite ON pg_rewrite.oid = dep.objid
+        INNER JOIN dependants ON dependants.oid = dep.refobjid
+        WHERE pg_rewrite.ev_class != dep.refobjid AND dep.deptype = 'n'
+      )
+
+      SELECT
+        oid::regclass::text AS name,
+        pg_catalog.pg_get_viewdef(oid) AS definition
+      FROM dependants
+      INNER JOIN active_record_views ON active_record_views.name = oid::regclass::text
+      WHERE level > 0
+      GROUP BY oid
+      ORDER BY MAX(level)
+      ;
+    SQL
+  end
+
+  def self.without_dependencies(connection, name)
+    dependencies = get_view_dependencies(connection, name)
+
+    dependencies.reverse.each do |name, _|
+      connection.execute "DROP VIEW #{name};"
+    end
+
+    yield
+
+    dependencies.each do |name, definition|
+      connection.execute "CREATE VIEW #{name} AS #{definition};"
+    end
+  end
+
   def self.register_for_reload(sql_path, model_path)
     self.registered_views << RegisteredView.new(sql_path, model_path)
   end

data/lib/active_record_views/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordViews
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/active_record_views_spec.rb

@@ -9,10 +9,18 @@ describe ActiveRecordViews do
     end
 
     def test_view_sql
-      connection.select_value <<-SQL
-        SELECT trim(view_definition)
+      connection.select_value(<<-SQL).try(&:squish)
+        SELECT view_definition
         FROM information_schema.views
-        WHERE table_name = 'test'
+        WHERE table_schema = 'public' AND table_name = 'test'
+      SQL
+    end
+
+    def view_names
+      connection.select_values <<-SQL
+        SELECT table_name
+        FROM information_schema.views
+        WHERE table_schema = 'public'
       SQL
     end
 
@@ -47,13 +55,53 @@ describe ActiveRecordViews do
         expect(test_view_sql).to eq "SELECT 'foo'::text AS name;"
       end
 
-      context 'having a dependant view' do
+      context 'having dependant views' do
+        before do
+          ActiveRecordViews.create_view connection, 'dependency1', 'SELECT id FROM test;'
+          ActiveRecordViews.create_view connection, 'dependency2a', 'SELECT id, id * 2 AS id2 FROM dependency1;'
+          ActiveRecordViews.create_view connection, 'dependency2b', 'SELECT id, id * 4 AS id4 FROM dependency1;'
+          ActiveRecordViews.create_view connection, 'dependency3', 'SELECT * FROM dependency2b;'
+          ActiveRecordViews.create_view connection, 'dependency4', 'SELECT id FROM dependency1 UNION ALL SELECT id FROM dependency3;'
+        end
+
+        after do
+          dependants = %w[test dependency1 dependency2a dependency2b dependency3 dependency4]
+          expect(view_names).to match_array dependants
+          dependants.reverse.each do |name|
+            ActiveRecordViews.drop_view connection, name
+          end
+        end
+
+        it 'updates view with compatible change' do
+          create_test_view 'select 2 as id'
+          expect(test_view_sql).to eq 'SELECT 2 AS id;'
+          expect(connection.select_value('SELECT id2 FROM dependency2a')).to eq '4'
+        end
+
+        describe 'changes incompatible with CREATE OR REPLACE' do
+          it 'updates view with new column added before existing' do
+            create_test_view "select 'foo'::text as name, 3 as id"
+            expect(test_view_sql).to eq "SELECT 'foo'::text AS name, 3 AS id;"
+            expect(connection.select_value('SELECT id2 FROM dependency2a')).to eq '6'
+          end
+
+          it 'fails to update view if column used by dependant view is removed' do
+            expect {
+              create_test_view "select 'foo'::text as name"
+            }.to raise_error ActiveRecord::StatementInvalid, /column test.id does not exist/
+            expect(test_view_sql).to eq 'SELECT 1 AS id;'
+            expect(connection.select_value('SELECT id2 FROM dependency2a')).to eq '2'
+          end
+        end
+      end
+
+      describe 'with unmanaged dependant view' do
         before do
-          connection.execute 'CREATE VIEW dependency AS SELECT * FROM test'
+          connection.execute 'CREATE VIEW dependency AS SELECT id FROM test'
         end
 
         after do
-          connection.execute 'DROP VIEW dependency'
+          connection.execute 'DROP VIEW dependency;'
         end
 
         it 'updates view with compatible change' do
@@ -61,10 +109,10 @@ describe ActiveRecordViews do
           expect(test_view_sql).to eq 'SELECT 2 AS id;'
         end
 
-        it 'fails to update view with incompatible signature change' do
+        it 'fails to update view with incompatible change' do
           expect {
-            create_test_view "select 'foo'::text as name"
-          }.to raise_error ActiveRecord::StatementInvalid, /cannot change name of view column/
+            create_test_view "SELECT 'foo'::text as name, 4 as id"
+          }.to raise_error ActiveRecord::StatementInvalid, /view dependency depends on view test/
           expect(test_view_sql).to eq 'SELECT 1 AS id;'
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_views
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jason Weathered
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-22 00:00:00.000000000 Z
+date: 2014-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: '3.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Appraisals
 - Gemfile
 - LICENSE.txt
@@ -102,6 +103,7 @@ files:
 - activerecord_views.gemspec
 - gemfiles/rails3_2.gemfile
 - gemfiles/rails4_0.gemfile
+- gemfiles/rails4_1.gemfile
 - lib/active_record_views.rb
 - lib/active_record_views/checksum_cache.rb
 - lib/active_record_views/extension.rb