swifter_enum 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b72cb72dc43be470b8170fd34843f2f2e7ddb4d64a2856c7094b63c0ba091e2
-  data.tar.gz: 791abe5497d7c623e9b5e5ef9554a00f2c242b74b4f0668e018d7cc7be2d0752
+  metadata.gz: 4147b58f08c0633761d7721503972bf4478d7b6295a634186810ebe146416bf8
+  data.tar.gz: 9fa17a88143342a5637866c8ac599a5bc9adb6e7ff3f28293aefac6957ef3767
 SHA512:
-  metadata.gz: b4f5bf8eab4588d23098bf11bab794205369820c0b6900b7dfa9f2d51cc85d489af4a9007a807d65c392b313cfb1201249a12650e4674cc77ed682cbb52f305e
-  data.tar.gz: 0a6226463dd0041d3c4999813b483ca274af966d82665cb0b10c7385ea682012775d835196edd231f2400a542c63f14148da2abfab61c0fda825e2af9ab9e8f9
+  metadata.gz: c322303bcf61cd899f66b0e444de08a4d4826cc787d2ef5fa53bda9f81b15130d4da4b6d63455c1215f5ef14b3cb523ac6112b8d62d4f61da069336e3d69c5e0
+  data.tar.gz: 7e53b29f10e6908f3f9bf3f282c98d6e40f9a5c6bd5103d1beee337870c2ac53430cc3c0d0818c021731178c19e236d261573aa65fe6ce9b0d1a1b9624563e8a

data/README.md

@@ -36,9 +36,7 @@ logic encapsluated within the enum class
 
     #app/models/swifter_enum/camera_enum.rb
     class CameraEnum < SwifterEnum::Base
-      def self.values
-        { videographer: 0, handcam: 1 }.freeze
-      end
+      set_values ({ videographer: 0, handcam: 1 })
 
       def icon
         ...
@@ -76,9 +74,7 @@ We have a Video ActiveModel with an enum defined by
 CameraEnum is a class like the following
 
     class CameraEnum < SwifterEnum::Base
-      def self.values
-        { videographer: 0, handcam: 1 }.freeze
-      end
+      set_values ({ videographer: 0, handcam: 1 })
 
       def icon
         case @value
@@ -125,9 +121,7 @@ Models are by convention stored in `/models/swifter_enum/your_model_enum.rb`
 Example:
 
     class CameraEnum < SwifterEnum::Base
-      def self.values
-        { videographer: 0, handcam: 1 }.freeze
-      end
+      set_values ({ videographer: 0, handcam: 1 })
 
       def icon
         case @value
@@ -168,18 +162,16 @@ run the generator to create an appropriate enum class
 Insert the values of your enum into `models/swifter_enum_album_status_enum.rb`
 
     class AlbumStatusEnum < SwifterEnum::Base
-      def self.values
-        {
-          waiting_for_footage: 0,
-          waiting_for_upload: 10,
-          uploading: 20,
-          processing_preview: 24,
-          delivered_preview: 26,
-          processing_paid: 30,
-          delivered_paid: 50,
-          processing_failed: 60
-        }.freeze
-      end
+      set_values ({
+                    waiting_for_footage: 0,
+                    waiting_for_upload: 10,
+                    uploading: 20,
+                    processing_preview: 24,
+                    delivered_preview: 26,
+                    processing_paid: 30,
+                    delivered_paid: 50,
+                    processing_failed: 60
+                  })
     end
 
 Now replace the definition in your model file with
@@ -240,10 +232,7 @@ For example, to create a `CameraEnum`, run:
 This command will generate a file `app/models/swifter_enum/camera_enum.rb` with the following structure:
 
     class CameraEnum < SwifterEnum::Base
-      def self.values
-        # Insert your values here. e.g. { foo: 1, bar: 2 }.freeze
-        { }.freeze
-      end
+      set_values <<Your Values Here>>
     end
 
 After generating your enum, you can add your specific enum values and use it in your ActiveRecord models.
@@ -264,6 +253,23 @@ Locale file example (`config/locales/en.yml`):
     #example usage
     v.camera.t => "Videographer"
 
+### Using string values to store Enum
+
+DHH has described using integer values for enums as a mistake he regrets.
+
+He has shown code like
+
+    enum direction: %w[ up down left right ].index_by(&:itself)
+
+which uses string values in the db by generating the hash `{"up"=>"up", "down"=>"down", "left"=>"left", "right"=>"right"}`
+
+Swifter enum allows the same - but lets you simply set your values using an array of strings or symbols
+
+    set_values %w[ up down left right]
+    #or
+    set_values [:up,:down,:left,:right]
+
+
 ### Raw Value Escape Hatch
 
 SwifterEnum is built on top of the normal Rails enum functionality.

data/Rakefile

@@ -12,7 +12,6 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-
 # publish with rake release:publish
 namespace :release do
   desc "Read version, build gem, tag and push release"
@@ -42,5 +41,4 @@ namespace :release do
   end
 end
 
-
 task default: [:standard, :test]

data/lib/swifter_enum/base.rb

@@ -1,11 +1,31 @@
 module SwifterEnum
   class Base
-    attr_reader :value
+    class << self
+      attr_accessor :values
+
+      def set_values(input)
+        case input
+        when Hash
+          @values = input
+        when Array
+          validate_array_elements!(input)
+          @values = input.map { |item| [item.to_sym, item.to_s] }.to_h
+        else
+          raise ArgumentError, "Input must be a Hash or an Array of symbols or strings"
+        end
+      end
+
+      private
 
-    def self.values
-      {}
+      def validate_array_elements!(array)
+        unless array.all? { |item| item.is_a?(Symbol) || item.is_a?(String) }
+          raise ArgumentError, "Array elements must all be symbols or strings"
+        end
+      end
     end
 
+    attr_reader :value
+
     def initialize(value)
       @value = value&.to_sym
     end

data/lib/swifter_enum/generators/enum/templates/enum.rb.tt

@@ -3,12 +3,14 @@
 
 class <%= class_name %>Enum < SwifterEnum::Base
 
-  def self.values
-    # Insert your values here as you would for a normal enum
-    # { foo: 1, bar: 2 }.freeze
+  #set your values using a hash, or array of symbols
+  #if you're using a hash with symbol:integer, then your database column should be of integer type
+  # e.g. set_values ({active: 10, inactive: 20})
+  # or set_values active: 10, inactive: 20
+  #if you're using an array of symbols (or strings), then your database column should be of string type
+  # e.g. set_values [:active,:passive]
 
-    { }.freeze
-  end
+  set_values <<Your Values Here>>
 
   # you can now define methods on the enum
   # this would allow you to access YourModel.<%= file_name %>.squared

data/lib/swifter_enum/swifter_enum.rb

@@ -5,7 +5,6 @@ module SwifterEnum
 
   class_methods do
     def swifter_enum(enum_name, enum_klass, enum_options = {})
-
       # Define the enum using values from the enum class
       enum(enum_name, enum_klass.values, **enum_options)
 

data/lib/swifter_enum/swifter_enum_validator.rb

@@ -3,13 +3,18 @@ require "active_model"
 module SwifterEnum
   class SwifterEnumValidator < ActiveModel::EachValidator
     def validate_each(record, attribute, a_value)
-      return if options[:allow_nil] && a_value.nil?
-
       if !a_value.is_a?(SwifterEnum::Base) || a_value.instance_of?(SwifterEnum::Base)
         record.errors.add(attribute, "#{a_value.value} is not a valid subclass of SwifterEnum")
       end
 
+      if a_value.value.nil?
+        return if options[:allow_nil]
+
+        record.errors.add(attribute, "nil value for #{attribute} is not allowed")
+      end
+
       unless a_value.class.values.key?(a_value.value)
+        # binding.b
         record.errors.add(attribute, "#{a_value.value} is not a valid #{attribute} type")
       end
     end

data/lib/swifter_enum/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swifter_enum
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Rob Jonson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-10 00:00:00.000000000 Z
+date: 2024-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord