linkingpaths-acts_as_scribe 0.0.2

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,53 @@
+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`
+ 
+Usage
+-----
+ 
+ * Make your ActiveRecord model acts as scribe.
+<pre>
+  class Comment < ActiveRecord::Base    
+    record_activity_of :user
+  end
+</pre>
+
+ * 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]
+  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,22 @@
+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

@@ -0,0 +1,22 @@
+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/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,17 @@
+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
+  end
+
+  def self.down
+    drop_table :activities
+  end
+
+end

data/init.rb

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

data/lib/activity.rb

@@ -0,0 +1,17 @@
+class Activity < ActiveRecord::Base
+  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})
+  end
+
+  def self.without_model_created_by(user)
+    Activity.find(:all, :conditions => { :user_id => user.id, :item_type => nil, :item_id => nil})
+  end
+
+  def without_model?
+    item.nil?
+  end
+end

data/lib/acts_as_scribe.rb

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

data/lib/scribe.rb

@@ -0,0 +1,70 @@
+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)
+                record.create_activity_from_self 
+              end
+            end
+          }
+          self.activity_options.merge! :actor => actor
+        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
+        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 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    
+
+
+      end
+
+    end
+  end
+end

data/test/factories.rb

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

data/test/functional/acts_as_scribe_test.rb

@@ -0,0 +1,46 @@
+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/schema.rb

@@ -0,0 +1,17 @@
+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
+    t.integer :item_id
+    t.string  :item_type
+    t.timestamps
+  end
+  create_table :users do |t|
+    t.string  :login
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,39 @@
+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

@@ -0,0 +1,40 @@
+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

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: linkingpaths-acts_as_scribe
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Linking Paths
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-16 00:00:00 -07: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: []
+
+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
+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: []
+
+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: acts_as_scribe
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+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: []
+