enum_fields 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9d8952fea1c21107106addd2a2dc5f7d02348d2c0c3d99210d892c08e5b9b5b
-  data.tar.gz: 48ce6bb0b1b97a0fba166605469c0247143ea0f217ed2e5348c1757d124719d2
+  metadata.gz: 4aba8fff03dbdf4c90cbe1b6ab1237ae6c06173b90b121e4b8766d5d43999b2e
+  data.tar.gz: 949a56d075cca6f44244cd72e9e31da089f4752793eb905758cdff3c32a1cee7
 SHA512:
-  metadata.gz: cb50aeafc28d33cc7cb09a69ec946581b0bd9a6560c29f08511846dc88050ddbb69bcc12a0fc0841881d2b46c6ff2afd04cd4962ccb00dabf303eafe78ebdf74
-  data.tar.gz: cea3d418bbc42e7789c025f2400c67a6587898282360b8673aefa716e6d2331b0d224e8dffbdb91b385bda5165828804704525d0bc56ffb7ca326dca39714060
+  metadata.gz: 586be756530f00da32796e169e531b1d0ca0233d18b1993997f4d38686e797d1e51e8acb85daaa2ebafbad25cbdb7f604c2bd07b2592a99f203622d3591a9095
+  data.tar.gz: a6f73682ed1cf7f02cdec75ed3e8116c42f9c950428b029eb0b7a87542e2b5ad8309fec276853000e5f8bb055e6e0dbc63642748b0f3542ec5251821ead55255

data/README.md

@@ -103,16 +103,6 @@ This automatically generates:
 }
 ```
 
-#### Custom Column Mapping
-
-If your accessor name differs from your column name:
-
-```ruby
-class User < ApplicationRecord
-  enum_field :role, definitions, column: :user_role
-end
-```
-
 ### Generated Methods
 
 For an enum field defined as:
@@ -227,6 +217,82 @@ Campaign.completed_stage
 
 Automatically validates that the column value is included in the defined values (with `allow_nil: true`).
 
+### Options
+
+#### `column`
+
+Map the accessor to a different database column name:
+
+```ruby
+enum_field :role, definitions, column: :user_role
+```
+
+#### `scope`
+
+Controls whether query scopes are generated. Defaults to `true`. Set to `false` to skip scope generation:
+
+```ruby
+enum_field :speed, definitions, scope: false
+```
+
+#### `validate`
+
+Controls whether inclusion validation is added. Defaults to `true`. Set to `false` to skip validation:
+
+```ruby
+enum_field :speed, definitions, validate: false
+```
+
+### Virtual Attributes
+
+`enum_field` works with computed/virtual attributes that aren't backed by a database column. Define a method on the model and use `scope: false` and `validate: false` since those features require a real column:
+
+```ruby
+class Segment < ApplicationRecord
+  enum_field :size_category, {
+    small: {
+      value: "small",
+      label: "Small (< 100)",
+    },
+    medium: {
+      value: "medium",
+      label: "Medium (< 1K)",
+    },
+    large: {
+      value: "large",
+      label: "Large (< 10K)",
+    },
+  }, scope: false, validate: false
+
+  def size_category
+    case profiles_count
+    when ...100
+      "small"
+    when 100...1_000
+      "medium"
+    else
+      "large"
+    end
+  end
+end
+```
+
+All instance methods work as expected:
+
+```ruby
+segment.size_category           # "small"
+segment.size_category_label     # "Small (< 100)"
+segment.size_category_metadata  # { value: "small", label: "Small (< 100)" }
+segment.small_size_category?    # true
+```
+
+Class methods (options, values, counts) also work normally:
+
+```ruby
+Segment.size_category_options # [["Small (< 100)", "small"], ["Medium (< 1K)", "medium"], ...]
+Segment.size_category_values  # ["small", "medium", "large"]
+```
+
 ### Custom Properties
 
 You can add any custom properties to your definitions, and the gem will automatically create accessor methods for them:

data/___release.md

@@ -0,0 +1,9 @@
+Enum Fields
+
+1. Update version.rb
+2. Commit "Bump version to 0.0.X"
+3. `rake release`
+   Even if API error comes, just do:
+4. And then just `gem push pkg/enum_fields-0.2.1.gem`
+
+gem push pkg/enum_fields-0.2.0.gem

data/lib/enum_fields/definition.rb

@@ -37,23 +37,46 @@ module EnumFields
         when Hash
           input.with_indifferent_access
         when Array
-          input.to_h do |value|
-            [value, { value: value }]
-          end.with_indifferent_access
+          build_from_array(input)
         else
           raise InvalidDefinitionsError, "Invalid definitions format: #{input.class}"
         end
       end
 
       output.transform_values do |metadata|
+        metadata = metadata.with_indifferent_access
+
         if metadata.key?(:label)
           metadata
         else
-          metadata.merge(label: metadata[:value])
+          metadata.merge(label: metadata[:value].to_s)
         end
       end
     end
 
+    def build_from_array(input)
+      input.to_h do |element|
+        metadata = normalize_item(element)
+
+        [normalize_key(metadata[:value]), metadata]
+      end.with_indifferent_access
+    end
+
+    def normalize_item(item)
+      if item.is_a?(Hash)
+        item.with_indifferent_access
+      else
+        {
+          value: item,
+          label: item.to_s,
+        }
+      end
+    end
+
+    def normalize_key(value)
+      value.to_s.to_sym
+    end
+
     def valid_hash?(data)
       return false unless data.is_a?(HashWithIndifferentAccess)
       return false unless data.values.all? { |metadata| metadata.key?(:value) }

data/lib/enum_fields/enum_field.rb

@@ -104,7 +104,7 @@ module EnumFields
       column_name = @column_name
 
       @model_class.define_method("#{accessor}_metadata") do
-        column_value = attributes[column_name.to_s]
+        column_value = public_send(column_name)
         return nil if column_value.nil?
 
         definitions = self.class.enum_field_for(accessor)
@@ -120,7 +120,7 @@ module EnumFields
 
       @definition.properties.each do |property|
         @model_class.define_method("#{accessor}_#{property}") do
-          column_value = attributes[column_name.to_s]
+          column_value = public_send(column_name)
           return nil if column_value.nil?
 
           definitions = self.class.enum_field_for(accessor)
@@ -145,6 +145,8 @@ module EnumFields
     end
 
     def define_scopes!
+      return unless column_scopeable?
+
       column_name = @column_name
 
       @definition.each do |key, metadata|
@@ -192,10 +194,6 @@ module EnumFields
       end
     end
 
-    def column_validatable?
-      @definition.present? && @options.fetch(:validate, true)
-    end
-
     def column_polymorphic_association_name
       return nil unless @model_class.respond_to?(:reflect_on_all_associations)
 
@@ -205,5 +203,13 @@ module EnumFields
 
       reflection&.name
     end
+
+    def column_scopeable?
+      @definition.present? && @options.fetch(:scope, true)
+    end
+
+    def column_validatable?
+      @definition.present? && @options.fetch(:validate, true)
+    end
   end
 end

data/lib/enum_fields/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EnumFields
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enum_fields
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kinnell Shah
@@ -60,9 +60,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE
 - README.md
+- ___release.md
 - lib/enum_fields.rb
 - lib/enum_fields/base.rb
 - lib/enum_fields/definition.rb
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.7
 specification_version: 4
 summary: Enhanced enum-like fields for ActiveRecord models with metadata support
 test_files: []

data/CHANGELOG.md

@@ -1,21 +0,0 @@
-# Changelog
-
-## [0.0.1] - 2025-11-17
-
-### Added
-
-- Initial release of EnumFields gem
-- Support for enum-like fields with metadata properties
-- Array and Hash definition formats
-- Automatic generation of:
-  - Class methods (`<accessor>s`, `<accessor>s_count`, `<accessor>_values`, `<accessor>_options`)
-  - Instance getter/setter methods (when accessor differs from column)
-  - Metadata accessor methods (`<accessor>_metadata`)
-  - Property accessor methods for all defined properties (`<accessor>_<property>`)
-  - Inquiry methods (`<key>_<accessor>?`)
-  - Scopes (`<key>_<accessor>`)
-  - Validations (inclusion with `allow_nil: true`)
-- Custom column mapping support via `column:` option
-- Dynamic property method generation for custom properties
-
-[0.0.1]: https://github.com/kinnell/enum_fields/releases/tag/v0.0.1