public_activity 0.1.1 → 0.2

data/README.md

@@ -3,6 +3,11 @@
 public_activity provides smooth acitivity tracking for your ActiveRecord models in Rails 3.
 Simply put: it records what has been changed or edited and gives you the ability to present those recorded activities to users - in a similar way Github does it.
 
+## Example
+
+A picture is worth a thousand words, so here is a visual representation of what this gem is about:
+
+![Example usage](http://i.imgur.com/uGPSm.png)
 
 ## Installation
 
@@ -21,7 +26,7 @@ Add 'tracked' to the model you want to keep track of:
     class Article < ActiveRecord::Base
       tracked
     end
-And now, by default create/update activites are recorded in activities table. 
+And now, by default create/update/destroy activities are recorded in activities table. 
 To display them you can do a simple query:
     # some_controller.rb
     def index
@@ -37,8 +42,12 @@ The only thing left is to add translations to your locale files, for example:
         article:
           create: 'Article has been created'
           update: 'Someone has edited the article'
+          destroy: 'Some user removed an article!'
 
 This is only a basic example, refer to documentation for more options and customization!
+## Documentation
+
+You can find documentation [here](http://rubydoc.info/gems/public_activity/)
 
 ## License
 Copyright (c) 2011 Piotrek Okoński, released under the MIT license

data/lib/public_activity.rb

@@ -1,4 +1,4 @@
-require 'rails'
+require 'active_support/concern'
 require 'active_support/dependencies'
 require 'active_record'
 # +public_activity+ keeps track of changes made to models
@@ -30,6 +30,7 @@ require 'active_record'
 #     activity:
 #       create: 'New article has been created'
 #       update: 'Someone modified the article'
+#       destroy: 'Someone deleted the article!'
 #
 # Check {PublicActivity::ClassMethods#tracked} for more details about customizing and specifing
 # ownership to users.
@@ -39,6 +40,7 @@ module PublicActivity
   autoload :Activity
   autoload :Tracked
   autoload :Creation
+  autoload :Destruction
   autoload :VERSION
   autoload :Common
   
@@ -80,19 +82,17 @@ module PublicActivity
     #   documentation.
     def tracked(options = {})
       return if tracked?
-      include Creation
       include Common
-      
+      include Creation
+      include Destruction
+            
       if options[:owner]
         self.activity_owner_global = options[:owner]
       end
       if options[:params]
         self.activity_params_global = options[:params]
       end
-      has_many :activities, :class_name => "PublicActivity::Activity", :as => :trackable
-      
-      
-      
+      has_many :activities, :class_name => "PublicActivity::Activity", :as => :trackable      
     end
   end
 

data/lib/public_activity/activity.rb

@@ -24,6 +24,8 @@ module PublicActivity
     #         article:
     #           create: "Someone has created an article '%{title}'"
     #           update: "Article '%{title}' has been modified"
+    #           destroy: "Someone deleted article '%{title}'!"
+    #
     # And in controller:
     #
     #   def create

data/lib/public_activity/common.rb

@@ -3,27 +3,31 @@ module PublicActivity
     extend ActiveSupport::Concern
     
     module InstanceMethods
-      # Prepare settings used during creation of Activity record.
-      # params passed directly to tracked model have priority over
-      # settings specified in tracked() method
-      def prepare_settings
-        # user responsible for the activity
-        if self.activity_owner
-          owner = self.activity_owner
-        else
-          case self.activity_owner_global
-            when Symbol, String 
-              owner = self[self.class.activity_owner_global]
-            when Proc
-              owner = self.class.activity_owner_global.call           
-          end
+      private
+        # Creates activity based on supplied arguments
+        def create_activity(key, owner, params)
+          self.activities.create(:key => key, :owner => owner, :parameters => params)
         end
-        #customizable parameters
-        parameters = self.class.activity_params_global
-        parameters.merge! self.activity_params if self.activity_params      
-        return {:owner => owner, :parameters => parameters}
-      end
-      
+        # Prepare settings used during creation of Activity record.
+        # params passed directly to tracked model have priority over
+        # settings specified in tracked() method
+        def prepare_settings
+          # user responsible for the activity
+          if self.activity_owner
+            owner = self.activity_owner
+          else
+            case self.activity_owner_global
+              when Symbol, String 
+                owner = self[self.class.activity_owner_global]
+              when Proc
+                owner = self.class.activity_owner_global.call           
+            end
+          end
+          #customizable parameters
+          parameters = self.class.activity_params_global
+          parameters.merge! self.activity_params if self.activity_params      
+          return {:owner => owner, :parameters => parameters}
+        end      
     end
   end
 end

data/lib/public_activity/creation.rb

@@ -8,12 +8,7 @@ module PublicActivity
     end   
     
     module InstanceMethods
-      private
-        # Creates activity based on supplied arguments
-        def create_activity(key, owner, params)
-          self.activities.create(:key => key, :owner => owner, :parameters => params)
-        end
-        
+      private       
         # Creates activity upon creation of the tracked model
         def activity_on_create
           settings = prepare_settings

data/lib/public_activity/destruction.rb

@@ -0,0 +1,18 @@
+module PublicActivity
+  module Destruction
+    extend ActiveSupport::Concern
+    
+    included do
+      before_destroy :activity_on_destroy
+    end   
+    
+    module InstanceMethods
+      private       
+        # Records an activity upon destruction of the tracked model
+        def activity_on_destroy
+          settings = prepare_settings
+          create_activity("activity."+self.class.name.downcase+".destroy", settings[:owner], settings[:parameters])
+        end
+    end
+  end
+end

data/lib/public_activity/version.rb

@@ -1,3 +1,3 @@
 module PublicActivity
-  VERSION = '0.1.1'
+  VERSION = '0.2'
 end

metadata

@@ -2,7 +2,7 @@
 name: public_activity
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: "0.2"
 platform: ruby
 authors: 
 - "Piotrek Oko\xC5\x84ski"
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-07 00:00:00 +01:00
+date: 2011-03-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,10 +74,10 @@ files:
 - lib/public_activity/activity.rb
 - lib/public_activity/common.rb
 - lib/public_activity/creation.rb
+- lib/public_activity/destruction.rb
 - lib/public_activity/tracked.rb
 - lib/public_activity/version.rb
 - Gemfile
-- Gemfile.lock
 - Rakefile
 - README.md
 - MIT-LICENSE

data/Gemfile.lock

@@ -1,85 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    abstract (1.0.0)
-    actionmailer (3.0.5)
-      actionpack (= 3.0.5)
-      mail (~> 2.2.15)
-    actionpack (3.0.5)
-      activemodel (= 3.0.5)
-      activesupport (= 3.0.5)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.4)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.13)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.5)
-      activesupport (= 3.0.5)
-      builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activerecord (3.0.5)
-      activemodel (= 3.0.5)
-      activesupport (= 3.0.5)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.5)
-      activemodel (= 3.0.5)
-      activesupport (= 3.0.5)
-    activesupport (3.0.5)
-    arel (2.0.9)
-    builder (2.1.2)
-    diff-lcs (1.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    i18n (0.5.0)
-    mail (2.2.15)
-      activesupport (>= 2.3.6)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.16)
-    mocha (0.9.12)
-    polyglot (0.3.1)
-    rack (1.2.1)
-    rack-mount (0.6.13)
-      rack (>= 1.0.0)
-    rack-test (0.5.7)
-      rack (>= 1.0)
-    rails (3.0.5)
-      actionmailer (= 3.0.5)
-      actionpack (= 3.0.5)
-      activerecord (= 3.0.5)
-      activeresource (= 3.0.5)
-      activesupport (= 3.0.5)
-      bundler (~> 1.0)
-      railties (= 3.0.5)
-    railties (3.0.5)
-      actionpack (= 3.0.5)
-      activesupport (= 3.0.5)
-      rake (>= 0.8.7)
-      thor (~> 0.14.4)
-    rake (0.8.7)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
-    thor (0.14.6)
-    treetop (1.4.9)
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.24)
-    yard (0.6.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  mocha
-  rails
-  rspec
-  yard