humanize_enum 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d6163c9c0cc6895cda69e255abc7c953814c863e76300d70b2916c8e2b245eb
-  data.tar.gz: da44277aabc9a034de3090b5f202ff49339d68b71d0213714b7c7254e2f45208
+  metadata.gz: e87b96ee4668b93f22c2bc46b9875370731950ade9a93fc7f8bb39430eb6b442
+  data.tar.gz: 9a68e4e3fcb1bcfb1c053ea737dc4e9e8eeed78644a786850f042fe874c10d29
 SHA512:
-  metadata.gz: dbc0ce238f10c8215b7555aa964d5f5611bfb8133eb521ebb98ed3c3c66641c402d25aa222877bfe85d4c94e79be272f06f19963cb4c9ce65ccfb56a0d6d8898
-  data.tar.gz: 6815ee75ea944d1c6df5cfde200d5c7190d852898eb2ea79e1b071b74069e88e62a37cd22db0d5e3439b9e0fcd85c400c08422def32c63d5a222c062c292dcd8
+  metadata.gz: 57553ef0eb58356028d0a5b9d4b7883284e80e1a06ea09cbface928763875df9ffa10141d94315a7f1419d9f4e3973df4495fc730ec210d79993061238344529
+  data.tar.gz: 3c3deb9f52281157c34dc207c5355b1eb90d2cf864ea865a8e145bc2bb9cf717bda7c3a7591628d083b988df7b99e4ac994bd376ed3fa26eb8392d27a2548d3e

data/README.md

@@ -151,6 +151,18 @@ Document.dehumanize_enum(:documentable_type, 'Article') # => :article
 ```
 
 
+### Configuration
+
+Before using `humanize_enum`, you should ensure it has been configured properly. Specifically, the `check_defined_enums` option should be set to `false` if you plan to use `humanize_enum` with polymorphic association types.
+```ruby
+# config/initializers/humanize_enum.rb
+HumanizeEnum.configure do |config|
+  config.check_defined_enums = false
+end
+```
+In absence of this configuration, humanize_enum would attempt to verify if the provided attribute is a defined enum, which is not what you want when working with polymorphic types. By default, `check_defined_enums` is true.
+
+
 ## Inspired by
 
 - a post by [Juraj Kostolanský](https://www.kostolansky.sk/posts/localize-rails-enums/) and

data/lib/humanize_enum/class_methods.rb

@@ -49,6 +49,7 @@ module HumanizeEnum
     # @param enum_name [String, Symbol]
     # @raise [UnknownEnumKey] if enum_name is not a defined enum
     def check_enum!(enum_name)
+      return unless HumanizeEnum.configuration.check_defined_enums
       raise UnknownEnumKey unless defined_enums.has_key?(enum_name.to_s)
     end
   end

data/lib/humanize_enum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HumanizeEnum
-  VERSION = '0.1.9'
+  VERSION = '0.1.10'
 end

data/lib/humanize_enum.rb

@@ -7,6 +7,25 @@ require 'active_support/lazy_load_hooks'
 require 'active_support/inflector'
 
 module HumanizeEnum
+  class Configuration
+    attr_accessor :check_defined_enums
+
+    def initialize
+      @check_defined_enums = true
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  # create configure class method to yield the config class
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
 
   # Error for an unknown enum key
   UnknownEnumKey = Class.new(StandardError)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: humanize_enum
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Max Buslaev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-21 00:00:00.000000000 Z
+date: 2024-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport