mongoid_timeline_fu 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2-p180@mongoid_timeline_fu

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mongoid_timeline_fu.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Teng Siong Ong
+
+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.md

@@ -0,0 +1,108 @@
+MongoidTimelineFu
+=================
+
+Easily build timelines, much like GitHub's news feed. But, on Mongoid tho. This
+project is a port of [TimelineFu](https://github.com/jamesgolick/timeline_fu) on [Mongoid](http://mongoid.org/).
+
+Usage
+=====
+
+MongoidTimelineFu requires you to have a TimelineEvent model. 
+The simplest way is to use the generator.
+
+    $ rails generate mongoid_timeline_fu
+          create  app/models/timeline_event.rb
+
+Next step is to determine what generates an event in your various models.
+
+    class Post
+      #...
+      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 Mongoid 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 above.
+
+The rest all fit neatly in an options hash.
+
+- :on => [Mongoid event] 
+  - mandatory. You use it to specify whether you want the event created after a create, update or destroy. You can also supply an array of events, e.g. [:create, :update].
+- :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 Mongoid event hook, so it's has the same behavior.
+
+Here's another example:
+
+    class Comment
+      #...
+      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 Mongoid 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
+      include Mongoid::Document
+      field :event_type, :type => String
+
+      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 or scopes 
+(if your situation is extremely simple). 
+
+MongoidTimelineFu 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
+======
+
+    # Gemfile
+    gem "mongoid_timeline_fu"
+
+License
+=======
+
+Copyright (c) 2011 Teng Siong Ong, released under the MIT license

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the timeline_fu plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/lib/generators/mongoid_timeline_fu_generator.rb

@@ -0,0 +1,9 @@
+require 'rails/generators'
+
+class MongoidTimelineFuGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../templates", __FILE__)
+
+  def create_migration_file
+    copy_file 'model.rb', 'app/models/timeline_event.rb'
+  end
+end

data/lib/generators/templates/model.rb

@@ -0,0 +1,8 @@
+class TimelineEvent
+  include Mongoid::Document
+  field :event_type, :type => String
+
+  belongs_to :actor,              :polymorphic => true
+  belongs_to :subject,            :polymorphic => true
+  belongs_to :secondary_subject,  :polymorphic => true
+end

data/lib/mongoid_timeline_fu/fires.rb

@@ -0,0 +1,36 @@
+module MongoidTimelineFu
+  module Fires
+    def fires(event_type, opts)
+      raise ArgumentError, "Argument :on is mandatory" unless opts.has_key?(:on)
+    
+      # Array provided, set multiple callbacks
+      if opts[:on].kind_of?(Array)
+        opts[:on].each { |on| fires(event_type, opts.merge({:on => on})) }
+        return
+      end
+    
+      opts[:subject] = :self unless opts.has_key?(:subject)
+    
+      method_name = :"fire_#{event_type}_after_#{opts[:on]}"
+      define_method(method_name) do
+        create_options = [:actor, :subject, :secondary_subject].inject({}) do |memo, sym|
+          if opts[sym]
+            if opts[sym].respond_to?(:call)
+              memo[sym] = opts[sym].call(self)
+            elsif opts[sym] == :self
+              memo[sym] = self
+            else
+              memo[sym] = send(opts[sym])
+            end
+          end
+          memo
+        end
+        create_options[:event_type] = event_type.to_s
+    
+        TimelineEvent.create!(create_options)
+      end
+    
+      send(:"after_#{opts[:on]}", method_name, :if => opts[:if])
+    end
+  end
+end

data/lib/mongoid_timeline_fu/version.rb

@@ -0,0 +1,3 @@
+module MongoidTimelineFu
+  VERSION = "0.0.1"
+end

data/lib/mongoid_timeline_fu.rb

@@ -0,0 +1,9 @@
+require "mongoid_timeline_fu/version"
+require "mongoid_timeline_fu/fires"
+
+module MongoidTimelineFu
+end
+
+Mongoid::Document::ClassMethods.class_eval do
+  include MongoidTimelineFu::Fires
+end

data/mongoid_timeline_fu.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mongoid_timeline_fu/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mongoid_timeline_fu"
+  s.version     = MongoidTimelineFu::VERSION
+  s.authors     = ["Teng Siong Ong"]
+  s.email       = ["siong1987@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Easily build timelines, much like GitHub's news feed. But, on Mongoid tho.}
+  s.description = %q{Easily build timelines, much like GitHub's news feed. But, on Mongoid tho.}
+
+  s.rubyforge_project = "mongoid_timeline_fu"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "mocha"
+  s.add_dependency("mongoid", "~> 2.0.0")
+  s.add_dependency("bson_ext", "~> 1.4.0")
+end

data/test/fires_test.rb

@@ -0,0 +1,79 @@
+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_or_updated')
+    @list.save
+    TimelineEvent.expects(:create!).with(:actor => @mat, :subject => @list, :event_type => 'list_created_or_updated')
+    @list.author = @mat
+    @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
+      some_class.class_eval do
+        include Mongoid::Document
+        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_or_updated"))
+    @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
+end

data/test/test_helper.rb

@@ -0,0 +1,77 @@
+require 'rubygems'
+require 'mongoid'
+require 'test/unit'
+require 'mocha'
+
+require File.dirname(__FILE__)+'/../lib/mongoid_timeline_fu'
+
+Mongoid.configure do |config|
+  config.master  = Mongo::Connection.new('127.0.0.1', 27017).db("timeline-fu-test-suite")
+  config.use_utc = true
+  config.include_root_in_json = true
+end
+
+class Person
+  include Mongoid::Document
+  field :email,    :type => String
+  field :password, :type => String
+  attr_accessor :new_watcher, :fire
+  
+  fires :follow_created,  :on     => :update, 
+                          :actor  => lambda { |person| person.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
+  include Mongoid::Document
+  field :title, :type => String
+
+  belongs_to :author, :class_name => "Person"
+  has_many :comments
+  
+  fires :list_created_or_updated,  :actor  => :author, 
+                                   :on     => [:create, :update]
+end
+
+class Comment
+  include Mongoid::Document
+  field :body, :type => String
+
+  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
+
+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,95 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_timeline_fu
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Teng Siong Ong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70235157266800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70235157266800
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &70235157266300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70235157266300
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &70235157265740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70235157265740
+description: Easily build timelines, much like GitHub's news feed. But, on Mongoid
+  tho.
+email:
+- siong1987@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/mongoid_timeline_fu_generator.rb
+- lib/generators/templates/model.rb
+- lib/mongoid_timeline_fu.rb
+- lib/mongoid_timeline_fu/fires.rb
+- lib/mongoid_timeline_fu/version.rb
+- mongoid_timeline_fu.gemspec
+- test/fires_test.rb
+- test/test_helper.rb
+homepage: ''
+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: mongoid_timeline_fu
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Easily build timelines, much like GitHub's news feed. But, on Mongoid tho.
+test_files:
+- test/fires_test.rb
+- test/test_helper.rb