mifix-timeline_fu 0.2.0

data/README.rdoc

@@ -0,0 +1,110 @@
+= TimelineFu
+
+Easily build timelines, much like GitHub's news feed.
+
+== Usage
+
+TimelineFu requires you to have a TimelineEvent model. 
+The simplest way is to use the generator.
+
+  $ script/generate timeline_fu && rake db:migrate
+        exists  db/migrate
+        create  db/migrate/20090333222034_create_timeline_events.rb
+        create  app/models/timeline_event.rb
+  # Migration blabber...
+
+Next step is to determine what generates an event in your various models.
+
+  class Post < ActiveRecord::Base
+    #...
+    belongs_to :author, :class_name => 'Person'
+    fires :new_post, :on    => :create,
+                     :actor => :author
+  end
+
+You can add 'fires' statements to as many models as you want on as many models
+as you want. 
+
+They are hooked for you after standard ActiveRecord events. In
+the previous example, it's an after_create on Posts. 
+
+=== Parameters for #fires
+
+You can supply a few parameters to fires, two of them are mandatory.
+- the first param is a custom name for the event type. It'll be your way of figuring out what events your reading back from the timeline_events table later.
+  - :new_post in the example
+
+The rest all fit neatly in an options hash.
+
+- :on => [ActiveRecord event] 
+  - mandatory. You use it to specify whether you want the event created after a create, update or destroy.
+- :actor is your way of specifying who took this action.
+  - In the example, post.author is going to be this person.
+- :subject is automatically set to self, which is good most of the time.  You can however override it if you need to, using :subject.
+- :secondary_subject can let you specify something else that's related to the event. A comment to a blog post would be a good example.
+- :if => symbol or proc/lambda lets you put conditions on when a TimelineEvent is created. It's passed right to the after_xxx ActiveRecord event hook, so it's has the same behavior.
+- any other parameter is treated as TimelineEvent's attribute
+  - This is useful if you add a custom field to timeline_events table
+
+Here's another example:
+
+  class Comment < ActiveRecord::Base
+    #...
+    belongs_to :commenter, :class_name => 'Person'
+    belongs_to :post
+    fires :new_comment, :on                 => :create,
+                        :actor              => :commenter,
+                        #implicit :subject  => self,
+                        :secondary_subject  => 'post',
+                        :if => lambda { |comment| comment.commenter != comment.post.author }
+  end
+
+=== TimelineEvent instantiation
+
+The ActiveRecord event hook will automatically instantiate a 
+TimelineEvent instance for you.
+It will receive the following parameters in #create!
+
+- event_type 
+  - "new_comment" in the comment example
+- actor 
+  - the commenter
+- subject
+  - the comment instance
+- secondary_subject
+  - the post instance
+
+The generated model stores most of its info as polymorphic relationships.
+
+  class TimelineEvent < ActiveRecord::Base
+    belongs_to :actor,              :polymorphic => true
+    belongs_to :subject,            :polymorphic => true
+    belongs_to :secondary_subject,  :polymorphic => true
+  end
+
+== How you actually get your timeline
+
+To get your timeline you'll probably have to create your own finder SQL or scopes 
+(if your situation is extremely simple). 
+
+TimelineFu is not currently providing anything to generate your timeline because 
+different situations will have wildly different requirements. Like access control 
+issues and actually just what crazy stuff you're cramming in that timeline.
+
+We're not saying it can't be done, just that we haven't done it yet. 
+Contributions are welcome :-)
+
+== Get it
+
+timeline_fu can be used as a plugin:
+
+  $ script/plugin install git://github.com/giraffesoft/timeline_fu.git
+
+or as a gem plugin:
+
+  config.gem "giraffesoft-timeline_fu", :lib => "timeline_fu", 
+    :source => "http://gems.github.com"
+
+== License
+
+Copyright (c) 2008 James Golick, released under the MIT license

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 2
+:patch: 0
+:major: 0

data/generators/timeline_fu/USAGE

@@ -0,0 +1,2 @@
+Generates both the TimelineEvent class and the migration to create its table. The table will have subject, actor and secondary actor as polymorphic associations.
+The use of this generator is optional. See README for more details. 

data/generators/timeline_fu/templates/migration.rb

@@ -0,0 +1,15 @@
+class CreateTimelineEvents < ActiveRecord::Migration
+  def self.up
+    create_table :timeline_events do |t|
+      t.string   :event_type, :subject_type,  :actor_type,  :secondary_subject_type
+      t.integer               :subject_id,    :actor_id,    :secondary_subject_id
+      t.timestamps
+    end
+  end
+ 
+  def self.down
+    drop_table :timeline_events
+  end
+end
+ 
+

data/generators/timeline_fu/templates/model.rb

@@ -0,0 +1,5 @@
+class TimelineEvent < ActiveRecord::Base
+  belongs_to :actor,              :polymorphic => true
+  belongs_to :subject,            :polymorphic => true
+  belongs_to :secondary_subject,  :polymorphic => true
+end

data/generators/timeline_fu/timeline_fu_generator.rb

@@ -0,0 +1,9 @@
+class TimelineFuGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate', 
+        :migration_file_name => 'create_timeline_events'
+      m.template 'model.rb', 'app/models/timeline_event.rb'
+    end
+  end
+end

data/lib/timeline_fu.rb

@@ -0,0 +1,6 @@
+require 'timeline_fu/fires'
+
+module TimelineFu  
+end
+
+ActiveRecord::Base.send :include, TimelineFu::Fires

data/lib/timeline_fu/fires.rb

@@ -0,0 +1,35 @@
+module TimelineFu
+  module Fires
+    def self.included(klass)
+      klass.send(:extend, ClassMethods)
+    end
+
+    module ClassMethods
+      def fires(event_type, opts)
+        raise ArgumentError, "Argument :on is mandatory" unless opts.has_key?(:on)
+        opts[:subject] = :self unless opts.has_key?(:subject)
+
+        on = opts.delete(:on)
+        _if = opts.delete(:if)
+
+        method_name = :"fire_#{event_type}_after_#{on}"
+        define_method(method_name) do
+          create_options = opts.keys.inject({}) do |memo, sym|
+            case opts[sym]
+            when :self
+              memo[sym] = self
+            else
+              memo[sym] = send(opts[sym]) if opts[sym]
+            end
+            memo
+          end
+          create_options[:event_type] = event_type.to_s
+
+          TimelineEvent.create!(create_options)
+        end
+
+        send(:"after_#{on}", method_name, :if => _if)
+      end
+    end
+  end
+end

data/lib/timeline_fu/macros.rb

@@ -0,0 +1,20 @@
+module TimelineFu
+  module Macros
+    def should_fire_event(event_type, opts = {})
+      should "fire #{event_type} on #{opts[:on]}" do
+        matcher = fire_event(event_type, opts)
+
+        assert_accepts matcher, self.class.name.gsub(/Test$/, '').constantize
+      end
+    end
+
+    def should_not_fire_event(event_type, opts = {})
+      should "fire #{event_type} on #{opts[:on]}" do
+        matcher = fire_event(event_type, opts)
+
+        assert_rejects matcher, self.class.name.gsub(/Test$/, '').constantize
+      end
+    end
+
+  end
+end

data/lib/timeline_fu/matchers.rb

@@ -0,0 +1,58 @@
+module TimelineFu
+  module Matchers
+    class FireEvent
+      def initialize(event_type, opts = {})
+        @event_type = event_type
+        @opts = opts
+        @method = :"fire_#{@event_type}_after_#{@opts[:on]}"
+      end
+
+      def matches?(subject)
+        @subject = subject
+
+        defines_callback_method? && setups_up_callback?
+      end
+
+      def defines_callback_method?
+        if @subject.instance_methods.include?(@method.to_s)
+          true
+        else
+          @missing = "#{@subject.name} does not respond to #{@method}"
+          false
+        end
+      end
+
+      def setups_up_callback?
+        callback_chain_name = "after_#{@opts[:on]}_callback_chain"
+        callback_chain = @subject.send(callback_chain_name)
+        if callback_chain.any? {|chain| chain.method == @method }
+          true
+        else
+          @missing = "does setup after #{@opts[:on]} callback for #{@method}"
+          false
+        end
+      end
+
+      def description
+        "fire a #{@event_type} event"
+      end
+
+      def expectation
+        expected = "#{@subject.name} to #{description}"
+      end
+
+      def failure_message
+        "Expected #{expectation} (#{@missing})"
+      end
+
+      def negative_failure_message
+        "Did not expect #{expectation}"
+      end
+
+    end
+
+    def fire_event(event_type, opts)
+      FireEvent.new(event_type, opts)
+    end
+  end
+end

data/test/fires_test.rb

@@ -0,0 +1,82 @@
+require File.dirname(__FILE__)+'/test_helper'
+
+class FiresTest < Test::Unit::TestCase
+  def setup
+    @james = create_person(:email => 'james@giraffesoft.ca')
+    @mat   = create_person(:email => 'mat@giraffesoft.ca')
+  end
+  
+  def test_should_fire_the_appropriate_callback
+    @list = List.new(hash_for_list(:author => @james));
+    TimelineEvent.expects(:create!).with(:actor => @james, :subject => @list, :event_type => 'list_created')
+    @list.save
+  end
+
+  def test_should_fire_event_with_secondary_subject
+    @list = List.new(hash_for_list(:author => @james));
+    TimelineEvent.stubs(:create!)
+    @list.save
+    @comment = Comment.new(:body => 'cool list!', :author => @mat, :list => @list)
+    TimelineEvent.expects(:create!).with(:actor             => @mat, 
+                                         :subject           => @comment, 
+                                         :secondary_subject => @list, 
+                                         :event_type        => 'comment_created')
+    @comment.save
+  end
+
+  def test_exception_raised_if_on_missing
+    # This needs to be tested with should_raise, to check out the msg content
+    assert_raise(ArgumentError) do
+      some_class = Class.new(ActiveRecord::Base)
+      some_class.class_eval do
+        attr_accessor :someone
+        fires :some_event, :actor => :someone
+      end
+    end
+  end
+
+  def test_should_only_fire_if_the_condition_evaluates_to_true
+    TimelineEvent.expects(:create!).with(:actor => @mat, :subject => @james, :event_type => 'follow_created')
+    @james.new_watcher = @mat
+    @james.save
+  end
+  
+  def test_should_not_fire_if_the_if_condition_evaluates_to_false
+    TimelineEvent.expects(:create!).never
+    @james.new_watcher = nil
+    @james.save
+  end
+  
+  def test_should_fire_event_with_symbol_based_if_condition_that_is_true
+    @james.fire = true
+    TimelineEvent.expects(:create!).with(:subject => @james, :event_type => 'person_updated')
+    @james.save
+  end
+  
+  def test_should_fire_event_with_symbol_based_if_condition
+    @james.fire = false
+    TimelineEvent.expects(:create!).never
+    @james.save
+  end
+
+  def test_should_set_secondary_subject_to_self_when_requested
+    @list = List.new(hash_for_list(:author => @james));
+    TimelineEvent.stubs(:create!).with(has_entry(:event_type, "list_created"))
+    @list.save
+    @comment = Comment.new(:body => 'cool list!', :author => @mat, :list => @list)
+    TimelineEvent.stubs(:create!).with(has_entry(:event_type, "comment_created"))
+    @comment.save
+    TimelineEvent.expects(:create!).with(:actor             => @mat, 
+                                         :subject           => @list, 
+                                         :secondary_subject => @comment, 
+                                         :event_type        => 'comment_deleted')
+    @comment.destroy
+  end
+
+  def test_should_set_additional_attributes_when_present
+    @site = Site.create(:name => 'foo.com')
+    @article = Article.new(:body => 'cool article!', :author => @james, :site => @site)
+    TimelineEvent.expects(:create!).with(:actor => @james, :subject => @article, :event_type => 'article_created', :site => @site)
+    @article.save
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,107 @@
+require 'rubygems'
+require 'activerecord'
+require 'mocha'
+require 'test/unit'
+require 'logger'
+
+require File.dirname(__FILE__)+'/../lib/timeline_fu'
+
+ActiveRecord::Base.configurations = {'sqlite3' => {:adapter => 'sqlite3', :database => ':memory:'}}
+ActiveRecord::Base.establish_connection('sqlite3')
+
+ActiveRecord::Base.logger = Logger.new(STDERR)
+ActiveRecord::Base.logger.level = Logger::WARN
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :people do |t|
+    t.string  :email,    :default => ''
+    t.string  :password, :default => ''
+  end
+
+  create_table :lists do |t|
+    t.integer :author_id
+    t.string  :title
+  end
+
+  create_table :comments do |t|
+    t.integer :list_id, :author_id
+    t.string  :body
+  end
+
+  create_table :sites do |t|
+    t.string  :name
+  end
+
+  create_table :articles do |t|
+    t.integer :site_id
+    t.string :body
+  end
+end
+
+class Person < ActiveRecord::Base
+  attr_accessor :new_watcher, :fire
+  
+  fires :follow_created,  :on     => :update, 
+                          :actor  => :new_watcher, 
+                          :if     => lambda { |person| !person.new_watcher.nil? }
+  fires :person_updated,  :on     => :update,
+                          :if     => :fire?
+
+  def fire?
+    new_watcher.nil? && fire
+  end
+end
+
+class List < ActiveRecord::Base
+  belongs_to :author, :class_name => "Person"
+  has_many :comments
+  
+  fires :list_created,  :actor  => :author, 
+                        :on     => :create
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :list
+  belongs_to :author, :class_name => "Person"
+
+  fires :comment_created, :actor   => :author,
+                          :on      => :create,
+                          :secondary_subject => :list
+  fires :comment_deleted, :actor   => :author,
+                          :on      => :destroy,
+                          :subject => :list,
+                          :secondary_subject => :self
+end
+
+class Site < ActiveRecord::Base
+end
+
+class Article < ActiveRecord::Base
+  belongs_to :author, :class_name => "Person"
+  belongs_to :site
+
+  fires :article_created, :actor => :author,
+                          :on    => :create,
+                          :site  => :site
+end
+
+TimelineEvent = Class.new
+
+class Test::Unit::TestCase
+  protected
+    def hash_for_list(opts = {})
+      {:title => 'whatever'}.merge(opts)
+    end
+    
+    def create_list(opts = {})
+      List.create!(hash_for_list(opts))
+    end
+    
+    def hash_for_person(opts = {})
+      {:email => 'james'}.merge(opts)
+    end
+    
+    def create_person(opts = {})
+      Person.create!(hash_for_person(opts))
+    end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: mifix-timeline_fu
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- James Golick
+- Mathieu Martin
+- Francois Beausoleil
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Easily build timelines, much like GitHub's news feed
+email: james@giraffesoft.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- VERSION.yml
+- generators/timeline_fu
+- generators/timeline_fu/templates
+- generators/timeline_fu/templates/migration.rb
+- generators/timeline_fu/templates/model.rb
+- generators/timeline_fu/timeline_fu_generator.rb
+- generators/timeline_fu/USAGE
+- lib/timeline_fu
+- lib/timeline_fu/fires.rb
+- lib/timeline_fu/macros.rb
+- lib/timeline_fu/matchers.rb
+- lib/timeline_fu.rb
+- test/fires_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/giraffesoft/timeline_fu
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Easily build timelines, much like GitHub's news feed
+test_files: []
+