lifestreamable 0.0.2 → 0.0.3

data/History.txt

@@ -2,3 +2,7 @@
 
 * 1 major enhancement:
   * Initial release
+
+=== 0.0.1 2010-05-19
+* 1 documentation:
+  * added a lot of documentation to Readme.rdoc and lib/lifestreamable/lifestreamable.rb

data/Manifest.txt

@@ -1,9 +1,17 @@
 History.txt
 Manifest.txt
-PostInstall.txt
 README.rdoc
 Rakefile
+generators/lifestreamable_migration/lifestreamable_migration_generator.rb
+generators/lifestreamable_migration/templates/migration.rb
 lib/lifestreamable.rb
+lib/lifestreamable/create_observer.rb
+lib/lifestreamable/destroy_observer.rb
+lib/lifestreamable/lifestream_observer.rb
+lib/lifestreamable/lifestreamable.rb
+lib/lifestreamable/lifestreamed.rb
+lib/lifestreamable/observer.rb
+lib/lifestreamable/update_observer.rb
 script/console
 script/destroy
 script/generate

data/README.rdoc

@@ -78,6 +78,7 @@ see the module Lifestreamable for all the details.
 == INSTALL:
 
 * sudo gem install lifestreamable
+* script/generate lifestreamable_migration
 
 == LICENSE:
 

data/lib/lifestreamable/lifestreamable.rb

@@ -1,7 +1,68 @@
-# :title: module Lifestreamable
+# :title: Lifestreamable
+# == DESCRIPTION:
+# 
+# Lifestreamable is a rails gem that allows social network life lifestream operations. A lifestream is a series of events that occured and that are related to an owner.
+# It has been designed to collect data upfront in model observers to minimize the number of request done at display time. the goal being that if the lifestream dislays several types of data over several different models, then only a single query will be run to get all the data to display instead of querying all data for each model. this radiaclly cuts down on display time.
+# This is a port to a gem of the lifestream libraries that have been designed for the sports social network legrandclub.rds.ca
+# 
+# == INSTALLATION:
+# * gem install lifestreamable
+# * script/generate lifestreamable_migration
+#
+# == SYNOPSIS:
+# 
+# Ths lifestream modules is made up of 2 mixins, the lifestreamable, and lifestreamed modules.
+# The lifestreamed module is included for models that own events, while the lifestreamable module is included on each model that triggers the event.
+# 
+# for example, a user can write posts and comments, we want to report in the user's lifestream that the user has written posts and comments.
+# 
+# defining the owner class
+#     class User < ActiveRecord::Base
+#         lifestreamed :order=>'id asc'     # <= overrides the normal order which is 'id desc'
+#     end
+# 
+# defining the event classes
+#     class Post < ActiveRecord::Base
+#         belongs_to :user
+#         has_many :comments
+#         lifestreamable :on=>[:create, :update, :destroy], data=>:get_data, :owner=>:user
+#     
+#         def get_data   # this method must return a data structure that is serializable by YAML
+#             {
+#                 :user=>{:firstname=>self.user.firstname, :lastname=>self.user.lastname},
+#                 :post=>{:title=>self.title}
+#             }
+#         end
+#     end
+# 
+#     class Comment < ActiveRecord::Base
+#         belongs_to :user
+#         belongs_to :post
+#         # another way to get the data is through a Proc
+#         lifestreamable :on=>[:create, :update, :destroy], :owner=>:user, data=> lambda {|model| 
+#                     {
+#                         :user=>{:firstname=>model.user.firstname, :lastname=>model.user.lastname},
+#                         :post=>{:title=>model.post.title},
+#                         :comment=>{:body=>model.body}
+#                     }
+#                 }
+#     end
+# 
+# Whenever a new post is created, it will create a new entry in the lifestream model. To get the lifestream from the owner:
+#     user=User.first
+# 
+#     # get the lifestream for the user
+#     lifestream = user.lifestream  #=> returns an array of Lifestreamable::Lifesteam model instances
+#     
+#     #get the data that was stored 
+#     data = lifestream.first.object_data
+#     
+# 
+# == module Lifestreamable 
+#
 # module for models that trigger lifestream events.
 #
-# Usage:
+# == Usage:
 #   class Post < ActiveRecord::Base
 #     belongs_to :user
 #     lifestreamable :on=>[:create, :update, :destroy], :data=>:get_data, :owner=>:user
@@ -11,7 +72,7 @@
 #     end
 #   end
 #
-# Options
+# == Options
 # Note, when using Proc for the options, the model that triggers the event is always passed to the Proc.
 # ex. Proc.new {|model| ... }
 # 
@@ -32,7 +93,7 @@
 # *  :update_instead_of_destroy => Specifies if a the last entry should be updated in the lifestream when a :destroy event is triggered. can be true, false, a Proc or a function name.
 #
 #
-# Usage with all options
+# == Usage with all options
 #   class Post < ActiveRecord::Base
 #     belongs_to :user
 #     lifestreamable :on=>[:create, :update, :destroy], 
@@ -72,7 +133,8 @@
 #
 #   end
 #
-# WARNING, the insertion into the lifestream is done as an after filter in the controller. when debigging in the console, you may want to generate the lifestream, in this case, call Lifestreamable::Lifestreamer.generate_lifestream
+# == NOTICE
+# the insertion into the lifestream is done as an after filter in the controller. when debigging in the console, you may want to generate the lifestream, in this case, call Lifestreamable::Lifestreamer.generate_lifestream
 
 module Lifestreamable
   Struct.new('LifestreamData', :reference_type, :reference_id, :owner_type, :owner_id, :stream_type, :object_data_hash)

data/lifestreamable.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{lifestreamable}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Benoit Goyette"]
@@ -11,7 +11,6 @@ Gem::Specification.new do |s|
   s.email = %q{benoit.goyette@gmail.com}
   s.files = ["History.txt",
     "Manifest.txt",
-    "PostInstall.txt",
     "README.rdoc",
     "Rakefile",
     "generators/lifestreamable_migration/lifestreamable_migration_generator.rb",

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Benoit Goyette
@@ -29,7 +29,6 @@ extra_rdoc_files: []
 files: 
 - History.txt
 - Manifest.txt
-- PostInstall.txt
 - README.rdoc
 - Rakefile
 - generators/lifestreamable_migration/lifestreamable_migration_generator.rb

data/PostInstall.txt

@@ -1,7 +0,0 @@
-
-For more information on lifestreamable, see http://lifestreamable.rubyforge.org
-
-NOTE: Change this information in PostInstall.txt 
-You can also delete it if you don't want it.
-
-