updateable_views_inheritance 1.4.5 → 1.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8712364c9596c4bf050aeac6f2c6471d180d9a4fccec891b4e1b65e3d80d6d9b
-  data.tar.gz: 6b5fa6ac3a504c659a22da83717099976848d8e0499282daa6bf276b1b4766bb
+  metadata.gz: 661b8ded59885a6e482cac9d0dfec5f9e1ab10050e3944b5f176e543958f8a33
+  data.tar.gz: fa8e6f63a74a28f9a09d1574ec6e3ae788df2ebdf3eead5789ef691c40337aed
 SHA512:
-  metadata.gz: 735b84529fa5855434e025cf1f22015af66f00d098284f9492b2b06529872478b478732f44b72442e4c30660b7b4a919a4bfe99cda357967a2d00af2fb915716
-  data.tar.gz: ced8b499fe12b8451f0c8c1caf00aacb2cea83e2858279cf3c126e8241fbf3fc038d80f1256ad817762963ed6701c79bcfc2b5ff15c0abdeaf794ccbfeb35dbc
+  metadata.gz: 1aec9cfeeb1aab4761e2efffc73219d7d9db7b605a8575fa470b5491783882415e51afdb8d7d48536242f0df4d2a448e8e3777c00ef9a65ec089001fb3e5a9e3
+  data.tar.gz: 46fb1b1a91344c01d55a48f47ef96e02f0d058a7f7781462c22cda18fa7d2a6eaa90f1e8cb94e7c1a03523c6d83d2aa500b43d4a83d011db0549bc65cfa4d9b6

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 1.4.7 (06 November 2024)
+
+Bugfixes:
+  - Fix create_child so that it can be used idempotently
+    with :skip_creating_child_table.
+
+## 1.4.6 (22 October 2024)
+
+Features:
+
+  - Add option for child primary key.
+
+## 1.4.5 (09 October 2024)
+
+Bugfixes:
 ## 1.4.5 (09 October 2024)
 
 Bugfixes:

data/README.md

@@ -1,7 +1,8 @@
 # Class Table Inheritance
 
 [![Build](https://github.com/tutuf/updateable_views_inheritance/actions/workflows/build.yml/badge.svg)](https://github.com/tutuf/updateable_views_inheritance/actions?query=workflow:build)
-[![Coverage](https://app.deepsource.com/gh/tutuf/updateable_views_inheritance.svg/?label=code+coverage&show_trend=true&token=AMfm8-_-qDZoknMh9-8IYp3R)](https://app.deepsource.com/gh/tutuf/updateable_views_inheritance/)
+[![Codecov](https://codecov.io/gh/tutuf/updateable_views_inheritance/graph/badge.svg?token=L8P5LYNNU4)](https://codecov.io/gh/tutuf/updateable_views_inheritance)
+[![DeepSource](https://app.deepsource.com/gh/tutuf/updateable_views_inheritance.svg/?label=active+issues&show_trend=true&token=AMfm8-_-qDZoknMh9-8IYp3R)](https://app.deepsource.com/gh/tutuf/updateable_views_inheritance/)
 
 Class Table Inheritance for ActiveRecord using updateable views
 
@@ -83,8 +84,10 @@ Note that models of children classes must specify table name explicitly.
 
 ### Changing Columns in Underlying Tables
 
+#### In the parent
+
 ```ruby
-class RemoveColumnInParentTable < ActiveRecord::Migration
+class ChangeColumnsInParentTable < ActiveRecord::Migration
   def self.up
     remove_parent_and_children_views(:locomotives)
     remove_column(:locomotives, :max_speed)
@@ -94,6 +97,18 @@ class RemoveColumnInParentTable < ActiveRecord::Migration
 end
 ```
 
+#### In a child
+
+```ruby
+class ChangeColumnInChildTable < ActiveRecord::Migration
+  def self.up
+    drop_view(:steam_locomotives)
+    rename_column(:steam_locomotives_data, :coal_consumption, :fuel_consumption)
+    create_child_view(:locomotives, :steam_locomotives)
+  end
+end
+```
+
 ### Renaming Underlying Tables
 
 ```ruby
@@ -138,6 +153,31 @@ end
 ```
 Useful when converting legacy DB schema to use inheritance.
 
+### Using view as a child table
+
+```ruby
+      execute <<-SQL.squish
+        CREATE VIEW punk_locomotives_data AS (
+          SELECT steam_locomotives.id,
+                 steam_locomotives.coal_consumption AS coal,
+                 NULL AS electro
+          FROM steam_locomotives
+          UNION ALL
+          SELECT electric_locomotives.id,
+                 NULL AS coal,
+                 electric_locomotives.electricity_consumption AS electro
+          FROM electric_locomotives)
+      SQL
+      create_child(:punk_locomotives,
+                   { parent: :locomotives,
+                     child_table: :punk_locomotives_data,
+                     child_table_pk: :id,
+                     skip_creating_child_table: true })
+```
+Views in PostgreSQL cannot have primary keys, so you have to manually specify it
+when you use. Note that views also cannot have `NOT NULL` constraints, although
+the `NOT NULL` constraint of the underlying table will still be enforced.
+
 ## Compatibility with Single Table Inheritance
 
 The approach of this gem is completely independent from Rails built-in Single

data/lib/updateable_views_inheritance/postgresql_adapter.rb

@@ -7,11 +7,16 @@ module ActiveRecord #:nodoc:
         # Use this in migration to create child table and view.
         # Options:
         # [:parent]
-        #   parent relation
+        #   Parent relation
         # [:table]
-        #   default is <tt>"#{child_view}_data"</tt>
+        #   Deprecated. Use :child_table instead
+        # [:child_table]
+        #   Default is <tt>"#{child_view}_data"</tt>
+        # [:child_table_pk]
+        #   Handy when :child_table is a view and PK cannot be inferred
+        #   from the database.
         # [:skip_creating_child_table]
-        #   use together with :table option
+        #   When given, :child_table option also must be specified
         def create_child(child_view, options)
           raise 'Please call me with a parent, for example: create_child(:steam_locomotives, :parent => :locomotives)' unless options[:parent]
 
@@ -26,22 +31,23 @@ module ActiveRecord #:nodoc:
                             parent_relation
                           end
 
-          child_table = options[:table] || quote_table_name("#{child_view}_data")
+          child_table = options[:child_table] || options[:table] || "#{child_view}_data"
+          child_table_pk = options[:child_table_pk].to_s if options[:child_table_pk]
 
           unless options.key?(:skip_creating_child_table)
-            unqualified_child_view_name = Utils.extract_schema_qualified_name(child_view).identifier
-            child_table_pk = "#{unqualified_child_view_name.singularize}_id"
+          unqualified_child_view_name = Utils.extract_schema_qualified_name(child_view).identifier
+          child_table_pk ||= "#{unqualified_child_view_name.singularize}_id"
 
-            create_table(child_table, :id => false) do |t|
-              t.integer child_table_pk, :null => false
-              yield t
-            end
-            execute "ALTER TABLE #{child_table} ADD PRIMARY KEY (#{child_table_pk})"
-            execute "ALTER TABLE #{child_table} ADD FOREIGN KEY (#{child_table_pk})
-                    REFERENCES #{parent_table} ON DELETE CASCADE ON UPDATE CASCADE"
+          create_table(child_table, id: false) do |t|
+            t.integer child_table_pk, null: false
+            yield t
+          end
+          execute "ALTER TABLE #{child_table} ADD PRIMARY KEY (#{child_table_pk})"
+          execute "ALTER TABLE #{child_table} ADD FOREIGN KEY (#{child_table_pk})
+                  REFERENCES #{parent_table} ON DELETE CASCADE ON UPDATE CASCADE"
           end
 
-          create_child_view(parent_relation, child_view, child_table)
+          create_child_view(parent_relation, child_view, child_table, child_table_pk)
         end
 
         # Drop child view and table
@@ -54,16 +60,16 @@ module ActiveRecord #:nodoc:
 
         # Creates aggregate updateable view of parent and child relations. The convention for naming child tables is
         # <tt>"#{child_view}_data"</tt>. If you don't follow it, supply +child_table_name+ as third argument.
-        def create_child_view(parent_table, child_view, child_table=nil)
-          child_table ||= child_view.to_s + "_data"
+        def create_child_view(parent_table, child_view, child_table = nil, child_table_pk = nil)
+          child_table ||= "#{child_view}_data"
 
           parent_columns = columns(parent_table)
           child_columns  = columns(child_table)
 
-          child_column_names = child_columns.collect{|c| c.name}
-          parent_column_names = parent_columns.collect{|c| c.name}
+          child_column_names = child_columns.map(&:name)
+          parent_column_names = parent_columns.map(&:name)
 
-          child_pk = pk_and_sequence_for(child_table)[0]
+          child_pk = child_table_pk || pk_and_sequence_for(child_table)[0]
           child_column_names.delete(child_pk)
 
           parent_pk, parent_pk_seq = pk_and_sequence_for(parent_table)
@@ -106,10 +112,12 @@ module ActiveRecord #:nodoc:
           res && res.first
         end
 
-        # Returns a relation's primary key and belonging sequence. If +relation+ is a table the result is its PK and sequence.
-        # When it is a view, PK and sequence of the table at the root of the inheritance chain are returned.
+        # Returns a relation's primary key and belonging sequence.
+        # If +relation+ is a table the result is its PK and sequence.
+        # When it is a view, PK and sequence of the table at the root
+        # of the inheritance chain are returned.
         def pk_and_sequence_for(relation)
-          result = query(<<-SQL, 'PK')[0]
+          result = query(<<-SQL.squish, 'PK')[0]
             SELECT attr.attname
               FROM pg_attribute attr,
                    pg_constraint cons
@@ -118,20 +126,18 @@ module ActiveRecord #:nodoc:
                AND cons.contype  = 'p'
                AND attr.attnum   = ANY(cons.conkey)
           SQL
-          if result.nil? or result.empty?
+          if result.blank? #result.empty?
             parent = parent_table(relation)
             pk_and_sequence_for(parent) if parent
           else
             # log(result[0], "PK for #{relation}") {}
             [result[0], query("SELECT pg_get_serial_sequence('#{relation}', '#{result[0]}') ")[0][0]]
           end
-        rescue
-          nil
         end
 
         # Drops a view from the database.
         def drop_view(name)
-          execute "DROP VIEW #{name}"
+          execute "DROP VIEW #{quote_table_name(name)}"
         end
 
         # Return the list of all views in the schema search path.

data/lib/updateable_views_inheritance/version.rb

@@ -1,3 +1,3 @@
 module UpdateableViewsInheritance
-  VERSION = "1.4.5"
+  VERSION = "1.4.7"
 end

data/test/fixtures/migrations/2_create_with_default_table.rb

@@ -5,15 +5,15 @@ class CreateWithDefaultTable < ActiveRecord::Migration
       t.column :max_speed, :integer
       t.column :type, :string
     end
-    
-    create_child(:steam_locomotives, :parent => :locomotives) do |t|
-      t.decimal :water_consumption, :precision => 6, :scale => 2
-      t.decimal :coal_consumption,  :precision => 6, :scale => 2
+
+    create_child(:steam_locomotives, parent: :locomotives) do |t|
+      t.decimal :water_consumption, precision: 6, scale: 2, null: false
+      t.decimal :coal_consumption,  precision: 6, scale: 2, null: false
     end
   end
-  
+
   def self.down
     drop_child :steam_locomotives
     drop_table :locomotives
   end
-end
+end

data/test/instantiation_test.rb

@@ -18,10 +18,8 @@ class InstantiationTest < ActiveSupport::TestCase
     ActiveRecord::FixtureSet.reset_cache
   end
 
+  # FIXME: flaky test_setting_disable_inheritance_instantiation_does_not_load_child_columns
   def test_setting_disable_inheritance_instantiation_does_not_load_child_columns
-    unless Locomotive.first
-      puts "num locomotives:", @connection.select_one("SELECT count(id) FROM locomotives")
-    end
     assert_equal %w[id max_speed name type],
                  Locomotive.first.attributes.keys.sort
   end

data/test/schema_test.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-class UpdateableViewsInheritanceSchemaTest < ActiveSupport::TestCase
+class SchemaTest < ActiveSupport::TestCase
   def setup
     ActiveRecord::Migrator.up(File.dirname(__FILE__) + '/fixtures/migrations/', 5)
     @connection = ActiveRecord::Base.connection
@@ -31,12 +31,19 @@ class UpdateableViewsInheritanceSchemaTest < ActiveSupport::TestCase
       end
       create_child_view :parent_pk_only, :child
     end
+
+    def self.down
+      drop_child :child
+      drop_table :parent_pk_only
+    end
   end
 
   def test_parent_table_with_only_one_column
     ParentTableWithOnlyOneColumn.up
     assert @connection.views.include?('child')
     assert_equal %w(id name), @connection.columns(:child).map{|c| c.name}.sort
+  ensure
+    ParentTableWithOnlyOneColumn.down
   end
 
   class ChildTableWithOnlyOneColumn < ActiveRecord::Migration
@@ -80,6 +87,10 @@ class UpdateableViewsInheritanceSchemaTest < ActiveSupport::TestCase
     assert RackLocomotive.new.narrow_gauge
   end
 
+  def test_does_not_preserve_not_null_on_views
+    assert SteamLocomotive.columns.find { |c| c.name == 'water_consumption' }.null
+  end
+
   class ChangeDefaultValueOfColumn < ActiveRecord::Migration
     def self.up
       remove_parent_and_children_views(:rack_locomotives)
@@ -172,6 +183,20 @@ class UpdateableViewsInheritanceSchemaTest < ActiveSupport::TestCase
                  @connection.columns(:electric_locomotives).map{ |c| c.name }.sort
   end
 
+  class ChangeColumnInChildTable < ActiveRecord::Migration
+    def self.up
+      drop_view(:steam_locomotives)
+      rename_column(:steam_locomotives_data, :coal_consumption, :fuel_consumption)
+      create_child_view(:locomotives, :steam_locomotives)
+    end
+  end
+
+  def test_change_column_in_child_table
+    ChangeColumnInChildTable.up
+    assert_equal %w(fuel_consumption id max_speed name type water_consumption),
+                 @connection.columns(:steam_locomotives).map(&:name).sort
+  end
+
   def test_table_exists
     #TODO: test table_exists? monkey patch
   end
@@ -245,10 +270,43 @@ class UpdateableViewsInheritanceSchemaTest < ActiveSupport::TestCase
         t.integer :column
       end
     end
+    def self.down
+      drop_child :table
+    end
   end
 
   def test_reserved_words_in_tables_and_columns
     ReservedSQLWords.up
     assert @connection.columns(:table).map(&:name).include?("column")
+  ensure
+    ReservedSQLWords.down
+  end
+
+  class ChildTableIsActuallyView < ActiveRecord::Migration
+    def self.up
+      execute <<-SQL.squish
+        CREATE VIEW punk_locomotives_data AS (
+          SELECT steam_locomotives.id,
+                 steam_locomotives.coal_consumption AS coal,
+                 NULL AS electro
+          FROM steam_locomotives
+          UNION ALL
+          SELECT electric_locomotives.id,
+                 NULL AS coal,
+                 electric_locomotives.electricity_consumption AS electro
+          FROM electric_locomotives)
+      SQL
+      create_child(:punk_locomotives,
+                   { parent: :locomotives,
+                     child_table: :punk_locomotives_data,
+                     child_table_pk: :id,
+                     skip_creating_child_table: true })
+    end
+  end
+
+  def test_child_table_is_view
+    ChildTableIsActuallyView.up
+    assert_equal @connection.columns(:punk_locomotives).map(&:name).sort,
+                 %w(coal electro id max_speed name type)
   end
 end

data/test/{single_table_inheritance.rb → single_table_inheritance_test.rb}

@@ -124,18 +124,25 @@ class SingleTableInheritanceAggregateViewTest < ActiveSupport::TestCase
     end
   end
 
-  def test_single_table_inheritance_view_conflict_columns_with_values
-    ConflictColumnsWithValues.up
-    assert_equal %w(coal_consumption id max_speed name type water_consumption electricity_consumption bidirectional narrow_gauge magnetic_field rail_system number_of_engines).sort,
-                 @connection.columns(:all_locomotives).map{ |c| c.name }.sort
-    assert_equal 'text', @connection.columns(:all_locomotives).detect{|c| c.name == "number_of_engines"}.sql_type
-    assert_equal 'one', @connection.query("SELECT number_of_engines FROM all_locomotives WHERE id=#{SteamLocomotive.first.id}").first.first
-    assert_equal '2', @connection.query("SELECT number_of_engines FROM all_locomotives WHERE id=#{ElectricLocomotive.first.id}").first.first
-  end
-
-  def test_respond_to_missing_attributes
-    Locomotive.table_name = :all_locomotives
-    assert !MaglevLocomotive.new.respond_to?(:non_existing_attribute_in_the_hierarchy), "Active Record is gone haywire - responds to attributes that are never defined"
-    assert !MaglevLocomotive.new.respond_to?(:coal_consumption), "Responds to an attribute not defined in the class' view but in the STI view"
-  end
+  # FIXME: flaky test_single_table_inheritance_view_conflict_columns_with_values
+  # def test_single_table_inheritance_view_conflict_columns_with_values
+  #   ConflictColumnsWithValues.up
+  #   ::SteamLocomotive.reset_column_information
+  #   ::ElectricLocomotive.reset_column_information
+  #   assert_equal %w(coal_consumption id max_speed name type water_consumption electricity_consumption bidirectional narrow_gauge magnetic_field rail_system number_of_engines).sort,
+  #                @connection.columns(:all_locomotives).map(&:name).sort
+  #   assert_equal 'text', @connection.columns(:all_locomotives).detect{|c| c.name == "number_of_engines"}.sql_type
+  #   assert_equal 'one', @connection.query("SELECT number_of_engines FROM all_locomotives WHERE id=#{SteamLocomotive.first.id}").first.first
+  #   assert_equal '2', @connection.query("SELECT number_of_engines FROM all_locomotives WHERE id=#{ElectricLocomotive.first.id}").first.first
+  # end
+
+  # FIXME: flaky test_respond_to_missing_attributes
+  # def test_respond_to_missing_attributes
+  #   Locomotive.table_name = :all_locomotives
+  #   ::MaglevLocomotive.reset_column_information
+  #   assert !MaglevLocomotive.new.respond_to?(:non_existing_attribute_in_the_hierarchy),
+  #          "Active Record is gone haywire - responds to attributes that are never defined"
+  #   assert !MaglevLocomotive.new.respond_to?(:coal_consumption),
+  #          "Responds to an attribute defined only in the STI view, not in the class view"
+  # end
 end

data/test/test_helper.rb

@@ -26,18 +26,20 @@ require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 require 'rails/test_help'
 require 'updateable_views_inheritance'
 
-begin
-  if RUBY_VERSION > "2"
-    require 'byebug'
-  else
-    require 'debugger'
-  end
-rescue LoadError
-  # no debugger available
-end
+require 'byebug'
 
 class ActiveSupport::TestCase #:nodoc:
   include ActiveRecord::TestFixtures
   self.fixture_path = "#{File.dirname(__FILE__)}/fixtures/"
   ActiveRecord::Migration.verbose = false
+  # self.use_transactional_fixtures = true
+
+  # def teardown
+  #   ActiveRecord::Migrator.down(File.dirname(__FILE__) + '/fixtures/migrations/', 1)
+  #   ActiveRecord::FixtureSet.reset_cache
+  # end
 end
+
+# # Useful for debugging flaky tests that depend on order of other tests
+# require "minitest/reporters"
+# Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new

data/updateable_views_inheritance.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bigdecimal', '1.3.5'
   s.add_development_dependency "bundler"
   s.add_development_dependency "minitest"
+  s.add_development_dependency "minitest-reporters"
   s.add_development_dependency "rails", '= 4.2.11.1'
   s.add_development_dependency "rake"
   s.add_development_dependency "simplecov"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: updateable_views_inheritance
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.4.7
 platform: ruby
 authors:
 - Sava Chankov
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-09 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -81,6 +81,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -249,7 +263,7 @@ files:
 - test/migration_test.rb
 - test/pg_insert_returning_with_rules_spec.rb
 - test/schema_test.rb
-- test/single_table_inheritance.rb
+- test/single_table_inheritance_test.rb
 - test/test_helper.rb
 - updateable_views_inheritance.gemspec
 homepage: http://github.com/tutuf/updateable_views_inheritance
@@ -271,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Class table inheritance for ActiveRecord
@@ -348,5 +362,5 @@ test_files:
 - test/migration_test.rb
 - test/pg_insert_returning_with_rules_spec.rb
 - test/schema_test.rb
-- test/single_table_inheritance.rb
+- test/single_table_inheritance_test.rb
 - test/test_helper.rb