updateable_views_inheritance 1.4.2 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7a73bd114b93585afae503c742efea0bbb5fa03a
-  data.tar.gz: 50871f961687a777113315c999b6f578add39566
+SHA256:
+  metadata.gz: 5a592cb214e5825bb4af87c5412ae3f91730d0e3882931f71bd16378ace7640a
+  data.tar.gz: 2fbf14052dde92e69724d574c0b5fb7b4d79297928220bc8bee5851cc8ee60ad
 SHA512:
-  metadata.gz: 710e9a867878a14618a1ec28881a9dc48ca530a82df33690d55a69e996b3720fb7c0fe1a14b03e76b67528a73fac8d23d76c35d13578dd47648cf9ba6694ccc7
-  data.tar.gz: 0d7b56539848266e86167887dc686995f5f2691ded47e29b4ebf2ed66fa236b2c7e2c8ecd3843ad9c8f6f5d0eafdbf0463c67331866e56ce14aa5fce11ca9f97
+  metadata.gz: b4da55b7632575a0fba84248130308890f56dd726e6aaec835d3423b874a959d88ecf51dbf482795ba97869e5255411b9599b0117df61c6e70b3f095322c23fe
+  data.tar.gz: edd29da257c91e7d8a53df032bc70dd2317c78433637649e23285118b058109116259ed22efc86b8495f44301c5c6831c125e26565c1aa203ad00663205c8f6c

data/.deepsource.toml

@@ -0,0 +1,8 @@
+version = 1
+
+[[analyzers]]
+name = "ruby"
+
+[[analyzers]]
+name = "test-coverage"
+enabled = true

data/.github/workflows/build.yml

@@ -0,0 +1,66 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Build
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:9.6.24
+        ports:
+          - "5432:5432"
+        env:
+          POSTGRES_DB: updateable_views_inheritance_test
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+    strategy:
+      matrix:
+        ruby-version: ['2.7']
+    env:
+      DATABASE_URL: "postgres://postgres:postgres@localhost:5432/updateable_views_inheritance_test"
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of Sonar analysis
+
+      - name: Set up Ruby
+      # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+      # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      # uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler: 1.17.3 # temporary set until rails 5 upgrade
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Run tests
+        run: bundle exec rake 2>/dev/null # disable warnings until ruby 3 upgrade
+
+      # From https://stackoverflow.com/questions/74199483/sonarcloud-ci-cant-find-source-files-for-ruby-simplecov-coverage
+      - name: Fix code coverage paths for DeepSource
+        working-directory: ./coverage
+        run: |
+          sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' .resultset.json
+
+      - name: Report test coverage to DeepSource
+        uses: deepsourcelabs/test-coverage-action@master
+        with:
+          key: ruby
+          coverage-file: ./coverage/.resultset.json
+          dsn: ${{ secrets.DEEPSOURCE_DSN }}
+

data/.gitignore

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

data/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "sonarlint.connectedMode.project": {
+    "connectionId": "tutuf",
+    "projectKey": "tutuf_updateable_views_inheritance"
+  }
+}

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 1.4.4 (09 October 2024)
+
+Bugfixes:
+
+  - Quote table and column names.
+
+## 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 +31,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 +65,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,166 @@
+# 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/)
+
+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/Rakefile

@@ -24,14 +24,14 @@ end
 namespace :test do
   desc 'Build the test database'
   task :create_database do
-    %x( createdb updateable_views_inheritance_test )
+    %x( createdb updateable_views_inheritance_test ) unless ENV['CI']
   end
 
   desc 'Drop the test database'
   task :drop_database do
-    %x( dropdb updateable_views_inheritance_test )
+    %x( dropdb updateable_views_inheritance_test ) unless ENV['CI']
   end
 
   desc 'Rebuild the test database'
   task :rebuild_database => [:drop_database, :create_database]
-end
+end

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])