acts_as_loggable 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in acts_as_loggable.gemspec
+gemspec

data/README

@@ -0,0 +1,39 @@
+Acts as Loggable
+================
+    Simplifies the process of logging activities.
+
+Prepare database
+================
+    ruby script/generate log_activity_files # This command will copy 3 files: helper file, RecentActivity model, and a migration file.
+    rake db:migrate
+
+Example
+=======
+Lets log the signup process and edit profile process
+Add these lines to user.rb:
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+acts_as_loggable
+
+after_create :create_signup_activity
+after_save :create_profile_updated_activity
+
+def create_signup_activity
+    # Here '1' denotes the type of the activity i.e. user creation.
+    # Also :user denotes the object who creates the activity.
+    create_recent_activity(:user => self, :activity_type => 1) 
+end
+
+def create_profile_updated_activity
+    if name_changed? || city_changed? || country_changed? # Create the recent activity only the any of these fields have changed.
+        # Here '2' denotes the type of the activity i.e. edit profile.
+        # If the user further updates his profile, no new record will be created. But it will simply update the time_stamp field of this record.
+        create_recent_activity(:user => self, :activity_type => 2, :disable_further_logging_for => 15.minutes)
+    end
+end
+
+
+
+
+Copyright (c) 2009 [Arun Kumar], released under the MIT license

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/acts_as_loggable.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_loggable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_loggable"
+  s.version     = ActsAsLoggable::VERSION
+  s.authors     = ["Arun Kumar Arjunan"]
+  s.email       = ["arun.immanuel1608@gmail"]
+  s.homepage    = ""
+  s.summary     = %q{Create and display activity feeds easily}
+  s.description = %q{Create and display activity feeds easily}
+
+  s.rubyforge_project = "acts_as_loggable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/generators/log_activity_files/log_activity_files_generator.rb

@@ -0,0 +1,10 @@
+class LogActivityFilesGenerator < Rails::Generator::Base 
+  def manifest 
+    record do |m|
+      m.file "recent_activities_helper.rb", "app/helpers/recent_activities_helper.rb"
+      m.file "recent_activity.rb", "app/models/recent_activity.rb"
+      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => 'create_recent_activities'
+    end 
+  end
+  
+end

data/generators/log_activity_files/templates/migration.rb

@@ -0,0 +1,15 @@
+class CreateRecentActivities < ActiveRecord::Migration
+  def self.up
+    create_table :recent_activities do |t|
+      t.integer  :user_id,  :null => false
+      t.integer  :activity_type, :null => false
+      t.references :onobject, :polymorphic => true
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :recent_activities
+  end
+end

data/generators/log_activity_files/templates/recent_activities_helper.rb

@@ -0,0 +1,13 @@
+module RecentActivitiesHelper
+
+  # Displays the recent activity string for the 'recent_activity'
+  def recent_activity_string_for(recent_activity, viewer = current_user, options = {})
+    # Uncomment the following lines
+    # viewer_name = viewer.full_name
+    # time = recent_activity.created_at(:yMd)
+    # case recent_activity.for_object
+    # when
+    # "#{viewer_name} updated his profile on #{time}"
+    # end
+  end
+end

data/generators/log_activity_files/templates/recent_activity.rb

@@ -0,0 +1,4 @@
+class RecentActivity < ActiveRecord::Base
+    belongs_to :onobject, :polymorphic => true
+    belongs_to :user
+end

data/lib/acts_as_loggable.rb

@@ -0,0 +1,50 @@
+require "acts_as_loggable/version"
+
+module ActiveRecord #:nodoc:
+  module ActsAsLoggable #:nodoc:
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def acts_as_loggable
+        has_many :recent_activities, :as => :onobject, :dependent => :destroy, :order => 'recent_activities.id DESC'
+
+        include ActiveRecord::ActsAsLoggable::InstanceMethods
+      end
+
+    end
+
+
+    module InstanceMethods
+      # Creates the recent activity record for the object.
+      #
+      # Compulsory Params:
+      # =============
+      # => user - Who creates this activity
+      # => activity_type - Type of the activity[Integer]
+      #
+      # Optional Params:
+      # =============
+      # =>  disable_further_logging_for - Ex: 15.minutes, No more record creation for further 15 minutes. But will update the updated at, and created_at field to the current Time.
+      #
+      def create_recent_activity(options = {})
+        user = options[:user]
+        disable_period = options.delete(:disable_further_logging_for)
+        if disable_period
+          activity = self.recent_activities.last(:conditions => ["user_id = ? AND activity_type = ? AND created_at > ?", user.id, options[:activity_type], Time.now.utc - disable_period])
+          if activity
+            activity.destroy
+          end
+        end
+
+        activity = RecentActivity.create(options)
+        self.recent_activities << activity
+        return activity
+      end
+    end
+  end
+end
+
+
+ActiveRecord::Base.send(:include, ActiveRecord::ActsAsLoggable)

data/lib/acts_as_loggable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsLoggable
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_loggable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Arun Kumar Arjunan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-30 00:00:00.000000000 +05:30
+default_executable: 
+dependencies: []
+description: Create and display activity feeds easily
+email:
+- arun.immanuel1608@gmail
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- acts_as_loggable.gemspec
+- generators/log_activity_files/log_activity_files_generator.rb
+- generators/log_activity_files/templates/migration.rb
+- generators/log_activity_files/templates/recent_activities_helper.rb
+- generators/log_activity_files/templates/recent_activity.rb
+- lib/acts_as_loggable.rb
+- lib/acts_as_loggable/version.rb
+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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: acts_as_loggable
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Create and display activity feeds easily
+test_files: []