public_activity 0.3.2 → 0.3.3

data/README.md

@@ -1,4 +1,4 @@
-# PublicActivity ![Build Status](http://travis-ci.org/sbower/public_activity.png)
+# PublicActivity ![Build Status](http://travis-ci.org/pokonski/public_activity.png)
 
 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.
@@ -25,12 +25,15 @@ Create migration for activities (in your Rails project):
 
 Add 'tracked' to the model you want to keep track of:
 
+```ruby
     class Article < ActiveRecord::Base
       tracked
     end
+```
 
 To default the owner to the current user (optional)
-    
+
+```ruby
     #Aplication Controller
     before_filter :define_current_user
     
@@ -42,32 +45,40 @@ To default the owner to the current user (optional)
     class User < ActiveRecord::Base
       cattr_accessor :current_user
     end
-    
+```
+
 And now, by default create/update/destroy activities are recorded in activities table. 
 To display them you can do a simple query:
 
+```ruby
     # some_controller.rb
     def index
       @activities = PublicActivity::Activity.all
     end
-    
+```
+
 And in your views:
 
+```erb
     <% for activity in @activities %>
       <%= activity.text %><br/>
     <% end %>
-    
+```
+
 The only thing left is to add templates (config/pba.yml), for example:
 
+```yaml
       activity:
         article:
           create: 'Article has been created'
           update: 'Someone has edited the article'
           destroy: 'Some user removed an article!'
+```
+Place this in a file and reference it in a Rails initializer.
 
-Place this in a file and reference it in a rail initializer.
-
+```ruby
     PublicActivity::Activity.template = YAML.load_file("#{RAILS_ROOT}/config/pba.yml")
+```
 
 This is only a basic example, refer to documentation for more options and customization!
 ## Documentation
@@ -75,4 +86,4 @@ This is only a basic example, refer to documentation for more options and custom
 You can find documentation [here](http://rubydoc.info/gems/public_activity/)
 
 ## License
-Copyright (c) 2011 Piotrek Okoński, released under the MIT license
+Copyright (c) 2012 Piotrek Okoński, released under the MIT license

data/lib/public_activity/activity.rb

@@ -12,7 +12,8 @@ module PublicActivity
     serialize :parameters, Hash
     
     class_attribute :template
-    
+
+    attr_accessible :key, :owner, :parameters
     # Virtual attribute returning text description of the activity
     # using basic ERB templating
     #

data/lib/public_activity/common.rb

@@ -2,58 +2,55 @@ module PublicActivity
   # Common methods shared across the gem.
   module Common
     extend ActiveSupport::Concern
-    # Instance methods used by other methods in PublicActivity module.
-    module InstanceMethods
-      # Directly creates activity record in the database, based on supplied arguments.
-      # Only first argument - key - is required.
-      #
-      # == Usage:
-      #
-      #   current_user.create_activity("activity.user.avatar_changed") if @user.avatar_file_name_changed?
-      #
-      # == Parameters:
-      # [key]
-      #   Custom key that will be used as a i18n translation key - *required*
-      # [owner]
-      #   Polymorphic relation specifying the owner of this activity (for example, a User who performed this task) - *optional*
-      # [params]
-      #  Hash with parameters passed directly into i18n.translate method - *optional*
-      #
-      def create_activity(key, owner = nil, params = {})   
-        
-        if owner.nil? && ((defined? User) != nil) && User.respond_to?(:current_user)  
-          owner = User.current_user
-        end
-            
-        activity = self.activities.create(:key => key, :owner => owner, :parameters => params)
-        if !Pusher.app_id.nil? && !Pusher.key.nil? && !Pusher.secret.nil?
-          Pusher['acitivty-channel'].trigger('acitivty-create', {:key => key, :owner => owner, :parameters => params, :text => activity.text, :object => self})
-        end
+    # Directly creates activity record in the database, based on supplied arguments.
+    # Only first argument - key - is required.
+    #
+    # == Usage:
+    #
+    #   current_user.create_activity("activity.user.avatar_changed") if @user.avatar_file_name_changed?
+    #
+    # == Parameters:
+    # [key]
+    #   Custom key that will be used as a i18n translation key - *required*
+    # [owner]
+    #   Polymorphic relation specifying the owner of this activity (for example, a User who performed this task) - *optional*
+    # [params]
+    #  Hash with parameters passed directly into i18n.translate method - *optional*
+    #
+    def create_activity(key, owner = nil, params = {})
+
+      if owner.nil? && ((defined? User) != nil) && User.respond_to?(:current_user)
+        owner = User.current_user
       end
 
-      private
-        # 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
-          # user responsible for the activity
-          if self.activity_owner
-            owner = self.activity_owner
-          else
-            owner = self.class.activity_owner_global
-          end
-          
-          case owner
-            when Symbol
-              owner = self.try(owner)
-            when Proc
-              owner = owner.call(self)    
-          end
-          #customizable parameters
-          parameters = self.class.activity_params_global
-          parameters.merge! self.activity_params if self.activity_params      
-          return {:key => self.activity_key,:owner => owner, :parameters => parameters}
-        end      
+      activity = self.activities.create(:key => key, :owner => owner, :parameters => params)
+      if !Pusher.app_id.nil? && !Pusher.key.nil? && !Pusher.secret.nil?
+        Pusher['acitivty-channel'].trigger('acitivty-create', {:key => key, :owner => owner, :parameters => params, :text => activity.text, :object => self})
+      end
     end
+
+    private
+      # 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
+        # user responsible for the activity
+        if self.activity_owner
+          owner = self.activity_owner
+        else
+          owner = self.class.activity_owner_global
+        end
+
+        case owner
+          when Symbol
+            owner = self.try(owner)
+          when Proc
+            owner = owner.call(self)
+        end
+        #customizable parameters
+        parameters = self.class.activity_params_global
+        parameters.merge! self.activity_params if self.activity_params
+        return {:key => self.activity_key,:owner => owner, :parameters => parameters}
+      end
   end
 end

data/lib/public_activity/creation.rb

@@ -6,14 +6,11 @@ module PublicActivity
     included do
       after_create :activity_on_create
     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(settings[:key] || "activity."+self.class.name.parameterize('_')+".create", settings[:owner], settings[:parameters])
-        end
-    end
+    private
+      # Creates activity upon creation of the tracked model
+      def activity_on_create
+        settings = prepare_settings
+        create_activity(settings[:key] || "activity."+self.class.name.parameterize('_')+".create", settings[:owner], settings[:parameters])
+      end
   end
 end

data/lib/public_activity/destruction.rb

@@ -6,14 +6,11 @@ module PublicActivity
     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.parameterize('_')+".destroy", settings[:owner], settings[:parameters])
-        end
-    end
+    private
+      # Records an activity upon destruction of the tracked model
+      def activity_on_destroy
+        settings = prepare_settings
+        create_activity("activity."+self.class.name.parameterize('_')+".destroy", settings[:owner], settings[:parameters])
+      end
   end
 end

data/lib/public_activity/tracked.rb

@@ -87,12 +87,12 @@ module PublicActivity
       #   method. It is later used in {Activity#text} method.
       #   == Example:
       #    @article.activity :parameters => {:title => @article.title, :short => truncate(@article.text, :length => 50)}
-      #   Everything specified here has a lower priority than parameters specified directly in {Tracked::InstanceMethods#activity} method.
+      #   Everything specified here has a lower priority than parameters specified directly in {#activity} method.
       #   So treat it as a place where you provide 'default' values.
       #   For more dynamic settings refer to {Activity} model 
       #   documentation.
       # [:skip_defaults]
-      #   Disables recording of activities on create/update/destroy leaving that to programmer's choice. Check {PublicActivity::Common::InstanceMethods#create_activity}
+      #   Disables recording of activities on create/update/destroy leaving that to programmer's choice. Check {PublicActivity::Common#create_activity}
       #   for a guide on how to manually record activities.
       def tracked(options = {})
         include Common
@@ -131,8 +131,6 @@ module PublicActivity
       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.
@@ -145,7 +143,7 @@ module PublicActivity
     #   Specify the owner of the {Activity} (person responsible for the action).
     #   It can be a Proc, Symbol or an ActiveRecord object:
     #   == Examples:
-    #    @article.activity :owner => :author    
+    #    @article.activity :owner => :author
     #    @article.activity :owner => {|o| o.author}
     #    @article.activity :owner => User.where(:login => 'piotrek').first
     #   Keep in mind that owner relation is polymorphic, so you can't just provide id number of the owner object.
@@ -160,22 +158,21 @@ module PublicActivity
     #
     #   class Article < ActiveRecord::Base
     #     tracked
-    #   end 
+    #   end
     #
     # In controller:
     #
     #   @article = Article.new
-    #   @article.title = "New article"    
+    #   @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
+    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

data/lib/public_activity/update.rb

@@ -6,14 +6,11 @@ module PublicActivity
     included do
       after_update :activity_on_update
     end   
-    # Handlers responsible for updating Activities.
-    module InstanceMethods
-      private       
-        # Creates activity upon modification of the tracked model
-        def activity_on_update
-          settings = prepare_settings
-          create_activity(settings[:key] || "activity."+self.class.name.parameterize('_')+".update", settings[:owner], settings[:parameters])
-        end
-    end
+    private
+      # Creates activity upon modification of the tracked model
+      def activity_on_update
+        settings = prepare_settings
+        create_activity(settings[:key] || "activity."+self.class.name.parameterize('_')+".update", settings[:owner], settings[:parameters])
+      end
   end
 end

data/lib/public_activity/version.rb

@@ -1,4 +1,4 @@
 module PublicActivity
   # A constant with gem's version
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: public_activity
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-19 00:00:00.000000000 Z
+date: 2012-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &74294530 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,15 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *74294530
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &74293790 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *74293790
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &74287740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +54,15 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *74287740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: pusher
-  requirement: &74287260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +70,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *74287260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &74286440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,7 +86,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74286440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Smooth activity tracking for your ActiveRecord models. Provides Activity
   model with details about actions performed by your users, like adding comments,
   responding etc.
@@ -122,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: Smooth activity tracking for ActiveRecord models