enumy 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eaa9f4a13fabe8f6011960a4df6ef9dcba23b7005f18aa19a898b0b1af6e273e
-  data.tar.gz: bbfd3f1b0c2ce4ecab2d55ffbe87b70859e7f858b914b514b9fadb77f857fc66
+  metadata.gz: 0c55b6f482c9297c67a5149c3d2c349c89018f89eec176d2e76fdb993bcc6d39
+  data.tar.gz: 0076a894f5661321360342fb1d3264f0e26b86d64858201b308908131a95714a
 SHA512:
-  metadata.gz: 8679f98840a6f998b59135357f23817833de47f2c1311779af1a14220faacaac1f9c9f83faecf5a186401d2731e1d955fa7b5d9d984a74b6f404f2487b1adf90
-  data.tar.gz: ba4c1b04664e3d4d8b697050a5068d01207744610027306046c9413c4593423dddfd5b725224551b21d7aa96841568aeda5d46e3af79142d1ffcc5926d8c7d4b
+  metadata.gz: 402f4d93a29fcfb54a940c063f95e2d11ba430cca569710e94283e12405a66f9c47df7de77c7cee8e0e1aea718b0ebe01ac53a59273a34a11ada78e05f68de75
+  data.tar.gz: 075243c844f724728cfc7dfc645d68fc24cc3f62e25a0367be9bacadb50918e563ca9fc70cf2198798c79bdd4f9522484b603fe8115c38eb07a0255e21c10824

data/lib/enumy/active_job/serializers/enum_serializer.rb

@@ -0,0 +1,28 @@
+require 'enumy/base.rb'
+
+module Enumy
+  module ActiveJob
+    module Serializers
+      class EnumSerializer < ::ActiveJob::Serializers::ObjectSerializer
+
+        def serialize(enum)
+          super({ class: enum.class.name, key: enum.key.to_s })
+        end
+
+        def deserialize(hash)
+          hash[:class].constantize.find_by_key(hash[:key])
+        end
+
+        def serialize?(value)
+          value.is_a?(klass)
+        end
+
+        private
+
+        def klass
+          Enumy::Base
+        end
+      end
+    end
+  end
+end

data/lib/enumy/active_model/type/enum.rb

@@ -0,0 +1,32 @@
+module Enumy
+  module ActiveModel
+    module Type
+      class Enum < ::ActiveModel::Type::Value
+        def initialize(enum_class)
+          @enum_class = enum_class
+          super()
+        end
+
+        def cast(value)
+          value.is_a?(@enum_class) ? value : @enum_class.find_by_key(value&.to_sym)
+        end
+
+        def serialize(value)
+          if value.is_a?(@enum_class)
+            value.key.to_s
+          else
+            @enum_class.find_by_key(value&.to_sym) ? value&.to_s : nil
+          end
+        end
+
+        def deserialize(value)
+          value.is_a?(@enum_class) ? value : @enum_class.find_by_key(value&.to_sym)
+        end
+
+        def type
+          :enum
+        end
+      end
+    end
+  end
+end

data/lib/enumy/base.rb

@@ -2,8 +2,8 @@ require_relative 'errors'
 
 module Enumy
   class Base
-    include ActiveModel::Model
-    include ActiveModel::Attributes
+    include ::ActiveModel::Model
+    include ::ActiveModel::Attributes
 
     attribute :key
 
@@ -18,6 +18,10 @@ module Enumy
       I18n.t("#{self.class.i18n_scope}.attributes.models.#{self.class.model_name.i18n_key}/#{self.key}.#{attribute}")
     end
 
+    def name
+      self.key.to_s
+    end
+
     def to_s
       self.key.to_s
     end
@@ -29,8 +33,10 @@ module Enumy
     class << self
 
       def define(enum)
+        raise ArgumentError, "Expected an object of type `Enumy::Base`, got #{enum.class.name}" unless enum.is_a?(Enumy::Base)
+
         if instances[enum.key]
-          raise ArgumentError, "Enum `#{enum.key.to_s.upcase}` is using a duplicate key `#{enum.key}` for Enum '#{enum.class.name}'."
+          raise Errors::DuplicateEnumInstanceError, "Enum `#{enum.key.to_s.upcase}` is using a duplicate key `#{enum.key}` for Enum '#{enum.class.name}'."
         else
           instances[enum.key] = enum
         end
@@ -45,17 +51,20 @@ module Enumy
       end
 
       def find_by_key(key)
+        key = key.to_sym if key.is_a?(String)
         instances[key]
       end
 
       def find_by(**args)
+        raise ArgumentError, "`find_by` requires at least one key-value pair" if args.empty?
+
         instances.values.find do |instance|
           args.all? { |attr, value| instance.send(attr) == value }
         end
       end
 
       def model_name
-        @model_name ||= ActiveModel::Name.new(self, nil, self.name.to_s)
+        @model_name ||= ::ActiveModel::Name.new(self, nil, self.name.to_s)
       end
 
       def i18n_scope

data/lib/enumy/errors.rb

@@ -3,6 +3,7 @@ module Enumy
 
     class EnumNotFoundError < StandardError; end
     class InvalidEnumClassError < NameError; end
+    class DuplicateEnumInstanceError < ArgumentError; end
 
   end
 end

data/lib/enumy/model.rb

@@ -6,7 +6,7 @@ module Enumy
     def has_enum(name, class_name: name, **options)
       enum_class = class_name.to_s.classify.safe_constantize
 
-      assert_valid_enum_type!(enum_class)
+      assert_valid_enum_type!(enum_class, class_name)
       define_enum_attributes(name, enum_class, default: options[:default])
       define_enum_validations(name, enum_class) unless options[:optional]
     end
@@ -21,9 +21,9 @@ module Enumy
       validates name, presence: true, inclusion: { in: enum_class.all }
     end
 
-    def assert_valid_enum_type!(enum_class)
+    def assert_valid_enum_type!(enum_class, class_name)
       if enum_class.nil?
-        raise Errors::InvalidEnumClassError, "Could not resolve class `#{enum_class.name.to_s.classify}`"
+        raise Errors::InvalidEnumClassError, "Could not resolve class `#{class_name.to_s.classify}`"
       elsif !enum_class.ancestors.include?(Enumy::Base)
         raise Errors::InvalidEnumClassError, "`#{enum_class.name}` does not inherit from `#{Enumy::Base.name}`"
       end

data/lib/enumy/rails/railtie.rb

@@ -0,0 +1,11 @@
+require 'enumy/active_job/serializers/enum_serializer'
+
+module Enumy
+  class Railtie < Rails::Railtie
+    initializer "enumy.register_active_job_serializer" do |app|
+      if Rails::VERSION::MAJOR >= 6
+        app.config.active_job.custom_serializers << Enumy::ActiveJob::Serializers::EnumSerializer
+      end
+    end
+  end
+end

data/lib/enumy/test_helpers.rb

@@ -0,0 +1,28 @@
+module Enumy
+  module TestHelpers
+    def with_enum_defined(enum_class, enum_instance)
+      enum_class.define(enum_instance)
+
+      yield
+
+      enum_class.send(:instances).delete(enum_instance.key)
+      enum_const_name = enum_class.constants.find { |const_name| enum_class.const_get(const_name) == enum_instance }
+      remove_const(enum_const_name) if enum_const_name
+    end
+
+    def enum_model_class(&block)
+      base_class = Class.new(ApplicationRecord) do
+        extend Enumy::Model
+
+        class << self
+          def name
+            "TempModel"
+          end
+        end
+      end
+
+      base_class.class_exec(&block) if block
+      base_class
+    end
+  end
+end

data/lib/enumy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Enumy
-  VERSION = "0.2.1"
+  VERSION = "0.4.0"
 end

data/lib/enumy.rb

@@ -1,4 +1,15 @@
-require 'enumy/base'
-require 'enumy/model'
-require 'generators/enumy/install/install_generator'
-require 'active_model/type/enum'
+require 'enumy/version'
+
+if defined?(ActiveModel)
+  require 'enumy/base'
+end
+
+if defined?(Rails)
+  require 'enumy/generators/enumy/install/install_generator'
+  require 'enumy/active_model/type/enum'
+  require 'enumy/model'
+
+  if defined?(Rails::Railtie)
+    require 'enumy/rails/railtie'
+  end
+end

metadata

@@ -1,28 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: enumy
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Bevan Holborn
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-21 00:00:00.000000000 Z
+date: 2025-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -37,24 +38,43 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 description: Use Enumeration objects as ActiveRecord like associations
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/active_model/type/enum.rb
 - lib/enumy.rb
+- lib/enumy/active_job/serializers/enum_serializer.rb
+- lib/enumy/active_model/type/enum.rb
 - lib/enumy/base.rb
 - lib/enumy/errors.rb
+- lib/enumy/generators/enumy/install/install_generator.rb
+- lib/enumy/generators/enumy/install/templates/app/enums/application_enum.rb
 - lib/enumy/model.rb
+- lib/enumy/rails/railtie.rb
+- lib/enumy/test_helpers.rb
 - lib/enumy/version.rb
-- lib/generators/enumy/install/install_generator.rb
-- lib/generators/enumy/install/templates/app/enums/application_enum.rb
 homepage: https://rubygems.org/gems/enumy
 licenses:
 - MIT
 metadata:
   source_code_uri: https://gitlab.com/BevanHolborn/enumy
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -62,14 +82,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: ActiveRecord like enum associations
 test_files: []

data/lib/active_model/type/enum.rb

@@ -1,26 +0,0 @@
-module ActiveModel
-  module Type
-    class Enum < ActiveModel::Type::Value
-      def initialize(enum_class)
-        @enum_class = enum_class
-        super()
-      end
-
-      def cast(value)
-        value.is_a?(@enum_class) ? value : @enum_class.find_by_key(value&.to_sym)
-      end
-
-      def serialize(value)
-        value.is_a?(@enum_class) ? value.key : value&.to_s
-      end
-
-      def deserialize(value)
-        value.is_a?(@enum_class) ? value : @enum_class.find_by_key(value&.to_sym)
-      end
-
-      def type
-        :enum
-      end
-    end
-  end
-end