features/scribe.feature features/steps/scribe_steps.rb features/support/env.rb spec/factories.rb spec/models.rb spec/models/activity_spec.rb spec/schema.rb spec/spec.opts spec/spec_helper.rb @@ -23,20 +23,47 @@ Install `rake db:migrate` -Usage ------ +Record activities in your models +--------------------------------------------- - * Make your ActiveRecord model acts as scribe. <pre> class Comment < ActiveRecord::Base record_activity_of :user end </pre> +You can use any association that is related to an user: +<pre> + class Post < ActiveRecord::Base + belongs_to :author, :class_name => "User" + record_activity_of :author + end +</pre> + +This will register automatically a new activity when you create or destroy a new record. If you want control over the activities registration based on your model's state just use the :if option - * If you want to record activities not related to any specific model just use `record_activities :activity` in your user model: <pre> - class User < ActiveRecord::Base - record_activities [:featured_on_home, :logged_in, :logged_out] + class Post < ActiveRecord::Base + belongs_to :author, :class_name => "User" + record_activity_of :author, :if => Proc.new { |post| post.private == false } + end +</pre> + + +Record activities without related item +-------------------------------------- + +If you want to record activities not related to any specific model just use `Activity.report` in your code: +<pre> + def grant_admin(user) + user.admin = true + Activity.report(current_user, :grant_admin, user) + end +</pre> +If the action is not related to any item, just don't use it. +<pre> + def login + current_user = User.find(…) + Activity.report(current_user, :login) end </pre> README.markdown @@ -1,22 +1,51 @@ require 'rake' -require 'rake/testtask' -require 'rake/rdoctask' -desc 'Default: run unit tests.' -task :default => :test - -desc 'Test the acts_as_scribe plugin.' -Rake::TestTask.new(:test) do |t| - t.libs << 'lib' - t.pattern = 'test/**/*_test.rb' - t.verbose = true +begin + require 'jeweler' + Jeweler::Tasks.new do |s| + s.name = "acts_as_scribe" + s.summary = %Q{A simple plugin that allows to keep track of the users activity. Common uses could be user's wall, public timeline portlets, etc...} + s.email = "aitor@linkingpaths.com" + s.homepage = "http://github.com/linkingpaths/acts_as_scribe" + s.description = "A simple plugin that allows to keep track of the users activity. Common uses could be user's wall, public timeline portlets, etc..." + s.authors = ["Linking Paths", "Aitor García", "Roberto Salicio"] + 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 acts_as_scribe plugin.' -Rake::RDocTask.new(:rdoc) do |rdoc| +require 'rake/rdoctask' +Rake::RDocTask.new do |rdoc| rdoc.rdoc_dir = 'rdoc' - rdoc.title = 'ActsAsScribe' + rdoc.title = 'acts_as_scribe' rdoc.options << '--line-numbers' << '--inline-source' - rdoc.rdoc_files.include('README') + rdoc.rdoc_files.include('README*') rdoc.rdoc_files.include('lib/**/*.rb') end + +require 'rake/testtask' +Rake::TestTask.new(:test) do |t| + t.libs << 'lib' << 'test' + t.pattern = 'test/**/*_test.rb' + t.verbose = false +end + +begin + require 'rcov/rcovtask' + Rcov::RcovTask.new do |t| + t.libs << 'test' + t.test_files = FileList['test/**/*_test.rb'] + t.verbose = true + end +rescue LoadError + puts "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov" +end + +begin + require 'cucumber/rake/task' + Cucumber::Rake::Task.new(:features) +rescue LoadError + puts "Cucumber is not available. In order to run features, you must: sudo gem install cucumber" +end + +task :default => :test Rakefile @@ -1,22 +1,29 @@ +# -*- encoding: utf-8 -*- + Gem::Specification.new do |s| s.name = %q{acts_as_scribe} - s.version = "0.0.2" + s.version = "0.1.0" s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= - s.authors = ["Linking Paths"] - s.date = %q{2008-10-16} + s.authors = ["Linking Paths", "Aitor Garc\303\255a", "Roberto Salicio"] + s.date = %q{2009-02-24} s.description = %q{A simple plugin that allows to keep track of the users activity. Common uses could be user's wall, public timeline portlets, etc...} - s.email = ["aitor@linkingpaths.com"] - s.files = ["MIT-LICENSE", "README.markdown", "Rakefile", "acts_as_scribe.gemspec", "generators", "generators/acts_as_scribe_migration", "generators/acts_as_scribe_migration/acts_as_scribe_migration_generator.rb", "generators/acts_as_scribe_migration/templates", "generators/acts_as_scribe_migration/templates/migration.rb", "generators/acts_as_scribe_migration/USAGE", "init.rb", "lib", "lib/activity.rb", "lib/acts_as_scribe.rb", "lib/scribe.rb", "test", "test/.DS_Store", "test/factories.rb", "test/functional", "test/functional/acts_as_scribe_test.rb", "test/schema.rb", "test/test_helper.rb", "test/unit", "test/unit/activity_test.rb" ] + s.email = %q{aitor@linkingpaths.com} + s.files = ["README.markdown", "VERSION.yml", "generators/acts_as_scribe_migration", "generators/acts_as_scribe_migration/acts_as_scribe_migration_generator.rb", "generators/acts_as_scribe_migration/templates", "generators/acts_as_scribe_migration/templates/migration.rb", "generators/acts_as_scribe_migration/USAGE", "lib/activity.rb", "lib/acts_as_scribe.rb", "lib/scribe.rb", "spec/factories.rb", "spec/models", "spec/models/activity_spec.rb", "spec/models.rb", "spec/schema.rb", "spec/spec.opts", "spec/spec_helper.rb"] s.has_rdoc = true s.homepage = %q{http://github.com/linkingpaths/acts_as_scribe} - s.post_install_message = %q{ -For more information on acts_as_scribe, see http://github.com/linkingpaths/acts_as_scribe - -} + s.rdoc_options = ["--inline-source", "--charset=UTF-8"] s.require_paths = ["lib"] - s.rubyforge_project = %q{acts_as_scribe} - s.rubygems_version = %q{1.2.0} + s.rubygems_version = %q{1.3.1} s.summary = %q{A simple plugin that allows to keep track of the users activity. Common uses could be user's wall, public timeline portlets, etc...} + if s.respond_to? :specification_version then + current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION + s.specification_version = 2 + + if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then + else + end + else + end end acts_as_scribe.gemspec @@ -8,9 +8,11 @@ class ActsAsScribeMigration < ActiveRecord::Migration t.string :item_type t.timestamps end + add_index :activities, [:item_type, :item_id] end def self.down + remove_index :activities, [:item_type, :item_id] drop_table :activities end generators/acts_as_scribe_migration/templates/migration.rb @@ -1,17 +1,44 @@ class Activity < ActiveRecord::Base + named_scope :by_user, lambda { |users| + { :conditions => { :user_id => users}} + } + + named_scope :by_action, lambda { |action| + { :conditions => { :action => action }} + } + + named_scope :by_item, lambda { |item| + { :conditions => { :item_type => item.class.name, :item_id => item.id }} + } + + named_scope :created_since, lambda { |time_ago| + { :conditions => ['created_at > ?', time_ago]} + } + + belongs_to :user belongs_to :item, :polymorphic => true validates_presence_of :user_id def self.created_by(user) - Activity.find(:all, :conditions => { :user_id => user.id}) + raise "Activity.created_by(user) has been deprecated. Use Activity.by_user(user) instead." end def self.without_model_created_by(user) - Activity.find(:all, :conditions => { :user_id => user.id, :item_type => nil, :item_id => nil}) + raise "Activity.without_model_created_by(user) has been deprecated. Use Activity.by_user(user) and filter the results instead." end def without_model? item.nil? end -end + + def self.report(user, action, object=nil) + returning Activity.new do |a| + a.item = object if object + a.action = action + a.user = user + a.save! + end + end + +end \ No newline at end of file lib/activity.rb @@ -1,3 +1,4 @@ +require 'activity' require 'scribe' ActiveRecord::Base.send :include, LinkingPaths::Acts::Scribe \ No newline at end of file lib/acts_as_scribe.rb @@ -14,7 +14,14 @@ module LinkingPaths has_many :activities, :as => :item, :dependent => :destroy after_create do |record| unless options[:if].kind_of?(Proc) and not options[:if].call(record) - record.create_activity_from_self + user = record.send(activity_options[:actor]) + Activity.report(user, :create, record) + end + end + after_destroy do |record| + unless options[:if].kind_of?(Proc) and not options[:if].call(record) + user = record.send(activity_options[:actor]) + Activity.report(user, :destroy, record) end end } @@ -22,13 +29,9 @@ module LinkingPaths end def record_activities(actions = []) - include_scribe_instance_methods { - has_many :activities - has_many :activities_without_model, :class_name => "Activity", :conditions => { :item_type => nil, :item_id => nil } - } - self.activity_options.merge! :actions => actions + raise "record_activities(#{actions.join ','}) has been deprecated. Use Activity.report(user, #{actions.first}), etc. instead." end - + def include_scribe_instance_methods(&block) unless included_modules.include? InstanceMethods yield if block_given? @@ -37,32 +40,13 @@ module LinkingPaths include InstanceMethods end end - + end module InstanceMethods - - def create_activity_from_self - activity = Activity.new - activity.item = self - activity.action = ActiveSupport::Inflector::underscore(self.class) - actor_id = self.send( activity_options[:actor].to_s + "_id" ) - activity.user_id = actor_id - activity.save - end - def record_activity(action) - if activity_options[:actions] && activity_options[:actions].include?(action) - activity = Activity.new - activity.action = action.to_s - activity.user_id = self.id - activity.save! - else - raise "The action #{action} can't be tracked." - end - end - - + raise "record_activity has been deprecated. Use Activity.report(actor, action, item)." + end end end lib/scribe.rb test/factories.rb test/functional/acts_as_scribe_test.rb test/schema.rb test/test_helper.rb test/unit/activity_test.rb cd0780ef713b35a7f102436bf40dd5043b7b0cfe Aitor García aitor.garcia@gmail.com http://github.com/linkingpaths/acts_as_scribe/commit/519713f521f2c714fef18bbc2edfe23ac00b8a0e 519713f521f2c714fef18bbc2edfe23ac00b8a0e 2009-02-24T10:14:36-08:00 2009-02-24T10:14:36-08:00 New version 0.1 9b7e931c10b1330450093822f5b65ee6148e7162 Aitor García aitor.garcia@gmail.com