swifter_enum 0.9.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4faeac3f2e6714d5af882726817712536924044c725a0aa252de4f0e89072f43
-  data.tar.gz: 5c818c9815c9e4e5165475260ffd42b503b815ca7eb92307ea98a703b8c2a933
+  metadata.gz: 4147b58f08c0633761d7721503972bf4478d7b6295a634186810ebe146416bf8
+  data.tar.gz: 9fa17a88143342a5637866c8ac599a5bc9adb6e7ff3f28293aefac6957ef3767
 SHA512:
-  metadata.gz: 813389dc72d261ac9aa903484829009f8853ce4a0e6c017f8529996f2816858bdd13b4e5294f10b6a1c6dd93d3c1341e5c4e9a651f6b14712bf8fdddf49255a9
-  data.tar.gz: 39941760574f2ac9438ab61537273ed593e0a813200169dcdb68f863251992b8973aada7f3b094ef0aeb6182e7f87fe5bd30d61303bbd643e5bb0313a7f0e1c5
+  metadata.gz: c322303bcf61cd899f66b0e444de08a4d4826cc787d2ef5fa53bda9f81b15130d4da4b6d63455c1215f5ef14b3cb523ac6112b8d62d4f61da069336e3d69c5e0
+  data.tar.gz: 7e53b29f10e6908f3f9bf3f282c98d6e40f9a5c6bd5103d1beee337870c2ac53430cc3c0d0818c021731178c19e236d261573aa65fe6ce9b0d1a1b9624563e8a

data/CHANGELOG.md

@@ -1,5 +1,10 @@
-## [Unreleased]
 
-## [0.1.0] - 2024-01-22
+
+## [0.9.0] - 2024-03-10
 
 - Initial release
+
+
+## [0.9.1] - 2024-03-10
+
+- Fix use of options to use current syntax. Use prefix: true, rather than _prefix: true

data/README.md

@@ -1,9 +1,8 @@
 # SwifterEnum
 
 SwifterEnum is a Ruby gem for creating enumerated types (enums) in Ruby on Rails applications. 
-It is inspired by Swift's enums, and allows for more expressive and feature-rich enums in your models.
 
-Rather than simply having a key/value, enums are Classes, and can have defined methods.
+It is inspired by Swift's enums, and allows you to keep logic related to your enum directly in your enum class.
 
 so - after defining
 
@@ -14,7 +13,41 @@ so - after defining
 you can then define and access methods on your enum like
 
 `video.camera.icon`
-or `video.camera.default_exposure`
+
+This avoids helper methods which distribute your enum logic around your application.
+
+**Before**
+
+helper method somewhere in the app
+
+    #app/helpers/controller_helper.rb
+
+    def icon_for(camera:)
+      ...
+    end
+
+called with
+
+    icon_for(camera:my_model.camera)
+
+**After**
+
+logic encapsluated within the enum class
+
+    #app/models/swifter_enum/camera_enum.rb
+    class CameraEnum < SwifterEnum::Base
+      set_values ({ videographer: 0, handcam: 1 })
+
+      def icon
+        ...
+      end
+    end
+
+called with
+
+    my_model.camera.icon
+
+I was prompted to create this gem by reading about enum approaches in [the RailsNotes Newsletter](https://railsnotes.beehiiv.com/p/issue-17-enums-value-objects-field-guide-enum-sort-in-order-of). Like any good programmer, none of those solutions *quite* met my requirements. Hopefully it will be useful. I welcome feedback, fixes and pull requests.
 
 
 ## Installation
@@ -23,16 +56,14 @@ Add this line to your application's Gemfile:
 
     gem 'swifter_enum'
 
-And then execute:
-
-    bundle install
-
 ## Usage
 
 ### Overview
 
 
-SwifterEnums act like a normal Rails enum - except that instead of returning symbol values, they return an instance of your selected class
+SwifterEnums act like a normal Rails enum - except that instead of returning string values, they return an instance of your selected class.
+
+They also have various affordances so that in many cases, you can treat them as if they return symbol values.
 
 We have a Video ActiveModel with an enum defined by
 
@@ -43,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
@@ -92,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
@@ -135,24 +162,24 @@ 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
 
     swifter_enum :album_status, AlbumStatusEnum, prefix: true
 
+(note - prefix: optional. I'm adding it here because it was an option I used on my original standard Rails enum)
+
 Optionally, add
 
     validates :album_status, swifter_enum: true
@@ -205,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.
@@ -229,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,4 +12,33 @@ 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"
+  task :publish do
+    # Read version
+    version_file_path = File.expand_path("../lib/swifter_enum/version.rb", __FILE__)
+    version_file_content = File.read(version_file_path)
+    version_match = version_file_content.match(/VERSION = "(\d+\.\d+\.\d+)"/)
+    unless version_match
+      puts "Version could not be found in #{version_file_path}"
+      exit 1
+    end
+    version = version_match[1]
+    gem_name = "swifter_enum-#{version}.gem"
+
+    # Build gem
+    Rake::Task["build"].invoke
+
+    # Git tag
+    system("git add .")
+    system("git commit -m 'Release version #{version}'")
+    system("git tag -a #{version} -m 'Version #{version} release'")
+    system("git push origin main --tags")
+
+    # Push gem to RubyGems
+    system("gem push pkg/#{gem_name}")
+  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

@@ -6,7 +6,7 @@ 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)
+      enum(enum_name, enum_klass.values, **enum_options)
 
       # Define getter method
       define_method(enum_name) do

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.0"
+  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.0
+  version: 0.9.2
 platform: ruby
 authors:
 - Rob Jonson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-09 00:00:00.000000000 Z
+date: 2024-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,10 +80,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.22'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple enum for active record that takes inspiration from Swift's enums
-  to allow you to add logic to your enum definition. 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.
+  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.
 email:
 - rob@hobbyistsoftware.com
 executables: []
@@ -104,7 +118,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,45 +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 add logic to your enum definition. 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"
-  spec.add_dependency "activesupport", "~> 7.0"
-  spec.add_dependency "activemodel", "~> 7.0"
-
-  # Specify development dependencies
-  spec.add_development_dependency "sqlite3", "~> 1.4" # For using SQL
-  spec.add_development_dependency "minitest", "~> 5.22"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end