public_activity 0.2.5 → 0.3

data/lib/public_activity/activist.rb

@@ -0,0 +1,26 @@
+module PublicActivity
+  # Module extending classes that serve as owners
+  module Activist
+    extend ActiveSupport::Concern
+    # Module extending classes that serve as owners
+    module ClassMethods
+      # Adds has_many :activities association to model
+      # so you can list activities performed by the owner.
+      # It is completely optional, but simplifies your work.
+      # 
+      # == Usage:
+      # In model:
+      #
+      #   class User < ActiveRecord::Base
+      #     activist
+      #   end 
+      #
+      # In controller:
+      #   User.first.activities
+      #
+      def activist
+        has_many :activities, :class_name => "PublicActivity::Activity", :as => :owner
+      end    
+    end
+  end
+end

data/lib/public_activity/activity.rb

@@ -13,7 +13,9 @@ module PublicActivity
     
     # Virtual attribute returning already
     # translated key with params passed
-    # to i18n.translate function
+    # to i18n.translate function. You can pass additional Hash
+    # you want to be passed to translation method. It will be merged with the default ones.
+    #
     # == Example:
     #
     # Let's say you want to show article's title inside Activity message.
@@ -37,7 +39,8 @@ module PublicActivity
     #
     # Now when you list articles, you should see:
     #   @article.activities.last.text #=> "Someone has created an article 'Rails 3.0.5 released!'"
-    def text
+    def text(params = {})
+      parameters.merge! params
       I18n.t(key, parameters || {})
     end
   end  

data/lib/public_activity/common.rb

@@ -17,14 +17,15 @@ module PublicActivity
           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
+            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      

data/lib/public_activity/tracked.rb

@@ -2,7 +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  
     # Set or get parameters that will be passed to {Activity} when saving
     #
     # == Usage:
@@ -20,8 +25,7 @@ module PublicActivity
     # changes after creating this {Activity}.
     attr_accessor :activity_params
     @activity_params = {}
-    # Set or get user id responsible for the {Activity}.
-    # Same rules apply like with the other attributes described.
+    # Set or get owner object responsible for the {Activity}.
     #
     # == Usage:
     # In model:
@@ -32,12 +36,14 @@ module PublicActivity
     # Controller:
     #
     #   @article = Article.new
-    #   @article.activity_owner = current_user #where current_user is an object of logged in user
+    #   @article.activity_owner = current_user # where current_user is an object of logged in user
+    #   @article.activity_owner = :author # OR: take @article.author attribute
+    #   @article.activity_owner = proc {|o| o.author } # OR: provide a Proc with custom code
     #   @article.save
-    #   @article.activities.last.user #=> Returns User object
+    #   @article.activities.last.owner #=> Returns owner object
     attr_accessor :activity_owner
     @activity_owner = nil
-    # Set or get custom i18n key passed to {Activity}
+    # Set or get custom i18n key passed to {Activity}, later used in {Activity#text}
     #
     # == Usage:
     # In model:
@@ -60,24 +66,43 @@ 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 with basic +tracked+ method that enables tracking models.
     module ClassMethods
-    # Overrides the +tracked+ method to first define the +tracked?+ class method before
-    # deferring to the original +tracked+.
-      def tracked(*args)
-        super(*args)
-
-        class << self
-          def tracked?
-            true
-          end
+      # 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 => {|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.
+      # [:params]
+      #   Accepts a Hash with custom parameters you want to pass to i18n.translate
+      #   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#activity} method.
+      #   So treat it as a place where you provide 'default' values.
+      #   For more dynamic settings refer to {Activity} model 
+      #   documentation.
+      def tracked(options = {})
+        include Common
+        include Creation
+        include Destruction
+            
+        if options[:owner]
+          self.activity_owner_global = options[:owner]
         end
-      end
-
-      # For ActiveRecord::Base models that do not call the +tracked+ method, the +tracked?+
-      # will return false
-      def tracked?
-        false
+        if options[:params]
+          self.activity_params_global = options[:params]
+        end
+        has_many :activities, :class_name => "PublicActivity::Activity", :as => :trackable      
       end
     end
     
@@ -87,6 +112,24 @@ module PublicActivity
     # 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.
     #
+    # === Options
+    #
+    # [:key]
+    #   Accepts a string that will be used as a i18n key for {Activity#text} method.
+    # [: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 => {|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.
+    # [:params]
+    #   Accepts a Hash with custom parameters you want to pass to i18n.translate
+    #   method. It is later used in {Activity#text} method.
+    #   == Example:
+    #    @article.activity :parameters => {:title => @article.title, :short => truncate(@article.text, :length => 50)}
+    #
     # == Usage:
     # In model:
     #

data/lib/public_activity/version.rb

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

data/lib/public_activity.rb

@@ -37,6 +37,7 @@ require 'active_record'
 module PublicActivity
   extend ActiveSupport::Concern
   extend ActiveSupport::Autoload
+  autoload :Activist
   autoload :Activity
   autoload :Tracked
   autoload :Creation
@@ -45,58 +46,9 @@ module PublicActivity
   autoload :Common
   
   included do
-    class_attribute :activity_owner_global, :activity_params_global
-    self.activity_owner_global = nil
-    self.activity_params_global = {}
     include Tracked
+    include Activist
   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
-    # associated activities.
-    # 
-    # == Parameters:
-    # :owner::
-    #   You can pass a Symbol or a String with an attribute from
-    #   which public_activity should take +user id+ responsible for 
-    #   this activity.
-    #
-    #   For example:
-    #    tracked :owner => :author
-    #   will take +owner+ from tracked model's +author+ attribute.
-    #
-    #   If you need more complex logic, you can pass a Proc:
-    #    tracked :owner => Proc.new{ User.first }
-    # :params::
-    #   Accepts a Hash containing parameters you wish
-    #   to pass to every {Activity} created from this model.
-    #
-    #   For example, if you want to pass a parameter that
-    #   should be in every {Activity}, you can do this:
-    #    tracked :params => {:user_name => "Piotrek"}
-    #   These params are passed to i18n.translate
-    #   when using {PublicActivity::Activity#text}, which returns
-    #   already translated {Activity} message.
-    #   For more dynamic settings refer to {Activity} model 
-    #   documentation.
-    def tracked(options = {})
-      return if tracked?
-      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      
-    end
-  end
-
 end
 
 ActiveRecord::Base.send :include, PublicActivity

metadata

@@ -2,7 +2,7 @@
 name: public_activity
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.5
+  version: "0.3"
 platform: ruby
 authors: 
 - "Piotrek Oko\xC5\x84ski"
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-09 00:00:00 +02:00
+date: 2011-04-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +71,7 @@ files:
 - lib/generators/public_activity/migration/migration_generator.rb
 - lib/generators/public_activity/migration/templates/migration.rb
 - lib/public_activity.rb
+- lib/public_activity/activist.rb
 - lib/public_activity/activity.rb
 - lib/public_activity/common.rb
 - lib/public_activity/creation.rb