mongoid_enumerable 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2297bea78c60f9cab28d878252f29a80752d7a29b708ba9e11b3ac6d5a3cefca
-  data.tar.gz: 619b26c22a62e2acbd6f84ad2623d62a7494048958c57ef9c01853e5526af274
+  metadata.gz: cc95ca01789205d6d562246b481decd47a4a9cc24f7737591f0a2ee6d0fed00b
+  data.tar.gz: 83d3e8f06edde0e37d9e212cf3a7727a6168130711ec8a4f52ba48344a81b883
 SHA512:
-  metadata.gz: da92a24350c59ee86e9c6f5035b45e640b0e8207e64c4fe93f0491edf3383c3ff68bde374cea0881567caacfa3ba724290357c35f756c6e20975368db52f62f2
-  data.tar.gz: 98a2761a3feaf2d62d8143327b935991e576457f764202daec1c907b6f35d622bb5411f181ffa4198a99f0b171ef748132a7adfb9b221e9bed6364fbf24d9170
+  metadata.gz: d7645e234a2157285ed33e4f8c06d04b3f956bc0d62305a0d6253a0fc88e3cd6d7c460702a007862348f69133eb3208d2204a5ffe1a074ae70042199bd0a13b2
+  data.tar.gz: 4b57b9eb7fe390848cdbb76dbbbf2848c247b597e223c94a8e3b77fb3db9cd9932ce56663be9fdcb555ca5cf014f77fef578b0b8dd81a0da619e40c849cf2320

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongoid_enumerable (0.2.2)
+    mongoid_enumerable (0.3.1)
       mongoid (>= 4.0)
 
 GEM

data/README.md

@@ -70,6 +70,57 @@ task.build_failed!
 task.deploy_running?
 task.deploy_failed!
 ```
+#### Callbacks
+##### Before Change
+You can define a `before_change` callback that runs before each change. If the method returns a falsey value (`nil` or `false`) then the change is be aborted.
+
+The method must receive two parameters: the old and the new value, respectively.
+
+Example:
+```ruby
+class Task
+  include Mongoid::Document
+  include MongoidEnumerable
+
+  enumerable :status, %w(completed running failed waiting), default: "waiting", before_change: :can_status_change?
+
+  def can_status_change?(old_value, new_value)
+    new_value != "waiting"
+  end
+end
+
+task = Task.new
+task.status # "waiting"
+
+task.running!
+task.status # "running"
+
+task.waiting!
+task.status # "running"
+```
+
+##### After Change
+You can define an `after_change` callback that runs after each change. The method must receive two parameters: the old and the new value, respectively.
+
+Example:
+```ruby
+class Task
+  include Mongoid::Document
+  include MongoidEnumerable
+
+  enumerable :status, %w(completed running failed waiting),
+    default: "waiting",
+    after_change: :status_changed
+
+  def status_changed(old_value, new_value)
+    puts "Status changed from #{old_value} to #{new_value}."
+  end
+end
+
+task = Task.new
+task.running!
+# Console output: "Status changed from waiting to running."
+```
 
 
 ### Scopes/Criterias
@@ -85,7 +136,6 @@ Task.build_waiting # Returns all tasks with build waiting status
 Task.deploy_running # Returns all tasks with deploy running status
 ```
 
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/mongoid_enumerable.rb

@@ -2,33 +2,83 @@ require "mongoid_enumerable/version"
 require "mongoid"
 
 module MongoidEnumerable
-  def self.included(base)
-    base.class.redefine_method :enumerable do |field_name, values, options = {}|
-      field_name = String(field_name)
-      values.collect!(&:to_s)
+  def self.included(model)
+    define_enumerable_methods(model)
+  end
+
+  private
+
+  def self.define_enumerable_methods(model)
+    model.define_singleton_method :enumerable do |field_name, values, options = {}|
+      MongoidEnumerable.define_enumerable_method(
+        model: model,
+        field_name: String(field_name),
+        values: values.collect(&:to_s),
+        default: options.fetch(:default, values.first),
+        prefix: options.fetch(:prefix, nil),
+        before_change: options[:before_change],
+        after_change: options[:after_change]
+      )
+    end
+  end
 
-      prefix = options.fetch(:prefix, "")
-      default = options.fetch(:default, values.first)
+  def self.define_enumerable_method(model:, field_name:, values:, default:, prefix:, before_change:, after_change:)
+    model.field(field_name, type: String, default: default)
 
-      field(field_name, type: String, default: default)
+    values.each do |value|
+      define_value_methods(
+        model: model,
+        value: value,
+        field_name: field_name,
+        prefix: prefix,
+        before_change: before_change,
+        after_change: after_change
+      )
+    end
 
-      values.each do |value|
-        method_name = "#{prefix}#{value}"
+    model.define_singleton_method("all_#{field_name}") do
+      values
+    end
+  end
 
-        define_method("#{method_name}!") do
-          update!(field_name => value)
-        end
+  def self.define_value_methods(model:, value:, field_name:, prefix:, before_change:, after_change:)
+    method_name = "#{prefix}#{value}"
 
-        define_method("#{method_name}?") do
-          send(field_name) == value
-        end
+    define_method("#{method_name}!") do
+      value_before = send(field_name)
+      value_after = value
 
-        scope value, -> { where(field_name => value) }
-      end
+      callback_result = run_callback(model: model, callback_method_name: before_change,
+        value_before: value_before, value_after: value_after)
 
-      base.define_singleton_method("all_#{field_name}") do
-        values
+      if callback_result
+        update!(field_name => value)
+        run_callback(model: model, callback_method_name: after_change,
+          value_before: value_before, value_after: value_after)
       end
     end
+
+    define_method("#{method_name}?") do
+      send(field_name) == value
+    end
+
+    model.scope value, -> { where(field_name => value) }
+  end
+
+  def run_callback(model:, callback_method_name:, value_before:, value_after:)
+    if callback_method_name
+      callback_method = method(callback_method_name)
+      validate_callback_method(method: callback_method)
+
+      callback_method.call(value_before, value_after)
+    else
+      true
+    end
+  end
+
+  def validate_callback_method(method:)
+    if method.arity != 2 && method.arity >= 0
+      raise "Method #{method.name} must receive two parameters: old_value and new_value"
+    end
   end
 end

data/lib/mongoid_enumerable/version.rb

@@ -1,3 +1,3 @@
 module MongoidEnumerable
-  VERSION = '0.2.2'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_enumerable
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Douglas Lise
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-28 00:00:00.000000000 Z
+date: 2018-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler