activerecord_views 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+Gemfile.lock
+pkg
+spec/internal/log/*.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jason Weathered
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,82 @@
+# ActiveRecordViews
+
+ActiveRecordViews makes it easy to create and update PostgreSQL database views for ActiveRecord models.
+
+Advantages over creating views manually in migrations include:
+
+* Automatic reloading in development mode.
+  This avoids the need to to run `rake db:migrate:redo` after every change.
+
+* Keeps view changes in a single SQL file instead of spread across multiple migration files.
+  This allows changes to views to be easily reviewed with `git diff`.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```
+gem 'activerecord_views'
+```
+
+## Usage
+
+app/models/account.rb:
+
+``` ruby
+class Account < ActiveRecord::Base
+  has_many :transactions
+
+  has_one :account_balance
+  delegate :balance, :to => :account_balance
+end
+```
+
+app/models/transaction.rb:
+
+``` ruby
+class Transaction < ActiveRecord::Base
+  belongs_to :account
+end
+```
+
+app/models/account_balance.rb:
+
+``` ruby
+class AccountBalance < ActiveRecord::Base
+  is_view
+
+  belongs_to :account
+end
+```
+
+app/models/account_balance.sql:
+
+``` sql
+SELECT accounts.id AS account_id, coalesce(sum(transactions.amount), 0) AS balance
+FROM accounts
+LEFT JOIN transactions ON accounts.id = transactions.account_id
+GROUP BY accounts.id
+```
+
+Example usage:
+
+``` ruby
+p Account.first.balance
+
+Account.includes(:account_balance).find_each do |account|
+  p account.balance
+end
+```
+
+### Usage outside of Rails
+
+``` ruby
+require 'active_record'
+require 'active_record_views'
+ActiveRecordViews.load_path = ['.']
+ActiveRecordViews.init!
+```
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/activerecord_views.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_views/version'
+
+Gem::Specification.new do |gem|
+  gem.name = 'activerecord_views'
+  gem.version = ActiveRecordViews::VERSION
+  gem.authors = ['Jason Weathered']
+  gem.email = ['jason@jasoncodes.com']
+  gem.summary = %q{Automatic database view creation for ActiveRecord}
+  gem.homepage = 'http://github.com/jasoncodes/activerecord_views'
+  gem.license = 'MIT'
+
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'activerecord', ['>= 3.1', '< 4.1']
+
+  gem.add_development_dependency 'rspec-rails', '>= 2.14'
+  gem.add_development_dependency 'combustion', '>= 0.5.1'
+  gem.add_development_dependency 'pg'
+end

data/lib/active_record_views/checksum_cache.rb

@@ -0,0 +1,34 @@
+require 'active_record'
+
+module ActiveRecordViews
+  class ChecksumCache
+    class Model < ActiveRecord::Base
+      self.table_name = 'active_record_views'
+      self.primary_key = 'name'
+    end
+
+    def initialize(connection)
+      @connection = connection
+      init_state_table!
+    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);'
+      end
+    end
+
+    def get(name)
+      Model.where(:name => name).first_or_initialize.checksum
+    end
+
+    def set(name, checksum)
+      row = Model.where(:name => name).first_or_initialize
+      if checksum
+        row.update_attributes! :checksum => checksum
+      else
+        row.destroy
+      end
+    end
+  end
+end

data/lib/active_record_views/extension.rb

@@ -0,0 +1,24 @@
+module ActiveRecordViews
+  module Extension
+    extend ActiveSupport::Concern
+
+    def self.currently_migrating?
+      if defined? Rake
+        Rake.application.top_level_tasks.include?('db:migrate')
+      end
+    end
+
+    module ClassMethods
+      def is_view(sql = nil)
+        sql ||= begin
+          sql_path = ActiveRecordViews.find_sql_file(self.name.underscore)
+          ActiveRecordViews.register_for_reload self, sql_path
+          File.read sql_path
+        end
+        unless ActiveRecordViews::Extension.currently_migrating?
+          ActiveRecordViews.create_view self.connection, self.table_name, sql
+        end
+      end
+    end
+  end
+end

data/lib/active_record_views/railtie.rb

@@ -0,0 +1,18 @@
+module ActiveRecordViews
+  class Railtie < ::Rails::Railtie
+    initializer 'active_record_views' do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecordViews.sql_load_path << Rails.root + 'app/models'
+        ActiveRecordViews.init!
+      end
+
+      ActiveSupport.on_load :action_controller do
+        unless app.config.cache_classes
+          ActionDispatch::Callbacks.before do
+            ActiveRecordViews.reload_stale_views!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record_views/registered_view.rb

@@ -0,0 +1,38 @@
+module ActiveRecordViews
+  class RegisteredView
+    attr_reader :model_class, :sql_path
+
+    def initialize(model_class, sql_path)
+      @model_class_name = model_class.name
+      @sql_path = sql_path
+      update_timestamp!
+    end
+
+    def model_class
+      @model_class_name.constantize
+    end
+
+    def stale?
+      sql_timestamp != @cached_sql_timestamp
+    end
+
+    def reload!
+      if File.exists? sql_path
+        ActiveRecordViews.create_view model_class.connection, model_class.table_name, File.read(sql_path)
+      else
+        ActiveRecordViews.drop_view model_class.connection, model_class.table_name
+      end
+      update_timestamp!
+    end
+
+    private
+
+    def sql_timestamp
+      File.exists?(sql_path) ? File.mtime(sql_path) : nil
+    end
+
+    def update_timestamp!
+      @cached_sql_timestamp = sql_timestamp
+    end
+  end
+end

data/lib/active_record_views/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordViews
+  VERSION = '0.0.1'
+end

data/lib/active_record_views.rb

@@ -0,0 +1,66 @@
+require 'active_record_views/version'
+require 'active_record_views/railtie' if defined? Rails
+require 'active_record_views/registered_view'
+require 'active_record_views/checksum_cache'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'digest/sha1'
+
+module ActiveRecordViews
+  mattr_accessor :sql_load_path
+  self.sql_load_path = []
+
+  mattr_accessor :registered_views
+  self.registered_views = []
+
+  def self.init!
+    require 'active_record_views/extension'
+    ::ActiveRecord::Base.send :include, ActiveRecordViews::Extension
+  end
+
+  def self.find_sql_file(name)
+    self.sql_load_path.each do |dir|
+      path = "#{dir}/#{name}.sql"
+      return path if File.exists?(path)
+    end
+    raise "could not find #{name}.sql"
+  end
+
+  def self.create_view(connection, name, sql)
+    cache = ActiveRecordViews::ChecksumCache.new(connection)
+    checksum = Digest::SHA1.hexdigest(sql)
+    return if cache.get(name) == checksum
+
+    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.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
+
+    cache.set name, checksum
+  end
+
+  def self.drop_view(connection, name)
+    cache = ActiveRecordViews::ChecksumCache.new(connection)
+    connection.execute "DROP VIEW IF EXISTS #{connection.quote_table_name name}"
+    cache.set name, nil
+  end
+
+  def self.register_for_reload(sql_path, model_path)
+    self.registered_views << RegisteredView.new(sql_path, model_path)
+  end
+
+  def self.reload_stale_views!
+    self.registered_views.each do |registered_view|
+      if registered_view.stale?
+        registered_view.reload!
+      end
+    end
+  end
+end

data/lib/activerecord_views.rb

@@ -0,0 +1 @@
+require 'active_record_views'

data/spec/active_record_views_extension_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe ActiveRecordViews::Extension do
+  describe '.as_view' do
+    it 'creates database views from heredocs' do
+      expect(ActiveRecordViews).to receive(:create_view).once.and_call_original
+      expect(HeredocTestModel.first.name).to eq 'Here document'
+    end
+
+    it 'creates database views from external SQL files' do
+      expect(ActiveRecordViews).to receive(:create_view).once.and_call_original
+      expect(ExternalFileTestModel.first.name).to eq 'External SQL file'
+    end
+
+    it 'errors if external SQL file is missing' do
+      expect {
+        MissingFileTestModel
+      }.to raise_error RuntimeError, /could not find missing_file_test_model.sql/
+    end
+
+    it 'reloads the database view when external SQL file is modified' do
+      %w[foo bar baz].each do |sql|
+        expect(ActiveRecordViews).to receive(:create_view).with(
+          anything,
+          'modified_file_test_models',
+          sql
+        ).once.ordered
+      end
+
+      with_temp_sql_dir do |temp_dir|
+        sql_file = File.join(temp_dir, 'modified_file_test_model.sql')
+        update_file sql_file, 'foo'
+
+        class ModifiedFileTestModel < ActiveRecord::Base
+          is_view
+        end
+
+        update_file sql_file, 'bar'
+
+        test_request
+        test_request # second request does not `create_view` again
+
+        update_file sql_file, 'baz'
+
+        test_request
+      end
+      test_request # trigger cleanup
+    end
+
+    it 'drops the view if the external SQL file is deleted' do
+      with_temp_sql_dir do |temp_dir|
+        sql_file = File.join(temp_dir, 'deleted_file_test_model.sql')
+        File.write sql_file, "SELECT 1 AS id, 'delete test'::text AS name"
+
+        class DeletedFileTestModel < ActiveRecord::Base
+          is_view
+        end
+
+        expect(DeletedFileTestModel.first.name).to eq 'delete test'
+
+        File.unlink sql_file
+
+        expect(ActiveRecord::Base.connection).to receive(:execute).with(/\ADROP/).once.and_call_original
+        expect(ActiveRecord::Base.connection).to receive(:execute).with(/\A(?:RELEASE )?SAVEPOINT/).at_least(1).times.and_call_original
+        test_request
+        test_request # second request does not `drop_view` again
+
+        expect {
+          DeletedFileTestModel.first.name
+        }.to raise_error ActiveRecord::StatementInvalid, /relation "deleted_file_test_models" does not exist/
+      end
+    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'
+      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
+  end
+end

data/spec/active_record_views_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe ActiveRecordViews do
+  describe '.create_view' do
+    let(:connection) { ActiveRecord::Base.connection }
+
+    self.use_transactional_fixtures = false
+    after do
+      connection.execute 'DROP VIEW IF EXISTS test'
+      connection.execute 'DROP TABLE IF EXISTS active_record_views'
+    end
+
+    def create_test_view(sql)
+      ActiveRecordViews.create_view connection, 'test', sql
+    end
+
+    def test_view_sql
+      connection.select_value <<-SQL
+        SELECT view_definition
+        FROM information_schema.views
+        WHERE table_name = 'test'
+      SQL
+    end
+
+    it 'creates database view' do
+      expect(test_view_sql).to be_nil
+      create_test_view 'select 1 as id'
+      expect(test_view_sql).to eq 'SELECT 1 AS id;'
+    end
+
+    context 'with existing view' do
+      before do
+        create_test_view 'select 1 as id'
+        expect(test_view_sql).to eq 'SELECT 1 AS id;'
+      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;'
+      end
+
+      it 'recreates view with incompatible change' do
+        create_test_view "select 'foo'::text as name"
+        expect(test_view_sql).to eq "SELECT 'foo'::text AS name;"
+      end
+
+      context 'having a dependant view' do
+        before do
+          connection.execute 'CREATE VIEW dependency AS SELECT * FROM test'
+        end
+
+        after do
+          connection.execute 'DROP VIEW dependency'
+        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;'
+        end
+
+        it 'fails to update view with incompatible signature change' do
+          expect {
+            create_test_view "select 'foo'::text as name"
+          }.to raise_error ActiveRecord::StatementInvalid, /cannot change name of view column/
+          expect(test_view_sql).to eq 'SELECT 1 AS id;'
+        end
+      end
+    end
+  end
+end

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

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

data/spec/internal/app/models/external_file_test_model.sql

@@ -0,0 +1 @@
+SELECT 1 AS id, 'External SQL file'::text AS name;

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

@@ -0,0 +1,5 @@
+class HeredocTestModel < ActiveRecord::Base
+  is_view <<-SQL
+    SELECT 1 AS id, 'Here document'::text AS name;
+  SQL
+end

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

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

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: postgresql
+  database: activerecord_views_test

data/spec/internal/db/schema.rb

@@ -0,0 +1,2 @@
+ActiveRecord::Schema.define do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+require 'bundler'
+Bundler.setup
+
+require 'combustion'
+require 'active_record_views'
+Combustion.initialize! :active_record, :action_controller do
+  config.cache_classes = false
+end
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+end
+
+def test_request
+  begin
+    Rails.application.call({'REQUEST_METHOD' => 'GET', 'PATH_INFO' => '/'})
+  rescue ActionController::RoutingError
+  end
+end
+
+def with_temp_sql_dir
+  Dir.mktmpdir do |temp_dir|
+    begin
+      old_sql_load_path = ActiveRecordViews.sql_load_path
+      ActiveRecordViews.sql_load_path = [temp_dir] + old_sql_load_path
+      yield temp_dir
+    ensure
+      ActiveRecordViews.sql_load_path = old_sql_load_path
+    end
+  end
+end
+
+def update_file(file, new_content)
+  time = File.exists?(file) ? File.mtime(file) : Time.parse('2012-01-01')
+  time = time + 1
+  File.write file, new_content
+  File.utime time, time, file
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_views
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jason Weathered
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jason@jasoncodes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- activerecord_views.gemspec
+- lib/active_record_views.rb
+- lib/active_record_views/checksum_cache.rb
+- lib/active_record_views/extension.rb
+- lib/active_record_views/railtie.rb
+- lib/active_record_views/registered_view.rb
+- lib/active_record_views/version.rb
+- lib/activerecord_views.rb
+- spec/active_record_views_extension_spec.rb
+- spec/active_record_views_spec.rb
+- 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/config/database.yml
+- spec/internal/db/schema.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jasoncodes/activerecord_views
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3691843505786316541
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3691843505786316541
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Automatic database view creation for ActiveRecord
+test_files:
+- spec/active_record_views_extension_spec.rb
+- spec/active_record_views_spec.rb
+- 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/config/database.yml
+- spec/internal/db/schema.rb
+- spec/spec_helper.rb