public_activity 0.3.3 → 0.3.4

data/README.md

@@ -1,6 +1,6 @@
 # PublicActivity ![Build Status](http://travis-ci.org/pokonski/public_activity.png)
 
-public_activity provides smooth acitivity tracking for your ActiveRecord models in Rails 3.
+public_activity provides smooth activity 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
@@ -26,58 +26,58 @@ 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
+class Article < ActiveRecord::Base
+  tracked
+end
 ```
 
 To default the owner to the current user (optional)
 
 ```ruby
-    #Aplication Controller
-    before_filter :define_current_user
-    
-    def define_current_user
-      User.current_user = current_user
-    end
-    
-    #User.rb (model)
-    class User < ActiveRecord::Base
-      cattr_accessor :current_user
-    end
+#Aplication Controller
+before_filter :define_current_user
+
+def define_current_user
+  User.current_user = current_user
+end
+
+#User.rb (model)
+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
+# some_controller.rb
+def index
+  @activities = PublicActivity::Activity.all
+end
 ```
 
 And in your views:
 
 ```erb
-    <% for activity in @activities %>
-      <%= activity.text %><br/>
-    <% end %>
+<% 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!'
+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.
 
 ```ruby
-    PublicActivity::Activity.template = YAML.load_file("#{RAILS_ROOT}/config/pba.yml")
+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!

data/lib/public_activity/activity.rb

@@ -42,7 +42,7 @@ module PublicActivity
     def text(params = {})
       begin
         erb_template = resolveTemplate(key)
-        if !erb_template.nil? 
+        if erb_template
           parameters.merge! params
           renderer = ERB.new(erb_template)
           renderer.result(binding)
@@ -56,17 +56,13 @@ module PublicActivity
     
     private
     def resolveTemplate(key)
-       res = nil
-       if !self.template.nil?
-         key.split(".").each do |k|
-           if res.nil?
-             res = self.template[k]
-           else
-             res = res[k]
-           end
-         end
+      res = nil
+      if self.template
+        key.split(".").each do |k|
+          res = (res ? res[k] : self.template[k])
         end
-       res
+      end
+      res
     end
   end  
 end

data/lib/public_activity/common.rb

@@ -25,7 +25,7 @@ module PublicActivity
 
       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})
+        Pusher['activity-channel'].trigger('activity-create', {:key => key, :owner => owner, :parameters => params, :text => activity.text, :object => self})
       end
     end
 
@@ -43,7 +43,7 @@ module PublicActivity
 
         case owner
           when Symbol
-            owner = self.try(owner)
+            owner = self.__send__(owner)
           when Proc
             owner = owner.call(self)
         end

data/lib/public_activity/tracked.rb

@@ -2,12 +2,12 @@ module PublicActivity
   # Main module extending classes we want to keep track of.
   module Tracked
     extend ActiveSupport::Concern
-    
+
     included do
       class_attribute :activity_owner_global, :activity_params_global
       self.activity_owner_global = nil
       self.activity_params_global = {}
-    end  
+    end
     # Set or get parameters that will be passed to {Activity} when saving
     #
     # == Usage:
@@ -15,7 +15,7 @@ module PublicActivity
     #
     #   class Article < ActiveRecord::Base
     #     tracked
-    #   end 
+    #   end
     #
     # In controller
     #   @article = Article.new
@@ -32,7 +32,7 @@ module PublicActivity
     #
     #   class Article < ActiveRecord::Base
     #     tracked
-    #   end 
+    #   end
     # Controller:
     #
     #   @article = Article.new
@@ -50,7 +50,7 @@ module PublicActivity
     #
     #   class Article < ActiveRecord::Base
     #     tracked
-    #   end 
+    #   end
     #
     # In controller:
     #
@@ -66,19 +66,19 @@ module PublicActivity
     #   @article.activities.last.key #=> "my.custom.article.key"
     attr_accessor :activity_key
     @activity_key = nil
-    
+
     # 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
       # associated activities.
-      # 
+      #
       # == Parameters:
       # [:owner]
       #   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.
@@ -89,48 +89,50 @@ module PublicActivity
       #    @article.activity :parameters => {:title => @article.title, :short => truncate(@article.text, :length => 50)}
       #   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 
+      #   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#create_activity}
       #   for a guide on how to manually record activities.
       def tracked(options = {})
         include Common
-        
+
         all_options = [:create, :update, :destroy]
-        
-        if !options[:skip_defaults] && !options[:only] && !options[:except] 
+
+        if !options[:skip_defaults] && !options[:only] && !options[:except]
           include Creation
           include Destruction
           include Update
         end
-        
+
         if options[:except].is_a? Array
           options[:only] = all_options - options[:except]
         end
-        
+
         if options[:only].is_a? Array
-            options[:only].each do |opt|
-              if opt.eql?(:create)
-                include Creation
-              elsif opt.eql?(:destroy)
-                include Destruction
-              elsif opt.eql?(:update)
-                include Update
-              end
+          options[:only].each do |opt|
+            if opt.eql?(:create)
+              include Creation
+            elsif opt.eql?(:destroy)
+              include Destruction
+            elsif opt.eql?(:update)
+              include Update
             end
+          end
         end
-            
+
         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
+
+        nil
       end
     end
-    
+
     # 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.

data/lib/public_activity/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: public_activity
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-19 00:00:00.000000000 Z
+date: 2012-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -147,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Smooth activity tracking for ActiveRecord models