enumbler 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3b8d2a2e38789cb62f2be5c895aa0fb2776b26b8efbbfe3386e88feaf041393
-  data.tar.gz: d981a2476760ab1d0afb09bd2eb790c125cf54ba54cad3493a5865f52163648b
+  metadata.gz: 012b0ded68a635ef8ac4cb765eec4a648f16a4365abaa1d6def1897d389bcba8
+  data.tar.gz: a74d123fa2635a2118e1300cbf75a56d3255756e9bf9384049bb27f74187eb7a
 SHA512:
-  metadata.gz: 65c1b774b7fd7fe86e3038c5bfea649608708e57ef626529c933e82e31249a43716b50e54d2a822640d11d6b98321832f032dfedf2efce9a750aebc1e25fd26c
-  data.tar.gz: c223ff2703dd5693ee9925dd4ffc025c890138962001acca6619f8c1d30b7e6056a5275fa84f5c159f163c052b8fbc546c1f9132917b93a96956c6aba9d1e72e
+  metadata.gz: e623093fbb3dbc1645c9d3f713c32100fa561b8ade1a62c03d4da9ae7b6c6a964b45ddcacd4bc158f8c41cc8bdf1150a02c340ce84c9b6e94ec831f798a00a76
+  data.tar.gz: '09ef23ba8854c6ff1f01fbffd7e9227e183148acf6a03ce14bd02f0244d9c38f2ef2b9d1e7494320b5b6c8be08849689d1875eff1d68d81545e358299e8ebeb8'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enumbler (0.8.0)
+    enumbler (0.8.1)
       activerecord (>= 5.2.3, < 6.1)
       activesupport (>= 5.2.3, < 6.1)
 

data/README.md

@@ -170,14 +170,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Roadmap
 
-* We need to add in support for additional attributes/columns in the enumbled table.  For example, following the `Color` concept, we may want to have a column which is `hex` and stores the colors `hex` value (e.g., `FFFFFF`).  This should be supported.
-* Ideally, we could make this work more like a traditional `enum`; for example, overriding the `.where` method by allowing something like: `House.where(color: :blue)` instead of `House.where_color(:blue)`.  But right now am in a rush and not sure how to go about doing that properly.
+* Ideally, we could make this work more like a traditional `enum`; for example, overriding the `.where` method by allowing something like: `House.where(color: :blue)` instead of `House.color(:blue)`.  But right now am in a rush and not sure how to go about doing that properly.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/linguabee/enumbler.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/enumbler/enabler.rb

@@ -375,11 +375,21 @@ module Enumbler
         method_name = "#{enumble.enum}?"
         not_method_name = "not_#{enumble.enum}?"
         alias_method_name = "is_#{enumble.enum}"
+        any_method_name = "any_#{enumble.enum}?"
+
+        [method_name, not_method_name, alias_method_name].each do |mname|
+          detect_enumbler_conflict(enumble.enum, mname)
+        end
+
+        [enumble.enum, any_method_name].each do |mname|
+          detect_enumbler_conflict(enumble.enum, mname, klass_method: true)
+        end
 
         const_set(enumble.enum.to_s.upcase, enumble.id)
         define_method(method_name) { id == enumble.id }
         define_method(not_method_name) { id != enumble.id }
         alias_method alias_method_name, method_name
+
         define_singleton_method(enumble.enum) do |attr = nil|
           return find(enumble.id) if attr.nil?
 
@@ -388,13 +398,42 @@ module Enumbler
           raise Enumbler::Error, "The attribute #{attr} is not supported on this Enumble."
         end
 
-        define_singleton_method("any_#{enumble.enum}?") do
+        define_singleton_method(any_method_name) do
           where(id: enumble.id).exists?
         rescue NoMethodError
           raise Enumbler::Error, "The attribute #{attr} is not supported on this Enumble."
         end
       end
 
+      # This idea sourced lovingly from ActiveRecord::Enum
+      ENUMBLER_CONFLICT_MESSAGE = <<~TEXT.squish
+        You tried to define the enumble :%<enum>s on the model %<klass>s, but
+        this will generate a %<type>s method `%<method>s`, which is already defined
+        by %<source>s.
+      TEXT
+
+      def detect_enumbler_conflict(enumble_name, method_name, klass_method: false)
+        if klass_method && dangerous_class_method?(method_name)
+          raise_conflict_error(enumble_name, method_name, type: 'class')
+        elsif klass_method && method_defined_within?(method_name, ActiveRecord::Relation)
+          raise_conflict_error(enumble_name, method_name, type: 'class', source: ActiveRecord::Relation.name)
+        elsif !klass_method && dangerous_attribute_method?(method_name)
+          raise_conflict_error(enumble_name, method_name)
+        end
+      end
+
+      def raise_conflict_error(enumble_name, method_name, type: 'instance', source: 'ActiveRecord')
+        raise Error,
+          format(
+            ENUMBLER_CONFLICT_MESSAGE,
+            enum: enumble_name,
+            klass: name,
+            type: type,
+            method: method_name,
+            source: source
+          )
+      end
+
       # I accidentally forgot to provide an id one time and it was confusing as
       # the last argument became the hash of options.  This should help.
       def validate_id_is_numeric(enum, id)

data/lib/enumbler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Enumbler
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumbler
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Damon Timm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-26 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -198,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Enums are terrific, but lack integrity.  Let's add some!