enumish 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd34d003bdef7eaf92786ab4e6e1bd25a1ca7cab
-  data.tar.gz: '092c70c046c113815500f169ffa669b84a225a72'
+  metadata.gz: c3996fbc95c17dbba17a1cdd9c19316a1b744a02
+  data.tar.gz: 0c39957e59b88433056262331370dfd761fa1a7a
 SHA512:
-  metadata.gz: 4fe669e7dc94447fb27d92907bfc40cff10fa88baf82e97c9cb72a92efc3549dfdc217cbdf0f3d7063325578c7d35acd3dcb651d357dedb1b0a867fc7cfb1bd2
-  data.tar.gz: c5d7069c7aa3c1f67c26262559af0f9932afee34ec3a39e618f3066342ea2eda9c115071248b2fa132725e3f7bdcdc2f09db914b640a11236e58e24667d2277a
+  metadata.gz: 0c64c8aa0568c57d7e167ed6e451615ccbd53657bd12ee5a91e2587d3c243d861072cdcd04968e4b6253bfa5a73c1706343a91283644475cac6c5aa7cf2b9e95
+  data.tar.gz: de7732dcc20673dca3559b0854929c6584181e89873445ac2a61aa000497bf1ca42abe7e611680bfe092e9841beb8b6a61bc764b91494b8fc77a094161a54013

data/.gitignore

@@ -10,3 +10,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.byebug_history

data/README.md

@@ -1,8 +1,10 @@
 # Enumish
 
-Enumish is "Enum for ActiveRecord".
+Enumish is "Database-backed Enum for ActiveRecord".
 
-It gives you the ability to create Enum-like values directly in the database.
+It gives you the ability to create Enum-like properties directly in the database.
+
+[![Build Status](https://travis-ci.org/cmer/enumish.svg?branch=master)](https://travis-ci.org/cmer/enumish)
 
 ## Simple Example
 
@@ -44,10 +46,14 @@ class Color < ActiveRecord
         { s.human_description => s.id }
       end
     end
+
+    def all_primary
+      Color.rank(:position).where(enabled: true).where(primary: true)
+    end
   end
 
-  def description
-    "#{self.to_s} is a beautiful color!"
+  def human_description
+    "The color #{self.to_s}"
   end
 end
 ````
@@ -108,6 +114,34 @@ class Color < ActiveRecord
 end
 ````
 
+## Why not just use ActiveRecord::Enum?
+
+Glad you asked! [`ActiveRecord::Enum`](http://api.rubyonrails.org/classes/ActiveRecord/Enum.html)
+(AR::E going forward) is an option you should definitely consider if it fits your needs. I wrote
+Enumish because I needed the following capabilities:
+
+- Ability to have more than one enum field per model.
+
+  For example, a `Car` model could have the following Enumish properties:
+  `exterior_color`, `interior_color`, `model`, `transmission`. This would not be possible
+  with vanilla AR::E.
+
+- Database-backed properties. There are many benefits to this. Notably, Enumish allows you to:
+
+    - Maintain an ever-evolving list of properties directly in the database instead of changing
+      and potentially breaking code. Your marketing team will love this!
+    - Keep a human-readable version of your Enumish properties in the database for your users
+      to see, or for your eyes only. Just add a `description` column.
+    - Enable or disable some properties. Just add an `enabled` column.
+    - Sort how properties are displayed to end-users. Pro-tip, just use
+      [`RankedModel`](https://github.com/mixonic/ranked-model).
+    - Limit possible Enumish properties under different circumstances. For example, a car from 2015
+      might have different color options than a car from 2016. Or in the example above, I have
+      an `.all_primary` method that only returns primary colors.
+    - Perform database `JOIN`s between your model and Enumish models.
+    - Maintain data integrity between your models and Enumish models. It's all just SQL after all.
+
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/enumish.rb

@@ -8,7 +8,7 @@ module Enumish
 
   module ClassMethods
     def method_missing(method_id, *args, &block)
-      if !method_id.to_s.match(/\?$/)
+      if !method_id.to_s.match(/\?$/) && enum_ids.include?(method_id.to_s)
         obj = self.where(enum_id => method_id.to_s).first
         return obj if obj.present?
       end
@@ -19,12 +19,27 @@ module Enumish
     def enum_id
       :short
     end
+
+    def refresh_enum_ids!
+      Mutex.new.synchronize do
+        @enum_ids = self.pluck(enum_id)
+      end
+    end
+
+    def enum_ids
+      refresh_enum_ids! if @enum_ids.blank?
+      @enum_ids
+    end
   end
 
   # Allow calls such as object.friendly? or model.attitude.friendly?
   def method_missing(method_id, *args, &block)
-    if method_id.to_s.match(/\?$/) && args.empty? && block.nil?
-      self.send(self.class.enum_id.to_s) == method_id.to_s.sub(/\?$/, "")
+    bare_method = if method_id.to_s.match(/\?$/) && args.empty? && block.nil?
+      method_id.to_s.sub(/\?$/, "")
+    end
+
+    if bare_method && self.class.enum_ids.include?(bare_method)
+      self.send(self.class.enum_id.to_s) == bare_method
     else
       super
     end

data/lib/enumish/version.rb

@@ -1,3 +1,3 @@
 module Enumish
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumish
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Carl Mercier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler