linkingpaths-acts_as_scribe 0.0.2 → 0.1.0

data/README.markdown

@@ -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>
  

data/VERSION.yml

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

data/generators/acts_as_scribe_migration/templates/migration.rb

@@ -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
 

data/lib/activity.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

data/lib/acts_as_scribe.rb

@@ -1,3 +1,4 @@
+require 'activity'
 require 'scribe'
 
 ActiveRecord::Base.send :include, LinkingPaths::Acts::Scribe

data/lib/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

data/spec/factories.rb

@@ -0,0 +1,14 @@
+Factory.define :user do |user|
+end
+Factory.define :group do |group|
+end
+Factory.define :activity do |activity|
+  activity.association :user
+end
+Factory.define :membership do |membership|
+  membership.association :user
+end
+Factory.define :post do |post|
+  post.private false
+  post.association :author, :factory => :user
+end

data/spec/models.rb

@@ -0,0 +1,20 @@
+class Post < ActiveRecord::Base
+  belongs_to :author, :class_name => "User"
+  record_activity_of :author, :if => Proc.new { |post| post.private == false }
+end
+
+
+class Membership < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :group
+  record_activity_of :user
+end
+
+class Group < ActiveRecord::Base
+  has_many :users, :through => :memberships
+end
+
+class User < ActiveRecord::Base
+  has_many :groups, :through => :memberships
+end
+

data/spec/models/activity_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Activity" do
+  
+  describe "when creating an instance of a model with a actor != user" do
+    before do
+      @p = Factory :post
+      @act = Activity.last
+    end
+    it "should find the created activity by the user" do
+      @act.user.should == @p.author
+    end
+  end
+  
+  describe "when creating an instance of a model with a :if option" do
+    before do
+      @p = Factory(:post, :private => true)
+    end
+    it "should not create the activity" do
+      Activity.by_item(@p).should have(0).things
+    end
+  end
+  
+  describe "when creating a new instance of a tracked model" do
+    before do
+      @m = Factory :membership
+      @act = Activity.last
+    end
+    it "should find the created activity by the user" do
+      Activity.by_user(@m.user).should include(@act)
+    end
+    it "should find the created activity by an users list" do
+      Activity.by_user([@m.user, Factory(:user)]).should include(@act)
+    end
+    it "should find the created activity by the action" do
+      Activity.by_action(:create).should include(@act)
+    end
+    it "should find the created activity by the item" do
+      Activity.by_item(@m).should include(@act)
+    end
+    it "should find the created activity by the creation date" do
+      Activity.created_since(5.second.ago).should include(@act)
+    end
+    it "should be related to an user" do
+      @act.should respond_to(:user)
+    end
+    it "should be related to an item" do
+      @act.should respond_to(:item)
+    end
+  end
+
+  describe "when destroying an instance of a tracked model" do
+    before do
+      Factory(:membership).destroy
+      @act = Activity.last
+    end
+    it "should find the created activity by the action" do
+      Activity.by_action(:destroy).should include(@act)
+    end
+  end
+
+  describe "when reporting a specific action" do
+    it "should create a new activity" do
+      lambda { 
+        Activity.report(Factory(:user), :grant_admin, Factory(:group))  
+      }.should change(Activity, :count).by(1)
+    end    
+    it "should allow to report actions without a item" do
+      Activity.report(Factory(:user), :login)  
+    end
+  end
+
+end

data/{test → spec}/schema.rb

@@ -1,9 +1,4 @@
 ActiveRecord::Schema.define(:version => 1) do
-  create_table :jaikus do |t|
-    t.string :content
-    t.integer :user_id
-    t.timestamps
-  end
   create_table :activities do |t|
     t.integer :user_id
     t.string  :action
@@ -14,4 +9,16 @@ ActiveRecord::Schema.define(:version => 1) do
   create_table :users do |t|
     t.string  :login
   end
+  create_table :groups do |t|
+    t.string  :name
+  end
+  create_table :memberships do |t|
+    t.integer :user_id
+    t.integer :group_id
+  end
+  create_table :posts do |t|
+    t.integer :author_id
+    t.boolean :private
+    t.string  :title
+  end
 end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+gem 'activerecord'
+require 'active_record'
+require 'factory_girl'
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'acts_as_scribe'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+load(File.dirname(__FILE__) + "/schema.rb")
+load(File.dirname(__FILE__) + "/models.rb")
+
+
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -1,21 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: linkingpaths-acts_as_scribe
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Linking Paths
+- "Aitor Garc\xC3\xADa"
+- Roberto Salicio
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-10-16 00:00:00 -07:00
+date: 2009-02-24 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
 description: A simple plugin that allows to keep track of the users activity. Common uses could be user's wall, public timeline portlets, etc...
-email: 
-- aitor@linkingpaths.com
+email: aitor@linkingpaths.com
 executables: []
 
 extensions: []
@@ -23,38 +24,29 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- MIT-LICENSE
 - README.markdown
-- Rakefile
-- acts_as_scribe.gemspec
-- generators
+- 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
-- 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
+- spec/factories.rb
+- spec/models
+- spec/models/activity_spec.rb
+- spec/models.rb
+- spec/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/linkingpaths/acts_as_scribe
-post_install_message: |+
-  
-  For more information on acts_as_scribe, see http://github.com/linkingpaths/acts_as_scribe
-  
-rdoc_options: []
-
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -71,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: acts_as_scribe
+rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2008 Linking Paths (http://www.linkingpaths.com)
- 
-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/Rakefile

@@ -1,22 +0,0 @@
-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
-end
-
-desc 'Generate documentation for the acts_as_scribe plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ActsAsScribe'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/acts_as_scribe.gemspec

@@ -1,22 +0,0 @@
-Gem::Specification.new do |s|
-  s.name = %q{acts_as_scribe}
-  s.version = "0.0.2"
-
-  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.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.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.require_paths = ["lib"]
-  s.rubyforge_project = %q{acts_as_scribe}
-  s.rubygems_version = %q{1.2.0}
-  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...}
-
-end

data/init.rb

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

data/test/factories.rb

@@ -1,5 +0,0 @@
-Factory.define :user do |u|
-end
-
-Factory.define :jaiku do |u|
-end

data/test/functional/acts_as_scribe_test.rb

@@ -1,46 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'test_helper')
-
-class ActsAsScribeTest < Test::Unit::TestCase
-  
-  context "The acts_as_scribe plugin" do
-    
-    setup do
-      @margie = Factory(:user, :login => 'm.thatcher')
-      @jaiku = Factory(:jaiku, :content => "To solve Britain’s economic Disease with Socialism is like treating leukaemia with leeches.", :user => @margie)
-      @activity =  @jaiku.activities.first
-    end
-    
-    should 'include the correct methods on user and jaiku class' do
-      [:activities, :create_activity_from_self].each{|method|
-        assert @jaiku.respond_to?(method, "Jaiku should responds_to #{method}")
-      }
-      [:activities, :activities_without_model, :record_activity].each{|method|
-        assert @margie.respond_to?(method, "Jaiku should responds_to #{method}")
-      }
-    end
-    should 'create a new activity every time a jaiku is created' do
-      assert_equal 1, @jaiku.activities.size, "Create a jaiku should create a new activity"
-    end
-    
-    should 'link the activities created on a model with the user that is generating the activity' do
-      assert_equal @margie, @activity.user, "The activity should be registered as made by the user that create the jaiku"
-    end
-    
-    should 'link the new activities to the correct model and id' do
-      assert_equal @jaiku.class.to_s, @activity.item_type, "The activity should be linked to the first jaiku"
-      assert_equal @jaiku.id, @activity.item_id, "The activity should be linked to the first jaiku"
-    end
-    
-    should 'raise an exception if we try to record an activity that is not defined on the user class' do
-      assert_raise RuntimeError do
-          @margie.record_activity :not_defined_featured
-      end
-    end
-    
-    should 'create an activity without model if we use the record_activity method on a user' do
-      @margie.record_activity :featured_on_home
-      assert_equal 1, @margie.activities_without_model.size,  "Track an unlinked activity should create a new activity on the user model"
-    end
-    
-  end
-end

data/test/test_helper.rb

@@ -1,39 +0,0 @@
-require 'test/unit'
-require 'rubygems'
-
-gem 'activerecord'
-require 'active_record'
-
-begin require 'redgreen'; rescue LoadError; end
-
-begin
-  require 'shoulda'
-  require 'shoulda/active_record'
-rescue LoadError => load_error
-  $stderr.puts
-  $stderr.puts "You need shoulda to run acts_as_scribe's tests. `gem install thoughtbot-shoulda` and try again."
-  $stderr.puts
-  exit
-end
-
-require 'factory_girl'
-require File.expand_path(File.dirname(__FILE__) + '/factories')
-
-require File.dirname(__FILE__) + "/../init"
-
-
-ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
-load(File.dirname(__FILE__) + "/schema.rb")
-
-class Jaiku < ActiveRecord::Base
-  belongs_to :user
-  record_activity_of :user
-end
-
-class User < ActiveRecord::Base
-  has_many :jaikus
-  record_activities [:featured_on_home, :logged_in, :logged_out]
-end
-
-
-

data/test/unit/activity_test.rb

@@ -1,40 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'test_helper')
-
-class ActivityTest < Test::Unit::TestCase
-
-  should_belong_to :user
-  should_belong_to :item
-
-  context 'An Activity model' do
-    
-    setup do
-      @margie = Factory(:user, :login => 'm.thatcher')
-      @britain = Factory(:jaiku, :content => "To solve Britain’s economic Disease with Socialism is like treating leukaemia with leeches.", :user => @margie)
-      @margie_activities =  @britain.activities
-
-      @reagan = Factory(:user, :login => 'r.reagan')
-      @reagan.record_activity :logged_in
-    end
-    
-    context 'at class level' do
-      should 'have a `created_by` method to allow us to find activities created by a given user' do
-        assert Activity.respond_to?:created_by
-        assert_same_elements @margie_activities, Activity.created_by(@margie)
-      end
-      should 'have a `without_model_created_by` method to allow us to find activities created by a given user and not related to any item' do
-        assert Activity.respond_to?:without_model_created_by
-        assert_same_elements @reagan.activities, Activity.without_model_created_by(@reagan)
-      end
-    end
-    context 'at instance level' do
-      should 'be linked to the correct item' do
-        assert_equal @britain, @britain.activities.first.item
-      end
-      should 'not be linked to any item is the activity has been generated without a model' do
-        assert_nil @reagan.activities.first.item
-        assert @reagan.activities.first.without_model?
-      end
-    end
-
-  end
-end