human_enum 0.1.3 → 1.1.3

data/lib/human_enum.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require 'human_enum/version'
+require 'active_support'
 require 'active_support/concern'
 require 'active_support/core_ext/array'
+require 'active_support/core_ext/module/deprecation'
 require 'active_model/naming'
 require 'active_model/translation'
 require 'active_record/type'
@@ -18,25 +20,67 @@ module HumanEnum
 
   extend ActiveSupport::Concern
 
+  class << self
+    def deprecator = @deprecator ||= ActiveSupport::Deprecation.new('2.0', 'HumanEnum')
+  end
+
   included do
-    def human_enum_value(enum_name)
-      enum_value = send enum_name
-      self.class.human_enum_value(enum_name, enum_value) unless enum_value.nil?
+    # DEPRECATED: This method is deprecated and will be removed in future versions.
+    #
+    # Returns the human-readable value of the specified enum.
+    #
+    # @param enum_name [Symbol] The name of the enum.
+    # @return [String] The human-readable value of the enum.
+    # @deprecated Use `human_<enum_name>` instead.
+    # :nocov:
+    def human_enum_value(enum_name, enum_value)
+      _translate_enum(enum_name, enum_value)
+    end
+    # :nocov:
+
+    deprecate(human_enum_value: 'use `human_<enum_name>` instead', deprecator: HumanEnum.deprecator)
+
+    private
+
+    def _translate_enum(enum_name, enum_value = send(enum_name))
+      self.class.send(:_translate_enum, enum_name, enum_value)
     end
   end
 
-  class_methods do
-    def enum(definitions)
-      super definitions
+  class_methods do # rubocop:disable Metrics/BlockLength
+    def enum(...)
+      super(...).tap { humanize_enums }
+    end
 
-      definitions.keys.without(:_prefix, :_suffix).each do |name|
-        human_enum name
+    # DEPRECATED: This method is deprecated and will be removed in future versions.
+    #
+    # Translates the given enum value into a human-readable string.
+    #
+    # @param enum_name [Symbol] The name of the enum.
+    # @param enum_value [Symbol] The value of the enum.
+    # @return [String] The human-readable string representation of the enum value.
+    # @deprecated Use `human_<plural_enum_name>` instead.
+    # :nocov:
+    def human_enum_value(enum_name, enum_value)
+      _translate_enum(enum_name, enum_value)
+    end
+    # :nocov:
+
+    deprecate(human_enum_value: 'use `human_<plural_enum_name>` instead', deprecator: HumanEnum.deprecator)
+
+    # Goes through all enums defined in the model and creates the necessary methods, if they don't exist yet.
+    def humanize_enums
+      defined_enums.each do |enum_name, values|
+        _define_instance_method(enum_name)
+        _define_class_method(enum_name, values)
       end
     end
 
-    def human_enum_value(enum_name, enum_value)
+    private
+
+    def _translate_enum(enum_name, enum_value)
       attributes_scope = "#{i18n_scope}.attributes"
-      enum_key = "#{enum_name.to_s.pluralize}.#{enum_value}"
+      enum_key = [enum_name.to_s.pluralize, enum_value].compact.join('.')
 
       defaults = lookup_ancestors.map do |klass|
         :"#{attributes_scope}.#{klass.model_name.i18n_key}.#{enum_key}"
@@ -45,17 +89,23 @@ module HumanEnum
       defaults << :"attributes.#{enum_key}"
       defaults << enum_value.to_s.humanize
 
-      I18n.translate defaults.shift, default: defaults
+      I18n.t defaults.shift, default: defaults
     end
 
-    def human_enum(enum_name)
-      send :define_method, "human_#{enum_name}" do
-        human_enum_value enum_name
+    def _define_instance_method(enum_name)
+      return if method_defined?(:"human_#{enum_name}")
+
+      define_method(:"human_#{enum_name}") do
+        _translate_enum(enum_name, send(enum_name))
       end
+    end
 
+    def _define_class_method(enum_name, values)
       collection_name = enum_name.to_s.pluralize
+      return if respond_to?(:"human_#{collection_name}")
+
       self.class.send :define_method, "human_#{collection_name}" do
-        human_enum_value enum_name, nil
+        values.to_h { |key, _| [key.to_sym, _translate_enum(enum_name, key)] }
       end
     end
   end

metadata

@@ -1,182 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: human_enum
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.1.3
 platform: ruby
 authors:
 - Rafael Soares
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2025-03-12 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.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'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.72.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.72.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.36'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.36'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.15'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: guard-rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 description: |-
   This gem allows you to specify enum value translations
       like any other ActiveRecord attribute and adds helper methods to get
       humanized translations of enum values
 email:
-- rafasoaresms@gmail.com
+- 893971+rafasoares@users.noreply.github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".github/FUNDING.yml"
-- ".github/workflows/gempush.yml"
+- ".codeclimate.yml"
+- ".devcontainer/devcontainer.json"
+- ".github/dependabot.yml"
+- ".github/workflows/publish.yml"
+- ".github/workflows/test-results.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".rspec"
@@ -184,16 +52,24 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - CODEOWNERS
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Gemfile.rails-6.1.lock
+- Gemfile.rails-7.0.lock
+- Gemfile.rails-7.1.lock
+- Gemfile.rails-7.2.lock
+- Gemfile.rails-8.0.lock
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/rake
+- bin/rspec
 - bin/setup
 - human_enum.gemspec
 - lib/human_enum.rb
@@ -204,8 +80,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/rafasoares/human_enum
   source_code_uri: https://github.com/rafasoares/human_enum
-  changelog_uri: https://github.com/rafasoares/human_enum/blob/master/CHANGELOG.md
-post_install_message: 
+  changelog_uri: https://github.com/rafasoares/human_enum/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -213,15 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Adds simple and easy I18n support for Rails enums
 test_files: []

data/.circleci/config.yml

@@ -1,15 +0,0 @@
-version: 2.1
-orbs:
-  ruby: circleci/ruby@0.1.2
-
-jobs:
-  build:
-    docker:
-      - image: circleci/ruby:2.6.4-stretch-node
-    executor: default
-    steps:
-      - checkout
-      - run:
-          name: Which bundler?
-          command: bundle -v
-      - ruby/bundle-install

data/.github/FUNDING.yml

@@ -1,12 +0,0 @@
-# These are supported funding model platforms
-
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: rafasoares
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: rafasoares 
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.github/workflows/gempush.yml

@@ -1,41 +0,0 @@
-name: Ruby Gem
-
-on:
-  push:
-    branches:
-      - master
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@master
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        version: 2.6.x
-
-    - name: Publish to GPR
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
-      env:
-        GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
-        OWNER: rafasoares
-
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}