Init

.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.3.0'
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sti_fallback.gemspec
+gemspec
+
+gem "activerecord", "~> 6.0"

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Ostap Brehin
+
+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.

README.md

@@ -0,0 +1,40 @@
+# StiFallback
+
+Handle validation or additonal behavior on missing subclasses in STI by falling back to the base class.
+
+Example:
+
+```ruby
+class Action < ApplicationRecord
+  include StiFallback
+
+  validates :type, inclusion: { in: %w[Value1 Value2 Value3] }
+
+  # optional: specify which types should still raise an error when not found
+  sti_fallback raise_error_for: %w[Value1 Value2]
+end
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add sti_fallback
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install sti_fallback
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/osbre/sti_fallback.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sti_fallback"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

lib/sti_fallback.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "sti_fallback/version"
+
+module StiFallback
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :_raise_error_for_types, instance_writer: false
+    self._raise_error_for_types = []
+  end
+
+  class_methods do
+    # Method to specify which types should raise an error when not found
+    def sti_fallback(raise_error_for: [])
+      self._raise_error_for_types = raise_error_for.map(&:to_s)
+    end
+
+    def sti_class_for(type_name)
+      type_name.constantize
+    rescue NameError
+      # Raises error if type is in the list for which errors should be raised
+      raise if _raise_error_for_types.include?(type_name)
+      # Falls back to the base class if the type is not in the error list
+      self
+    end
+  end
+end

lib/sti_fallback/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module StiFallback
+  VERSION = "0.1.0"
+end

sig/sti_fallback.rbs

@@ -0,0 +1,16 @@
+module StiFallback
+  VERSION: String
+
+  extend ActiveSupport::Concern
+
+  class_methods do
+    # Specifies which types should raise an error when not found
+    def sti_fallback: (raise_error_for: Array[String]?) -> void
+
+    # Returns the class for a given type name, falling back to the base class or raising an error as configured
+    def sti_class_for: (String) -> untyped
+  end
+
+  # This attribute holds the types that should raise an error
+  _raise_error_for_types: Array[String]
+end

sti_fallback.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/sti_fallback/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sti_fallback"
+  spec.version = StiFallback::VERSION
+  spec.authors = ["Ostap Brehin"]
+  spec.email = ["[email protected]"]
+
+  spec.summary = "Fall back to base model on missing STI subclasses in ActiveRecord"
+  spec.homepage = "https://github.com/osbre/sti_fallback"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/osbre/sti_fallback.git"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 6.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end