updateable_views_inheritance 1.4.4 → 1.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a592cb214e5825bb4af87c5412ae3f91730d0e3882931f71bd16378ace7640a
-  data.tar.gz: 2fbf14052dde92e69724d574c0b5fb7b4d79297928220bc8bee5851cc8ee60ad
+  metadata.gz: 1c36199deb17d6a32a617a2193c52ef0cb5e6b955464fb31b8509eb4aef0212d
+  data.tar.gz: 62286805f012a6db4bbc44de4a3ac9848f735d7d0e90d674f7605cbd48c590da
 SHA512:
-  metadata.gz: b4da55b7632575a0fba84248130308890f56dd726e6aaec835d3423b874a959d88ecf51dbf482795ba97869e5255411b9599b0117df61c6e70b3f095322c23fe
-  data.tar.gz: edd29da257c91e7d8a53df032bc70dd2317c78433637649e23285118b058109116259ed22efc86b8495f44301c5c6831c125e26565c1aa203ad00663205c8f6c
+  metadata.gz: a533be494b122a7b0e9bf2fcebd0083b314892cfe6da865faed721bd7cd5859820bc1eb969f098cfbb43ef4ec6d762521dbd9b911e57444fd286bdfa85540911
+  data.tar.gz: 45cd523f6e1430c3638ce7df73aabc87e09246a51d6b22591eea762c4d191fc7114c3f9a3f7d358dadf808c09844b8d5fa6a5f7480b45e61158f91796d1b8bf0

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## 1.4.4 (09 October 2024)
+## 1.4.6 (22 October 2024)
+
+Features:
+
+  - Add option for child primary key.
+
+## 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
 
@@ -138,6 +139,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,7 +31,7 @@ module ActiveRecord #:nodoc:
                             parent_relation
                           end
 
-          child_table = options[:table] || quote_table_name("#{child_view}_data")
+          child_table = options[:child_table] || options[:table] || quote_table_name("#{child_view}_data")
 
           unless options.key?(:skip_creating_child_table)
             unqualified_child_view_name = Utils.extract_schema_qualified_name(child_view).identifier
@@ -41,7 +46,9 @@ module ActiveRecord #:nodoc:
                     REFERENCES #{parent_table} ON DELETE CASCADE ON UPDATE CASCADE"
           end
 
-          create_child_view(parent_relation, child_view, child_table)
+          child_table_pk ||= options[:child_table_pk].to_s if options[:child_table_pk]
+
+          create_child_view(parent_relation, child_view, child_table, child_table_pk)
         end
 
         # Drop child view and table
@@ -54,7 +61,7 @@ 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)
+        def create_child_view(parent_table, child_view, child_table=nil, child_table_pk=nil)
           child_table ||= child_view.to_s + "_data"
 
           parent_columns = columns(parent_table)
@@ -63,7 +70,7 @@ module ActiveRecord #:nodoc:
           child_column_names = child_columns.collect{|c| c.name}
           parent_column_names = parent_columns.collect{|c| c.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 +113,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,15 +127,13 @@ 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.
@@ -305,7 +312,7 @@ module ActiveRecord #:nodoc:
         def do_create_child_view(parent_table, parent_columns, parent_pk, child_view, child_columns, child_pk, child_table)
           view_columns = parent_columns + child_columns
           execute(<<~SQL)
-            CREATE OR REPLACE VIEW #{quote_column_name(child_view)} AS (
+            CREATE OR REPLACE VIEW #{quote_table_name(child_view)} AS (
               SELECT parent.#{parent_pk},
                      #{ view_columns.map { |col| quote_column_name(col) }.join(",") }
                 FROM #{parent_table} parent
@@ -322,7 +329,7 @@ module ActiveRecord #:nodoc:
           # Setting the sequence to its value (explicitly supplied or the default) covers both cases.
           execute(<<~SQL)
             CREATE OR REPLACE RULE #{quote_column_name("#{child_view}_insert")} AS
-            ON INSERT TO #{quote_column_name(child_view)} DO INSTEAD (
+            ON INSERT TO #{quote_table_name(child_view)} DO INSTEAD (
               INSERT INTO #{parent_table}
                      ( #{ [parent_pk, parent_columns].flatten.map { |col| quote_column_name(col) }.join(", ") } )
                      VALUES( DEFAULT #{ parent_columns.empty? ? '' : ' ,' + parent_columns.collect{ |col| "NEW.#{quote_column_name(col)}" }.join(", ") } ) ;
@@ -336,14 +343,14 @@ module ActiveRecord #:nodoc:
           # delete
           execute(<<~SQL)
             CREATE OR REPLACE RULE #{quote_column_name("#{child_view}_delete")} AS
-            ON DELETE TO #{quote_column_name(child_view)} DO INSTEAD
+            ON DELETE TO #{quote_table_name(child_view)} DO INSTEAD
             DELETE FROM #{parent_table} WHERE #{parent_pk} = OLD.#{parent_pk}
           SQL
 
           # update
           execute(<<~SQL)
             CREATE OR REPLACE RULE #{quote_column_name("#{child_view}_update")} AS
-            ON UPDATE TO #{quote_column_name(child_view)} DO INSTEAD (
+            ON UPDATE TO #{quote_table_name(child_view)} DO INSTEAD (
               #{ if parent_columns.empty?
                    ''
                  else
@@ -364,9 +371,9 @@ module ActiveRecord #:nodoc:
 
         def insert_returning_clause(parent_pk, child_pk, child_view)
           columns_cast_to_null = columns(child_view)
-                                  .reject { |c| c.name == parent_pk}
-                                  .map { |c| "CAST (NULL AS #{c.sql_type})" }
-                                  .join(", ")
+                                 .reject { |c| c.name == parent_pk }
+                                 .map { |c| "CAST (NULL AS #{c.sql_type})" }
+                                 .join(", ")
           "RETURNING #{child_pk}, #{columns_cast_to_null}"
         end
 

data/lib/updateable_views_inheritance/version.rb

@@ -1,3 +1,3 @@
 module UpdateableViewsInheritance
-  VERSION = "1.4.4"
+  VERSION = "1.4.6"
 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/schema_test.rb

@@ -80,6 +80,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)
@@ -184,22 +188,22 @@ class UpdateableViewsInheritanceSchemaTest < ActiveSupport::TestCase
         t.column :interrail_max_speed, :integer
         t.column :type, :string
       end
-      create_child('interrail.steam_locomotives', :parent => 'interrail.locomotives') do |t|
-        t.decimal :interrail_water_consumption, :precision => 6, :scale => 2
-        t.decimal :interrail_coal_consumption,  :precision => 6, :scale => 2
+      create_child('interrail.steam_locomotives', parent: 'interrail.locomotives') do |t|
+        t.decimal :interrail_water_consumption, precision: 6, scale: 2
+        t.decimal :interrail_coal_consumption,  precision: 6, scale: 2
       end
     end
   end
 
   def test_create_child_in_schema
     CreateChildInSchema.up
-    assert_equal %w(id
+    assert_equal %w[id
                     interrail_coal_consumption
                     interrail_max_speed
                     interrail_name
                     interrail_water_consumption
-                    type),
-                 @connection.columns('interrail.steam_locomotives').map{ |c| c.name }.sort
+                    type],
+                 @connection.columns('interrail.steam_locomotives').map(&:name).sort
   end
 
   class ChangeTablesInTwoInheritanceChains < ActiveRecord::Migration
@@ -251,4 +255,31 @@ class UpdateableViewsInheritanceSchemaTest < ActiveSupport::TestCase
     ReservedSQLWords.up
     assert @connection.columns(:table).map(&:name).include?("column")
   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 @connection.columns(:punk_locomotives).map(&:name).sort == %w(coal electro id max_speed name type)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: updateable_views_inheritance
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.6
 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-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -271,7 +271,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