Stream 0.0.5 → 0.0.6

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+.DS_Store

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 James Golick
+
+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,102 @@
+= 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. 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 ActiveRecord event hook, so it's has the same behavior.
+
+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
+
+  # Gemfile
+  gem "timeline_fu"
+
+== License
+
+Copyright (c) 2008 James Golick, released under the MIT license

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+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
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "timeline_fu"
+    s.summary = %Q{Easily build timelines, much like GitHub's news feed}
+    s.email = "james@giraffesoft.ca"
+    s.homepage = "http://github.com/giraffesoft/timeline_fu"
+    s.description = "Easily build timelines, much like GitHub's news feed"
+    s.authors = ["James Golick", "Mathieu Martin", "Francois Beausoleil"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc 'Generate documentation for the timeline_fu plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TimelineFu'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

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

data/generators/stream/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/stream/stream_generator.rb

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

data/generators/stream/templates/migration.rb

@@ -0,0 +1,15 @@
+class CreateActivities < ActiveRecord::Migration
+  def self.up
+    create_table :activities do |t|
+      t.string   :activity_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 :activities
+  end
+end
+ 
+

data/generators/stream/templates/model.rb

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

data/init.rb

@@ -0,0 +1 @@
+require 'timeline_fu'

data/lib/stream/fires.rb

@@ -0,0 +1,42 @@
+module Stream
+  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)
+
+        # 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
+
+          Activity.create!(create_options)
+        end
+
+        send(:"after_#{opts[:on]}", method_name, :if => opts[:if])
+      end
+    end
+  end
+end

data/lib/stream/macros.rb

@@ -0,0 +1,20 @@
+module Stream
+  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/stream/matchers.rb

@@ -0,0 +1,58 @@
+module Stream
+  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/lib/stream.rb

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

data/stream.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{Stream}
+  s.version = "0.0.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gretchen Gapol"]
+  s.date = %q{2011-06-27}
+  s.description = %q{news feed}
+  s.email = %q{ggapol@exist.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "generators/stream/USAGE",
+     "generators/stream/templates/migration.rb",
+     "generators/stream/templates/model.rb",
+     "generators/stream/stream_generator.rb",
+     "init.rb",
+     "lib/stream.rb",
+     "lib/stream/fires.rb",
+     "lib/stream/macros.rb",
+     "lib/stream/matchers.rb",
+     "stream.gemspec"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/gretch}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{news feed}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+  end
+end

metadata

@@ -1,309 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: Stream
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
-- GING - DIT - UPM
-- CISE - ESPOL
+- Gretchen Gapol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-23 00:00:00.000000000 +08:00
+date: 2011-06-27 00:00:00.000000000 +08:00
 default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: ancestry
-  requirement: &12558400 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.3
-  type: :runtime
-  prerelease: false
-  version_requirements: *12558400
-- !ruby/object:Gem::Dependency
-  name: foreigner
-  requirement: &12557900 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.1
-  type: :runtime
-  prerelease: false
-  version_requirements: *12557900
-- !ruby/object:Gem::Dependency
-  name: devise
-  requirement: &12557440 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.rc
-  type: :runtime
-  prerelease: false
-  version_requirements: *12557440
-- !ruby/object:Gem::Dependency
-  name: inherited_resources
-  requirement: &12556980 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.2
-  type: :runtime
-  prerelease: false
-  version_requirements: *12556980
-- !ruby/object:Gem::Dependency
-  name: stringex
-  requirement: &12556520 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *12556520
-- !ruby/object:Gem::Dependency
-  name: paperclip
-  requirement: &12556060 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.3.4
-  type: :runtime
-  prerelease: false
-  version_requirements: *12556060
-- !ruby/object:Gem::Dependency
-  name: avatars_for_rails
-  requirement: &12555600 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.9
-  type: :runtime
-  prerelease: false
-  version_requirements: *12555600
-- !ruby/object:Gem::Dependency
-  name: jquery-rails
-  requirement: &12555140 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.2.5
-  type: :runtime
-  prerelease: false
-  version_requirements: *12555140
-- !ruby/object:Gem::Dependency
-  name: cancan
-  requirement: &12591500 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.4
-  type: :runtime
-  prerelease: false
-  version_requirements: *12591500
-- !ruby/object:Gem::Dependency
-  name: will_paginate
-  requirement: &12591040 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.0.pre2
-  type: :runtime
-  prerelease: false
-  version_requirements: *12591040
-- !ruby/object:Gem::Dependency
-  name: omniauth
-  requirement: &12590580 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.2.6
-  type: :runtime
-  prerelease: false
-  version_requirements: *12590580
-- !ruby/object:Gem::Dependency
-  name: oauth-plugin
-  requirement: &12590120 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.4.0.pre1
-  type: :runtime
-  prerelease: false
-  version_requirements: *12590120
-- !ruby/object:Gem::Dependency
-  name: rails_css_themes
-  requirement: &12589660 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *12589660
-- !ruby/object:Gem::Dependency
-  name: mailboxer
-  requirement: &12589200 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.1.4
-  type: :runtime
-  prerelease: false
-  version_requirements: *12589200
-- !ruby/object:Gem::Dependency
-  name: rmagick
-  requirement: &12588740 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.13.1
-  type: :runtime
-  prerelease: false
-  version_requirements: *12588740
-- !ruby/object:Gem::Dependency
-  name: acts-as-taggable-on
-  requirement: &12588280 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.0.6
-  type: :runtime
-  prerelease: false
-  version_requirements: *12588280
-- !ruby/object:Gem::Dependency
-  name: formtastic
-  requirement: &12587820 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.3
-  type: :runtime
-  prerelease: false
-  version_requirements: *12587820
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &12587360 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.0.7
-  type: :development
-  prerelease: false
-  version_requirements: *12587360
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: &12586900 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.3.9
-  type: :development
-  prerelease: false
-  version_requirements: *12586900
-- !ruby/object:Gem::Dependency
-  name: sqlite3-ruby
-  requirement: &12586520 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *12586520
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: &12585960 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.5.0
-  type: :development
-  prerelease: false
-  version_requirements: *12585960
-- !ruby/object:Gem::Dependency
-  name: factory_girl
-  requirement: &12585460 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.3.2
-  type: :development
-  prerelease: false
-  version_requirements: *12585460
-- !ruby/object:Gem::Dependency
-  name: forgery
-  requirement: &12585000 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.3.6
-  type: :development
-  prerelease: false
-  version_requirements: *12585000
-- !ruby/object:Gem::Dependency
-  name: ci_reporter
-  requirement: &12584540 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.4
-  type: :development
-  prerelease: false
-  version_requirements: *12584540
-- !ruby/object:Gem::Dependency
-  name: nifty-generators
-  requirement: &12584080 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.4.5
-  type: :development
-  prerelease: false
-  version_requirements: *12584080
-description: ! 'Social Stream is a Ruby on Rails engine providing your application
-  with social networking features and activity streams.
-
-
-  This gem packages the basic functionality, along with basic actors (user, group)
-  and activity objects(post and comments)'
-email: 
+dependencies: []
+description: news feed
+email: ggapol@exist.com
 executables: []
 extensions: []
-extra_rdoc_files: []
-files: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- generators/stream/USAGE
+- generators/stream/templates/migration.rb
+- generators/stream/templates/model.rb
+- generators/stream/stream_generator.rb
+- init.rb
+- lib/stream.rb
+- lib/stream/fires.rb
+- lib/stream/macros.rb
+- lib/stream/matchers.rb
+- stream.gemspec
 has_rdoc: true
-homepage: http://social-stream.dit.upm.es/
+homepage: http://github.com/gretch
 licenses: []
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -322,6 +58,6 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.6.2
 signing_key: 
-specification_version: 3
-summary: Basic features for Social Stream, the core for building social network websites
+specification_version: 2
+summary: news feed
 test_files: []