power_enum 3.1.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 62f78fa7a580eaeb3f024857990083633b16bb84
-  data.tar.gz: e2d6b28e0ac710338ac343cbc6f82ca889eeb258
+SHA256:
+  metadata.gz: e2f8367b2fd4b4e5d5620725c8f8133db78fe9a3737bb00d2019546345215fc1
+  data.tar.gz: 0ef3b6a9709516dba463b137aae4a7aab54a3374abaf6c91c7dcd87c1fc0e7a5
 SHA512:
-  metadata.gz: 9df60352bf0960811460e14c38a97e792369f9d46cd4378c95ca7983f384abb38e0f018870802f74c12f24713af152e896cf8955c615fbb23f7ed6cbdcf1441c
-  data.tar.gz: 27ef578eb74cfbef342cd50c310f72f3f9c16fc49c8c13e9d2f325dbe7cf1cca06523765adce1ffd1ed31e6379772ad974210932f54b970aefb51b76a8fcdc6c
+  metadata.gz: c7857ebcf50b49d544afd0acaf3f6b366cf9f022030613eafcc64eaed6befdbb53fa768ec5880ef6ccc972aca32d08cdb021d3e18a9352bcfeade06add26d25d
+  data.tar.gz: '08b4955a6492efcc9845432d39d09b498fbb341ae69e3859e19b55d0baa3f19d0661ae7adf10dfda0aff685d22e1b66bc1fe941dbf83f928ca2a7f1d23198eae'

data/README.markdown

@@ -10,7 +10,7 @@ Enumerations for Rails Done Right.
 
 ## Versions
 
-* PowerEnum 3.X (this version) supports Rails 4.2 and Rails 5.X
+* PowerEnum 3.X (this version) supports Rails 4.2, Rails 5.X and Rails 6.0
 * PowerEnum 2.X supports Rails 4.X and Rails 5.0
 * PowerEnum 1.X supports Rails 3.1/3.2, available here: https://github.com/albertosaurus/power_enum
 
@@ -54,7 +54,7 @@ See "How to use it" below for more information.
 ### PowerEnum 3.X
 
 * Ruby 2.1 or later (JRuby should work but isn't extensively tested; Travis is being difficult).
-* Rails 4.2, 5.0, 5.1
+* Rails 4.2, 5.0, 5.1, 5.2, 6.0
 
 ### PowerEnum 2.X
 
@@ -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
 
@@ -198,7 +179,7 @@ create_table :bookings do |t|
   t.timestamps
 end
 ```
-    
+
 There are two methods added to Rails migrations:
 
 ##### create\_enum(enum\_name, options = {}, &block)
@@ -285,7 +266,7 @@ Example:
 ```ruby
 remove_enum :booking_status
 ```
-    
+
 is the equivalent of
 
 ```ruby
@@ -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
 ```
 
@@ -341,6 +324,10 @@ other value.
 `BookingStatus.all` returns an array of all BookingStatus records that match the `:conditions` specified in
 `acts_as_enumerated`, in the order specified by `:order`.
 
+##### all_except(*items)
+
+`BookingStatus.all_except(arg1, arg2)` returns an array of all BookingStatus records with the given items filtered out.
+
 ##### active
 
 `BookingStatus.active` returns an array of all BookingStatus records that are marked active. See the `active?` instance
@@ -784,7 +771,7 @@ Execute the test setup script:
 #### Manually (if required)
 
 Go to the 'dummy' project:
-    
+
     cd ./spec/dummy
 
 If this is your first time, create the test database
@@ -808,7 +795,7 @@ Go back to gem root directory:
 * Initial Version Copyright (c) 2005 Trevor Squires
 * Rails 3 Updates Copyright (c) 2010 Pivotal Labs
 * Initial Test Suite Copyright (c) 2011 Sergey Potapov
-* Subsequent Updates Copyright (c) 2011-2016 Arthur Shagall
+* Subsequent Updates Copyright (c) 2011-2020 Arthur Shagall
 
 Released under the MIT License. See the LICENSE file for more details.
 

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.
@@ -194,6 +206,11 @@ module PowerEnum::Enumerated
       all.map { |item| item.name_sym }
     end
 
+    # Returns all except for the given list
+    def all_except(*excluded)
+      all.find_all { |item| !(item === excluded) }
+    end
+
     # Enum lookup by Symbol, String, or id.  Returns <tt>arg<tt> if arg is
     # an enum instance.  Passing in a list of arguments returns a list of
     # enums.  When called with no arguments, returns nil.
@@ -309,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)
@@ -334,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
@@ -349,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
@@ -368,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
@@ -378,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
 

data/lib/power_enum/reflection.rb

@@ -63,6 +63,8 @@ of these associations is deprecated and will be removed in the future.
       @active_record_primary_key ||= options[:primary_key] || active_record.primary_key
     end
 
+    alias_method :join_primary_key, :active_record_primary_key
+
     def klass
       @klass ||= active_record.send(:compute_type, class_name)
     end
@@ -87,6 +89,8 @@ of these associations is deprecated and will be removed in the future.
       @foreign_key ||= (@options[:foreign_key] || "#{@name}_id").to_s
     end
 
+    alias_method :join_foreign_key, :foreign_key
+
     # Returns the name of the enum table
     def table_name
       @table_name ||= self.class.const_get(class_name).table_name
@@ -116,6 +120,11 @@ of these associations is deprecated and will be removed in the future.
       false
     end
 
+    # Always returns true.
+    def collection?
+      true
+    end
+
     # In this case, returns [[]]
     def conditions
       [[]]

metadata

@@ -1,32 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: power_enum
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Trevor Squires
 - Pivotal Labs
 - Arthur Shagall
 - Sergey Potapov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-12-11 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -64,7 +64,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +84,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -94,7 +94,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -104,7 +104,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -114,7 +114,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7'
 description: |
   Power Enum allows you to treat instances of your ActiveRecord models as though they were an enumeration of values.
   It allows you to cleanly solve many of the problems that the traditional Rails alternatives handle poorly if at all.
@@ -149,7 +149,7 @@ homepage: http://github.com/albertosaurus/power_enum_2
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,9 +164,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Allows you to treat instances of your ActiveRecord models as though they
   were an enumeration of values