power_enum 2.12.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 64844e550c505a4a4f76be6db166cb8cfe619211
-  data.tar.gz: a52e8c4606a8466f4427e8c311d77bc5d0191586
+SHA256:
+  metadata.gz: e64bc976c66ec97d00cd14baabeb0fa7c13afc66500bb8408bc9d1e884be30ee
+  data.tar.gz: 43f0a3fa296b90154d32b82a38d8ae207b0b8f400edc821ded353e341ddb5187
 SHA512:
-  metadata.gz: 8c4eefff7165c2465455555eba9f73a7ecf81d92db1288ebfee7fabf0848cc10ec8c0d71c56485e32df98e5ed1178e827f95c4a6987907f344a8fc188bd29b45
-  data.tar.gz: 79fabb30097902433ad93e59ecc1b3397924c65e9ea5526c8fc12334fb51d3fa5d812abd76f7879eba4a8e7735af2a27e27da87c1dae84ba6e9d965bfffc35db
+  metadata.gz: b36b482f22cf0ddc61e817f77838a245a250a3c28771c0d0e39d8e23f29b782abd93fbb06c84fa6b009f66bdb510933b0e292a8ceeed60d190caeeeba24d05f2
+  data.tar.gz: 2731947e3bb7d5f9b91fffd726db29ab26451536fc60b8110886d2d8ed3402af9f8f0d10471bea00c83f36e4577476df2fb1c2cdebe106b74d684e80d7637d33

data/README.markdown

@@ -10,7 +10,8 @@ Enumerations for Rails Done Right.
 
 ## Versions
 
-* PowerEnum 2.X (this version) supports Rails 4.X and Rails 5.0
+* 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
 
 ## What is this?:
@@ -50,10 +51,15 @@ See "How to use it" below for more information.
 
 ## Requirements
 
+### 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, 5.2, 6.0
+
 ### PowerEnum 2.X
 
 * Ruby 1.9.3, 2.0, JRuby 1.7+ (Ruby 1.9.3 or 2.0 required for development)
-* Rails 4.0
+* Rails 4.0, 4.1, 4.2, 5.0
 
 ## Installation
 
@@ -192,7 +198,7 @@ create_table :bookings do |t|
   t.timestamps
 end
 ```
-    
+
 There are two methods added to Rails migrations:
 
 ##### create\_enum(enum\_name, options = {}, &block)
@@ -279,7 +285,7 @@ Example:
 ```ruby
 remove_enum :booking_status
 ```
-    
+
 is the equivalent of
 
 ```ruby
@@ -335,6 +341,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
@@ -778,7 +788,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
@@ -802,7 +812,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/generators/enum/templates/rails31_migration.rb.erb

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < ActiveRecord::Migration<%= Rails.version =~ /^4\.2\.*/ ? "" : "[5.0]" %>
 
   def change
     create_enum :<%=file_name%><%= ", description: true" if @description %>

data/lib/power_enum/enumerated.rb

@@ -126,6 +126,7 @@ module PowerEnum::Enumerated
         before_save :enumeration_model_update
         before_destroy :enumeration_model_update
         validates acts_enumerated_name_column, :presence => true, :uniqueness => true
+        validate :validate_enumeration_model_updates_permitted
 
         define_method :__enum_name__ do
           read_attribute(acts_enumerated_name_column).to_s
@@ -193,6 +194,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.
@@ -489,16 +495,25 @@ module PowerEnum::Enumerated
     # and rather than completely disallow changes I make you jump
     # through an extra hoop just in case you're defining your enumeration
     # values in Migrations.  I.e. set enumeration_model_updates_permitted = true
-    def enumeration_model_update
+    private def enumeration_model_update
       if self.class.enumeration_model_updates_permitted
         self.class.purge_enumerations_cache
         true
       else
         # Ugh.  This just seems hack-ish.  I wonder if there's a better way.
+        if Rails.version =~ /^4\.2\.*/
+          false
+        else
+          throw(:abort)
+        end
+      end
+    end
+
+    # Validates that model updates are enabled.
+    private def validate_enumeration_model_updates_permitted
+      unless self.class.enumeration_model_updates_permitted
         self.errors.add(self.class.name_column, "changes to acts_as_enumeration model instances are not permitted")
-        false
       end
     end
-    private :enumeration_model_update
   end # module EnumInstanceMethods
 end # module PowerEnum::Enumerated

data/lib/power_enum/has_enumerated.rb

@@ -125,17 +125,7 @@ module PowerEnum::HasEnumerated
     def create_ar_reflection(part_id, options)
       reflection = PowerEnum::Reflection::EnumerationReflection.new(part_id, options, self)
 
-      # ActiveRecord >= 4.1 handles this differently.
-      if self.respond_to? :_reflections=
-        if Rails.version =~ /^4\.2\.*/ || Rails.version =~ /^5\.0\.*/
-          self._reflections = self._reflections.merge(part_id.to_s => reflection)
-        else
-          self._reflections = self._reflections.merge(part_id => reflection)
-        end
-
-      else
-        self.reflections = self.reflections.merge(part_id => reflection)
-      end
+      self._reflections = self._reflections.merge(part_id.to_s => reflection)
       reflection
     end
     private :create_ar_reflection

data/lib/power_enum/reflection.rb

@@ -17,11 +17,7 @@ module PowerEnum::Reflection
   # the reflection, otherwise returns nil.
   # @return [PowerEnum::Reflection::EnumerationReflection]
   def reflect_on_enumerated( enumerated )
-    key = if Rails.version =~ /^4\.2\.*/ || Rails.version =~ /^5\.*/
-            enumerated.to_s
-          else
-            enumerated.to_sym
-          end
+    key = enumerated.to_s
     reflections[key].is_a?(PowerEnum::Reflection::EnumerationReflection) ? reflections[key] : nil
   end
 
@@ -39,47 +35,48 @@ module PowerEnum::Reflection
     attr_accessor :parent_reflection
 
     # See ActiveRecord::Reflection::MacroReflection
-    def initialize( name, options, active_record )
-      if Rails.version =~ /^4\.2\.*/ || Rails.version =~ /^5\.0\.*/
-        super name, nil, options, active_record
-      else
-        super :has_enumerated, name, nil, options, active_record
-      end
+    def initialize(name, options, active_record)
+      super name, nil, options, active_record
     end
 
-    if Rails.version =~ /^4\.2\.*/ || Rails.version =~ /^5\.0\.*/
-      def macro
-        :has_enumerated
-      end
+    def macro
+      :has_enumerated
+    end
 
-      def check_preloadable!
-        return unless scope
-        if scope.arity > 0
-          ActiveSupport::Deprecation.warn(<<-MSG.squish)
+    def check_preloadable!
+      return unless scope
+      if scope.arity > 0
+        ActiveSupport::Deprecation.warn(<<-MSG.squish)
 The association scope '#{name}' is instance dependent (the scope
 block takes an argument). Preloading happens before the individual
 instances are created. This means that there is no instance being
 passed to the association scope. This will most likely result in
 broken or incorrect behavior. Joining, Preloading and eager loading
 of these associations is deprecated and will be removed in the future.
-          MSG
-        end
+        MSG
       end
-      alias :check_eager_loadable! :check_preloadable!
+    end
 
-      def active_record_primary_key
-        @active_record_primary_key ||= options[:primary_key] || active_record.primary_key
-      end
+    alias :check_eager_loadable! :check_preloadable!
 
-      def klass
-        @klass ||= active_record.send(:compute_type, class_name)
-      end
+    def active_record_primary_key
+      @active_record_primary_key ||= options[:primary_key] || active_record.primary_key
+    end
 
-      EnumJoinKeys = Struct.new(:key, :foreign_key)
+    alias_method :join_primary_key, :active_record_primary_key
 
-      def join_keys(_)
-        EnumJoinKeys.new(active_record_primary_key, foreign_key)
-      end
+    def klass
+      @klass ||= active_record.send(:compute_type, class_name)
+    end
+
+    def association_class
+      ::ActiveRecord::Associations::HasOneAssociation
+    end
+
+    EnumJoinKeys = Struct.new(:key, :foreign_key)
+
+    def join_keys(*_)
+      EnumJoinKeys.new(active_record_primary_key, foreign_key)
     end
 
     # Returns the class name of the enum
@@ -92,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
@@ -121,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: 2.12.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Trevor Squires
 - Pivotal Labs
 - Arthur Shagall
 - Sergey Potapov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-19 00:00:00.000000000 Z
+date: 2020-06-16 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
@@ -61,60 +61,60 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        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