sti_fallback 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b536e45474f6f0eb9c8af256cbda3168c40cab260bc6be2b65ccba67535cacd
+  data.tar.gz: d64ac7a8c40988d07dea79747eaae1d307fe1404e02814551292da53d3e23025
+SHA512:
+  metadata.gz: ebf56536b24ddf649c51f98e60571dce825089dae348b7748ed40386ef52e5e2b7c2d5b20e9d539826441d95f0b9f12198129d4ede9264eab3ebd3e046585f7c
+  data.tar.gz: aae5099701a63a86c10ebf6103c44f6c5bba0917c975d2deab7a8df5dfbf4d7fe54b8dd5edc0e9c56004b94682ea375d59363bfe2b0680062b48eebdb566ef94

data/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.

data/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).

data/Rakefile

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

data/lib/sti_fallback/version.rb

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

data/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

data/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

data/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 = ["osbre@protonmail.com"]
+
+  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"] = "https://rubygems.org"
+
+  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

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: sti_fallback
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ostap Brehin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description:
+email:
+- osbre@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sti_fallback.rb
+- lib/sti_fallback/version.rb
+- sig/sti_fallback.rbs
+- sti_fallback.gemspec
+homepage: https://github.com/osbre/sti_fallback
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/osbre/sti_fallback
+  source_code_uri: https://github.com/osbre/sti_fallback.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Fall back to base model on missing STI subclasses in ActiveRecord
+test_files: []