rails_column_enumerator 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6142a21527dc7356777b36c1d29f0ecb092cbf7
-  data.tar.gz: 5f5af75ce9697d802da55f2afd630c79b2ff2130
+  metadata.gz: 39c202ca855e2b163e88de24c8d9bc756b12a465
+  data.tar.gz: f1d96c5f3f5fda7107958ef157fa55f103394244
 SHA512:
-  metadata.gz: f4122a21688fb8d6d72f862b1e9a1855a3d1f8877a7087d3df00a26e4c04f6edadd14c93e672fb6a5c69ad1ca9d731e90077cd1c8419517a549428fa46812635
-  data.tar.gz: 983bf0c595fc9bcd4e182858a459296a6327d01625f97aa127f6139591f98e68874e09547125a3c0aadf489257cea103b84691ecc3a4ef958021f11152fb2630
+  metadata.gz: b783c4d7ebea0659a40a7267700e06547b52c182ddf93d7b5e919d64d80c9641d3636ba41ca109bb10ffb23017b89287ebb9c69265d501e71813bb776e14a9af
+  data.tar.gz: 7b15862ae3199453d4c0b775dae9da7cdf623c0c6f45e314bb92383c716c73e914956cf98bd06ffe95ce9e14a413f0c00ccd280a80a708fb28e2c5358b8141c8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_column_enumerator (1.0.0)
+    rails_column_enumerator (1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -23,9 +23,9 @@ GEM
     builder (3.2.2)
     i18n (0.7.0)
     json (1.8.3)
-    minitest (5.8.3)
+    minitest (5.8.4)
     mysql2 (0.3.18)
-    rake (10.4.2)
+    rake (10.5.0)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)

data/README.md

@@ -20,20 +20,20 @@ Or install it yourself as:
 
 ## Usage
 
-Add ```extends RailsColumnEnumerator``` to the top of whatever class you want to add an enumerated column to.
+Add ```extend RailsColumnEnumerator``` to the top of whatever class you want to add an enumerated column to.
 
 Then define the attribute with ```enumerated_column``` method.
 
 example:
 ```ruby
 class TestClass < ActiveRecord::Base
-  extends RailsColumnEnumerator
+  extend RailsColumnEnumerator
 
-  enumerated_column :state, { open: 1, closed: 2, failed: 3 }
+  enumerated_column :state, { open: 1, closed: 2, failed: 3 }, scopes: { not_failed: [1, 2], not_open: [:closed, :failed] }
 end
 
 # The following two consts would be added to your class (Their name is derived from the attribute name you pass into 'enumerated_column')
-TestClass::STATES # { "open" => 1, "closed" => 2, "failed" => 3}
+TestClass::STATES # { "open" => 1, "closed" => 2, "failed" => 3 }
 TestClass::STATE_NAMES # { 1 => :open, 2 => :closed, 3 => :failed }
 
 # You can use your enumerated attribute as follows
@@ -59,7 +59,26 @@ example.state # nil
 example.state = 4
 example.state # 4
 
-example.state.save! # raises "ActiveRecord::RecordInvalid, 'Validation failed: Sample column is not included in the list'"
+example.state.save! # raises "ActiveRecord::RecordInvalid, 'Validation failed: State is not included in the list'"
+
+# You can add scopes on your enumerated column by passing in the scope name and an array containing values that should be included in your scope
+
+TestClass.not_failed # SELECT `test_class`.* FROM `test_class` WHERE `state` IN (1, 2);
+TestClass.not_open # SELECT `test_class`.* FROM `test_class` WHERE `state` IN (2, 3);
+
+# Values can be added to scopes as either their integer value or their key.
+# If the values you enter are not valid values for your enumerator, or if you don't provide any, it will raise an error.
+
+enumerated_column :state, { open: 1, closed: 2, failed: 3 }, scopes: { not_open: [1, 2, 5], finished: [:closed, :failed, :pending] } # Raises RuntimeError "Values in options must be valid for enumerated column."
+enumerated_column :state, { open: 1, closed: 2, failed: 3 }, scopes: { not_open: [] } # Raises RuntimeError "You must provide some values for the scope."
+
+# When you create a scope you also get an 'include?' method using that scope's name that allows you to check if a value is part of that scope
+
+example.not_failed_include?(1)       #true
+example.not_failed_include?(:open)   #true
+
+example.not_failed_include?(3)       #false
+example.not_failed_include?(:failed) #false
 ```
 
 ## Development

data/lib/rails_column_enumerator/version.rb

@@ -1,3 +1,3 @@
 module RailsColumnEnumerator
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/rails_column_enumerator.rb

@@ -1,6 +1,14 @@
 require "rails_column_enumerator/version"
 
 module RailsColumnEnumerator
+  def self.get_int(val, enum_values = nil, valid_values = nil)
+    if val.is_a?(String) || val.is_a?(Symbol)
+      val = enum_values[val.to_s.downcase]
+    end
+    raise "Values in options must be valid for enumerated column." if valid_values && valid_values[val].blank?
+    val
+  end
+
   def enumerated_column(column_name, enumerated_values, options = {})
     enum_name = column_name.to_s.pluralize.upcase.to_sym
     enum_symbols_name = (column_name.to_s.upcase + '_NAMES').to_sym
@@ -12,12 +20,21 @@ module RailsColumnEnumerator
       return_symbol ? self.class.const_get(enum_symbols_name)[read_attribute(column_name)].to_sym : read_attribute(column_name)
     end
 
-    self.send(:define_method, (column_name.to_s + '=').to_sym)do |val|
-      if val.is_a?(String) || val.is_a?(Symbol)
-        val = val.to_s.downcase
-        write_attribute(column_name, self.class.const_get(enum_name)[val])
-      else
-        write_attribute(column_name, val)
+    self.send(:define_method, column_name.to_s + '=') do |val|
+      write_attribute(column_name, RailsColumnEnumerator.get_int(val, self.class.const_get(enum_name), self.class.const_get(enum_symbols_name)))
+    end
+
+    enumerator_associations = options.delete(:scopes)
+    if enumerator_associations
+      enumerator_associations.each do |key,values|
+        found_values = values.map { |val| RailsColumnEnumerator.get_int(val, self.const_get(enum_name), self.const_get(enum_symbols_name)) }
+        raise "You must provide some values for the scope." if found_values.blank?
+        self.define_singleton_method(key) do
+          self.where(column_name => found_values)
+        end
+        self.send(:define_method, key.to_s + "_include?") do |val|
+          found_values.include?(RailsColumnEnumerator.get_int(val, self.class.const_get(enum_name)))
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_column_enumerator
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian O'Reilly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-19 00:00:00.000000000 Z
+date: 2016-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler