activerecord_views 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc8196b50d197fd74c7c92238a69124295490b6a991f1618fae1daf610ad041d
-  data.tar.gz: 235d0e987824299051a1249e9f955a11ccc8966e77ffb0939485797f5285e559
+  metadata.gz: 483aba6d404f5f766bf6cc234b8c2b8a6675b6a5302f260a362673e95c56d41c
+  data.tar.gz: d95085556edf79f561de0bd9adffdcac7b60ba0e68c8a497140c1584bd0c7e64
 SHA512:
-  metadata.gz: 7f9370196f53175590f98636c67d98885c7a6e0ac29a030baaea0357536e643500eb4f937d06da114a0054b5febd6b91c1c13abcb3f5853118c4e9685ed1ac82
-  data.tar.gz: 3f751a3bbdd5761dff8e3e73d587cdc335a68d9b3d08fbfc3a6b7285f1e5de22236857dfc7f842024a5486db6e6ebb7c41186147d56640c1316f40941e20083a
+  metadata.gz: 260b637a4b39f22777a9151af3fe4f3305a34dfefd3dfd8410952f2a2a6b3c3a5d9252acb95d7a0fda674469eaf8aa8824576beec0f032ece1b8ca8b3f518e6e
+  data.tar.gz: 69ffc4688582c19b51e842afd5969168da26beccafafd0703d660226b4c3cd3faa1bdf6e0d37206e67decb77725a4f6abb11554e315cac5806b7ce12d7a3a7ee

data/lib/active_record_views/database_tasks.rb

@@ -0,0 +1,91 @@
+module ActiveRecordViews::DatabaseTasks
+  def migrate(*)
+    super
+
+    unless ActiveRecordViews::Extension.create_enabled
+      Rails.application.eager_load!
+      ActiveRecordViews::Extension.process_create_queue!
+      ActiveRecordViews.drop_unregistered_views!
+    end
+  end
+
+  def dump_schema(db_config, format = ActiveRecord.respond_to?(:schema_format) ? ActiveRecord.schema_format : ActiveRecord::Base.schema_format, *args)
+    super
+
+    return unless format == :sql
+
+    connection = if respond_to?(:migration_connection)
+      migration_connection
+    else
+      ActiveRecord::Base.connection
+    end
+    return unless connection.data_source_exists?('active_record_views')
+
+    filename = case
+    when respond_to?(:schema_dump_path)
+      schema_dump_path(db_config, format)
+    when respond_to?(:dump_filename)
+      spec_name = args.first
+      dump_filename(spec_name || db_config.name, format)
+    else
+      raise 'unsupported ActiveRecord version'
+    end
+
+    adapter = case
+    when respond_to?(:database_adapter_for)
+      database_adapter_for(db_config)
+    when respond_to?(:class_for_adapter, true)
+      adapter_name = if db_config.respond_to?(:adapter)
+        db_config.adapter
+      else
+        db_config.fetch('adapter')
+      end
+      class_for_adapter(adapter_name).new(db_config)
+    else
+      raise 'unsupported ActiveRecord version'
+    end
+
+    database_name = if db_config.respond_to?(:database)
+      db_config.database
+    else
+      db_config.fetch('database')
+    end
+
+    active_record_views_dump = Tempfile.open(['active_record_views_dump', '.sql'])
+    adapter.send(:run_cmd, 'pg_dump', %W[--data-only --no-owner --table=active_record_views #{database_name} -f #{active_record_views_dump.path}], 'dumping')
+    adapter.send(:remove_sql_header_comments, active_record_views_dump.path)
+
+    active_record_views_dump_content = active_record_views_dump.read
+
+    # Substitute out any timestamps that were dumped from the active_record_views table
+    #
+    # Before:
+    #
+    #     COPY public.active_record_views (name, class_name, checksum, options, refreshed_at) FROM stdin;
+    #     test_view       TestView        42364a017b73ef516a0eca9827e6fa00623257ee        {"dependencies":[]}     2021-10-26 02:49:12.247494
+    #     \.
+    #
+    # After:
+    #
+    #     COPY public.active_record_views (name, class_name, checksum, options, refreshed_at) FROM stdin;
+    #     test_view       TestView        42364a017b73ef516a0eca9827e6fa00623257ee        {"dependencies":[]}     \N
+    #     \.
+    if active_record_views_dump_content !~ /^COPY public.active_record_views \(.+, refreshed_at\) FROM stdin;$/
+      raise 'refreshed_at is not final column'
+    end
+    active_record_views_dump_content.gsub!(/\t\d\d\d\d-\d\d-\d\d.*$/, "\t\\N")
+
+    active_record_views_dump_content = active_record_views_dump_content
+      .lines
+      .chunk { |line| line.include?("\t") }
+      .flat_map { |is_data, lines| is_data ? lines.sort : lines }
+      .join
+
+    File.open filename, 'a' do |io|
+      io.puts active_record_views_dump_content
+    end
+  ensure
+    active_record_views_dump&.close
+    active_record_views_dump&.unlink
+  end
+end

data/lib/active_record_views/railtie.rb

@@ -16,9 +16,5 @@ module ActiveRecordViews
         end
       end
     end
-
-    rake_tasks do
-      load 'tasks/active_record_views.rake'
-    end
   end
 end

data/lib/active_record_views/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordViews
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

data/lib/active_record_views.rb

@@ -15,6 +15,8 @@ module ActiveRecordViews
   def self.init!
     require 'active_record_views/extension'
     ::ActiveRecord::Base.send :include, ActiveRecordViews::Extension
+    require 'active_record_views/database_tasks'
+    ::ActiveRecord::Tasks::DatabaseTasks.singleton_class.prepend ActiveRecordViews::DatabaseTasks
     require 'active_record_views/database_cleaner/truncation_extension' if defined? ::DatabaseCleaner
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_views
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Jason Weathered
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-01 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -107,49 +107,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".tool-versions"
-- Appraisals
-- Gemfile
-- LICENSE.txt
 - README.markdown
-- Rakefile
-- activerecord_views.gemspec
-- gemfiles/rails5_2.gemfile
-- gemfiles/rails6_0.gemfile
-- gemfiles/rails6_1.gemfile
-- gemfiles/rails7_0.gemfile
 - lib/active_record_views.rb
 - lib/active_record_views/checksum_cache.rb
 - lib/active_record_views/database_cleaner/truncation_extension.rb
+- lib/active_record_views/database_tasks.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
-- lib/tasks/active_record_views.rake
-- spec/active_record_views_checksum_cache_spec.rb
-- spec/active_record_views_extension_spec.rb
-- spec/active_record_views_spec.rb
-- spec/internal/Rakefile
-- spec/internal/app/models/dependency_a.rb
-- spec/internal/app/models/dependency_b.rb
-- spec/internal/app/models/dependency_c.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/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
-- spec/internal/config/routes.rb
-- spec/spec_helper.rb
-- spec/support/silence_warnings.rb
-- spec/tasks_spec.rb
 homepage: http://github.com/jasoncodes/activerecord_views
 licenses:
 - MIT
@@ -173,25 +140,4 @@ rubygems_version: 3.1.6
 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/Rakefile
-- spec/internal/app/models/dependency_a.rb
-- spec/internal/app/models/dependency_b.rb
-- spec/internal/app/models/dependency_c.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/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
-- spec/internal/config/routes.rb
-- spec/spec_helper.rb
-- spec/support/silence_warnings.rb
-- spec/tasks_spec.rb
+test_files: []

data/.gitignore

@@ -1,8 +0,0 @@
-.bundle
-tmp/**
-Gemfile.lock
-gemfiles/*.gemfile.lock
-pkg
-spec/internal/db/schema.rb
-spec/internal/app/models_temp/**
-spec/internal/log/*.log

data/.rspec

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

data/.tool-versions

@@ -1 +0,0 @@
-ruby 2.7.7

data/Appraisals

@@ -1,15 +0,0 @@
-appraise 'rails5_2' do
-  gem 'rails', '~> 5.2.0'
-end
-
-appraise 'rails6_0' do
-  gem 'rails', '~> 6.0.0'
-end
-
-appraise 'rails6_1' do
-  gem 'rails', '~> 6.1.0'
-end
-
-appraise 'rails7_0' do
-  gem 'rails', '~> 7.0.0'
-end

data/Gemfile

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

data/LICENSE.txt

@@ -1,22 +0,0 @@
-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/Rakefile

@@ -1,14 +0,0 @@
-require 'appraisal'
-require 'bundler/setup'
-require 'bundler/gem_tasks'
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-task :default do
-  if ENV['BUNDLE_GEMFILE'] == File.expand_path('Gemfile')
-    exec 'rake appraisal:all'
-  else
-    Rake::Task['spec'].invoke
-  end
-end

data/activerecord_views.gemspec

@@ -1,27 +0,0 @@
-# -*- 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', ['>= 5.2', '< 7.1']
-
-  gem.add_development_dependency 'appraisal'
-  gem.add_development_dependency 'rspec-rails', '>= 2.14'
-  gem.add_development_dependency 'combustion', '>= 0.5.1'
-  gem.add_development_dependency 'pg'
-  gem.add_development_dependency 'warning'
-end

data/gemfiles/rails5_2.gemfile

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

data/gemfiles/rails6_0.gemfile

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

data/gemfiles/rails6_1.gemfile

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

data/gemfiles/rails7_0.gemfile

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

data/lib/tasks/active_record_views.rake

@@ -1,106 +0,0 @@
-Rake::Task['db:migrate'].enhance do
-  unless ActiveRecordViews::Extension.create_enabled
-    Rails.application.eager_load!
-    ActiveRecordViews::Extension.process_create_queue!
-    ActiveRecordViews.drop_unregistered_views!
-  end
-end
-
-schema_rake_task = Gem::Version.new(Rails.version) >= Gem::Version.new("6.1") ? 'db:schema:dump' : 'db:structure:dump'
-
-Rake::Task[schema_rake_task].enhance do
-  table_exists = ActiveRecord::Base.connection.data_source_exists?('active_record_views')
-
-  if schema_rake_task == 'db:structure:dump'
-    ActiveRecord::Base.schema_format = :sql
-  end
-
-  schema_format = if ActiveRecord.respond_to?(:schema_format)
-    ActiveRecord.schema_format
-  else
-    ActiveRecord::Base.schema_format
-  end
-
-  if table_exists && schema_format == :sql
-    tasks = ActiveRecord::Tasks::DatabaseTasks
-
-    config = if ActiveRecord::Base.configurations.respond_to?(:configs_for)
-      if Rails.version.start_with?('6.0.')
-        ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, spec_name: 'primary').config
-      else
-        ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: 'primary')
-      end
-    else
-      tasks.current_config
-    end
-    adapter = if config.respond_to?(:adapter)
-      config.adapter
-    else
-      config.fetch('adapter')
-    end
-    database = if config.respond_to?(:database)
-      config.database
-    else
-      config.fetch('database')
-    end
-
-    filename = case
-    when tasks.respond_to?(:schema_dump_path)
-      tasks.schema_dump_path(config)
-    when tasks.respond_to?(:dump_filename)
-      tasks.dump_filename('primary')
-    else
-      tasks.schema_file
-    end
-
-    pg_tasks = tasks.send(:class_for_adapter, adapter).new(config)
-    psql_env = if pg_tasks.respond_to?(:psql_env, true)
-      pg_tasks.send(:psql_env)
-    else
-      pg_tasks.send(:set_psql_env)
-      {}
-    end
-
-    begin
-      active_record_views_dump = Tempfile.open("active_record_views_dump.sql")
-      require 'shellwords'
-      system(psql_env, "pg_dump --data-only --no-owner --table=active_record_views #{Shellwords.escape database} >> #{Shellwords.escape active_record_views_dump.path}")
-      raise 'active_record_views metadata dump failed' unless $?.success?
-
-      pg_tasks.send(:remove_sql_header_comments, active_record_views_dump.path)
-
-      active_record_views_dump_content = active_record_views_dump.read
-
-      # Substitute out any timestamps that were dumped from the active_record_views table
-      #
-      # Before:
-      #
-      #     COPY public.active_record_views (name, class_name, checksum, options, refreshed_at) FROM stdin;
-      #     test_view       TestView        42364a017b73ef516a0eca9827e6fa00623257ee        {"dependencies":[]}     2021-10-26 02:49:12.247494
-      #     \.
-      #
-      # After:
-      #
-      #     COPY public.active_record_views (name, class_name, checksum, options, refreshed_at) FROM stdin;
-      #     test_view       TestView        42364a017b73ef516a0eca9827e6fa00623257ee        {"dependencies":[]}     \N
-      #     \.
-      if active_record_views_dump_content !~ /^COPY public.active_record_views \(.+, refreshed_at\) FROM stdin;$/
-        raise 'refreshed_at is not final column'
-      end
-      active_record_views_dump_content.gsub!(/\t\d\d\d\d-\d\d-\d\d.*$/, "\t\\N")
-
-      active_record_views_dump_content = active_record_views_dump_content
-        .lines
-        .chunk { |line| line.include?("\t") }
-        .flat_map { |is_data, lines| is_data ? lines.sort : lines }
-        .join
-
-      File.open filename, 'a' do |io|
-        io.puts active_record_views_dump_content
-      end
-    ensure
-      active_record_views_dump.close
-      active_record_views_dump.unlink
-    end
-  end
-end

data/spec/active_record_views_checksum_cache_spec.rb

@@ -1,112 +0,0 @@
-require 'spec_helper'
-
-describe ActiveRecordViews::ChecksumCache do
-  let(:connection) { ActiveRecord::Base.connection }
-
-  describe 'initialisation' do
-    def metadata_table_exists?
-      connection.data_source_exists?('active_record_views')
-    end
-
-    context '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(metadata_table_exists?).to eq false
-        ActiveRecordViews::ChecksumCache.new(connection)
-        expect(metadata_table_exists?).to eq true
-
-        expect(connection.column_exists?('active_record_views', 'class_name')).to eq true
-        expect(connection.column_exists?('active_record_views', 'options')).to eq true
-      end
-    end
-
-    context 'existing table with current structure' do
-      before do
-        ActiveRecordViews::ChecksumCache.new(connection)
-        expect(metadata_table_exists?).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 'existing table without class name' do
-      before do
-        connection.execute 'CREATE TABLE active_record_views(name text PRIMARY KEY, checksum text NOT NULL);'
-
-        connection.execute 'CREATE VIEW test_view AS SELECT 42 AS id;'
-        connection.execute "INSERT INTO active_record_views VALUES ('test_view', 'dummy');"
-
-        connection.execute 'CREATE VIEW other_view AS SELECT 123 AS id;'
-      end
-
-      it 'drops existing managed views recreates the table' do
-        expect(connection.column_exists?('active_record_views', 'class_name')).to eq false
-        expect(ActiveRecordViews.view_exists?(connection, 'test_view')).to eq true
-        expect(ActiveRecordViews.view_exists?(connection, 'other_view')).to eq true
-
-        sql_statements.clear
-
-        ActiveRecordViews::ChecksumCache.new(connection)
-
-        expect(sql_statements.grep_v(/^\s*SELECT/)).to match [
-          'BEGIN',
-          'DROP VIEW IF EXISTS test_view CASCADE;',
-          'DROP TABLE active_record_views;',
-          /^CREATE TABLE active_record_views/,
-          'COMMIT',
-        ]
-
-        expect(connection.column_exists?('active_record_views', 'class_name')).to eq true
-        expect(ActiveRecordViews.view_exists?(connection, 'test_view')).to eq false
-        expect(ActiveRecordViews.view_exists?(connection, 'other_view')).to eq true
-      end
-    end
-
-    context 'existing table without options or refreshed at timestamp' do
-      before do
-        connection.execute 'CREATE TABLE active_record_views(name text PRIMARY KEY, class_name text NOT NULL UNIQUE, checksum text NOT NULL);'
-
-        connection.execute 'CREATE VIEW test_view AS SELECT 42 AS id;'
-        connection.execute "INSERT INTO active_record_views VALUES ('test_view', 'dummy', 'Dummy');"
-      end
-
-      it 'upgrades the table without losing data' do
-        expect(connection.column_exists?('active_record_views', 'options')).to eq false
-        expect(connection.column_exists?('active_record_views', 'refreshed_at')).to eq false
-        expect(ActiveRecordViews.view_exists?(connection, 'test_view')).to eq true
-
-        expect(ActiveRecord::Base.connection).to receive(:execute).with("ALTER TABLE active_record_views ADD COLUMN options json NOT NULL DEFAULT '{}';").once.and_call_original
-        expect(ActiveRecord::Base.connection).to receive(:execute).with("ALTER TABLE active_record_views ADD COLUMN refreshed_at timestamp;").once.and_call_original
-
-        ActiveRecordViews::ChecksumCache.new(connection)
-
-        expect(connection.column_exists?('active_record_views', 'options')).to eq true
-        expect(connection.column_exists?('active_record_views', 'refreshed_at')).to eq true
-        expect(ActiveRecordViews.view_exists?(connection, 'test_view')).to eq true
-      end
-    end
-  end
-
-  describe 'options serialization' do
-    let(:dummy_data) { {class_name: 'Test', checksum: '12345'} }
-    it 'errors if setting with non-symbol keys' do
-      cache = ActiveRecordViews::ChecksumCache.new(connection)
-      expect {
-        cache.set 'test', dummy_data.merge(options: {'blah' => 123})
-      }.to raise_error ArgumentError, 'option keys must be symbols'
-    end
-
-    it 'retrieves hash with symbolized keys and preserves value types' do
-      options = {foo: 'hi', bar: 123, baz: true}
-
-      cache = ActiveRecordViews::ChecksumCache.new(connection)
-      cache.set 'test', dummy_data.merge(options: options)
-      expect(cache.get('test')[:options]).to eq options
-    end
-  end
-end