acts_as_scribe 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.sw?
+.DS_Store
+coverage

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+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/README.markdown

@@ -0,0 +1,80 @@
+ActsAsScribe
+============
+A simple plugin that allows to keep history records of the users activities. Common uses could be user's wall, public timeline portlets, etc...
+
+> Scribe (From Wikipedia, the free encyclopedia):
+"A scribe was traditionally a person who could read and write. This usually indicated secretarial and administrative duties such as dictation and keeping business, judicial, and history records for kings, nobles, temples, and cities."
+
+Resources
+=========
+
+Install
+-------
+ 
+ * Run the following command:
+ 
+ `script/plugin install git://github.com/linkingpaths/acts_as_scribe.git`
+ 
+ * Generate the tables via the given generator:
+
+ `script/generate acts_as_scribe_migration`
+ 
+ * And finally...
+ 
+ `rake db:migrate`
+ 
+Record activities in your models
+---------------------------------------------
+ 
+<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
+
+<pre>
+  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>
+ 
+
+
+More
+-------
+
+[http://github.com/linkingpaths/acts\_as\_scribe](http://github.com/linkingpaths/acts_as_scribe)
+
+[http://github.com/linkingpaths/acts\_as\_scribe/wikis](http://github.com/linkingpaths/acts_as_scribe/wikis)
+
+
+Copyright (c) 2008 Linking Paths, released under the MIT license

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rake'
+
+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
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'acts_as_scribe'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  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

data/VERSION.yml

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

data/acts_as_scribe.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_scribe}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Linking Paths", "Aitor Garc\303\255a", "Roberto Salicio"]
+  s.date = %q{2009-12-23}
+  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 = %q{aitor@linkingpaths.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION.yml",
+     "acts_as_scribe.gemspec",
+     "features/scribe.feature",
+     "features/steps/scribe_steps.rb",
+     "features/support/env.rb",
+     "generators/acts_as_scribe_migration/USAGE",
+     "generators/acts_as_scribe_migration/acts_as_scribe_migration_generator.rb",
+     "generators/acts_as_scribe_migration/templates/migration.rb",
+     "init.rb",
+     "lib/activity.rb",
+     "lib/acts_as_scribe.rb",
+     "lib/scribe.rb",
+     "spec/factories.rb",
+     "spec/models.rb",
+     "spec/models/activity_spec.rb",
+     "spec/schema.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/linkingpaths/acts_as_scribe}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  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.test_files = [
+    "spec/spec_helper.rb",
+     "spec/models/activity_spec.rb",
+     "spec/factories.rb",
+     "spec/schema.rb",
+     "spec/models.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/features/scribe.feature

@@ -0,0 +1,26 @@
+Feature: Activity Streams
+  In order to represent activity streams
+  As a developer
+  I want to bea able to add activity registration hooks on the AR models
+  
+  Scenario: Action executed by actor
+    Given I'm a user
+    When I create a membership
+    Then a new activity should be reported
+    And the activity should be related to me
+
+#  USE CASES
+#
+#  [ACTOR-S]                             [ACTION]                    [OBJECT] 
+#
+#  Obie Fernandez                        escribió                    una nueva nota. 
+#  Obie Fernandez y Steven Bustos        son amigos.  
+#  Manuel Gonzalez Noriega               se ha hecho fan             de Monkey Island.
+#  Manuel Gonzalez Noriega               se ha unido al              grupo Do you poken?
+#  Obie Fernandez y Rogelio J. Samour    ahora son amigos(as)        gracias a "Personas que quizá conozcas". 
+#  Obie Fernandez                        posted                      “Rane and Serano (instead of working)."
+#  Angela Lerma                          se hizo fan de              "Soy 100% Colombiano!"
+#  Obie Fernandez                        subió desde el móvil        una foto
+#  Obie Fernandez                        [puso su status a]          "is crazy for staying up this late."
+#  Fulano                                ha compartido               el post 'De Fulanos y Menganos' con el grupo 'Futaneros'
+#  Aitor                                 ha jugado                   un partido +3 en el campo 'meaztegi'

data/features/steps/scribe_steps.rb

@@ -0,0 +1,19 @@
+Given /^I'm a user$/ do
+  @me = Factory :user
+end
+
+When /^I create a membership$/ do
+  @creating_membership = lambda do
+    @membership = Factory :membership, :user => @me 
+  end
+end
+
+Then /^a new activity should be reported$/ do
+  @creating_membership.should change(Activity, :count).by(1)
+end
+Then /^the activity should be related to me$/ do
+  acts = Activity.by_item(@membership)
+  acts.should have(1).things
+  acts.first.user.should == @me
+end
+

data/features/support/env.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+gem 'activerecord'
+require 'active_record'
+require 'factory_girl'
+require 'redgreen'
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'acts_as_scribe'
+require 'activity'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+load(File.dirname(__FILE__) + "/../../spec/schema.rb")
+load(File.dirname(__FILE__) + "/../../spec/models.rb")
+
+
+require 'test/unit/assertions'
+
+World do |world|
+  
+  world.extend(Test::Unit::Assertions)
+  
+  world
+end

data/generators/acts_as_scribe_migration/USAGE

@@ -0,0 +1,8 @@
+Description:
+    The migration generator creates a migration to add the activities table to your database and takes no arguments.
+
+Example:
+    ./script/generate acts_as_scribe_migration
+	
+	Migration:  db/migrate/add_activities_table.rb
+	The Activity model lives in the lib directory of this plugin. You can move that model into your models directory and modify it if you like.

data/generators/acts_as_scribe_migration/acts_as_scribe_migration_generator.rb

@@ -0,0 +1,13 @@
+class ActsAsScribeMigrationGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate'
+    end
+  end
+
+  def file_name
+    "acts_as_scribe_migration"
+  end
+
+end

data/generators/acts_as_scribe_migration/templates/migration.rb

@@ -0,0 +1,19 @@
+class ActsAsScribeMigration < ActiveRecord::Migration
+
+  def self.up
+    create_table :activities do |t|
+      t.integer :user_id
+      t.string  :action
+      t.integer :item_id
+      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
+
+end

data/init.rb

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

data/lib/activity.rb

@@ -0,0 +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.to_s }}
+  }
+
+  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)
+    raise "Activity.created_by(user) has been deprecated. Use Activity.by_user(user) instead."
+  end
+
+  def self.without_model_created_by(user)
+    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
+  
+  def self.report(user, action, object=nil)
+    returning Activity.new do |a|
+      a.item = object if object
+      a.action = action.to_s
+      a.user = user
+      a.save!
+    end
+  end
+
+end

data/lib/acts_as_scribe.rb

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

data/lib/scribe.rb

@@ -0,0 +1,54 @@
+module LinkingPaths
+  module Acts #:nodoc:
+    module Scribe #:nodoc:
+
+      def self.included(base) # :nodoc:
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        activity_options ||= {}
+
+        def record_activity_of(actor, options = {})
+          include_scribe_instance_methods {
+            has_many :activities, :as => :item, :dependent => :destroy
+            after_create do |record|
+              unless options[:if].kind_of?(Proc) and not options[:if].call(record)
+                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
+          }
+          self.activity_options.merge! :actor => actor
+        end
+
+        def record_activities(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?
+            class_inheritable_accessor :activity_options
+            self.activity_options ||= {}
+            include InstanceMethods
+          end
+        end
+
+      end
+
+      module InstanceMethods
+        def record_activity(action)
+            raise "record_activity has been deprecated. Use Activity.report(actor, action, item)."
+        end
+      end
+
+    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/spec/schema.rb

@@ -0,0 +1,24 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :activities do |t|
+    t.integer :user_id
+    t.string  :action
+    t.integer :item_id
+    t.string  :item_type
+    t.timestamps
+  end
+  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,19 @@
+require 'rubygems'
+gem 'activerecord'
+require 'active_record'
+require 'factory_girl'
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'acts_as_scribe'
+require 'activity'
+
+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

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_scribe
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Linking Paths
+- "Aitor Garc\xC3\xADa"
+- Roberto Salicio
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-23 00:00:00 +01: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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION.yml
+- acts_as_scribe.gemspec
+- features/scribe.feature
+- features/steps/scribe_steps.rb
+- features/support/env.rb
+- generators/acts_as_scribe_migration/USAGE
+- generators/acts_as_scribe_migration/acts_as_scribe_migration_generator.rb
+- generators/acts_as_scribe_migration/templates/migration.rb
+- init.rb
+- lib/activity.rb
+- lib/acts_as_scribe.rb
+- lib/scribe.rb
+- spec/factories.rb
+- spec/models.rb
+- spec/models/activity_spec.rb
+- spec/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/linkingpaths/acts_as_scribe
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple plugin that allows to keep track of the users activity. Common uses could be user's wall, public timeline portlets, etc...
+test_files: 
+- spec/spec_helper.rb
+- spec/models/activity_spec.rb
+- spec/factories.rb
+- spec/schema.rb
+- spec/models.rb