action_callback 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a4abe852096e06e5583e4cfcca4d52602849ffe
-  data.tar.gz: 1e60d8d0f4af193dbddab6afcd3de35cacb52873
+  metadata.gz: e2308622a7b13b58904071fd5c6190d5b3433988
+  data.tar.gz: c65e93d23b37e7690a18c621f835fad5785434c5
 SHA512:
-  metadata.gz: b7c228312cf98559c0820a580a7e21e9f2156083e659a36835621aeed54cc023b3692338695c0a93e43d093e645c4adee90b8806c83fcd44b4636daeeb714b48
-  data.tar.gz: 97c9fc56abc6318928644dffd38e305e110830b55726161af12e0a755b382effc8572dfb04b43c33ee142c74afe9ebfa5fd0b9763a61890dfa79909c72bb4a7f
+  metadata.gz: 555276c5220445cf130f7998f79e1684c9ee945ac4042149874b5bb68e118ed3407e4cc16d598fa14fdc270d55c27f225a58e3ed6dad722cc71c9c8232c32065
+  data.tar.gz: ccb8a7d7f36eae991d0458bbb77c94af7e45758aa52746586cab0be8cbe6bbf9988f57c3b696ceebfaa313cdb25d1b9d30cec9fb45635bc8cfa8f746314a3d53

data/.gitignore

@@ -8,4 +8,6 @@
 /spec/reports/
 /tmp/
 *.gem
-*.log
+*.log
+.ruby-version
+.DS_Store

data/Gemfile

@@ -5,6 +5,5 @@ gemspec
 group :test do
   gem "sqlite3"
   gem 'minitest-reporters'
-  gem 'minitest-debugger'
   gem 'rails', '4.0.0'
 end

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/action_callback.svg)](https://badge.fury.io/rb/action_callback)
+[![security](https://hakiri.io/github/EdmundLeex/action_callback/master.svg)](https://hakiri.io/github/EdmundLeex/action_callback/master)
+[![Code Climate](https://codeclimate.com/github/EdmundLeex/action_callback/badges/gpa.svg)](https://codeclimate.com/github/EdmundLeex/action_callback)
 [![Build Status](https://travis-ci.org/EdmundLeex/action_callback.svg?branch=master)](https://travis-ci.org/EdmundLeex/action_callback)
 
 # CallbackAction
@@ -20,8 +23,87 @@ Or install it yourself as:
 
     $ gem install callback_action
 
+## Preliminary
+
+- Ruby >= 2.1.0
+- Rails >= 4.2.6 
+
 ## Usage
 
+### 1. `validate`
+
+#### In Rails
+
+This gem adds a `before` option to the `validate` method.
+Use it on any of your model's method. Simply add custom validation method just
+like you usually do. 
+
+- It runs the method if validation is good
+- Otherwise, it returns false (if there is any error)
+
+```ruby
+class Car < ActiveRecord::Base
+  validate :key_present, before: [:unlock_door]
+
+  def unlock_door
+    # unlock the door
+  end
+
+  private
+
+  def key_present
+    unless has_key? && valid_key?
+      errors.add(:base, 'need the right key')
+    end
+  end
+end
+
+car = Car.new
+car.unlock_door
+# If has_key?
+#   - do whatever the method does
+#   - return whatever it returns
+# If !has_key?
+#   - returns false
+#   - car.errors.full_messages => ['need the right key']
+```
+
+At the same time, it preserves the default `validate` logic if `before` option is
+not used.
+
+```ruby
+class Car < ActiveRecord::Base
+  validate :valid_vin_number
+end
+```
+
+#### In Plain Ruby
+
+This gem adds a `validate` method to classes that extend this module. You should
+raise error in the validator method
+
+- It execute the method if validation passes.
+- It raises the error you specify in the validator method, and stop there.
+
+```ruby
+class Car
+  extend ActionCallback
+  validate :key_present, before: [:unlock_door]
+
+  def unlock_door
+    # unlock the door
+  end
+
+  private
+
+  def key_present
+    fail 'key invalid' unless valid_key?
+  end
+end
+```
+
+### 2. `before_action` / `after_action`
+
 If you are using Rails, in your Active Record models:
 
 ```ruby

data/action_callback.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.summary     = 'Add callbacks to your ActiveRecord models or plain Ruby classes'
   spec.description = "Here you can add callbacks to your models using `before_action`, `after_action`"
 
-  spec.required_ruby_version = ">= 2.0.0"
+  spec.required_ruby_version = ">= 2.1.0"
 
   spec.license = "MIT"
 

data/lib/action_callback.rb

@@ -1,9 +1,12 @@
-require "action_callback/version"
-require "action_callback/define_callback"
-require "action_callback/callback"
+require_relative "./action_callback/version"
+require_relative "./action_callback/define_callback"
+require_relative "./action_callback/callback"
+require_relative "./action_callback/define_validation"
+require_relative "./action_callback/validation"
 
 module ActionCallback
   include Callback
+  include Validation
   extend self
 
   def ActionCallback.extended(mod)
@@ -13,6 +16,9 @@ module ActionCallback
       define_callback(callback)
       alias_method :"#{callback}_filter", :"#{callback}_action"
     end
+
+    initialize_validation_chain(mod)
+    define_validation
   end
 end
 

data/lib/action_callback/callback.rb

@@ -1,54 +1,39 @@
 require 'set'
 
 module Callback
-  # The chain should have each method that has callback as key
-  # and each callback points to a hash with :before, :after as key
-  # each of those keys points to an array of callbacks
-  # {
-  #   method: {
-  #     before: [...],
-  #     after:  [...]
-  #   }
-  # }
+  HOOKS = [:before, :after].freeze
+
   class Chain
-    CALLBACK_HOOK = [:before, :after].freeze
+    HOOKS.each do |cb_hook|
+      define_method("#{cb_hook}_chain_of") do |mth_name|
+        get_hook(cb_hook, mth_name)
+      end
+    end
 
     def initialize
-      CALLBACK_HOOK.each do |cb_hook|
+      HOOKS.each do |cb_hook|
         instance_variable_set("@_#{cb_hook}_chain", new_chain)
       end
     end
 
-    def append_callback(callback_hook, mth, callback)
-      chain = get_chain(callback_hook)
-      chain[mth] << callback
-    end
-
-    CALLBACK_HOOK.each do |cb_hook|
-      define_method("#{cb_hook}_chain_of") do |mth_name|
-        get_callbacks(cb_hook, mth_name)
-      end
+    def append(hook_name, mth, hook_mth)
+      chain = get_chain(hook_name)
+      chain[mth] << hook_mth
     end
 
     private
 
-    def get_callbacks(callback_hook, mth)
-      chain = get_chain(callback_hook)
+    def get_hook(hook_name, mth)
+      chain = get_chain(hook_name)
       chain[mth].dup
     end
 
-    def get_chain(callback_hook)
-      instance_variable_get("@_#{callback_hook}_chain")
+    def get_chain(hook_name)
+      instance_variable_get("@_#{hook_name}_chain")
     end
 
     def new_chain
-      Hash.new { |h, k| h[k] = [] }
-    end
-  end
-
-  class << self
-    def get_callbacks(mth)
-      @_callback_chain.get_callbacks[mth]
+      Hash.new { |h, k| h[k] = Set.new }
     end
   end
 end

data/lib/action_callback/define_callback.rb

@@ -2,19 +2,19 @@ module ActionCallback
   private
 
   def initialize_callback_chain(mod)
-    mod.instance_variable_set('@_callback_chain', Callback::Chain.new)
-
     mod.define_singleton_method(:_callback_chain) do
-      instance_variable_get('@_callback_chain')
+      @_callback_chain
     end
   end
 
   def define_callback(callback_hook)
     define_method("#{callback_hook}_action") do |callback, method_scope|
+      @_callback_chain ||= Callback::Chain.new
+
       method_scope[:on].each do |mth_name|
-        @_callback_chain.append_callback(callback_hook, mth_name, callback)
+        _callback_chain.append(callback_hook, mth_name, callback)
 
-        undef_method(mth_name) if method_defined?(mth_name)
+        undef_method(mth_name) if included_modules.map(&:to_s).include?('ActionWithCallbacks')
 
         class_eval <<-RUBY
           module ActionWithCallbacks

data/lib/action_callback/define_validation.rb

@@ -0,0 +1,41 @@
+module ActionCallback
+  private
+
+  def initialize_validation_chain(mod)
+    mod.define_singleton_method(:_validation_chain) do
+      @_validation_chain
+    end
+  end
+
+  def define_validation
+    define_method(:validate) do |*args, &block|
+      @_validation_chain ||= Validation::Chain.new
+
+      options = args.last
+      if options.key?(:before)
+        validator_mth_name = args.first
+        options[:before].each do |mth_name|
+          _validation_chain.append(:before, mth_name, validator_mth_name)
+          undef_method(mth_name) if included_modules.map(&:to_s).include?('ActionWithValidations')
+
+          class_eval <<-RUBY
+            module ActionWithValidations
+              define_method(:#{mth_name}) do |*args, &block|
+                self.class._validation_chain.before_chain_of(:#{mth_name}).each { |v| send(v) }
+
+                should_run = true
+                should_run = !errors.present? if self.class.ancestors.include?(ActiveRecord::Base)
+
+                super(*args, &block) if should_run
+              end
+            end
+          RUBY
+
+          prepend self::ActionWithValidations
+        end
+      else
+        super(*args, &block)
+      end
+    end
+  end
+end

data/lib/action_callback/validation.rb

@@ -0,0 +1,39 @@
+require 'set'
+
+module Validation
+  HOOKS = [:before].freeze
+
+  class Chain
+    HOOKS.each do |cb_hook|
+      define_method("#{cb_hook}_chain_of") do |mth_name|
+        get_hook(cb_hook, mth_name)
+      end
+    end
+
+    def initialize
+      HOOKS.each do |cb_hook|
+        instance_variable_set("@_#{cb_hook}_chain", new_chain)
+      end
+    end
+
+    def append(hook_name, mth, hook_mth)
+      chain = get_chain(hook_name)
+      chain[mth] << hook_mth
+    end
+
+    private
+
+    def get_hook(hook_name, mth)
+      chain = get_chain(hook_name)
+      chain[mth].dup
+    end
+
+    def get_chain(hook_name)
+      instance_variable_get("@_#{hook_name}_chain")
+    end
+
+    def new_chain
+      Hash.new { |h, k| h[k] = Set.new }
+    end
+  end
+end

data/lib/action_callback/version.rb

@@ -1,5 +1,5 @@
 module ActionCallback
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 
   def self.version
     VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_callback
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Edmund Li
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-08 00:00:00.000000000 Z
+date: 2017-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,8 @@ files:
 - lib/action_callback.rb
 - lib/action_callback/callback.rb
 - lib/action_callback/define_callback.rb
+- lib/action_callback/define_validation.rb
+- lib/action_callback/validation.rb
 - lib/action_callback/version.rb
 homepage: https://github.com/EdmundLeex/action_callback
 licenses:
@@ -85,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -93,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Add callbacks to your ActiveRecord models or plain Ruby classes