power_enum 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e64bc976c66ec97d00cd14baabeb0fa7c13afc66500bb8408bc9d1e884be30ee
-  data.tar.gz: 43f0a3fa296b90154d32b82a38d8ae207b0b8f400edc821ded353e341ddb5187
+  metadata.gz: e2f8367b2fd4b4e5d5620725c8f8133db78fe9a3737bb00d2019546345215fc1
+  data.tar.gz: 0ef3b6a9709516dba463b137aae4a7aab54a3374abaf6c91c7dcd87c1fc0e7a5
 SHA512:
-  metadata.gz: b36b482f22cf0ddc61e817f77838a245a250a3c28771c0d0e39d8e23f29b782abd93fbb06c84fa6b009f66bdb510933b0e292a8ceeed60d190caeeeba24d05f2
-  data.tar.gz: 2731947e3bb7d5f9b91fffd726db29ab26451536fc60b8110886d2d8ed3402af9f8f0d10471bea00c83f36e4577476df2fb1c2cdebe106b74d684e80d7637d33
+  metadata.gz: c7857ebcf50b49d544afd0acaf3f6b366cf9f022030613eafcc64eaed6befdbb53fa768ec5880ef6ccc972aca32d08cdb021d3e18a9352bcfeade06add26d25d
+  data.tar.gz: '08b4955a6492efcc9845432d39d09b498fbb341ae69e3859e19b55d0baa3f19d0661ae7adf10dfda0aff685d22e1b66bc1fe941dbf83f928ca2a7f1d23198eae'

data/README.markdown

@@ -63,26 +63,7 @@ See "How to use it" below for more information.
 
 ## Installation
 
-### READ THIS FIRST
-
-This gem is signed. The public key is available
-here: https://github.com/albertosaurus/power_enum (look for gem-public\_cert.pem). Hence, if
-you can get an error like the following if you're installing in `HighSecurity` mode.
-
-```
-ERROR:  While executing gem ... (RuntimeError)
-    Couldn't verify data signature: Untrusted Signing Chain Root: cert = 'cert name', error = 'path "/your_gem_home/.gem/trust/cert-blah.pem" does not exist'
-```
-
-If this happens, you need to add the PowerEnum public cert to your gem cert
-store. Download the certificate (gem-public\_cert.pem) and run the following.
-
-    gem cert -a gem-public_cert.pem
-
-More information is available at http://guides.rubygems.org/security/
-which I strongly urge you to read.
-
-#### Using Bundler
+### Using Bundler
 
 Add the gem to your Gemfile
 
@@ -92,7 +73,7 @@ then run
 
     bundle install
 
-#### Manual Installation
+### Manual Installation
 
     gem install power_enum
 
@@ -298,10 +279,12 @@ drop_table :booking_statuses
 class BookingStatus < ActiveRecord::Base
   acts_as_enumerated  :conditions        => 'optional_sql_conditions',
                       :order             => 'optional_sql_order_by',
-                      :on_lookup_failure => :optional_class_method, #This also works: lambda{ |arg| some_custom_action }
-                      :name_column       => 'optional_name_column'  #If required, may override the default name column
-                      :alias_name        => false                   #If set to false and have name_column set, will not
-                                                                    #  alias :name to the name column attribute.
+                      :on_lookup_failure => :optional_class_method, # This also works: lambda{ |arg| some_custom_action }
+                      :name_column       => 'optional_name_column'  # If required, may override the default name column
+                      :alias_name        => false,                  # If set to false and have name_column set, will not
+                                                                    #   alias :name to the name column attribute.
+                      :freeze_members    => true                    # Optional, default is true in prod.
+                                                                    # This also works: lambda { true }
 end
 ```
 

data/lib/power_enum/enumerated.rb

@@ -33,8 +33,11 @@ module PowerEnum::Enumerated
     # [:name_column]
     #   Override for the 'name' column.  By default, assumed to be 'name'.
     # [:alias_name]
-    #   By default, if a name column is not 'name', will create an alias of 'name' to the name_column attribute.  Set
+    #   By default, if a name column is not 'name', will create an alias of 'name' to the name_column attribute. Set
     #   this to +false+ if you don't want this behavior.
+    # [:freeze_members]
+    #   Specifies whether individual enum instances should be frozen on database load. By default, true in production.
+    #   Can be either a lambda or a boolean.
     #
     # === Examples
     #
@@ -66,10 +69,11 @@ module PowerEnum::Enumerated
     #    acts_as_enumerated :conditions        => [:exclude => false],
     #                       :order             => 'created_at DESC',
     #                       :on_lookup_failure => lambda { |arg| raise CustomError, "BookingStatus lookup failed; #{arg}" },
-    #                       :name_column       => :status_code
+    #                       :name_column       => :status_code,
+    #                       :freeze_members    => true
     #  end
     def acts_as_enumerated(options = {})
-      valid_keys = [:conditions, :order, :on_lookup_failure, :name_column, :alias_name]
+      valid_keys = [:conditions, :order, :on_lookup_failure, :name_column, :alias_name, :freeze_members]
       options.assert_valid_keys(*valid_keys)
 
       valid_keys.each do |key|
@@ -79,7 +83,6 @@ module PowerEnum::Enumerated
         end
       end
 
-      class_attribute :acts_enumerated_name_column
       self.acts_enumerated_name_column = get_name_column(options)
 
       unless self.is_a? PowerEnum::Enumerated::EnumClassMethods
@@ -138,7 +141,6 @@ module PowerEnum::Enumerated
       end # class_eval
 
     end
-    private :extend_enum_class_methods
 
     # Determines if the name column should be explicitly aliased
     def should_alias_name?(options) #:nodoc:
@@ -148,7 +150,6 @@ module PowerEnum::Enumerated
         true
       end
     end
-    private :should_alias_name?
 
     # Extracts the name column from options or gives the default
     def get_name_column(options) #:nodoc:
@@ -158,7 +159,6 @@ module PowerEnum::Enumerated
         :name
       end
     end
-    private :get_name_column
   end
 
   # These are class level methods which are patched into classes that act as
@@ -174,7 +174,19 @@ module PowerEnum::Enumerated
     # Returns all the enum values.  Caches results after the first time this method is run.
     def all
       return @all if @all
-      @all = load_all.collect{|val| val.freeze}.freeze
+
+      freeze_handler = if (handler = self.acts_enumerated_freeze_members).nil?
+                         -> { Rails.env.production? }
+                       else
+                         case handler
+                         when Proc
+                           handler
+                         else
+                           -> { handler }
+                         end
+                       end
+
+      @all = load_all.collect{ |val| !!freeze_handler.call ? val.freeze : val }.freeze
     end
 
     # Returns all the active enum values.  See the 'active?' instance method.
@@ -314,15 +326,14 @@ module PowerEnum::Enumerated
 
     # ---Private methods---
 
-    def load_all
+    private def load_all
       conditions = self.acts_enumerated_conditions
       order      = self.acts_enumerated_order
       unscoped.where(conditions).order(order)
     end
-    private :load_all
 
     # Looks up the enum based on the type of the argument.
-    def lookup_enum_by_type(arg)
+    private def lookup_enum_by_type(arg)
       case arg
       when Symbol
         lookup_name(arg.id2name)
@@ -339,10 +350,9 @@ module PowerEnum::Enumerated
                          " be a String, Symbol or Integer but got a: #{arg.class.name}"
       end
     end
-    private :lookup_enum_by_type
 
     # Deals with a lookup failure for the given argument.
-    def handle_lookup_failure(arg)
+    private def handle_lookup_failure(arg)
       if (lookup_failure_handler = self.acts_enumerated_on_lookup_failure)
         case lookup_failure_handler
         when Proc
@@ -354,16 +364,14 @@ module PowerEnum::Enumerated
         self.send(:enforce_none, arg)
       end
     end
-    private :handle_lookup_failure
 
     # Returns a hash of all enumeration members keyed by their ids.
-    def all_by_id
+    private def all_by_id
       @all_by_id ||= all_by_attribute( primary_key )
     end
-    private :all_by_id
 
     # Returns a hash of all the enumeration members keyed by their names.
-    def all_by_name
+    private def all_by_name
       begin
         @all_by_name ||= all_by_attribute( :__enum_name__ )
       rescue NoMethodError => err
@@ -373,9 +381,8 @@ module PowerEnum::Enumerated
         raise
       end
     end
-    private :all_by_name
 
-    def all_by_attribute(attr) # :nodoc:
+    private def all_by_attribute(attr) # :nodoc:
       aba = all.inject({}) { |memo, item|
         memo[item.send(attr)] = item
         memo
@@ -383,42 +390,35 @@ module PowerEnum::Enumerated
       aba.freeze unless enumerations_model_updating?
       aba
     end
-    private :all_by_attribute
 
-    def enforce_none(arg) # :nodoc:
+    private def enforce_none(arg) # :nodoc:
       nil
     end
-    private :enforce_none
 
-    def enforce_strict(arg) # :nodoc:
+    private def enforce_strict(arg) # :nodoc:
       raise_record_not_found(arg)
     end
-    private :enforce_strict
 
-    def enforce_strict_literals(arg) # :nodoc:
+    private def enforce_strict_literals(arg) # :nodoc:
       raise_record_not_found(arg) if (Integer === arg) || (Symbol === arg)
       nil
     end
-    private :enforce_strict_literals
 
-    def enforce_strict_ids(arg) # :nodoc:
+    private def enforce_strict_ids(arg) # :nodoc:
       raise_record_not_found(arg) if Integer === arg
       nil
     end
-    private :enforce_strict_ids
 
-    def enforce_strict_symbols(arg) # :nodoc:
+    private def enforce_strict_symbols(arg) # :nodoc:
       raise_record_not_found(arg) if Symbol === arg
       nil
     end
-    private :enforce_strict_symbols
 
     # raise the {ActiveRecord::RecordNotFound} error.
     # @private
-    def raise_record_not_found(arg)
+    private def raise_record_not_found(arg)
       raise ActiveRecord::RecordNotFound, "Couldn't find a #{self.name} identified by (#{arg.inspect})"
     end
-    private :raise_record_not_found
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power_enum
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Trevor Squires
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler