public_activity 0.2 → 0.2.5

data/lib/generators/public_activity.rb

@@ -1,8 +1,11 @@
 require 'rails/generators/named_base'
 
 module PublicActivity
+  # A generator module with Activity table schema.
   module Generators
+    # A base module 
     module Base
+      # Get path for migration template
       def source_root
         @_public_activity_source_root ||= File.expand_path(File.join('../public_activity', generator_name, 'templates'), __FILE__)
       end

data/lib/generators/public_activity/migration/migration_generator.rb

@@ -3,11 +3,12 @@ require 'rails/generators/active_record'
 
 module PublicActivity
   module Generators
+    # Migration generator that creates migration file from template
     class MigrationGenerator < ActiveRecord::Generators::Base
       extend Base
 
       argument :name, :type => :string, :default => 'create_activities'
-
+      # Create migration in project's folder
       def generate_files
         migration_template 'migration.rb', "db/migrate/#{name}"
       end

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

@@ -1,4 +1,6 @@
+# Migration responsible for creating a table with activities
 class CreateActivities < ActiveRecord::Migration
+  # Create table
   def self.up
     create_table :activities do |t|
       t.belongs_to :trackable, :polymorphic => true
@@ -9,7 +11,7 @@ class CreateActivities < ActiveRecord::Migration
       t.timestamps
     end
   end
-
+  # Drop table
   def self.down
     drop_table :activities
   end

data/lib/public_activity.rb

@@ -51,6 +51,7 @@ module PublicActivity
     include Tracked
   end  
   
+  # Module with basic +tracked+ method that enables tracking models.
   module ClassMethods
     # Adds required callbacks for creating and updating
     # tracked models and adds +activities+ relation for listing

data/lib/public_activity/common.rb

@@ -1,14 +1,15 @@
 module PublicActivity
+  # Common methods shared across the gem.
   module Common
     extend ActiveSupport::Concern
-    
+    # Instance methods used by other methods in PublicActivity module.
     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
-        # Prepare settings used during creation of Activity record.
+        # Prepares settings used during creation of Activity record.
         # params passed directly to tracked model have priority over
         # settings specified in tracked() method
         def prepare_settings
@@ -23,10 +24,11 @@ module PublicActivity
                 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}
+          return {:key => self.activity_key,:owner => owner, :parameters => parameters}
         end      
     end
   end

data/lib/public_activity/creation.rb

@@ -1,24 +1,25 @@
 module PublicActivity
+  # Handles creation of Activities upon destruction and update of tracked model.
   module Creation
     extend ActiveSupport::Concern
-    
+
     included do
       after_create :activity_on_create
       after_update :activity_on_update
     end   
-    
+    # Handlers responsible for creating Activities.
     module InstanceMethods
       private       
         # Creates activity upon creation of the tracked model
         def activity_on_create
           settings = prepare_settings
-          create_activity("activity."+self.class.name.downcase+".create", settings[:owner], settings[:parameters])
+          create_activity(settings[:key] || "activity."+self.class.name.parameterize('_')+".create", settings[:owner], settings[:parameters])
         end
         
         # Creates activity upon modification of the tracked model
         def activity_on_update
           settings = prepare_settings
-          create_activity("activity."+self.class.name.downcase+".update", settings[:owner], settings[:parameters])
+          create_activity(settings[:key] || "activity."+self.class.name.parameterize('_')+".update", settings[:owner], settings[:parameters])
         end
     end
   end

data/lib/public_activity/destruction.rb

@@ -1,17 +1,18 @@
 module PublicActivity
+  # Handles creation of Activities upon destruction of tracked model.
   module Destruction
     extend ActiveSupport::Concern
     
     included do
       before_destroy :activity_on_destroy
     end   
-    
+    # Handlers responsible for adding {Activity} when object is destroyed.
     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])
+          create_activity("activity."+self.class.name.parameterize('_')+".destroy", settings[:owner], settings[:parameters])
         end
     end
   end

data/lib/public_activity/tracked.rb

@@ -1,5 +1,5 @@
 module PublicActivity
-  # Add a flag to determine whether a model class is being tracked
+  # Main module extending classes we want to keep track of.
   module Tracked
     extend ActiveSupport::Concern
 
@@ -16,7 +16,7 @@ module PublicActivity
     #   @article = Article.new
     #   @article.activity_params = {:article_title => @article.title}
     #   @article.save
-    # This way you can pass strings that should remain constant, even when {Article}
+    # This way you can pass strings that should remain constant, even when Article
     # changes after creating this {Activity}.
     attr_accessor :activity_params
     @activity_params = {}
@@ -51,7 +51,7 @@ module PublicActivity
     #   @article = Article.new
     #   @article.save
     #   @article.activities.last.key #=> "activity.article.create"
-    # By default, key looks like "activity.{class_name}.{create|update}"
+    # By default, key looks like "activity.[class_name].[create|update|destroy]"
     #
     # You can customize it, by setting your own key:
     #   @article = Article.new
@@ -60,9 +60,10 @@ module PublicActivity
     #   @article.activities.last.key #=> "my.custom.article.key"
     attr_accessor :activity_key
     @activity_key = nil
+    # Placeholder methods for classes not tracked by public_activity gem.
+    module ClassMethods
     # Overrides the +tracked+ method to first define the +tracked?+ class method before
     # deferring to the original +tracked+.
-    module ClassMethods
       def tracked(*args)
         super(*args)
 
@@ -79,6 +80,34 @@ module PublicActivity
         false
       end
     end
-
+    
+    # A module with shortcut method for setting own parameters to the {Activity} model
+    module InstanceMethods
+    # A shortcut method for setting custom key, owner and parameters of {Activity}
+    # in one line. Accepts a hash with 3 keys:
+    # :key, :owner, :params. You can specify all of them or just the ones you want to overwrite.
+    #
+    # == Usage:
+    # In model:
+    #
+    #   class Article < ActiveRecord::Base
+    #     tracked
+    #   end 
+    #
+    # In controller:
+    #
+    #   @article = Article.new
+    #   @article.title = "New article"    
+    #   @article.activity :key => "my.custom.article.key", :owner => @article.author, :params => {:title => @article.title}
+    #   @article.save
+    #   @article.activities.last.key #=> "my.custom.article.key"
+    #   @article.activities.last.parameters #=> {:title => "New article"}
+      def activity(options = {}) 
+        self.activity_key = options[:key] if options[:key]      
+        self.activity_owner = options[:owner] if options[:owner]
+        self.activity_params = options[:params] if options[:params]
+      end
+    end
+    
   end
 end

data/lib/public_activity/version.rb

@@ -1,3 +1,4 @@
 module PublicActivity
-  VERSION = '0.2'
+  # A constant with gem's version
+  VERSION = '0.2.5'
 end

metadata

@@ -2,7 +2,7 @@
 name: public_activity
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: "0.2"
+  version: 0.2.5
 platform: ruby
 authors: 
 - "Piotrek Oko\xC5\x84ski"
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-10 00:00:00 +01:00
+date: 2011-04-09 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency