event_machine 0.2.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

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/README.rdoc

@@ -0,0 +1,87 @@
+= 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:
+
+<pre>
+
+BlogController:
+
+def create
+ # new and save code
+ notice_all_friends
+end
+
+end
+
+</pre>
+
+  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:
+
+    config.gem "event_machine", :version => ">=0.2.0"
+
+and the generate command :
+
+<pre>
+  ~your_project_path> script/generate event_machine create_favorite FavoriteController create 
+</pre>
+
+then it will generate a event file which content like following:
+
+<pre>
+
+  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
+
+</pre>
+
+now you can add your code in the block and after block, enjoy.
+
+= to observe multiple actions 
+
+  to observe multiple actions, you should:
+
+<pre>
+  for_actions [[FavoritesController, :create], [BlogsController,:create]] do
+
+    before do
+      # your code goes here
+    end
+
+    after do
+      # your code goes here
+    end
+
+  end
+
+</pre>
+
+
+== 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,53 @@
+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

@@ -0,0 +1 @@
+0.2.0

data/event_machine.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{event_machine}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["tim.teng"]
+  s.date = %q{2010-05-12}
+  s.description = %q{Event Machine is observer to record any action you want to keep an eye on}
+  s.email = %q{tim.rubist@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "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 = %q{http://github.com/tteng/event_machine}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{an observer to record events}
+  s.test_files = [
+    "test/test_event_machine.rb",
+     "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= 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

@@ -0,0 +1,2 @@
+Usage: ./script/generate event EventName Controller Action
+Example: ./script/generate event media_rated Admin::ContentController rate_media

data/generators/event_machine/event_machine_generator.rb

@@ -0,0 +1,43 @@
+class EventMachineGenerator < Rails::Generator::NamedBase
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @event_name = runtime_args.shift
+    @controller_name = runtime_args.shift
+    @controller_action = runtime_args.shift
+    unless valid_options?
+      puts "Invalid arguments!"
+      puts banner
+      exit
+    end
+  end
+
+  def manifest
+    record do |m|
+      m.directory "app/events"
+      m.directory "test/functional/events"
+      m.template "event.rb",
+        File.join('app/events', "#{@event_name}Event".underscore + ".rb"),
+        :assigns => { :controller => @controller_name, :action => @controller_action }
+
+      m.template "functional_test.rb",
+        File.join('test/functional/events', "#{@event_name}Event".underscore + "_test.rb"),
+          :assigns => { :controller => @controller_name,
+                        :action => @controller_action,
+                        :event => "#{@event_name}Event"
+                      }
+    end
+  end
+
+  def banner
+    "Usage: #{$0} event EventName Controller Action"
+    "Example: #{$0} event media_rated Admin::ContentController rate"
+  end
+
+  private
+
+  def valid_options?
+    [@event_name, @controller_name, @controller_action].all? { |v| !v.blank? }
+  end
+
+end

data/generators/event_machine/templates/event.rb

@@ -0,0 +1,11 @@
+for_action <%= controller %>, :<%= action %> do
+  
+  before do
+    # This will be called before <%= controller %>#<%= action %>
+  end
+  
+  after do
+    # This will be called after <%= controller %>#<%= action %>
+  end
+  
+end

data/generators/event_machine/templates/functional_test.rb

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

data/lib/event_machine.rb

@@ -0,0 +1,112 @@
+require "pp"
+require 'benchmark'
+
+module EventMachine 
+
+  EVENTS_DIR = (defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/app/events" : "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["#{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

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,88 @@
+--- !ruby/object:Gem::Specification 
+name: event_machine
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- tim.teng
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-12 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Event Machine is observer to record any action you want to keep an eye on
+email: tim.rubist@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- 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
+has_rdoc: true
+homepage: http://github.com/tteng/event_machine
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: an observer to record events
+test_files: 
+- test/test_event_machine.rb
+- test/helper.rb