event_machine 0.3.1 → 0.4.0

data/lib/event_machine.rb

@@ -1,112 +1,13 @@
-require "pp"
-require 'benchmark'
-
-module EventMachine 
-
-  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["#{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
+require "event_machine/version"
+require "active_support/dependencies"
+
+module EventMachine
+  mattr_accessor :app_root
+
+  def self.setup
+    yield self
+  end
+end
+
+require "event_machine/engine"
+require "event_machine/hooks"

data/lib/event_machine/engine.rb

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

data/lib/event_machine/hooks.rb

@@ -0,0 +1,116 @@
+require "pp"
+require 'benchmark'
+
+module EventMachine 
+
+  module Hooks
+    
+    EVENTS_DIR = "app/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/event_machine/version.rb

@@ -0,0 +1,3 @@
+module EventMachine
+  VERSION = "0.4.0"
+end

data/{generators → lib/generators}/event_machine/event_machine_generator.rb

@@ -1,16 +1,13 @@
-#coding: utf-8
-require 'fileutils'
-
+require 'rails/generators'
 class EventMachineGenerator < 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
+  argument :action_name,     :type => :string
 
   def generate_event
-    template "event.rb", "events/#{parsed_event_name}_event.rb"
+    template "event.rb", "app/events/#{parsed_event_name}_event.rb"
     template "functional_test.rb", "test/functional/events/#{parsed_event_name}_test.rb"
   end
 

metadata

@@ -1,50 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: event_machine
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
-- tim.teng
+- tteng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-16 00:00:00.000000000Z
+date: 2013-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thoughtbot-shoulda
-  requirement: &70202617010360 !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 3.0.0
+  type: :runtime
   prerelease: false
-  version_requirements: *70202617010360
-description: Event Machine is observer to record any action you want to keep an eye
-  on
-email: tim.rubist@gmail.com
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: simple elegant customize hooks
+email:
+- tim.rubist@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
 files:
-- .document
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
-- event_machine.gemspec
-- generators/event_machine/USAGE
-- generators/event_machine/event_machine_generator.rb
-- generators/event_machine/templates/event.rb
-- generators/event_machine/templates/functional_test.rb
 - lib/event_machine.rb
-- test/helper.rb
-- test/test_event_machine.rb
-homepage: http://github.com/tteng/event_machine
+- lib/event_machine/engine.rb
+- lib/event_machine/hooks.rb
+- lib/event_machine/version.rb
+- lib/generators/event_machine/event_machine_generator.rb
+- lib/generators/event_machine/templates/event.rb
+- lib/generators/event_machine/templates/functional_test.rb
+homepage: http://github.com/tteng
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -64,8 +77,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: an observer to record events
+summary: simple elegant around filters to handle routines
 test_files: []

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/LICENSE

@@ -1,20 +0,0 @@
-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/README.rdoc

@@ -1,77 +0,0 @@
-= event_machine
-With event machine, 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, and this is also what IoC(AOP) teach us.  
-
-Usage:
-
-in your config/environment.rb:
-
-    gem "event_machine", :version => ">=0.2.1"
-
-application_controller.rb:
-
-  class ApplicationController < ActionController::Base
-    include EventMachine
-  end
-
-and the generate command :
-
-  ~your_project_path> rails g event_machine create_favorite FavoriteController create 
-
-then it will generate a event file 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

@@ -1,53 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "event_machine"
-    gem.summary = %Q{an observer to record events}
-    gem.description = %Q{Event Machine is observer to record any action you want to keep an eye on}
-    gem.email = "tim.rubist@gmail.com"
-    gem.homepage = "http://github.com/tteng/event_machine"
-    gem.authors = ["tim.teng"]
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "event_machine #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-0.3.1

data/event_machine.gemspec

@@ -1,51 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = "event_machine"
-  s.version = "0.3.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["tim.teng"]
-  s.date = "2011-12-16"
-  s.description = "Event Machine is observer to record any action you want to keep an eye on"
-  s.email = "tim.rubist@gmail.com"
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "event_machine.gemspec",
-    "generators/event_machine/USAGE",
-    "generators/event_machine/event_machine_generator.rb",
-    "generators/event_machine/templates/event.rb",
-    "generators/event_machine/templates/functional_test.rb",
-    "lib/event_machine.rb",
-    "test/helper.rb",
-    "test/test_event_machine.rb"
-  ]
-  s.homepage = "http://github.com/tteng/event_machine"
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
-  s.summary = "an observer to record events"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-    else
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-  end
-end
-

data/generators/event_machine/USAGE

@@ -1,2 +0,0 @@
-Usage: rails g event_machine EventName Controller Action
-Example: rails g event_machine media_rated Admin::ContentController rate_media

data/test/helper.rb

@@ -1,10 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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