swifter_enum 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f70feef4d3937618d057d99d62e1f08cc3a733580c523f9e131508d2386d1a1e
-  data.tar.gz: d47f2661ab4bf284eb13b7c40c358a226c6a6c5fc416567498fa312a4abc7960
+  metadata.gz: b447021b43c633d5d52bdaa9d10175e121eab3ebdefcd8400fb12421c0b127af
+  data.tar.gz: 3d960b5fb93cf81659d049ceba6c40bf397f2f3d051c05e136579738a9f35d2b
 SHA512:
-  metadata.gz: c522bc3565a9e6d98da82f8e4e61b59e1e00632348600ab0d1550dd56760e4b1bc76a9e2e3c1a5a4de8f93131f81e051e239aa0d74327f46c65c99fe0f4eb40b
-  data.tar.gz: 2d3e496779b2c8ad21d393286279de27353c7c04f71f749ab8f15c371e270f936c08e5e108d79c564798eba640f2f5bf2bfedfd6076ee1d88acc3ba7b6b9187f
+  metadata.gz: 1a4c829b0768b63f2de100eaa8439e066db41b1d8ea6fcf62691121d15c6c16f6b7c70395bd1fd08d34074e05a39fd26326d1dab4f60fdb8d26610047c91d8ea
+  data.tar.gz: 200af325588c59f48568cda24b3125aa420fd6354d66a3c589b58aa879bb37f337fbc09f770d6de321bde9359091affe0130ce201c15215c7ad74bc838aad458

data/CLAUDE.md

@@ -0,0 +1,46 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Commands
+
+### Testing
+- Run all tests: `bundle exec appraisal rake test`
+- Run specific test file: `bundle exec appraisal rake test TEST=test/path/to/test_file.rb`
+- Test with specific Rails version: `bundle exec appraisal rails-7.1 rake test`
+
+### Code Quality
+- Run Standard Ruby linter: `standardrb`
+- Auto-fix linting issues: `standardrb --fix`
+
+### Building & Publishing
+- Build gem: `rake build`
+- Release new version: `rake release:publish` (builds, tags, and publishes to RubyGems)
+
+## Architecture
+
+SwifterEnum is a Ruby gem that extends Rails ActiveRecord enums by using classes instead of simple string/integer values. This allows encapsulating enum-related logic within the enum class itself.
+
+### Core Components
+
+1. **SwifterEnum::Base** (`lib/swifter_enum/base.rb`): Base class for all enum implementations. Key methods:
+   - `set_values`: Defines enum values (accepts hash of symbol->integer or array of symbols/strings)
+   - Instance comparison via `==` supports symbols, strings, and other enum instances
+   - `t` method for i18n translations
+   - `in?` method for collection checking
+
+2. **SwifterEnum Module** (`lib/swifter_enum/swifter_enum.rb`): ActiveSupport::Concern that adds `swifter_enum` class method to ActiveRecord models. Creates:
+   - Getter returning enum class instance
+   - Setter accepting enum instances or raw values
+   - `_raw` getter/setter for backward compatibility with standard Rails enums
+   - `_raws` class method returning the value mappings
+
+3. **SwifterEnumValidator** (`lib/swifter_enum/swifter_enum_validator.rb`): Custom validator for enum attributes
+
+4. **Generator** (`lib/swifter_enum/generators/enum/enum_generator.rb`): Rails generator for creating new enum classes in `app/models/swifter_enum/`
+
+### Integration Pattern
+
+Models use `swifter_enum :attribute_name, EnumClass` instead of standard Rails `enum`. This maintains database compatibility while returning enum class instances that can have custom methods.
+
+The gem maintains full backward compatibility through `_raw` accessors, making it easy to migrate existing Rails enums incrementally.

data/README.md

@@ -97,7 +97,31 @@ This provides a richer approach to enums:
     v.camera => #<CameraEnum:0x000000013385f078 @value=:videographer> 
 
     #the purpose of this gem is that you can now define and access methods on the CameraEnum
-    v.camera.icon => "icons/video-camera" 
+    v.camera.icon => "icons/video-camera"
+
+
+### Safe Value Access with Bracket Notation
+
+You can use bracket notation to safely access enum values, which will raise an error if you try to access a non-existent value:
+
+    # Access enum values with bracket notation
+    emotion = EmotionEnum[:happy]
+    emotion => #<EmotionEnum:0x0000000134c7c290 @value=:happy>
+
+    # Raises ArgumentError for invalid values
+    EmotionEnum[:invalid]  # ArgumentError: Unknown enum value: :invalid
+
+    # Must use symbols, not strings
+    EmotionEnum["happy"]   # ArgumentError: Enum key must be a Symbol, got String
+
+This is useful when you want to ensure you're only using valid enum values, such as when processing user input or configuration:
+
+    # Example: Setting a model attribute with validation
+    video.camera = CameraEnum[:videographer]  # Safe - will raise if :videographer doesn't exist
+
+    # Example: Using with dynamic values
+    status_key = params[:status].to_sym
+    model.status = StatusEnum[status_key]  # Will raise error if status_key is invalid
 
 
 ### Using Enums in ActiveRecord Models

data/gemfiles/rails_7.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    swifter_enum (0.9.7)
+    swifter_enum (1.0.0)
       activemodel (>= 7.0, < 9.0)
       activerecord (>= 7.0, < 9.0)
       activesupport (>= 7.0, < 9.0)

data/gemfiles/rails_8.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    swifter_enum (0.9.7)
+    swifter_enum (1.0.0)
       activemodel (>= 7.0, < 9.0)
       activerecord (>= 7.0, < 9.0)
       activesupport (>= 7.0, < 9.0)

data/lib/swifter_enum/base.rb

@@ -19,6 +19,18 @@ module SwifterEnum
         @values.keys.map { |key| new(key) }
       end
 
+      def [](key)
+        unless key.is_a?(Symbol)
+          raise ArgumentError, "Enum key must be a Symbol, got #{key.class}"
+        end
+
+        unless @values.key?(key)
+          raise ArgumentError, "Unknown enum value: :#{key}. Valid values are: #{@values.keys.map { |k| ":#{k}" }.join(", ")}"
+        end
+
+        new(key)
+      end
+
       private
 
       def validate_array_elements!(array)

data/lib/swifter_enum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SwifterEnum
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swifter_enum
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Rob Jonson
@@ -138,6 +138,7 @@ files:
 - ".standard.yml"
 - Appraisals
 - CHANGELOG.md
+- CLAUDE.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -154,7 +155,6 @@ files:
 - lib/swifter_enum/swifter_enum_validator.rb
 - lib/swifter_enum/version.rb
 - sig/swifter_enum.rbs
-- swifter_enum.gemspec
 homepage: https://github.com/ConfusedVorlon/SwifterEnum
 licenses:
 - MIT

data/swifter_enum.gemspec

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/swifter_enum/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "swifter_enum"
-  spec.version = SwifterEnum::VERSION
-  spec.authors = ["Rob Jonson"]
-  spec.email = ["rob@hobbyistsoftware.com"]
-
-  spec.summary = "Active Record enum that uses a class, so you can add methods."
-  spec.description = "Simple enum for active record that takes inspiration from Swift's enums to allow you to encapsulate enum logic within an enum class. This is easy to drop-in as a replacement for regular rails enums, with minimal changes required. Once you switch, then you can easily extend your enums with methods."
-  spec.homepage = "https://github.com/ConfusedVorlon/SwifterEnum"
-  spec.license = "MIT"
-
-  # I'm using 3.2 and above. If you're willing/able to test on lower rubies, then please let me know and feel free to change this.
-  spec.required_ruby_version = ">= 3.2.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/ConfusedVorlon/SwifterEnum"
-  spec.metadata["changelog_uri"] = "https://github.com/ConfusedVorlon/SwifterEnum"
-
-  # 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 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", ">= 7.0", "< 9.0"
-  spec.add_dependency "activesupport", ">= 7.0", "< 9.0"
-  spec.add_dependency "activemodel", ">= 7.0", "< 9.0"
-
-  # Specify development dependencies
-  spec.add_development_dependency "sqlite3", ">= 1.4"
-  spec.add_development_dependency "minitest", "~> 5.22"
-  spec.add_development_dependency "debug"
-  spec.add_development_dependency "appraisal", "~> 2.4"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end