enhanced_hooks 0.5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p362@event_machine

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in event_machine.gemspec
+gemspec
+
+gem 'activesupport', ">= 3.0.0"
+gem 'rails', ">= 3.0.0"

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 tim.teng
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 readline
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,73 @@
+= enhanced_hooks
+With enhanced hooks, you can keep an eye on any action on your rails controller, say in your sns website, when user posts a blog, you need to notice all of his friends, but it's really urgly to do like this:
+
+  BlogController:
+    def create
+      # new and save code
+      notice_all_friends
+    end
+  end
+
+let's take another scenario, in your sns site, when one user makes friends with the other one, we should notice all friends of these two people, but how to?
+we'd beeter have an observer on the action, the code in the make_friends action block only concerns about building relationship between the two people, the observer then notice other people on fly.  
+
+Usage:
+
+in your Gemfile:
+
+    gem "enhanced_hooks", :version => ">=0.4.1"
+
+and the generate command :
+
+  ~your_project_path> rails g enhanced_hooks create_favorite Favorites create 
+
+here 'create_event' stands for the event name, and 'Favorites' 'create' for which contorller#action to observe
+
+then it will generate a event file named create_favorite_event.rb under the Rails.root/events directory,  which content like following:
+
+
+  for_action FavoritesController, :create do
+
+    before do
+      # This will be called before FavoriteController#create
+    end
+
+    after do
+      # This will be called after FavoriteController#create
+    end
+
+  end
+
+
+now you can add your code in the block and after block, enjoy.
+
+= to observe multiple actions 
+
+to observe multiple actions, you should:
+
+  for_actions [[FavoritesController, :create], [BlogsController,:create]] do
+
+    before do
+      # your code goes here
+    end
+
+    after do
+      # your code goes here
+    end
+
+  end
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 tim.teng. See LICENSE for details.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/enhanced_hooks.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enhanced_hooks/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "enhanced_hooks"
+  gem.version       = EnhancedHooks::VERSION
+  gem.authors       = ["readline"]
+  gem.email         = ["tim.rubist@gmail.com"]
+  gem.description   = %q{enhanced before/after filter hooks}
+  gem.summary       = %q{enhanced before/after filter hooks}
+  gem.homepage      = "http://github.com/tteng/enhanced_hooks"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/enhanced_hooks.rb

@@ -0,0 +1,15 @@
+require "enhanced_hooks/version"
+require "active_support/dependencies"
+
+module EnhancedHooks
+
+  mattr_accessor :app_root
+
+  def self.setup
+    yield self
+  end
+
+end
+
+require "enhanced_hooks/engine"
+require "enhanced_hooks/hooks"

data/lib/enhanced_hooks/engine.rb

@@ -0,0 +1,21 @@
+module EnhancedHooks
+  class Engine < Rails::Engine
+
+    initializer "enhanced_hooks.load_app_instance_data" do |app|
+      EnhancedHooks.setup do |config|
+        config.app_root = app.root
+      end
+    end
+
+    #initialize "enhanced_hooks.load_static_assets" do |app| 
+    #  app.middleware.use ::ActionDispatc::Static, "#{root}/public"
+    #end
+
+    initializer "enhanced_hooks.application" do
+      ActiveSupport.on_load :action_controller do
+        include EnhancedHooks::Hooks
+      end
+    end
+   
+  end
+end

data/lib/enhanced_hooks/hooks.rb

@@ -0,0 +1,116 @@
+require "pp"
+require 'benchmark'
+
+module EnhancedHooks 
+
+  module Hooks
+    
+    EVENTS_DIR = "events"
+    
+    def self.included(base)
+      class_eval <<-EOF 
+        @@reporter_events = Array.new
+      EOF
+      base.class_eval <<-BCE 
+        around_filter :reporter_around_filter
+      BCE
+    end
+    
+    protected
+    
+    def reporter_around_filter
+      
+      events_load_bm = Benchmark.measure do
+        load_events if @@reporter_events.empty?
+      end
+      
+      events = @@reporter_events.select {|e| e.match_event?(self.class, action_name)}
+    
+      # Calling all before actions for this controler and action
+      events.each { |event| event.call_before(self) }
+    
+      # Calling original action
+      yield
+      
+      # Calling all after actions for this controler and action
+      events.each { |event| event.call_after(self) }
+    end
+    
+    def for_action(controller, action, &block)
+      @@reporter_events << EventMeta.new(controller, action, &block)
+    end
+    
+    def for_actions(actions_array, &block)
+      actions_array.each do |item|
+        @@reporter_events << EventMeta.new(item[0], item[1], &block)
+      end
+    end
+    
+    def turn_off_for_action(controller, action, &block)
+      for_action(controller, action, &block) if test?
+    end
+    
+    def load_events
+      return if test?
+      Dir["#{Rails.root + EVENTS_DIR}/**/*event.rb"].collect do |file|
+        load_event(file)
+      end
+    end
+    
+    def load_event(file)
+      clear_events if test?
+      code = File.new(file).readlines.join('')
+      begin
+        instance_eval code, __FILE__, __LINE__
+      rescue => e
+        logger.warn "FAILED!"
+        logger.warn e.backtrace
+      end
+    end
+    
+    def clear_events
+      @@reporter_events.clear
+    end
+    
+    def reporter_events
+      @@reporter_events
+    end
+    
+    def test?
+      ENV["RAILS_ENV"] == "test"
+    end
+    
+    class EventMeta
+    
+      def initialize(controller_class, name, &block)
+        @controller_class = controller_class
+        @action = name
+        self.instance_eval(&block)
+      end
+    
+      def call_before(controller_instance)
+        controller_instance.instance_eval(&@before) if @before
+      end
+      
+      def call_after(controller_instance)
+        controller_instance.instance_eval(&@after) if @after
+      end
+    
+      def match_event?(clazz, action_name)
+        @controller_class == clazz && @action.to_s == action_name.to_s
+      end
+      private
+      
+      def before(&block)
+        @before = block
+      end
+    
+      def after(&block)
+        @after = block
+      end
+    
+    end
+
+  end
+    
+end

data/lib/enhanced_hooks/version.rb

@@ -0,0 +1,3 @@
+module EnhancedHooks
+  VERSION = "0.5"
+end

data/lib/generators/enhanced_hooks/enhanced_hooks_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators'
+class EnhancedHooksGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :this_event_name, :type => :string
+  argument :controller_name, :type => :string
+  argument :action_name,     :type => :string
+
+  def generate_event
+    template "event.rb", "#{EnhancedHooks::Hooks::EVENTS_DIR}/#{parsed_event_name}_event.rb"
+    template "functional_test.rb", "test/functional/events/#{parsed_event_name}_test.rb"
+  end
+
+  private
+
+  def parsed_event_name
+    this_event_name.underscore
+  end
+
+  def parsed_controller_name
+    controller_name.camelize
+  end
+
+  def parsed_action_name 
+    action_name.underscore
+  end
+
+end

data/lib/generators/enhanced_hooks/templates/event.rb

@@ -0,0 +1,11 @@
+for_action <%= parsed_controller_name %>Controller, :<%= action_name %> do
+  
+  before do
+    # This will be called before <%= parsed_controller_name %>#<%= parsed_action_name %>
+  end
+  
+  after do
+    # This will be called after <%= parsed_controller_name %>#<%= parsed_action_name %>
+  end
+  
+end

data/lib/generators/enhanced_hooks/templates/functional_test.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+require File.dirname(__FILE__) + '/../../functional/events/events_base_test'
+require '<%= parsed_controller_name.underscore -%>_controller'
+
+# Re-raise errors caught by the controller.
+class <%= parsed_controller_name -%>; def rescue_action(e) raise e end; end
+
+class <%= parsed_event_name.camelize -%>Test < EventBaseTest
+  
+  fixtures :users
+  
+  def setup
+    @controller = <%= parsed_controller_name.camelize-%>.new
+    @request = ActionController::TestRequest.new
+    @response = ActionController::TestResponse.new
+    
+    prepare
+    load_event "app/events/<%= parsed_event_name-%>_event.rb"
+    emulate_login
+  end
+  
+  # Put actual tests here
+  def test_true
+    assert true
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'event_machine'
+
+class Test::Unit::TestCase
+end

data/test/test_event_machine.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestEventMachine < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: enhanced_hooks
+version: !ruby/object:Gem::Version
+  version: '0.5'
+  prerelease: 
+platform: ruby
+authors:
+- readline
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-09 00:00:00.000000000 Z
+dependencies: []
+description: enhanced before/after filter hooks
+email:
+- tim.rubist@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- enhanced_hooks.gemspec
+- lib/enhanced_hooks.rb
+- lib/enhanced_hooks/engine.rb
+- lib/enhanced_hooks/hooks.rb
+- lib/enhanced_hooks/version.rb
+- lib/generators/enhanced_hooks/enhanced_hooks_generator.rb
+- lib/generators/enhanced_hooks/templates/event.rb
+- lib/generators/enhanced_hooks/templates/functional_test.rb
+- test/helper.rb
+- test/test_event_machine.rb
+homepage: http://github.com/tteng/enhanced_hooks
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: enhanced before/after filter hooks
+test_files:
+- test/helper.rb
+- test/test_event_machine.rb