enumy 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eb558fc84613c310a1f660e944233954a74d9c613dc777ac68d67305d55b168
-  data.tar.gz: 057cf069fe5810e2ef4af942c1b52f7ab253e6bcef4726bf094877cdcc50e3da
+  metadata.gz: 8967f465fedf7db2ebaed2f024a942ed580d4ace8fac502a8a144d9720685d99
+  data.tar.gz: 708184decf1b1f474735792e53c4ec529a3317e3b824c2a7889b26f2eb0e6884
 SHA512:
-  metadata.gz: 0c8b3606430fa433bac4af10b1946bfa1c3690d9010fb3a013e5aaec49876a879eaaa3aebbe3719c9e8f2155ec5cc0ae640a88e830189fc35746614b41af96b2
-  data.tar.gz: 743aeeffc4604c367940f3e6b38aecf66bed583f91c63a6406d22c4d070982d7569c25feaa379b7ba1e1568a6b18625d5fd401cc6bde1ceace5648a8769c0bd6
+  metadata.gz: 7e9bcf100b39f8f84363f9932b9785f6d208e16af94b455991eff8eb5092350de31457368769f496c71837381bf7749d9e15f61001d8bcf43aa430a635482a72
+  data.tar.gz: 7b4052eb2852bd40cc9aefed3afeb398b6b5e832f4a1aa66d77342eca8439170b3737e4d0df2f571e1ce085d512a8437ca4de90d049fa7e0cfaf28935c308e15

data/lib/active_model/type/enum.rb

@@ -0,0 +1,26 @@
+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

data/lib/enumy/base.rb

@@ -5,27 +5,34 @@ module Enumy
     include ActiveModel::Model
     include ActiveModel::Attributes
 
-    attribute :id
-    attribute :name
+    attribute :key
 
-    def initialize(id, name, **attrs)
-      raise ArgumentError, "#{self.class.name.upcase} enum requires an `id`" if id.nil?
-      raise ArgumentError, "#{self.class.name.upcase} enum requires a `name`" if name.nil?
+    def initialize(key, **attrs)
+      raise ArgumentError, "#{self.class.name.upcase} enum requires a `key`" if key.nil?
+      key = key.to_sym
 
-      super(id: id, name: name, **attrs)
+      super(key: key, **attrs)
     end
 
     def human_attribute_name(attribute)
-      I18n.t("#{self.class.i18n_scope}.attributes.models.#{self.class.model_name.i18n_key}/#{self.name}.#{attribute}")
+      I18n.t("#{self.class.i18n_scope}.attributes.models.#{self.class.model_name.i18n_key}/#{self.key}.#{attribute}")
+    end
+
+    def to_s
+      self.key.to_s
+    end
+
+    def inspect
+      "#<#{self.class.name} #{attributes.map { |name, value| "#{name}: #{value.inspect}" }.join(', ')}>"
     end
 
     class << self
 
-      def register(enum)
-        if instances[enum.id]
-          raise ArgumentError, "Enum `#{enum.name.to_s.upcase}` is using a duplicate id `#{enum.id}` for Enum '#{enum.class.name}'."
+      def define(enum)
+        if instances[enum.key]
+          raise ArgumentError, "Enum `#{enum.key.to_s.upcase}` is using a duplicate key `#{enum.key}` for Enum '#{enum.class.name}'."
         else
-          instances[enum.id] = enum
+          instances[enum.key] = enum
         end
       end
 
@@ -33,12 +40,12 @@ module Enumy
         instances.values
       end
 
-      def find(id)
-        find_by_id(id) || raise(Errors::EnumNotFoundError.new("Could not find a `#{name}` enum with an `id` of #{id}"))
+      def find(key)
+        find_by_key(key) || raise(Errors::EnumNotFoundError.new("Could not find a `#{self.name}` enum with a `key` of #{key}"))
       end
 
-      def find_by_id(id)
-        instances[id]
+      def find_by_key(key)
+        instances[key]
       end
 
       def find_by(**args)
@@ -48,7 +55,7 @@ module Enumy
       end
 
       def model_name
-        @model_name ||= ActiveModel::Name.new(self, nil, name.to_s)
+        @model_name ||= ActiveModel::Name.new(self, nil, self.name.to_s)
       end
 
       def i18n_scope

data/lib/enumy/model.rb

@@ -3,48 +3,30 @@ require_relative 'errors'
 
 module Enumy
   module Model
-    def belongs_to_enum(name, class_name: name, default: nil)
+    def has_enum(name, class_name: name, **options)
       enum_class = class_name.to_s.classify.safe_constantize
-      
-      if enum_class.nil?
-        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`"
-      end
-
-      define_method "#{name}=" do |enum|
-        raise NameError, "Enum `#{enum_class.name}` expected #{self.class.name} to have attribute `#{name}_id`." unless self.has_attribute?("#{name}_id")
 
-        if enum
-          raise Errors::InvalidEnumClassError, "Expected an enum of type `#{enum_class.name}`, got `#{enum.class.name}`" if enum_class != enum.class
-          self.send("#{name}_id=", enum.id)
-        else
-          self.send("#{name}_id=", nil)
-        end
-
-        instance_variable_set("@#{name}", enum)
-      end
+      assert_valid_enum_type!(enum_class)
+      define_enum_attributes(name, enum_class, default: options[:default])
+      define_enum_validations(name, enum_class) unless options[:optional]
+    end
 
-      define_method "#{name}" do
-        enum = instance_variable_get("@#{name}")
-        return enum if enum
+    private
 
-        raise NameError, "Enum `#{enum_class.name}` expected #{self.class.name} to have attribute `#{name}_id`." unless self.has_attribute?("#{name}_id")
-        return nil unless self.send("#{name}_id")
-        instance_variable_set("@#{name}", enum_class.find(self.send("#{name}_id")))
-      end
+    def define_enum_attributes(name, enum_class, **options)
+      attribute name, ActiveModel::Type::Enum.new(enum_class), default: -> { options[:default] }
+    end
 
-      define_method "#{name}_id=" do |new_id|
-        super(new_id)
+    def define_enum_validations(name, enum_class)
+      validates name, presence: true, inclusion: { in: enum_class.all }
+    end
 
-        if new_id
-          instance_variable_set("@#{name}", enum_class.find(new_id))
-        else
-          instance_variable_set("@#{name}", nil)
-        end
+    def assert_valid_enum_type!(enum_class)
+      if enum_class.nil?
+        raise Errors::InvalidEnumClassError, "Could not resolve class `#{enum_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
-
-      after_initialize -> { self.send("#{name}=", default) if self.has_attribute?("#{name}_id") && self.send("#{name}").nil? && default.present? }
     end
   end
 end

data/lib/enumy/version.rb

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

data/lib/enumy.rb

@@ -1,3 +1,4 @@
 require 'enumy/base'
 require 'enumy/model'
 require 'generators/enumy/install/install_generator'
+require 'active_model/type/enum'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: enumy
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Bevan Holborn
 bindir: bin
 cert_chain: []
-date: 2025-03-14 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -42,6 +42,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/active_model/type/enum.rb
 - lib/enumy.rb
 - lib/enumy/base.rb
 - lib/enumy/errors.rb