updateable_views_inheritance 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7a73bd114b93585afae503c742efea0bbb5fa03a
-  data.tar.gz: 50871f961687a777113315c999b6f578add39566
+SHA256:
+  metadata.gz: d1310b2e6e48b891171acd2c8eaebb3f194ee6cd9fac97ebbaa5a6eca5cc7ceb
+  data.tar.gz: 0d240ed0c411840f800e0e01a52e05933c5e64903d4ec648a39279fb358c8c53
 SHA512:
-  metadata.gz: 710e9a867878a14618a1ec28881a9dc48ca530a82df33690d55a69e996b3720fb7c0fe1a14b03e76b67528a73fac8d23d76c35d13578dd47648cf9ba6694ccc7
-  data.tar.gz: 0d7b56539848266e86167887dc686995f5f2691ded47e29b4ebf2ed66fa236b2c7e2c8ecd3843ad9c8f6f5d0eafdbf0463c67331866e56ce14aa5fce11ca9f97
+  metadata.gz: fdddba487660479c4ed5530764be9bee03aa13bea8ff658319d48938c34e8a276c9e5f7ba6d9769111a4c2e93e1d0b35632ccd111811402eb9188fce12e20d56
+  data.tar.gz: 4a50e703717eb50314beed8563134dc20cdd430533aead0398c42c7fd2082b63b00375dc0db39b012688d0d6ec6ad3a1b49c7a5b9e2873a90b556bdcada6515c

data/.gitignore

@@ -1,5 +1,6 @@
-Gemfile.lock
 .bundle/
+.byebug_history
+Gemfile.lock
 html/*
 pkg/*
 test/dummy/log/*.log

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 1.4.3 (01 October 2024)
+
+Features:
+
+  - Add option to disable inheritance instantiation for less
+  database hits when loading large object collections from a
+  parent class.
+
+  - Add option to skip creating child table in migrations.
+
 ## 1.4.2 (28 March 2017)
 
 Upgrade to Rails 4.2
@@ -15,31 +25,31 @@ Upgrade to Rails 4
 
 Features:
 
-  - rebuild views in all inheritance chains (must be run when upgrading from <= 1.2.1)
+  - Rebuild views in all inheritance chains (must be run when upgrading from <= 1.2.1)
 
 ## 1.2.2 (18 August 2015)
 
 Bugfixes:
 
-  - fixed compatibility with Rails 3.2.19+ and ActiveRecord's prepared statements
+  - Fixed compatibility with Rails 3.2.19+ and ActiveRecord's prepared statements
 
 ## 1.2.1 (27 August 2014)
 
 Bugfixes:
 
-  - parent relations can be in a schema
+  - Parent relations can be in a schema
 
 ## 1.2.0 (27 August 2014)
 
 Features:
 
-  - support for PostgreSQL schemas
+  - Support for PostgreSQL schemas
 
 ## 1.1.2 (14 June 2013)
 
 Bugfixes:
 
-  - fixed generating migration on installation
+  - Fixed generating migration on installation
 
 Documentation:
 
@@ -49,17 +59,17 @@ Documentation:
 
 Features:
 
-  - gemified and released on rubygems.org
+  - Gemified and released on rubygems.org
 
 ## 1.1.0 (13 June 2013)
 
 Features:
 
-  - updated for rails 3.2.x
+  - Updated for Rails 3.2.x
 
 ## 1.0.0 (14 September 2009)
 
 Features:
 
   - class_table_inheritance plugin has behaved stably in production for a year
-  - supports rails 2.1, 2.2 and 2.3
+  - Supports Rails 2.1, 2.2 and 2.3

data/README.md

@@ -0,0 +1,163 @@
+# Class Table Inheritance
+
+Class Table Inheritance for ActiveRecord using updateable views
+
+More about the pattern on
+http://www.martinfowler.com/eaaCatalog/classTableInheritance.html. This gem
+messes very little with Rails inheritance mechanism. Instead it relies on
+updatable views in the database to represent classes in the inheritance chain.
+The approach was [first suggested by John
+Wilger](http://web.archive.org/web/20060408145717/johnwilger.com/articles/2005/09/29/class-table-inheritance-in-rails-with-postgresql).
+
+
+# Requirements
+
+Rails: 4.x
+
+Ruby: 1.9.3+
+
+Database: PostgreSQL only. Patches for other DBMS are welcome. Note that you are
+not required to use updateable views, children relations can be tables with
+some triggers involved.
+
+# Usage
+
+## Setup
+
+* Add `gem 'updateable_views_inheritance'` to your `Gemfile`
+* Run `rails generate updateable_views_inheritance:install && rake db:migrate`
+* In `config/environment.rb` set `config.active_record.schema_format = :sql`
+
+## Example
+
+The database migration:
+
+```ruby
+class CtiExample < ActiveRecord::Migration
+  def self.up
+    create_table :locomotives do |t|
+      t.column :name, :string
+      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
+    end
+
+    create_child(:electric_locomotives,
+                 table: :raw_electric_locomotives,
+                 parent: :locomotives)  do |t|
+      t.decimal :electricity_consumption, precision: 6, scale: 2
+    end
+  end
+
+  def self.down
+    drop_child  :steam_locomotives
+    drop_child  :electric_locomotives
+    drop_table  :locomotives
+  end
+end
+```
+
+And the models:
+
+```ruby
+class Locomotive
+end
+
+class SteamLocomotive < Locomotive
+  self.table_name =  :steam_locomotives
+end
+
+class ElectricLocomotive < Locomotive
+  self.table_name =  :electric_locomotives
+end
+```
+
+Note that models of children classes must specify table name explicitly.
+
+### Changing Columns in Underlying Tables
+
+```ruby
+class RemoveColumnInParentTable < ActiveRecord::Migration
+  def self.up
+    remove_parent_and_children_views(:locomotives)
+    remove_column(:locomotives, :max_speed)
+    rename_column(:name, :title)
+    rebuild_parent_and_children_views(:locomotives)
+  end
+end
+```
+
+### Renaming Underlying Tables
+
+```ruby
+remove_parent_and_children_views(:old_name)
+rename_table(:old_name,:new_name)
+execute "UPDATE updateable_views_inheritance SET child_aggregate_view = 'new_name' WHERE child_aggregate_view = 'old_name'"
+execute "UPDATE updateable_views_inheritance SET parent_relation = 'new_name' WHERE parent_relation = 'old_name'"
+rebuild_parent_and_children_views(:new_name)
+```
+
+### Removing Classes
+
+Note that you should remove only leaf classes (i.e. those that do not have
+descendants). If you want to erase a whole chain or part of chain you have to
+remove first the leaves and then their ancestors. Use `drop_child(child_view)`
+in migrations.
+
+### Using parent class without instantiating subclass
+
+If you don't want to make a second SQL query to the subclass table when you instantiate
+parent class with `Locomotive.find(1)` use
+```ruby
+class Locomotive
+  self.disable_inheritance_instantiation = true
+end
+```
+Quite handy for flat and wide class hierarchies (one parent class, many subclasses).
+
+### Using existing table for inherited class
+
+```ruby
+class CreateIkarusBus < ActiveRecord::Migration
+  def self.up
+    # table `tbl_ikarus_buses` exists in the database
+    end
+    create_child(:ikarus_buses,
+                 table: :tbl_ikarus_buses,
+                 parent: :buses,
+                 skip_creating_child_table: true)
+  end
+end
+```
+Useful when converting legacy DB schema to use inheritance.
+
+## Compatibility with Single Table Inheritance
+
+The approach of this gem is completely independent from Rails built-in Single
+Table Inheritance. STI and CLTI can safely be mixed in one inheritance chain.
+
+## Testing Your App
+
+If you use fixtures, you must run `rake updateable_views_inheritance:fixture` to
+generate fixture for the updateable_views_inheritance table after you
+add/remove classes from the hierarchy or change underlying table or view names.
+**Without it primary key sequence for inheritors' tables won't be bumped to the
+max and it might not be possible to save objects!** If you don't use fixtures
+for the classes in the hierarchy you don't need to do that.
+
+This gem re-enables referential integrity on fixture loading. This means that
+`fixtures :all` may fail when there are foreign key constraints on tables. To
+fix this, explicitly declare fixture load order in `test_helper.rb`:
+
+```
+fixtures :roots, :trunks, :leafs, ...
+```
+for all fixtures you want to load.
+
+## Gem Development & Testing
+
+In order to run gem tests, you have to be a superuser in PostgreSQL.

data/lib/updateable_views_inheritance/active_record.rb

@@ -1,10 +1,12 @@
 module ActiveRecord #:nodoc:
   class Base #:nodoc:
     class << self
+      attr_accessor :disable_inheritance_instantiation
+
       private
       def instantiate_with_updateable_views_inheritance_support(attributes, column_types = {})
         object = instantiate_without_updateable_views_inheritance_support(attributes, column_types = {})
-        if object.class.name == self.name
+        if object.class.name == self.name || self.disable_inheritance_instantiation
           object
         else
           object.class.find(attributes.with_indifferent_access[:id])

data/lib/updateable_views_inheritance/postgresql_adapter.rb

@@ -1,6 +1,5 @@
 require 'active_record/connection_adapters/postgresql/utils'
 
-
 module ActiveRecord #:nodoc:
   module ConnectionAdapters #:nodoc:
     module PostgreSQL
@@ -9,30 +8,38 @@ module ActiveRecord #:nodoc:
         # Options:
         # [:parent]
         #   parent relation
-        # [:child_table_name]
+        # [:table]
         #   default is <tt>"#{child_view}_data"</tt>
+        # [:skip_creating_child_table]
+        #   use together with :table option
         def create_child(child_view, options)
           raise 'Please call me with a parent, for example: create_child(:steam_locomotives, :parent => :locomotives)' unless options[:parent]
 
-          unqualified_child_view_name = Utils.extract_schema_qualified_name(child_view).identifier
-
           parent_relation = options[:parent].to_s
-          if is_view?(parent_relation) # interpreted as inheritance chain deeper than two levels
-            parent_table = query("SELECT child_relation FROM updateable_views_inheritance WHERE child_aggregate_view = #{quote(parent_relation)}")[0][0]
-          else
-            parent_table = parent_relation
-          end
+          parent_table =  if is_view?(parent_relation) # interpreted as inheritance chain deeper than two levels
+                            query(<<~SQL)[0][0]
+                              SELECT child_relation
+                              FROM updateable_views_inheritance
+                              WHERE child_aggregate_view = #{quote(parent_relation)}
+                            SQL
+                          else
+                            parent_relation
+                          end
 
           child_table = options[:table] || quote_table_name("#{child_view}_data")
-          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
+          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"
+
+            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
-          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_child_view(parent_relation, child_view, child_table)
         end
@@ -130,7 +137,7 @@ module ActiveRecord #:nodoc:
         # Return the list of all views in the schema search path.
         def views(name=nil)
           schemas = schema_search_path.split(/,\s*/).map { |p| quote(p) }.join(',')
-          query(<<-SQL, name).map { |row| row[0] }
+          query(<<~SQL, name).map { |row| row[0] }
             SELECT viewname
               FROM pg_views
              WHERE schemaname IN (#{schemas})
@@ -139,7 +146,7 @@ module ActiveRecord #:nodoc:
 
         # Checks whether relation +name+ is a view.
         def is_view?(name)
-          result = query(<<-SQL, name).map { |row| row[0] }
+          result = query(<<~SQL, name).map { |row| row[0] }
             SELECT viewname
               FROM pg_views
              WHERE viewname = '#{name}'
@@ -234,7 +241,7 @@ module ActiveRecord #:nodoc:
           create_single_table_inheritance_view(sti_aggregate_view, parent_relation, columns_for_view)
         end
 
-        # Overriden - it must return false, otherwise deleting fixtures won't work
+        # Overriden - it solargraph-must return false, otherwise deleting fixtures won't work
         def supports_disable_referential_integrity?
           false
         end
@@ -247,194 +254,196 @@ module ActiveRecord #:nodoc:
         module Tutuf #:nodoc:
           class ClassTableReflection
             class << self
-                # Returns all models' class objects that are ActiveRecord::Base descendants
-                def all_db_klasses
-                  return @@klasses if defined?(@@klasses)
-                  @@klasses = []
-                  # load model classes so that inheritance_column is set correctly where defined
-                  model_filenames.collect{|m| load "#{Rails.root}/app/models/#{m}";m.match(%r{([^/]+?)\.rb$})[1].camelize.constantize }.each do |klass|
-                    @@klasses << klass if  klass < ActiveRecord::Base
-                  end
-                  @@klasses.uniq
+              # Returns all models' class objects that are ActiveRecord::Base descendants
+              def all_db_klasses
+                return @@klasses if defined?(@@klasses)
+
+                @@klasses = []
+                # load model classes so that inheritance_column is set correctly where defined
+                model_filenames.collect{|m| load "#{Rails.root}/app/models/#{m}";m.match(%r{([^/]+?)\.rb$})[1].camelize.constantize }.each do |klass|
+                  @@klasses << klass if  klass < ActiveRecord::Base
                 end
+                @@klasses.uniq
+              end
 
-                # Returns the class object for +table_name+
-                def get_klass_for_table(table_name)
-                  klass_for_tables()[table_name.to_s]
-                end
+              # Returns the class object for +table_name+
+              def get_klass_for_table(table_name)
+                klass_for_tables()[table_name.to_s]
+              end
 
-                # Returns hash with tables and thier corresponding class.
-                # {table_name1 => ClassName1, ...}
-                def klass_for_tables
-                  return @@tables_klasses if defined?(@@tables_klasses)
-                  @@tables_klasses = {}
-                  all_db_klasses.each do |klass|
-                    @@tables_klasses[klass.table_name] = klass if klass.respond_to?(:table_name)
-                  end
-                  @@tables_klasses
-                end
+              # Returns hash with tables and thier corresponding class.
+              # {table_name1 => ClassName1, ...}
+              def klass_for_tables
+                return @@tables_klasses if defined?(@@tables_klasses)
 
-                # Returns filenames for models in the current Rails application
-                def model_filenames
-                  Dir.chdir("#{Rails.root}/app/models"){ Dir["**/*.rb"] }
+                @@tables_klasses = {}
+                all_db_klasses.each do |klass|
+                  @@tables_klasses[klass.table_name] = klass if klass.respond_to?(:table_name)
                 end
+                @@tables_klasses
+              end
+
+              # Returns filenames for models in the current Rails application
+              def model_filenames
+                Dir.chdir("#{Rails.root}/app/models"){ Dir["**/*.rb"] }
+              end
+            end
+          end
+        end
+
+        # Set default values from the table columns for a view
+        def set_defaults(view_name, table_name)
+          column_definitions(table_name).each do |column_name, type, default, notnull|
+            if !default.nil?
+              execute("ALTER TABLE #{quote_table_name(view_name)} ALTER #{quote_column_name(column_name)} SET DEFAULT #{default}")
             end
           end
         end
 
         private
 
-          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 <<-end_sql
-              CREATE OR REPLACE VIEW #{child_view} AS (
-                SELECT parent.#{parent_pk},
-                       #{ view_columns.join(",") }
-                  FROM #{parent_table} parent
-                       INNER JOIN #{child_table} child
-                       ON ( parent.#{parent_pk}=child.#{child_pk} )
-              )
-            end_sql
-          end
+        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 <<-end_sql
+            CREATE OR REPLACE VIEW #{child_view} AS (
+              SELECT parent.#{parent_pk},
+                     #{ view_columns.join(",") }
+                FROM #{parent_table} parent
+                     INNER JOIN #{child_table} child
+                     ON ( parent.#{parent_pk}=child.#{child_pk} )
+            )
+          end_sql
+        end
 
-          # Creates rules for +INSERT+, +UPDATE+ and +DELETE+ on the view
-          def make_child_view_updateable(parent_table, parent_columns, parent_pk, parent_pk_seq, child_view, child_columns, child_pk, child_table)
-            # insert
-            # NEW.#{parent_pk} can be explicitly specified and when it is null every call to it increments the sequence.
-            # Setting the sequence to its value (explicitly supplied or the default) covers both cases.
-            execute <<-end_sql
-              CREATE OR REPLACE RULE #{quote_column_name("#{child_view}_insert")} AS
-              ON INSERT TO #{child_view} DO INSTEAD (
-                INSERT INTO #{parent_table}
-                       ( #{ [parent_pk, parent_columns].flatten.join(", ") } )
-                       VALUES( DEFAULT #{ parent_columns.empty? ? '' : ' ,' + parent_columns.collect{ |col| "NEW." + col}.join(", ") } ) ;
-                INSERT INTO #{child_table}
-                       ( #{ [child_pk, child_columns].flatten.join(",")} )
-                       VALUES( currval('#{parent_pk_seq}') #{ child_columns.empty? ? '' : ' ,' + child_columns.collect{ |col| "NEW." + col}.join(", ") }  )
-                       #{insert_returning_clause(parent_pk, child_pk, child_view)}
-              )
-            end_sql
+        # Creates rules for +INSERT+, +UPDATE+ and +DELETE+ on the view
+        def make_child_view_updateable(parent_table, parent_columns, parent_pk, parent_pk_seq, child_view, child_columns, child_pk, child_table)
+          # insert
+          # NEW.#{parent_pk} can be explicitly specified and when it is null every call to it increments the sequence.
+          # Setting the sequence to its value (explicitly supplied or the default) covers both cases.
+          execute <<-end_sql
+            CREATE OR REPLACE RULE #{quote_column_name("#{child_view}_insert")} AS
+            ON INSERT TO #{child_view} DO INSTEAD (
+              INSERT INTO #{parent_table}
+                     ( #{ [parent_pk, parent_columns].flatten.join(", ") } )
+                     VALUES( DEFAULT #{ parent_columns.empty? ? '' : ' ,' + parent_columns.collect{ |col| "NEW." + col}.join(", ") } ) ;
+              INSERT INTO #{child_table}
+                     ( #{ [child_pk, child_columns].flatten.join(",")} )
+                     VALUES( currval('#{parent_pk_seq}') #{ child_columns.empty? ? '' : ' ,' + child_columns.collect{ |col| "NEW." + col}.join(", ") }  )
+                     #{insert_returning_clause(parent_pk, child_pk, child_view)}
+            )
+          end_sql
 
-            # delete
-            execute <<-end_sql
-             CREATE OR REPLACE RULE #{quote_column_name("#{child_view}_delete")} AS
-             ON DELETE TO #{child_view} DO INSTEAD
-             DELETE FROM #{parent_table} WHERE #{parent_pk} = OLD.#{parent_pk}
-            end_sql
+          # delete
+          execute <<-end_sql
+           CREATE OR REPLACE RULE #{quote_column_name("#{child_view}_delete")} AS
+           ON DELETE TO #{child_view} DO INSTEAD
+           DELETE FROM #{parent_table} WHERE #{parent_pk} = OLD.#{parent_pk}
+          end_sql
 
-            # update
-            execute <<-end_sql
-              CREATE OR REPLACE RULE #{quote_column_name("#{child_view}_update")} AS
-              ON UPDATE TO #{child_view} DO INSTEAD (
-                #{ parent_columns.empty? ? '':
-                   "UPDATE #{parent_table}
-                       SET #{ parent_columns.collect{ |col| col + "= NEW." + col }.join(", ") }
-                       WHERE #{parent_pk} = OLD.#{parent_pk};"}
-                #{ child_columns.empty? ? '':
-                   "UPDATE #{child_table}
-                       SET #{ child_columns.collect{ |col| col + " = NEW." + col }.join(", ") }
-                       WHERE #{child_pk} = OLD.#{parent_pk}"
-                  }
-              )
-            end_sql
-          end
+          # update
+          execute <<-end_sql
+            CREATE OR REPLACE RULE #{quote_column_name("#{child_view}_update")} AS
+            ON UPDATE TO #{child_view} DO INSTEAD (
+              #{ parent_columns.empty? ? '':
+                 "UPDATE #{parent_table}
+                     SET #{ parent_columns.collect{ |col| col + "= NEW." + col }.join(", ") }
+                     WHERE #{parent_pk} = OLD.#{parent_pk};"}
+              #{ child_columns.empty? ? '':
+                 "UPDATE #{child_table}
+                     SET #{ child_columns.collect{ |col| col + " = NEW." + col }.join(", ") }
+                     WHERE #{child_pk} = OLD.#{parent_pk}"
+                }
+            )
+          end_sql
+        end
 
-          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(", ")
-            "RETURNING #{child_pk}, #{columns_cast_to_null}"
-          end
+        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(", ")
+          "RETURNING #{child_pk}, #{columns_cast_to_null}"
+        end
 
-          # Set default values from the table columns for a view
-          def set_defaults(view_name, table_name)
-            column_definitions(table_name).each do |column_name, type, default, notnull|
-              if !default.nil?
-                execute("ALTER TABLE #{quote_table_name(view_name)} ALTER #{quote_column_name(column_name)} SET DEFAULT #{default}")
-              end
-            end
+        def create_system_table_records(parent_relation, child_aggregate_view, child_relation)
+          parent_relation, child_aggregate_view, child_relation = [parent_relation, child_aggregate_view, child_relation].collect{|rel| quote(rel.to_s)}
+          exists = query <<~SQL
+            SELECT parent_relation, child_aggregate_view, child_relation
+              FROM updateable_views_inheritance
+             WHERE parent_relation      = #{parent_relation}
+               AND child_aggregate_view = #{child_aggregate_view}
+               AND child_relation       = #{child_relation}
+          SQL
+          # log "res: #{exists}"
+          if exists.nil? or exists.empty?
+            execute "INSERT INTO updateable_views_inheritance (parent_relation, child_aggregate_view, child_relation)" +
+                    "VALUES( #{parent_relation}, #{child_aggregate_view}, #{child_relation} )"
           end
+        end
 
-          def create_system_table_records(parent_relation, child_aggregate_view, child_relation)
-            parent_relation, child_aggregate_view, child_relation = [parent_relation, child_aggregate_view, child_relation].collect{|rel| quote(rel.to_s)}
-            exists = query <<-end_sql
-              SELECT parent_relation, child_aggregate_view, child_relation
+        def parent_table(relation)
+          if table_exists?('updateable_views_inheritance')
+           res = query(<<-end_sql, 'Parent relation')[0]
+              SELECT parent_relation
                 FROM updateable_views_inheritance
-               WHERE parent_relation      = #{parent_relation}
-                 AND child_aggregate_view = #{child_aggregate_view}
-                 AND child_relation       = #{child_relation}
+               WHERE child_aggregate_view = '#{relation}'
             end_sql
-            # log "res: #{exists}"
-            if exists.nil? or exists.empty?
-              execute "INSERT INTO updateable_views_inheritance (parent_relation, child_aggregate_view, child_relation)" +
-                      "VALUES( #{parent_relation}, #{child_aggregate_view}, #{child_relation} )"
-            end
-          end
-
-          def parent_table(relation)
-            if table_exists?('updateable_views_inheritance')
-             res = query(<<-end_sql, 'Parent relation')[0]
-                SELECT parent_relation
-                  FROM updateable_views_inheritance
-                 WHERE child_aggregate_view = '#{relation}'
-              end_sql
-              res[0] if res
-            end
+            res[0] if res
           end
+        end
 
-          # Single Table Inheritance Aggregate View
-
-          # Nested list for the +parent_relation+ inheritance hierarchy
-          # Every descendant relation is presented as an array with relation's name as first element
-          # and the other elements are the relation's children presented in the same way as lists.
-          # For example:
-          # [[child_view1, [grandchild11,[...]], [grandchild12]],
-          #  [child_view2, [...]
-          # ]
-          def get_view_hierarchy_for(parent_relation)
-            hierarchy = []
-            children = query(<<-end_sql)
-              SELECT parent_relation, child_aggregate_view, child_relation
-                FROM updateable_views_inheritance
-              WHERE parent_relation = '#{parent_relation}'
-            end_sql
-            children.each do |child|
-              hierarchy << [child[1], *get_view_hierarchy_for(child[1])]
-            end
-            hierarchy
+        # Single Table Inheritance Aggregate View
+
+        # Nested list for the +parent_relation+ inheritance hierarchy
+        # Every descendant relation is presented as an array with relation's name as first element
+        # and the other elements are the relation's children presented in the same way as lists.
+        # For example:
+        # [[child_view1, [grandchild11,[...]], [grandchild12]],
+        #  [child_view2, [...]
+        # ]
+        def get_view_hierarchy_for(parent_relation)
+          hierarchy = []
+          children = query(<<-end_sql)
+            SELECT parent_relation, child_aggregate_view, child_relation
+              FROM updateable_views_inheritance
+            WHERE parent_relation = '#{parent_relation}'
+          end_sql
+          children.each do |child|
+            hierarchy << [child[1], *get_view_hierarchy_for(child[1])]
           end
+          hierarchy
+        end
 
-          def get_leaves_relations(hierarchy)
-            return [] if hierarchy.nil? || hierarchy.empty?
-            head, hierarchy = hierarchy.first, hierarchy[1..(hierarchy.size)]
-            if(head.is_a? Array)
-              return (get_leaves_relations(head) + get_leaves_relations(hierarchy)).compact
-            elsif(hierarchy.nil? || hierarchy.empty?)
-              return [head]
-            else
-              return get_leaves_relations(hierarchy).compact
-            end
+        def get_leaves_relations(hierarchy)
+          return [] if hierarchy.nil? || hierarchy.empty?
+          head, hierarchy = hierarchy.first, hierarchy[1..(hierarchy.size)]
+          if(head.is_a? Array)
+            return (get_leaves_relations(head) + get_leaves_relations(hierarchy)).compact
+          elsif(hierarchy.nil? || hierarchy.empty?)
+            return [head]
+          else
+            return get_leaves_relations(hierarchy).compact
           end
+        end
 
-          def generate_single_table_inheritanche_union_clause(rel, column_names, conflict_column_names, columns_hash, quoted_inheritance_column)
-            relation_columns = columns(rel).collect{|c| c.name}
-            columns_select = column_names.inject([]) do |arr, col_name|
-              sql_type = conflict_column_names.include?(col_name) ? 'text' : columns_hash[col_name].sql_type
-              value = "NULL::#{sql_type}"
-              if(relation_columns.include?(col_name))
-                value = col_name
-                value = "#{value}::text" if conflict_column_names.include?(col_name)
-              end
-              statement = " AS #{col_name}"
-              statement = "#{value} #{statement}"
-              arr << " #{statement}"
+        def generate_single_table_inheritanche_union_clause(rel, column_names, conflict_column_names, columns_hash, quoted_inheritance_column)
+          relation_columns = columns(rel).collect{|c| c.name}
+          columns_select = column_names.inject([]) do |arr, col_name|
+            sql_type = conflict_column_names.include?(col_name) ? 'text' : columns_hash[col_name].sql_type
+            value = "NULL::#{sql_type}"
+            if(relation_columns.include?(col_name))
+              value = col_name
+              value = "#{value}::text" if conflict_column_names.include?(col_name)
             end
-            columns_select = columns_select.join(", ")
-            rel_klass_name = Tutuf::ClassTableReflection.get_klass_for_table(rel)
-            where_clause = " WHERE #{quoted_inheritance_column} = '#{rel_klass_name}'"
-            ["SELECT", columns_select, "FROM #{rel} #{where_clause}"].join(" ")
+            statement = " AS #{col_name}"
+            statement = "#{value} #{statement}"
+            arr << " #{statement}"
           end
+          columns_select = columns_select.join(", ")
+          rel_klass_name = Tutuf::ClassTableReflection.get_klass_for_table(rel)
+          where_clause = " WHERE #{quoted_inheritance_column} = '#{rel_klass_name}'"
+          ["SELECT", columns_select, "FROM #{rel} #{where_clause}"].join(" ")
+        end
       end
     end
   end

data/lib/updateable_views_inheritance/version.rb

@@ -1,3 +1,3 @@
 module UpdateableViewsInheritance
-  VERSION = "1.4.2"
+  VERSION = "1.4.3"
 end

data/test/instantiation_test.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class InstantiationTest < ActiveSupport::TestCase
+  def setup
+    ActiveRecord::Migrator.up(File.dirname(__FILE__) + '/fixtures/migrations/', 7)
+    # order of fixtures is important for the test - last loaded should not be with max(id)
+    %w[steam_locomotives electric_locomotives maglev_locomotives bicycles].each do |f|
+      ActiveRecord::FixtureSet.create_fixtures(File.dirname(__FILE__) + '/fixtures/', f)
+    end
+    @connection = ActiveRecord::Base.connection
+  end
+
+  def teardown
+    ActiveRecord::FixtureSet.reset_cache
+  end
+
+  class ::Locomotive < ActiveRecord::Base
+    self.disable_inheritance_instantiation = true
+  end
+
+  class ::ElectricLocomotive < Locomotive
+    self.disable_inheritance_instantiation = false
+  end
+
+  def test_setting_disable_inheritance_instantiation_does_not_load_child_columns
+    assert_equal %w[id max_speed name type],
+                 Locomotive.first.attributes.keys.sort
+  end
+
+  def test_switching_off_disable_inheritance_instantiation_loads_child_columns
+    assert_equal %w[electricity_consumption id magnetic_field max_speed name type],
+                 MaglevLocomotive.first.attributes.keys.sort
+  end
+
+  def test_disable_inheritance_instantiatioon_not_set_loads_child_attributes
+    assert_equal %w[id name number_of_gears number_of_wheels vehicle_type],
+                 Bicycle.first.attributes.keys.sort
+
+  end
+end

data/test/schema_test.rb

@@ -221,4 +221,22 @@ class UpdateableViewsInheritanceSchemaTest < ActiveSupport::TestCase
     assert @connection.columns(:bicycles).map{ |c| c.name }.include?('wheel_size'),
            "Newly added column not present in view after rebuild for 2. hierarchy"
   end
+
+  class UseExistingTable < ActiveRecord::Migration
+    def self.up
+      create_table :tbl_diesel_locomotives do |t|
+        t.belongs_to :locomotives
+        t.integer :num_cylinders
+      end
+      create_child(:diesel_locomotives,
+                   table: :tbl_diesel_locomotives,
+                   parent: :locomotives,
+                   skip_creating_child_table: true)
+    end
+  end
+
+  def test_skip_creating_child_table
+    UseExistingTable.up
+    assert @connection.columns(:diesel_locomotives).map(&:name).include?("num_cylinders")
+  end
 end

data/updateable_views_inheritance.gemspec

@@ -19,10 +19,12 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "activerecord", "~> 4.2.8"
-  s.add_dependency "pg"
+  s.add_dependency "pg", "~> 0.21"
 
   s.add_development_dependency 'minitest'
-  s.add_development_dependency "rails", ' ~> 4.2.8'
-  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rails", '= 4.2.11.1'
+  s.add_development_dependency "bundler"
   s.add_development_dependency "rake"
+  s.add_development_dependency 'bigdecimal', '1.3.5'
+  s.add_development_dependency "solargraph"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: updateable_views_inheritance
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.3
 platform: ruby
 authors:
 - Sava Chankov
 - Denitsa Belogusheva
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-28 00:00:00.000000000 Z
+date: 2024-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -29,16 +29,16 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -57,30 +57,30 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.8
+        version: 4.2.11.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.8
+        version: 4.2.11.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  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'
 description: Class table inheritance for ActiveRecord based on updatable views in
   the database that join parent and children tables
 email:
@@ -108,7 +136,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - doc/template/horo.rb
 - lib/generators/updateable_views_inheritance/install_generator.rb
@@ -121,6 +149,7 @@ files:
 - test/content_test.rb
 - test/deep_hierarchy_test.rb
 - test/dummy/Rakefile
+- test/dummy/app/assets/config/manifest.js
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
@@ -185,6 +214,7 @@ files:
 - test/fixtures/steam_locomotives.yml
 - test/fixtures/steam_trains.yml
 - test/install_generator_test.rb
+- test/instantiation_test.rb
 - test/migration_test.rb
 - test/pg_insert_returning_with_rules_spec.rb
 - test/schema_test.rb
@@ -195,7 +225,7 @@ homepage: http://github.com/tutuf/updateable_views_inheritance
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -210,15 +240,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.4.12
+signing_key:
 specification_version: 4
 summary: Class table inheritance for ActiveRecord
 test_files:
 - test/content_test.rb
 - test/deep_hierarchy_test.rb
 - test/dummy/Rakefile
+- test/dummy/app/assets/config/manifest.js
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
@@ -283,6 +313,7 @@ test_files:
 - test/fixtures/steam_locomotives.yml
 - test/fixtures/steam_trains.yml
 - test/install_generator_test.rb
+- test/instantiation_test.rb
 - test/migration_test.rb
 - test/pg_insert_returning_with_rules_spec.rb
 - test/schema_test.rb

data/README.rdoc

@@ -1,121 +0,0 @@
-==Class Table Inheritance
-
-Class Table Inheritance for ActiveRecord using updateable views.
-
-More about the pattern on http://www.martinfowler.com/eaaCatalog/classTableInheritance.html. This gem messes very little with Rails inheritance mechanism.
-Instead it relies on updatable views in the database to represent classes in the inheritance chain. The approach was {first suggested by John
-Wilger}[http://web.archive.org/web/20060408145717/johnwilger.com/articles/2005/09/29/class-table-inheritance-in-rails-with-postgresql].
-
-
-==Requirements
-
-Rails: 4.x
-
-Ruby: 1.9.3+
-
-Database: PostgreSQL 8.1+ only. Patches for other DBMS are welcome. Note that you are not required to use updateable views, children relations can be tables (with some triggers involved) or materialized views.
-
-==Install
-Run
-  gem install updateable_views_inheritance
-
-==Usage
-
-===Setup
-
-* In <tt>Gemfile</tt> add <tt>gem 'updateable_views_inheritance'</tt>
-* Run <tt>rails generate updateable_views_inheritance:install && rake db:migrate</tt>
-* In <tt>config/environment.rb</tt> set <tt>config.active_record.schema_format = :sql</tt>
-* In case you're using fixtures, don't forget to run
-
-    rake updateable_views_inheritance:fixture
-
-after every change to the class hierarchy. Otherwise tests may fail.
-
-===Example
-
-  class CtiExample < ActiveRecord::Migration
-    def self.up
-      create_table :locomotives do |t|
-        t.column :name, :string
-        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
-      end
-
-      create_child(:electric_locomotives, :table => :raw_electric_locomotives, :parent => :locomotives)  do |t|
-        t.decimal :electricity_consumption, :precision => 6, :scale => 2
-      end
-    end
-
-    def self.down
-      drop_child  :steam_locomotives
-      drop_child  :electric_locomotives
-      drop_table  :locomotives
-    end
-  end
-
-And the models:
-  class Locomotive
-  end
-
-  class SteamLocomotive < Locomotive
-    self.table_name =  :steam_locomotives
-  end
-
-  class ElectricLocomotive < Locomotive
-    self.table_name =  :electric_locomotives
-  end
-
-Note that models of children classes must specify table name explicitly.
-
-===Changing Columns in Underlying Tables
-
-  class RemoveColumnInParentTable < ActiveRecord::Migration
-    def self.up
-      remove_parent_and_children_views(:locomotives)
-      remove_column(:locomotives, :max_speed)
-      rename_column(:name, :title)
-      rebuild_parent_and_children_views(:locomotives)
-    end
-  end
-
-===Renaming Underlying Tables
-
-  remove_parent_and_children_views(:old_name)
-  rename_table(:old_name,:new_name)
-  execute "UPDATE updateable_views_inheritance SET child_aggregate_view = 'new_name' WHERE child_aggregate_view = 'old_name'"
-  execute "UPDATE updateable_views_inheritance SET parent_relation = 'new_name' WHERE parent_relation = 'old_name'"
-  rebuild_parent_and_children_views(:new_name)
-
-===Removing Classes
-
-Note that you should remove only leaf classes (i.e. those that do not have descendants). If you want to erase a whole chain or part of chain you have to remove first the leaves and then their ancestors. Use <tt>drop_child(child_view)</tt> in migrations.
-
-==Compatibility with Single Table Inheritance
-
-The approach of this gem is completely independent from Rails built-in Single Table Inheritance. STI and CLTI can safely be mixed in one inheritance chain.
-
-==Testing Your App
-
-If you use fixtures, you must run <tt>rake updateable_views_inheritance:fixture</tt> to generate fixture for the updateable_views_inheritance table after you add/remove
-classes from the hierarchy or change underlying table or view names. <b>Without it primary key sequence for inheritors' tables won't be bumped to the max and it might not be possible to save objects!</b> If you don't use fixtures for the classes in the hierarchy you don't need to do that.
-
-This gem re-enables referential integrity on fixture loading. This means that
-
-  fixtures :all
-
-may fail when there are foreign key constraints on tables. To fix this, explicitly declare fixture load order in <tt>test_helper.rb</tt>:
-
-  fixtures :roots, :trunks, :leafs, ...
-
-for all fixtures you want to load.
-
-==Gem Development & Testing
-
-The gem has a comprehensive test suite. In order to run it, your user must be a superuser in PostgreSQL.
-If this is not the case, run <tt>createuser -s pesho</tt> (assuming your Unix account is <tt>pesho</tt>).