enum_errors_away 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3109aa3ed90342b1a9efd7021566b58b7d575f160886c5f05485a376e26a1f05
+  data.tar.gz: 1b47116a202a1adc29105447e351a05e165789cf64d29681ca77471acdd25e25
+SHA512:
+  metadata.gz: 6a6329676b1ccda218d1cb2b119eaa8417d53e3017b9dc11575ac24c342894a5f339dbe2da479ba909639df9ed06d470ae7c85a524c030dcf7bdd6522b5f80e5
+  data.tar.gz: 30aec5078925bb1eff6fb06e85869aa68d9bd1a8904991067b4e08d8d6dc2350343bd7fc4a0c804e9cd21e01452728061af1566f6469cbfdfcb600bf821822d1

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [0.1.0] - 2024-01-01
+
+### Added
+- Initial release
+- Automatic suppression of "Undeclared attribute type for enum" errors
+- Rails railtie for seamless integration
+- Configuration option to enable/disable the gem

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 enum_errors_away
+
+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,261 @@
+# EnumErrorsAway
+
+[![CI](https://github.com/sampokuokkanen/enum_errors_away/actions/workflows/ci.yml/badge.svg)](https://github.com/sampokuokkanen/enum_errors_away/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/enum_errors_away.svg)](https://badge.fury.io/rb/enum_errors_away)
+
+**Fix Rails 7.2+ enum migration failures** - EnumErrorsAway eliminates "Undeclared attribute type for enum" errors that break migrations when enum columns are added in separate migrations.
+
+## The Problem
+
+Rails 7.2+ requires enum attributes to be declared with a type when they don't have a corresponding database column. This causes migration failures in a common scenario:
+
+```ruby
+# Your model defines multiple enums
+class Organization < ApplicationRecord
+  enum :status, { active: 0, inactive: 1 }
+  enum :billing_plan, { free: 0, paid: 1 }
+end
+
+# db/migrate/20240101_add_status_to_organizations.rb
+add_column :organizations, :status, :integer
+
+# db/migrate/20240201_add_billing_plan_to_organizations.rb
+add_column :organizations, :billing_plan, :integer
+```
+
+**When running migrations from scratch**, the first migration fails:
+
+```
+ArgumentError: Undeclared attribute type for enum 'billing_plan' in Organization.
+Enums must be backed by a database column or declared with an explicit type via `attribute`.
+```
+
+This happens because:
+1. The first migration runs and loads the Organization model
+2. The model defines both `status` AND `billing_plan` enums
+3. But the `billing_plan` column doesn't exist yet (it's added in the second migration)
+4. Rails 7.2+ throws an error
+
+This is especially problematic when:
+- **Running migrations from scratch** (new development environments, CI/CD, test databases)
+- **Adding new enums over time** in separate migrations
+- **Migrating legacy applications** to Rails 7.2+
+- **Working with large teams** where different developers add enums in different migrations
+
+## The Solution
+
+EnumErrorsAway automatically handles this for you. Just add the gem and your enums work again - no code changes required!
+
+The gem:
+- ✅ **Automatically declares missing enum attributes** as integers
+- ✅ **Preserves legitimate enum errors** (method collisions, invalid values, etc.)
+- ✅ **Zero configuration required** - works out of the box
+- ✅ **Type-safe** - includes RBS type definitions for Steep/TypeProf
+- ✅ **Fully tested** - comprehensive test suite
+- ✅ **Rails 7.2+ compatible**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enum_errors_away'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install enum_errors_away
+```
+
+## Usage
+
+Once installed, the gem automatically works for all ActiveRecord models. No configuration needed!
+
+### Before (Rails 7.2+ without this gem):
+```ruby
+class Organization < ApplicationRecord
+  enum :status, { active: 0, inactive: 1 }           # Added in first migration
+  enum :billing_plan, { free: 0, paid: 1 }            # Added in second migration
+end
+
+# Running the first migration fails because billing_plan column doesn't exist yet!
+# You'd need to manually add: attribute :billing_plan, :integer
+```
+
+### After (with this gem):
+```ruby
+class Organization < ApplicationRecord
+  enum :status, { active: 0, inactive: 1 }
+  enum :billing_plan, { free: 0, paid: 1 }
+end
+
+# Migrations run successfully - attributes are automatically declared as integers
+# No manual attribute declarations needed!
+```
+
+## Features
+
+### All Enum Syntaxes Supported
+
+```ruby
+class User < ApplicationRecord
+  # Hash syntax
+  enum :status, { active: 0, inactive: 1 }
+
+  # Array syntax
+  enum :role, [:admin, :user, :guest]
+
+  # With options
+  enum :access_level, { basic: 0, premium: 1 }, prefix: true
+
+  # With Rails 7.2+ options
+  enum :visibility, { public: 0, private: 1 }, scopes: false
+end
+```
+
+### Legitimate Errors Still Raised
+
+The gem **only suppresses** the "Undeclared attribute type" error. Other enum errors are preserved:
+
+```ruby
+class Organization < ApplicationRecord
+  enum :status, { available: 0, unavailable: 1 }
+
+  # This will correctly raise an error about method collision
+  enum :availability, { available: 0, unavailable: 1 }
+  # ArgumentError: already defined by another enum
+end
+```
+
+### Type Safety with RBS
+
+The gem includes RBS type definitions for Steep and TypeProf:
+
+```ruby
+# Your types are automatically available
+module EnumErrorsAway
+  def self.enabled?: () -> bool
+  def self.configure: () { (singleton(EnumErrorsAway)) -> void } -> void
+end
+```
+
+## Configuration
+
+### Disabling the Gem
+
+You can disable the gem globally or conditionally:
+
+```ruby
+# config/initializers/enum_errors_away.rb
+EnumErrorsAway.configure do |config|
+  config.enabled = false
+end
+
+# Or conditionally
+EnumErrorsAway.enabled = Rails.env.production?
+```
+
+### Checking Status
+
+```ruby
+EnumErrorsAway.enabled?  # => true
+```
+
+## Real-World Example
+
+Here's the typical scenario this gem solves:
+
+```ruby
+# app/models/organization.rb
+class Organization < ApplicationRecord
+  enum :status, { active: 0, inactive: 1 }        # Added May 2024
+  enum :billing_plan, { free: 0, paid: 1 }        # Added June 2024
+  enum :notification_preference, { email: 0, sms: 1, both: 2 }  # Added July 2024
+end
+
+# db/migrate/20240501_add_status_to_organizations.rb
+class AddStatusToOrganizations < ActiveRecord::Migration[7.2]
+  def change
+    add_column :organizations, :status, :integer, default: 0
+  end
+end
+
+# db/migrate/20240601_add_billing_plan_to_organizations.rb
+class AddBillingPlanToOrganizations < ActiveRecord::Migration[7.2]
+  def change
+    add_column :organizations, :billing_plan, :integer, default: 0
+  end
+end
+
+# db/migrate/20240701_add_notification_preference_to_organizations.rb
+class AddNotificationPreferenceToOrganizations < ActiveRecord::Migration[7.2]
+  def change
+    add_column :organizations, :notification_preference, :integer, default: 0
+  end
+end
+```
+
+**Without this gem**: When a new developer runs `rails db:migrate` from scratch, the first migration fails because the model references enums that don't have columns yet.
+
+**With this gem**: All migrations run successfully. The gem automatically declares the missing enum attributes, and everything works seamlessly.
+
+## How It Works
+
+1. **Hooks into ActiveRecord** - Uses a Railtie to integrate with Rails initialization
+2. **Extends enum method** - Wraps the standard `enum` method via `ActiveSupport::Concern`
+3. **Pre-declares attributes** - Before defining an enum, checks if the attribute exists in the database; if not, declares it as `:integer`
+4. **Handles migration timing** - Gracefully handles database connection errors during migrations
+5. **Preserves error handling** - Only catches "Undeclared attribute type" errors; all other enum errors pass through
+6. **Zero runtime performance impact** - Only runs during class definition, not during model usage
+
+## Compatibility
+
+- **Ruby**: 3.1+
+- **Rails**: 7.2+
+
+## Development
+
+```bash
+# Install dependencies
+bundle install
+
+# Run tests
+bundle exec rake test
+
+# Run type checks
+bundle exec steep check
+```
+
+## Testing
+
+The gem includes a comprehensive test suite covering:
+- Enums without database columns
+- Enums with database columns
+- Multiple enum syntaxes (hash, array, with options)
+- Error handling (ensures legitimate errors aren't suppressed)
+- Configuration and enable/disable functionality
+- Integration with real Rails models
+
+Run tests with:
+```bash
+bundle exec rake test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sampokuokkanen/enum_errors_away.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+Created to solve the Rails 7.2+ enum declaration requirement while maintaining backward compatibility with existing codebases.

data/lib/enum_errors_away/active_record_extension.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module EnumErrorsAway
+  module ActiveRecordExtension # rubocop:todo Style/Documentation
+    extend ActiveSupport::Concern
+
+    class_methods do # rubocop:todo Metrics/BlockLength
+      # rubocop:todo Metrics/PerceivedComplexity
+      # rubocop:todo Metrics/MethodLength
+      # rubocop:todo Metrics/AbcSize
+      def enum(name, values = nil, **options) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
+        return super(name, values, **options) unless EnumErrorsAway.enabled?
+
+        # Extract enum definitions based on Rails 8 signature: enum(name, values = nil, **options)
+        definitions = if values.nil? && options.any?
+                        # enum(:status, active: 0, archived: 1) syntax
+                        { name => options.except(:prefix, :suffix, :scopes, :validate, :default, :_prefix, :_suffix,
+                                                 :_scopes, :_validate, :_default) }
+                      elsif values.is_a?(Hash)
+                        # enum(:status, { active: 0, archived: 1 }) syntax
+                        { name => values }
+                      elsif values.is_a?(Array)
+                        # enum(:status, [:active, :archived]) syntax
+                        { name => values }
+                      else
+                        # Fallback - shouldn't happen but just in case
+                        { name => values }
+                      end
+
+        # Pre-declare attributes for enum names that don't exist as columns
+        definitions.each do |enum_name, enum_values|
+          next if enum_name.nil? || enum_name.to_s.empty?
+          next if enum_values.nil?
+
+          begin
+            enum_name_str = enum_name.to_s
+            # @type var enum_name: Symbol | String
+            attribute enum_name, :integer if !attribute_types.key?(enum_name_str) && !columns_hash.key?(enum_name_str)
+          rescue ActiveRecord::StatementInvalid, ActiveRecord::ConnectionNotEstablished
+            # Ignore database errors during schema introspection
+          end
+        end
+
+        # Call the original enum method
+        begin
+          super(name, values, **options)
+        rescue ArgumentError => e
+          raise e unless e.message.include?('Undeclared attribute type for enum')
+
+          # Fallback: declare missing attributes and retry
+          definitions.each do |enum_name, enum_values|
+            next if enum_name.nil? || enum_name.to_s.empty?
+            next if enum_values.nil?
+
+            enum_name_str = enum_name.to_s
+            # @type var enum_name: Symbol | String
+            attribute enum_name, :integer unless attribute_types.key?(enum_name_str)
+          end
+          super(name, values, **options)
+        end
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/PerceivedComplexity
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.include(EnumErrorsAway::ActiveRecordExtension)
+end

data/lib/enum_errors_away/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module EnumErrorsAway
+  class Railtie < Rails::Railtie # rubocop:todo Style/Documentation
+    initializer 'enum_errors_away.suppress_enum_errors', before: 'active_record.set_configs' do
+      ActiveSupport.on_load(:active_record) do
+        require 'enum_errors_away/active_record_extension'
+      end
+    end
+  end
+end

data/lib/enum_errors_away/version.rb

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

data/lib/enum_errors_away.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'enum_errors_away/version'
+require 'enum_errors_away/railtie' if defined?(Rails)
+
+module EnumErrorsAway # rubocop:todo Style/Documentation
+  class << self
+    attr_accessor :enabled
+
+    def enabled?
+      @enabled != false
+    end
+
+    def configure
+      yield self
+    end
+  end
+end

data/sig/enum_errors_away.rbs

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module EnumErrorsAway
+  VERSION: String
+
+  @enabled: bool
+
+  def self.enabled: () -> bool
+  def self.enabled?: () -> bool
+  def self.enabled=: (bool value) -> bool
+  def self.configure: () { (singleton(EnumErrorsAway)) -> void } -> void
+
+  module ActiveRecordExtension : ActiveSupport::Concern
+    def self.class_methods: () { () -> void } -> void
+
+    def enum: (Symbol | String name, ?Array[Symbol] | Hash[Symbol, Integer] | nil values, **untyped options) -> void
+    def attribute: (Symbol | String name, Symbol type, **untyped options) -> void
+    def attribute_types: () -> Hash[String, untyped]
+    def columns_hash: () -> Hash[String, untyped]
+  end
+
+  class Railtie < Rails::Railtie
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: enum_errors_away
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sampo Kuokkanen
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Eliminates "Undeclared attribute type for enum" errors that occur when
+  running migrations with multiple enum columns added in separate migrations. Automatically
+  declares missing enum attributes as integers, preventing migration failures.
+email:
+- sampo.kuokkanen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/enum_errors_away.rb
+- lib/enum_errors_away/active_record_extension.rb
+- lib/enum_errors_away/railtie.rb
+- lib/enum_errors_away/version.rb
+- sig/enum_errors_away.rbs
+homepage: https://github.com/sampokuokkanen/enum_errors_away
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sampokuokkanen/enum_errors_away
+  source_code_uri: https://github.com/sampokuokkanen/enum_errors_away
+  changelog_uri: https://github.com/sampokuokkanen/enum_errors_away/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Fix Rails 7.2+ enum migration failures
+test_files: []