activerecord_views 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f28ee79b39ed0d431534523ef129ba9e63e8aad
-  data.tar.gz: 39e683254984dff81f2fdf7e43a3b96588738612
+  metadata.gz: be3aa1741d6dced3c4afcf32a941d3821ec0eafc
+  data.tar.gz: f29929115236d12395bad521420b03a4f799f382
 SHA512:
-  metadata.gz: 2654eb5b8107e4cac185668a89769569efae3a13d627029da037ad2a4b0faea6fbfeb9695f67453175300b7899de19aac21c911ea240f9be0c6dc72b54dcb3e9
-  data.tar.gz: c5c7685c4598c46c43230958fcac5336b906a43b77e15d0c34a5ab73b373d02d51d263e1b8f11ebb8ae35780f26124cd3776fbd497d9f2f9a27b74485d262c92
+  metadata.gz: 6c623e3dec891c353d1bb3d2b4a6466a2ea4ea520d5c4082007a3303c358982b6e832d251e9127b37ce0ba1b366cb866547eaa0ae57173fb868d0c4683582e4f
+  data.tar.gz: 7cde80415bc90e545f7cdcc6f987525c7c53050e59a2e26b8a83838f40c0f9e9cbbeae29ad15568e4a4e886a028b3bfce359167453d56f7af0d80a89111e3d3d

data/lib/active_record_views/checksum_cache.rb

@@ -6,19 +6,27 @@ module ActiveRecordViews
     end
 
     def init_state_table!
-      unless @connection.table_exists?('active_record_views')
-        @connection.execute 'CREATE TABLE active_record_views(name text PRIMARY KEY, checksum text NOT NULL);'
+      table_exists = @connection.table_exists?('active_record_views')
+
+      if table_exists && !@connection.column_exists?('active_record_views', 'class_name')
+        @connection.execute 'DROP TABLE active_record_views;'
+        table_exists = false
+      end
+
+      unless table_exists
+        @connection.execute 'CREATE TABLE active_record_views(name text PRIMARY KEY, class_name text NOT NULL UNIQUE, checksum text NOT NULL);'
       end
     end
 
     def get(name)
-      @connection.select_value("SELECT checksum FROM active_record_views WHERE name = #{@connection.quote name}")
+      @connection.select_one("SELECT class_name, checksum FROM active_record_views WHERE name = #{@connection.quote name}").try(:symbolize_keys)
     end
 
-    def set(name, checksum)
-      if checksum
-        if @connection.update("UPDATE active_record_views SET checksum = #{@connection.quote checksum} WHERE name = #{@connection.quote name}") == 0
-          @connection.insert "INSERT INTO active_record_views (name, checksum) VALUES (#{@connection.quote name}, #{@connection.quote checksum})"
+    def set(name, data)
+      if data
+        data.assert_valid_keys :class_name, :checksum
+        if @connection.update("UPDATE active_record_views SET class_name = #{@connection.quote data[:class_name]}, checksum = #{@connection.quote data[:checksum]} WHERE name = #{@connection.quote name}") == 0
+          @connection.insert "INSERT INTO active_record_views (name, class_name, checksum) VALUES (#{@connection.quote name}, #{@connection.quote data[:class_name]}, #{@connection.quote data[:checksum]})"
         end
       else
         @connection.delete "DELETE FROM active_record_views WHERE name = #{@connection.quote name}"

data/lib/active_record_views/extension.rb

@@ -1,3 +1,5 @@
+require 'erb'
+
 module ActiveRecordViews
   module Extension
     extend ActiveSupport::Concern
@@ -13,10 +15,16 @@ module ActiveRecordViews
         sql ||= begin
           sql_path = ActiveRecordViews.find_sql_file(self.name.underscore)
           ActiveRecordViews.register_for_reload self, sql_path
-          File.read sql_path
+
+          if sql_path.end_with?('.erb')
+            ERB.new(File.read(sql_path)).result
+          else
+            File.read(sql_path)
+          end
         end
+
         unless ActiveRecordViews::Extension.currently_migrating?
-          ActiveRecordViews.create_view self.connection, self.table_name, sql
+          ActiveRecordViews.create_view self.connection, self.table_name, self.name, sql
         end
       end
     end

data/lib/active_record_views/registered_view.rb

@@ -18,7 +18,7 @@ module ActiveRecordViews
 
     def reload!
       if File.exists? sql_path
-        ActiveRecordViews.create_view model_class.connection, model_class.table_name, File.read(sql_path)
+        ActiveRecordViews.create_view model_class.connection, model_class.table_name, model_class.name, File.read(sql_path)
       else
         ActiveRecordViews.drop_view model_class.connection, model_class.table_name
       end

data/lib/active_record_views/version.rb

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

data/lib/active_record_views.rb

@@ -21,6 +21,8 @@ module ActiveRecordViews
     self.sql_load_path.each do |dir|
       path = "#{dir}/#{name}.sql"
       return path if File.exists?(path)
+      path = path + '.erb'
+      return path if File.exists?(path)
     end
     raise "could not find #{name}.sql"
   end
@@ -32,27 +34,35 @@ module ActiveRecordViews
       !connection.outside_transaction?
     end
 
-    if in_transaction
-      begin
-        temp_connection = connection.pool.checkout
-        yield temp_connection
-      ensure
-        connection.pool.checkin temp_connection
+    begin
+      recursing = Thread.current[:active_record_views_without_transaction]
+      Thread.current[:active_record_views_without_transaction] = true
+
+      if in_transaction && !recursing
+        begin
+          temp_connection = connection.pool.checkout
+          yield temp_connection
+        ensure
+          connection.pool.checkin temp_connection
+        end
+      else
+        yield connection
       end
-    else
-      yield connection
+    ensure
+      Thread.current[:active_record_views_without_transaction] = nil
     end
   end
 
-  def self.create_view(connection, name, sql)
+  def self.create_view(connection, name, class_name, sql)
     without_transaction connection do |connection|
       cache = ActiveRecordViews::ChecksumCache.new(connection)
-      checksum = Digest::SHA1.hexdigest(sql)
-      return if cache.get(name) == checksum
+      data = {class_name: class_name, checksum: Digest::SHA1.hexdigest(sql)}
+      return if cache.get(name) == data
 
       begin
         connection.execute "CREATE OR REPLACE VIEW #{connection.quote_table_name name} AS #{sql}"
       rescue ActiveRecord::StatementInvalid => original_exception
+        raise unless view_exists?(connection, name)
         connection.transaction :requires_new => true do
           without_dependencies connection, name do
             connection.execute "DROP VIEW #{connection.quote_table_name name}"
@@ -61,7 +71,7 @@ module ActiveRecordViews
         end
       end
 
-      cache.set name, checksum
+      cache.set name, data
     end
   end
 
@@ -73,6 +83,14 @@ module ActiveRecordViews
     end
   end
 
+  def self.view_exists?(connection, name)
+    connection.select_value(<<-SQL).present?
+      SELECT 1
+      FROM information_schema.views
+      WHERE table_schema = 'public' AND table_name = #{connection.quote name};
+    SQL
+  end
+
   def self.get_view_dependencies(connection, name)
     connection.select_rows <<-SQL
       WITH RECURSIVE dependants AS (
@@ -93,11 +111,12 @@ module ActiveRecordViews
 
       SELECT
         oid::regclass::text AS name,
+        class_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
+      GROUP BY oid, class_name
       ORDER BY MAX(level)
       ;
     SQL
@@ -106,19 +125,24 @@ module ActiveRecordViews
   def self.without_dependencies(connection, name)
     dependencies = get_view_dependencies(connection, name)
 
-    dependencies.reverse.each do |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};"
+    dependencies.each do |name, class_name, definition|
+      begin
+        class_name.constantize
+      rescue NameError => e
+        raise unless e.missing_name?(class_name)
+        connection.execute "CREATE VIEW #{name} AS #{definition};"
+      end
     end
   end
 
-  def self.register_for_reload(sql_path, model_path)
-    self.registered_views << RegisteredView.new(sql_path, model_path)
+  def self.register_for_reload(model_class, sql_path)
+    self.registered_views << RegisteredView.new(model_class, sql_path)
   end
 
   def self.reload_stale_views!

data/spec/active_record_views_checksum_cache_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe ActiveRecordViews::ChecksumCache do
+  let(:connection) { ActiveRecord::Base.connection }
+
+  describe 'initialisation' do
+    context 'with no existing table' do
+      it 'creates the table' do
+        expect(ActiveRecord::Base.connection).to receive(:execute).with(/\ACREATE TABLE active_record_views/).once.and_call_original
+
+        expect(connection.table_exists?('active_record_views')).to eq false
+        ActiveRecordViews::ChecksumCache.new(connection)
+        expect(connection.table_exists?('active_record_views')).to eq true
+      end
+    end
+
+    context 'with existing table' do
+      before do
+        ActiveRecordViews::ChecksumCache.new(connection)
+        expect(connection.table_exists?('active_record_views')).to eq true
+      end
+
+      it 'does not recreate the table' do
+        expect(ActiveRecord::Base.connection).to receive(:execute).never
+
+        ActiveRecordViews::ChecksumCache.new(connection)
+      end
+    end
+
+    context 'with old table' do
+      before do
+        connection.execute 'CREATE TABLE active_record_views(name text PRIMARY KEY, checksum text NOT NULL);'
+      end
+
+      it 'recreates the table' do
+        expect(ActiveRecord::Base.connection).to receive(:execute).with(/\ADROP TABLE active_record_views/).once.and_call_original
+        expect(ActiveRecord::Base.connection).to receive(:execute).with(/\ACREATE TABLE active_record_views/).once.and_call_original
+
+        expect(connection.column_exists?('active_record_views', 'class_name')).to eq false
+        ActiveRecordViews::ChecksumCache.new(connection)
+        expect(connection.column_exists?('active_record_views', 'class_name')).to eq true
+      end
+    end
+  end
+end

data/spec/active_record_views_extension_spec.rb

@@ -17,6 +17,11 @@ describe ActiveRecordViews::Extension do
       expect(Namespace::TestModel.first.name).to eq 'Namespaced SQL file'
     end
 
+    it 'creates database views from external ERB files' do
+      expect(ActiveRecordViews).to receive(:create_view).once.and_call_original
+      expect(ErbTestModel.first.name).to eq 'ERB file'
+    end
+
     it 'errors if external SQL file is missing' do
       expect {
         MissingFileTestModel
@@ -28,6 +33,7 @@ describe ActiveRecordViews::Extension do
         expect(ActiveRecordViews).to receive(:create_view).with(
           anything,
           'modified_file_test_models',
+          'ModifiedFileTestModel',
           sql
         ).once.ordered
       end
@@ -76,11 +82,18 @@ describe ActiveRecordViews::Extension do
     end
 
     it 'does not create if database view is initially up to date' do
-      ActiveRecordViews.create_view ActiveRecord::Base.connection, 'initial_create_test_models', 'SELECT 42 as id'
+      ActiveRecordViews.create_view ActiveRecord::Base.connection, 'initial_create_test_models', 'InitialCreateTestModel', 'SELECT 42 as id'
       expect(ActiveRecord::Base.connection).to receive(:execute).with(/\ACREATE (?:OR REPLACE )?VIEW/).never
       class InitialCreateTestModel < ActiveRecord::Base
         is_view 'SELECT 42 as id'
       end
     end
+
+    it 'successfully recreates modified paired views with incompatible changes' do
+      ActiveRecordViews.create_view ActiveRecord::Base.connection, 'modified_as', 'ModifiedA', 'SELECT 11 AS old_name;'
+      ActiveRecordViews.create_view ActiveRecord::Base.connection, 'modified_bs', 'ModifiedB', 'SELECT old_name FROM modified_as;'
+
+      expect(ModifiedB.first.attributes.except(nil)).to eq('new_name' => 22)
+    end
   end
 end

data/spec/active_record_views_spec.rb

@@ -5,7 +5,7 @@ describe ActiveRecordViews do
     let(:connection) { ActiveRecord::Base.connection }
 
     def create_test_view(sql)
-      ActiveRecordViews.create_view connection, 'test', sql
+      ActiveRecordViews.create_view connection, 'test', 'Test', sql
     end
 
     def test_view_sql
@@ -30,6 +30,17 @@ describe ActiveRecordViews do
       expect(test_view_sql).to eq 'SELECT 1 AS id;'
     end
 
+    it 'records checksum and class name' do
+      create_test_view 'select 1 as id'
+      expect(connection.select_all('select * from active_record_views').to_a).to eq [
+        {
+          'name' => 'test',
+          'class_name' => 'Test',
+          'checksum' => Digest::SHA1.hexdigest('select 1 as id')
+        }
+      ]
+    end
+
     it 'persists views if transaction rolls back' do
       expect(test_view_sql).to be_nil
       connection.transaction :requires_new => true do
@@ -39,6 +50,12 @@ describe ActiveRecordViews do
       expect(test_view_sql).to eq 'SELECT 1 AS id;'
     end
 
+    it 'raises descriptive error if view SQL is invalid' do
+      expect {
+        create_test_view 'select blah'
+      }.to raise_error ActiveRecord::StatementInvalid, /column "blah" does not exist/
+    end
+
     context 'with existing view' do
       before do
         create_test_view 'select 1 as id'
@@ -57,11 +74,11 @@ describe ActiveRecordViews 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;'
+          ActiveRecordViews.create_view connection, 'dependency1', 'Dependency1', 'SELECT id FROM test;'
+          ActiveRecordViews.create_view connection, 'dependency2a', 'Dependency2a', 'SELECT id, id * 2 AS id2 FROM dependency1;'
+          ActiveRecordViews.create_view connection, 'dependency2b', 'Dependency2b', 'SELECT id, id * 4 AS id4 FROM dependency1;'
+          ActiveRecordViews.create_view connection, 'dependency3', 'Dependency3', 'SELECT * FROM dependency2b;'
+          ActiveRecordViews.create_view connection, 'dependency4', 'Dependency4', 'SELECT id FROM dependency1 UNION ALL SELECT id FROM dependency3;'
         end
 
         after do
@@ -118,4 +135,33 @@ describe ActiveRecordViews do
       end
     end
   end
+
+  describe '.without_transaction' do
+    let(:original_connection) { ActiveRecord::Base.connection }
+
+    it 'yields original connection if no active transaction' do
+      ActiveRecordViews.without_transaction original_connection do |new_connection|
+        expect(new_connection).to eq original_connection
+      end
+    end
+
+    it 'yields a new connection if inside a transaction' do
+      original_connection.transaction do
+        ActiveRecordViews.without_transaction original_connection do |new_connection|
+          expect(new_connection).to_not eq original_connection
+        end
+      end
+    end
+
+    it 'yields original connection if called recursively' do
+      ActiveRecordViews.without_transaction original_connection do |new_connection_1|
+        expect(new_connection_1).to eq original_connection
+        new_connection_1.transaction do
+          ActiveRecordViews.without_transaction new_connection_1 do |new_connection_2|
+            expect(new_connection_2).to eq new_connection_1
+          end
+        end
+      end
+    end
+  end
 end

data/spec/internal/app/models/erb_test_model.rb

@@ -0,0 +1,3 @@
+class ErbTestModel < ActiveRecord::Base
+  is_view
+end

data/spec/internal/app/models/erb_test_model.sql.erb

@@ -0,0 +1 @@
+SELECT 1 AS id, '<%= "ERB" %> file'::text AS name;

data/spec/internal/app/models/modified_a.rb

@@ -0,0 +1,3 @@
+class ModifiedA < ActiveRecord::Base
+  is_view 'SELECT 22 AS new_name;'
+end

data/spec/internal/app/models/modified_b.rb

@@ -0,0 +1,3 @@
+class ModifiedB < ActiveRecord::Base
+  is_view "SELECT new_name FROM #{ModifiedA.table_name};"
+end

data/spec/spec_helper.rb

@@ -23,7 +23,7 @@ RSpec.configure do |config|
       WHERE table_schema = 'public';
     SQL
     view_names.each do |view_name|
-      connection.execute "DROP VIEW IF EXISTS #{connection.quote_table_name view_name}"
+      connection.execute "DROP VIEW IF EXISTS #{connection.quote_table_name view_name} CASCADE"
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_views
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jason Weathered
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-07 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -111,12 +111,17 @@ files:
 - lib/active_record_views/registered_view.rb
 - lib/active_record_views/version.rb
 - lib/activerecord_views.rb
+- spec/active_record_views_checksum_cache_spec.rb
 - spec/active_record_views_extension_spec.rb
 - spec/active_record_views_spec.rb
+- spec/internal/app/models/erb_test_model.rb
+- spec/internal/app/models/erb_test_model.sql.erb
 - spec/internal/app/models/external_file_test_model.rb
 - spec/internal/app/models/external_file_test_model.sql
 - spec/internal/app/models/heredoc_test_model.rb
 - spec/internal/app/models/missing_file_test_model.rb
+- spec/internal/app/models/modified_a.rb
+- spec/internal/app/models/modified_b.rb
 - spec/internal/app/models/namespace/test_model.rb
 - spec/internal/app/models/namespace/test_model.sql
 - spec/internal/config/database.yml
@@ -147,12 +152,17 @@ signing_key:
 specification_version: 4
 summary: Automatic database view creation for ActiveRecord
 test_files:
+- spec/active_record_views_checksum_cache_spec.rb
 - spec/active_record_views_extension_spec.rb
 - spec/active_record_views_spec.rb
+- spec/internal/app/models/erb_test_model.rb
+- spec/internal/app/models/erb_test_model.sql.erb
 - spec/internal/app/models/external_file_test_model.rb
 - spec/internal/app/models/external_file_test_model.sql
 - spec/internal/app/models/heredoc_test_model.rb
 - spec/internal/app/models/missing_file_test_model.rb
+- spec/internal/app/models/modified_a.rb
+- spec/internal/app/models/modified_b.rb
 - spec/internal/app/models/namespace/test_model.rb
 - spec/internal/app/models/namespace/test_model.sql
 - spec/internal/config/database.yml