activity 0.0.1

data/README

@@ -0,0 +1,15 @@
+Activity
+=======
+
+Activity is a rails engine that enables you to log actions by users on your models.
+
+
+Example
+=======
+
+class Comment < ActiveRecord::Base
+  actionable :user_id
+  # Your comment model here
+end
+
+Copyright (c) 2010 Joshua Wood (joshuawood.net), released under the MIT license

data/app/models/action.rb

@@ -0,0 +1,17 @@
+class Action < ActiveRecord::Base
+  set_table_name :activity
+  
+  belongs_to :model, :polymorphic => true
+  belongs_to :actor, :polymorphic => true
+  
+  scope :latest, order("`created_at` DESC, `id` DESC")
+  scope :limit, lambda {|lim| limit(lim) }
+  scope :for_model, lambda {|model| where(:model_id => model.id, :model_type => model.class.name.to_sym) }
+  scope :for_model_type, lambda {|type| where(:model_type => type) }
+
+  def to_s(l=nil)
+    haml = Haml::Engine.new(I18n.t('activity.'+self.model_type.to_s.downcase+'.'+(l.nil? ? '' : l.to_s+'.')+self.action.to_s.downcase))
+    haml.render( Object.new, {:actor => self.actor, :model => self.model} )
+  end
+
+end

data/lib/activity.rb

@@ -0,0 +1,70 @@
+# Require Rails engine
+module Activity
+  require 'activity/engine' if defined?(Rails)
+  require 'generators/activity/activity_generator'
+
+  module Actionable
+
+    def self.included(base)
+      base.extend ClassMethods  
+    end
+
+    module ClassMethods
+      def actionable
+        has_many :actions, :as => :model, :dependent => :destroy, :order => 'created_at ASC'
+        # after_create :action_after_create
+        include Activity::Actionable::InstanceMethods
+        extend Activity::Actionable::SingletonMethods
+      end
+    end
+    
+    # This module contains class methods
+    module SingletonMethods
+    end
+    
+    # This module contains instance methods
+    module InstanceMethods
+      # Method to determine if the model is actionable
+      def actionable
+        true
+      end
+    end
+
+  end
+
+  module Actable
+
+    def self.included(base)
+      base.extend ClassMethods  
+    end
+
+    module ClassMethods
+      def actable
+        has_many :acts, :class_name => 'Action', :as => :actor, :dependent => :destroy, :order => 'created_at ASC'
+        # after_create :action_after_create
+        include Activity::Actable::InstanceMethods
+        extend Activity::Actable::SingletonMethods
+      end
+    end
+    
+    # This module contains class methods
+    module SingletonMethods
+    end
+    
+    # This module contains instance methods
+    module InstanceMethods
+      # Method to determine if the model is actable
+      def actable
+        true
+      end
+      # Records the activity to the model
+      def act(action,model)
+        self.acts.create({:action=>action,:model_id=>model.id,:model_type=>model.class.name.to_sym})
+      end
+    end
+
+  end
+
+end
+ActiveRecord::Base.send(:include, Activity::Actionable)
+ActiveRecord::Base.send(:include, Activity::Actable)

data/lib/activity/engine.rb

@@ -0,0 +1,9 @@
+require "activity"
+require "rails"
+require "active_record"
+
+module Activity
+ class Engine < Rails::Engine
+    engine_name :activity
+  end
+end

data/lib/generators/activity.rb

@@ -0,0 +1,31 @@
+# Activity
+module Activity
+  module Actionable
+
+    def self.included(base)
+      base.extend ClassMethods  
+    end
+
+    module ClassMethods
+      def actionable(user_key)
+        has_many :actions, :as => :model, :dependent => :destroy, :order => 'created_at ASC'
+        belongs_to :actioner, :class_name => 'User', :foreign_key => user_key
+        after_create :action_after_create
+        include Activity::Actionable::InstanceMethods
+        extend Activity::Actionable::SingletonMethods
+      end
+    end
+    
+    # This module contains class methods
+    module SingletonMethods
+    end
+    
+    # This module contains instance methods
+    module InstanceMethods
+      def action_after_create
+        self.actions.create({:action=>:create,:user_id=>self.actioner.id})
+      end
+    end
+    
+  end
+end

data/lib/generators/activity/activity_generator.rb

@@ -0,0 +1,24 @@
+# lib/generators/activity/activity_generator.rb
+# http://www.themodestrubyist.com/2010/03/16/rails-3-plugins---part-3---rake-tasks-generators-initializers-oh-my/
+require 'rails/generators'
+require 'rails/generators/migration'     
+
+class ActivityGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_activity.rb'
+  end
+end

data/lib/generators/activity/templates/migration.rb

@@ -0,0 +1,20 @@
+class CreateActivity < ActiveRecord::Migration
+  def self.up
+    create_table :activity do |t|
+      t.integer :model_id
+      t.string :model_type
+      t.string :action
+      t.integer  :actor_id
+      t.string :actor_type
+      t.timestamps
+    end
+    add_index :activity, :model_id, :name => "index_activity_on_model_id"
+    add_index :activity, :model_type, :name => "index_activity_on_model_type"
+    add_index :activity, :actor_id, :name => "index_activity_on_actor_id"
+    add_index :activity, :actor_type, :name => "index_activity_on_actor_type"
+  end
+
+  def self.down
+    drop_table :activity
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: activity
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-26 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: haml
+  prerelease: false
+  version_requirements: *id001
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- app/models/action.rb
+- lib/activity.rb
+- lib/activity/engine.rb
+- lib/generators/activity.rb
+- lib/generators/activity/activity_generator.rb
+- lib/generators/activity/templates/migration.rb
+- README
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Logging engine for Ruby on Rails 3
+test_files: []
+