enumy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bfc350598385baf6ebb12df7a2585f9f9f60e0586cb62cea80d5b24147edc93
+  data.tar.gz: 977649afef0532bb37164c67f37cb455aaddf9b8146353170d28c69222ec413d
+SHA512:
+  metadata.gz: ae0d236ea8a2af53589294683ada6eb3c7ad92acb01862dd970d3354d0c3d615f3499b27e61037d55d337e0eec7c016189e60fe22efc807640833b508c6da57a
+  data.tar.gz: 8c544baca8ebb6ee40d92ba8c9a7dd155234bfd4e97a1494061604eb364a36cbae7256c35a9f0404fbf2552ccf7390fee9f6ab9f34a30554f079d563b5958100

data/lib/enumy/base.rb

@@ -0,0 +1,64 @@
+require_relative 'errors'
+
+module Enumy
+  class Base
+    include ActiveModel::Model
+
+    attr_accessor :id
+    attr_accessor :name
+
+    def initialize(id = nil, name = nil)
+      @id = id
+      @name = name
+    end
+
+    def human_attribute_name(attribute)
+      I18n.t("#{self.class.i18n_scope}.attributes.models.#{self.class.model_name.i18n_key}/#{self.name}.#{attribute}")
+    end
+
+    class << self
+
+      def register(enum)
+        if instances[enum.id]
+          warn "Enum `#{enum.name.to_s.upcase}` is using a duplicate id `#{enum.id}` for Enum '#{enum.class.name}'. Ignoring the duplicate."
+        else
+          instances[enum.id] = enum
+        end
+      end
+
+      def all
+        instances.values
+      end
+
+      def find(id)
+        find_by_id(id) || raise(Errors::EnumNotFoundError.new)
+      end
+
+      def find_by_id(id)
+        instances[id]
+      end
+
+      def find_by(**args)
+        instances.values.find do |instance|
+          args.all? { |attr, value| instance.send(attr) == value }
+        end
+      end
+
+      def model_name
+        @model_name ||= ActiveModel::Name.new(self.class, nil, name.to_s)
+      end
+
+      def i18n_scope
+        :enum
+      end
+
+      private
+
+      def instances
+        @instances ||= {}
+      end
+
+    end
+
+  end
+end

data/lib/enumy/errors.rb

@@ -0,0 +1,8 @@
+module Enumy
+  module Errors
+
+    class EnumNotFoundError < StandardError; end
+    class InvalidEnumClassError < NameError; end
+
+  end
+end

data/lib/enumy/model.rb

@@ -0,0 +1,25 @@
+require_relative 'base'
+require_relative 'errors'
+
+module Enumy
+  module Model
+    def belongs_to_enum(name, class_name: name, default: nil)
+      enum_class = class_name.to_s.classify.safe_constantize
+      raise Errors::InvalidEnumClassError if enum_class.nil? || !enum_class.ancestors.include?(Enumy::Base)
+
+      define_method "#{name}=" do |enum|
+        return nil unless self.has_attribute?("#{name}_id")
+        instance_variable_set("@#{name}", self.send("#{name}_id=", enum.id))
+      end
+
+      define_method "#{name}" do
+        enum = instance_variable_get("@#{name}")
+        return enum if enum
+        return nil unless self.has_attribute?("#{name}_id") && self.send("#{name}_id")
+        instance_variable_set("@#{name}", enum_class.find(self.send("#{name}_id")))
+      end
+
+      after_initialize -> { self.send("#{name}=", default) if self.send("#{name}").nil? && default.present? }
+    end
+  end
+end

data/lib/enumy/version.rb

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

data/lib/enumy.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'enumy/base'
+require 'enumy/model'
+require "generators/enumy/install/install_generator"

data/lib/generators/enumy/install/install_generator.rb

@@ -0,0 +1,20 @@
+module Enumy
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_application_enum
+        template "app/enums/application_enum.rb", "app/enums/application_enum.rb"
+      end
+
+      def add_application_record_concern
+        inject_into_file "app/models/application_record.rb", after: /^.*primary_abstract_class.*$/ do
+          <<~CODE
+      
+            \textend Enumy::Model\n
+          CODE
+        end
+      end
+    end
+  end
+end

data/lib/generators/enumy/install/templates/app/enums/application_enum.rb

@@ -0,0 +1,10 @@
+class ApplicationEnum < Enumy::Base
+  include ActiveModel::Attributes
+
+  attribute :id, :integer
+  attribute :name, :symbol
+
+  def initialize(id, name, **attrs)
+    super(id: id, name: name, **attrs)
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: enumy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bevan Holborn
+bindir: bin
+cert_chain: []
+date: 2025-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Use Enumeration objects as ActiveRecord like associations
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/enumy.rb
+- lib/enumy/base.rb
+- lib/enumy/errors.rb
+- lib/enumy/model.rb
+- lib/enumy/version.rb
+- lib/generators/enumy/install/install_generator.rb
+- lib/generators/enumy/install/templates/app/enums/application_enum.rb
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://gitlab.com/BevanHolborn/enumy
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: ActiveRecord like enum associations
+test_files: []