enum_fields 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52a056fc46a1cb6934d9dc11ab2717f4babb8b32ee2ccf6a85ab97b147517152
-  data.tar.gz: b1d671075bbebd910032795752b42da8a94123c7f245f8c7f4cfb99a874eae1c
+  metadata.gz: 4aba8fff03dbdf4c90cbe1b6ab1237ae6c06173b90b121e4b8766d5d43999b2e
+  data.tar.gz: 949a56d075cca6f44244cd72e9e31da089f4752793eb905758cdff3c32a1cee7
 SHA512:
-  metadata.gz: 76715e583a3cff76e5cd00da9c88060a0fe38d9d46e8899ba987014483a968ac8a678ac66f3847263021c7851d51e45e709a349fe6650fb369f5d347f8f2e0f6
-  data.tar.gz: 3ffce4b7a7830e2744cc1aed9f80c908646658733eea38ae312188262713b0ac9ef37fe868dd2d1cbc5f0572c1a096aab90d55b467457b0b16875d03d463f0f5
+  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

@@ -4,6 +4,6 @@ Enum Fields
 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.0.5.gem`
+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/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.1"
+  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.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Kinnell Shah