public_activity 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86fca5f56a3715cdc7aa50a5429478d3da652e2a
-  data.tar.gz: 6873ddaac083d14044c4e9eb7f4137b257d7bfec
+  metadata.gz: dc33d068df00d2d1ab1df8449bfd3c403b94ff02
+  data.tar.gz: ac6cd95c756f4509ec2b6543d9e39c11dd08d8b4
 SHA512:
-  metadata.gz: 8b432bcada38def3820e0a72b49d233e14bd1c87ceb6fdca7263e5b442a1c4d888cf88cc106a3df66febf6b5a6785b1a92a15b148c5410a72b8608596732a540
-  data.tar.gz: 8ace1656f39368a932ff0e5883d710a59a546ce269f25608bfaa9e08e6fde99881681e8eade10461f0d8142e3a72751545016a0a9eda3aae5f3c319332cb731c
+  metadata.gz: 0cde8051ae540c65efe52fe188161b2e811c261bfe561d152f1e3459878d8944e5ec8245864aaf21c916df2047a3cd3dd8094a5c5d4bb4c01aaacff90acaecfd
+  data.tar.gz: 7183678eb58a29ae1009a4d96c01c362998ac3e86f9e2b821e94660ec6d406a44648ac14847f23574f0affb34e7300f70a59b2fc049a76e48dea22c005e5f7af

data/README.md

@@ -1,9 +1,14 @@
-# PublicActivity [![Build Status](https://secure.travis-ci.org/pokonski/public_activity.png)](http://travis-ci.org/pokonski/public_activity) [![Dependency Status](https://gemnasium.com/pokonski/public_activity.png)](https://gemnasium.com/pokonski/public_activity)
+# PublicActivity [![Build Status](https://secure.travis-ci.org/pokonski/public_activity.png)](http://travis-ci.org/pokonski/public_activity) [![Dependency Status](https://gemnasium.com/pokonski/public_activity.png)](https://gemnasium.com/pokonski/public_activity) [![Code Climate](https://codeclimate.com/github/pokonski/public_activity.png)](https://codeclimate.com/github/pokonski/public_activity) [![Gem Version](https://badge.fury.io/rb/public_activity.png)](http://badge.fury.io/rb/public_activity)
 
-_public_activity_ provides easy activity tracking for your **ActiveRecord**, **Mongoid 3** and **MongoMapper** models
+`public_activity` provides easy activity tracking for your **ActiveRecord**, **Mongoid 3** and **MongoMapper** models
 in Rails 3. Simply put: it records what has been changed or created and gives you the ability to present those
 recorded activities to users - in a similar way to how GitHub does it.
 
+## Rails 4
+
+**As of 1.4.0 version, public_activity now supports both Rails 3.X and 4.0.**
+
+
 ## Table of contents
 
 1. [Example](#example)
@@ -18,9 +23,10 @@ recorded activities to users - in a similar way to how GitHub does it.
   5. [Displaying activities](#displaying-activities)
     1. [Activity views](#activity-views)
     2. [i18n](#i18n)
-3. [Documentation](#documentation)
-4. **[Help](#help)**
-5. [Upgrading](https://github.com/pokonski/public_activity/wiki/Upgrading-from-pre-0.4.0-versions)
+3. [Testing](#testing)
+4. [Documentation](#documentation)
+5. **[Help](#help)**
+6. [Upgrading](https://github.com/pokonski/public_activity/wiki/Upgrading-from-pre-0.4.0-versions)
 
 ## Example
 
@@ -202,6 +208,32 @@ activity:
 
 This structure is valid for activities with keys `"activity.article.create"` or `"article.create"`. As mentioned before, `"activity."` part of the key is optional.
 
+## Testing
+
+For RSpec you can first disable `public_activity` and add the `test_helper` in
+the `spec_helper.rb` with
+
+```ruby
+#spec_helper.rb
+require 'public_activity/testing'
+
+PublicActivity.enabled = false
+```
+
+In your specs you can then blockwise decide wether to turn `public_activity` on
+or off.
+
+```ruby
+# file_spec.rb
+PublicActivity.with_tracking do
+  # your test code goes here
+end
+
+PublicActivity.without_tracking do
+  # your test code goes here
+end
+```
+
 ## Documentation
 
 For more documentation go [here](http://rubydoc.info/gems/public_activity/index)

data/lib/generators/public_activity.rb

@@ -3,7 +3,7 @@ require 'rails/generators/named_base'
 module PublicActivity
   # A generator module with Activity table schema.
   module Generators
-    # A base module 
+    # A base module
     module Base
       # Get path for migration template
       def source_root

data/lib/public_activity.rb

@@ -65,4 +65,4 @@ module PublicActivity
 end
 
 require 'public_activity/utility/store_controller'
-require 'public_activity/utility/view_helpers'
+require 'public_activity/utility/view_helpers'

data/lib/public_activity/actions/creation.rb

@@ -6,10 +6,12 @@ module PublicActivity
     included do
       after_create :activity_on_create
     end
+
     private
-      # Creates activity upon creation of the tracked model
-      def activity_on_create
-        create_activity(:create)
-      end
+
+    # Creates activity upon creation of the tracked model
+    def activity_on_create
+      create_activity(:create)
+    end
   end
 end

data/lib/public_activity/actions/destruction.rb

@@ -6,10 +6,12 @@ module PublicActivity
     included do
       before_destroy :activity_on_destroy
     end
+
     private
-      # Records an activity upon destruction of the tracked model
-      def activity_on_destroy
-        create_activity(:destroy)
-      end
+
+    # Records an activity upon destruction of the tracked model
+    def activity_on_destroy
+      create_activity(:destroy)
+    end
   end
 end

data/lib/public_activity/actions/update.rb

@@ -6,10 +6,12 @@ module PublicActivity
     included do
       after_update :activity_on_update
     end
+
     private
-      # Creates activity upon modification of the tracked model
-      def activity_on_update
-        create_activity(:update)
-      end
+
+    # Creates activity upon modification of the tracked model
+    def activity_on_update
+      create_activity(:update)
+    end
   end
 end

data/lib/public_activity/common.rb

@@ -269,60 +269,65 @@ module PublicActivity
     # @overload prepare_settings(options = {})
     #   @see #create_activity
     def prepare_settings(*args)
-      # key
-      all_options = args.extract_options!
-      options = {
-        key: all_options.delete(:key),
-        action: all_options.delete(:action),
-        parameters: all_options.delete(:parameters) || all_options.delete(:params)
-      }
-      action = (args.first || options[:action]).try(:to_s)
+      raw_options = args.extract_options!
+      action      = [args.first, raw_options.delete(:action)].compact.first
+      key         = prepare_key(action, raw_options)
 
-      options[:key] = extract_key(action, options)
+      raise NoKeyProvided, "No key provided for #{self.class.name}" unless key
 
-      raise NoKeyProvided, "No key provided for #{self.class.name}" unless options[:key]
-
-      options.delete(:action)
-
-      # user responsible for the activity
-      options[:owner] = PublicActivity.resolve_value(self,
-        (all_options.has_key?(:owner) ? all_options[:owner] : (
-          self.activity_owner || self.class.activity_owner_global
-          )
-        )
+      prepare_custom_fields(raw_options.except(:params)).merge(
+        {
+          key:        key,
+          owner:      prepare_relation(:owner,     raw_options),
+          recipient:  prepare_relation(:recipient, raw_options),
+          parameters: prepare_parameters(raw_options),
+        }
       )
+    end
 
-      # recipient of the activity
-      options[:recipient] = PublicActivity.resolve_value(self,
-        (all_options.has_key?(:recipient) ? all_options[:recipient] : (
-          self.activity_recipient || self.class.activity_recipient_global
-          )
-        )
-      )
+    # Prepares and resolves custom fields
+    # users can pass to `tracked` method
+    # @private
+    def prepare_custom_fields(options)
+      customs = self.class.activity_custom_fields_global.clone
+      customs.merge!(self.activity_custom_fields) if self.activity_custom_fields
+      customs.merge!(options)
+      customs.each do  |k, v|
+        customs[k] = PublicActivity.resolve_value(self, v)
+      end
+    end
 
-      #customizable parameters
+    # Prepares i18n parameters that will
+    # be serialized into the Activity#parameters column
+    # @private
+    def prepare_parameters(options)
       params = {}
       params.merge!(self.class.activity_params_global)
       params.merge!(self.activity_params) if self.activity_params
-      params.merge!(options[:params] || options[:parameters] || {})
+      params.merge!([options.delete(:parameters), options.delete(:params), {}].compact.first)
       params.each { |k, v| params[k] = PublicActivity.resolve_value(self, v) }
-      options[:parameters] = params
-      options.delete(:params)
+    end
 
-      customs = self.class.activity_custom_fields_global.clone
-      customs.merge!(self.activity_custom_fields) if self.activity_custom_fields
-      customs.merge!(all_options)
-      customs.each do  |k, v|
-        customs[k] = PublicActivity.resolve_value(self, v)
-      end.merge options
+    # Prepares relation to be saved
+    # to Activity. Can be :recipient or :owner
+    # @private
+    def prepare_relation(name, options)
+      PublicActivity.resolve_value(self,
+        (options.has_key?(name) ? options[name] : (
+          self.send("activity_#{name}") || self.class.send("activity_#{name}_global")
+          )
+        )
+      )
     end
 
     # Helper method to serialize class name into relevant key
     # @return [String] the resulted key
     # @param [Symbol] or [String] the name of the operation to be done on class
     # @param [Hash] options to be used on key generation, defaults to {}
-    def extract_key(action, options = {})
-      (options[:key] || self.activity_key ||
+    def prepare_key(action, options = {})
+      (
+        options[:key] ||
+        self.activity_key ||
         ((self.class.name.underscore.gsub('/', '_') + "." + action.to_s) if action)
       ).try(:to_s)
     end

data/lib/public_activity/config.rb

@@ -4,13 +4,14 @@ module PublicActivity
   # Class used to initialize configuration object.
   class Config
     include ::Singleton
-    attr_accessor :enabled
+    attr_accessor :enabled, :table_name
 
     @@orm = :active_record
 
     def initialize
       # Indicates whether PublicActivity is enabled globally
-      @enabled  = true
+      @enabled    = true
+      @table_name = "activities"
     end
 
     # Evaluates given block to provide DSL configuration.
@@ -18,15 +19,14 @@ module PublicActivity
     #   PublicActivity::Config.set do
     #     orm :mongo_mapper
     #     enabled false
+    #     table_name "activities"
     #   end
     def self.set &block
       b = Block.new
       b.instance_eval &block
-      orm = b.instance_variable_get(:@orm)
-      @@orm = orm unless orm.nil?
-      enabled = b.instance_variable_get(:@en)
+      @@orm = b.orm unless b.orm.nil?
       instance
-      instance.instance_variable_set(:@enabled, enabled) unless enabled.nil?
+      instance.instance_variable_set(:@enabled,    b.enabled)     unless  b.enabled.nil?
     end
 
     # Set the ORM for use by PublicActivity.
@@ -48,6 +48,7 @@ module PublicActivity
 
     # Provides simple DSL for the config block.
     class Block
+      attr_reader :orm, :enabled, :table_name
       # @see Config#orm
       def orm(orm = nil)
         @orm = (orm ? orm.to_sym : false) || @orm
@@ -56,7 +57,13 @@ module PublicActivity
       # Decides whether to enable PublicActivity.
       # @param en [Boolean] Enabled?
       def enabled(en = nil)
-        @en = (en.nil? ? @en : en)
+        @enabled = (en.nil? ? @enabled : en)
+      end
+
+      # Sets the table_name
+      # for the model
+      def table_name(name = nil)
+        PublicActivity.config.table_name = name
       end
     end
   end

data/lib/public_activity/orm/active_record/activist.rb

@@ -3,44 +3,29 @@ module PublicActivity
     module ActiveRecord
       # Module extending classes that serve as owners
       module Activist
-        extend ActiveSupport::Concern
-
-        # Loads the {ClassMethods#activist} method for declaring the class
-        # as an activist.
-        def self.extended(base)
-          base.extend(ClassMethods)
-        end
-
-
-        # Module extending classes that serve as owners
-        module ClassMethods
-          # Adds ActiveRecord associations to model to simplify fetching
-          # so you can list activities performed by the owner.
-          # It is completely optional. Any model can be an owner to an activity
-          # even without being an explicit activist.
-          #
-          # == Usage:
-          # In model:
-          #
-          #   class User < ActiveRecord::Base
-          #     include PublicActivity::Model
-          #     activist
-          #   end
-          #
-          # In controller:
-          #   User.first.activities
-          #
-          def activist
-            # Association of activities as their owner.
-            # @!method activities_as_owner
-            # @return [Array<Activity>] Activities which self is the owner of.
-            has_many :activities_as_owner, :class_name => "::PublicActivity::Activity", :as => :owner
-
-            # Association of activities as their recipient.
-            # @!method activities_as_recipient
-            # @return [Array<Activity>] Activities which self is the recipient of.
-            has_many :activities_as_recipient, :class_name => "::PublicActivity::Activity", :as => :recipient
-          end
+        # Adds ActiveRecord associations to model to simplify fetching
+        # so you can list activities performed by the owner.
+        # It is completely optional. Any model can be an owner to an activity
+        # even without being an explicit activist.
+        #
+        # == Usage:
+        # In model:
+        #
+        #   class User < ActiveRecord::Base
+        #     include PublicActivity::Model
+        #     activist
+        #   end
+        #
+        # In controller:
+        #   User.first.activities
+        #
+        def activist
+          has_many :activities_as_owner,
+            :class_name => "::PublicActivity::Activity",
+            :as => :owner
+          has_many :activities_as_recipient,
+            :class_name => "::PublicActivity::Activity",
+            :as => :recipient
         end
       end
     end

data/lib/public_activity/orm/active_record/activity.rb

@@ -5,6 +5,7 @@ module PublicActivity
       # details about recorded activity.
       class Activity < ::ActiveRecord::Base
         include Renderable
+        self.table_name = PublicActivity.config.table_name
 
         # Define polymorphic association to the parent
         belongs_to :trackable, :polymorphic => true
@@ -15,10 +16,10 @@ module PublicActivity
         # Serialize parameters Hash
         serialize :parameters, Hash
 
-        if ::ActiveRecord::VERSION::MAJOR < 4
+        if ::ActiveRecord::VERSION::MAJOR < 4 || defined?(ProtectedAttributes)
           attr_accessible :key, :owner, :parameters, :recipient, :trackable
         end
       end
     end
   end
-end
+end

data/lib/public_activity/orm/mongo_mapper/activist.rb

@@ -3,42 +3,30 @@ module PublicActivity
     module MongoMapper
       # Module extending classes that serve as owners
       module Activist
-        extend ActiveSupport::Concern
-
-        def self.extended(base)
-          base.extend(ClassMethods)
-        end
-        # Association of activities as their owner.
-        # @!method activities
-        # @return [Array<Activity>] Activities which self is the owner of.
-
-        # Association of activities as their recipient.
-        # @!method private_activities
-        # @return [Array<Activity>] Activities which self is the recipient of.
-
-        # Module extending classes that serve as owners
-        module ClassMethods
-          # Adds MongoMapper associations to model to simplify fetching
-          # so you can list activities performed by the owner.
-          # It is completely optional. Any model can be an owner to an activity
-          # even without being an explicit activist.
-          #
-          # == Usage:
-          # In model:
-          #
-          #   class User
-          #     include MongoMapper::Document
-          #     include PublicActivity::Model
-          #     activist
-          #   end
-          #
-          # In controller:
-          #   User.first.activities
-          #
-          def activist
-            many :activities_as_owner,      :class_name => "::PublicActivity::Activity", :as => :owner
-            many :activities_as_recipient,  :class_name => "::PublicActivity::Activity", :as => :recipient
-          end
+        # Adds MongoMapper associations to model to simplify fetching
+        # so you can list activities performed by the owner.
+        # It is completely optional. Any model can be an owner to an activity
+        # even without being an explicit activist.
+        #
+        # == Usage:
+        # In model:
+        #
+        #   class User
+        #     include MongoMapper::Document
+        #     include PublicActivity::Model
+        #     activist
+        #   end
+        #
+        # In controller:
+        #   User.first.activities
+        #
+        def activist
+          many :activities_as_owner,
+            :class_name => "::PublicActivity::Activity",
+            :as => :owner
+          many :activities_as_recipient,
+            :class_name => "::PublicActivity::Activity",
+            :as => :recipient
         end
       end
     end

data/lib/public_activity/orm/mongoid/activist.rb

@@ -3,41 +3,30 @@ module PublicActivity
     module Mongoid
       # Module extending classes that serve as owners
       module Activist
-        extend ActiveSupport::Concern
+        # Adds ActiveRecord associations to model to simplify fetching
+        # so you can list activities performed by the owner.
+        # It is completely optional. Any model can be an owner to an activity
+        # even without being an explicit activist.
+        #
+        # == Usage:
+        # In model:
+        #
+        #   class User < ActiveRecord::Base
+        #     include PublicActivity::Model
+        #     activist
+        #   end
+        #
+        # In controller:
+        #   User.first.activities
+        #
+        def activist
+          has_many :activities_as_owner,
+            :class_name => "::PublicActivity::Activity",
+            :inverse_of => :owner
 
-        def self.extended(base)
-          base.extend(ClassMethods)
-        end
-        # Association of activities as their owner.
-        # @!method activities
-        # @return [Array<Activity>] Activities which self is the owner of.
-
-        # Association of activities as their recipient.
-        # @!method private_activities
-        # @return [Array<Activity>] Activities which self is the recipient of.
-
-        # Module extending classes that serve as owners
-        module ClassMethods
-          # Adds ActiveRecord associations to model to simplify fetching
-          # so you can list activities performed by the owner.
-          # It is completely optional. Any model can be an owner to an activity
-          # even without being an explicit activist.
-          #
-          # == Usage:
-          # In model:
-          #
-          #   class User < ActiveRecord::Base
-          #     include PublicActivity::Model
-          #     activist
-          #   end
-          #
-          # In controller:
-          #   User.first.activities
-          #
-          def activist
-            has_many :activities_as_owner,      :class_name => "::PublicActivity::Activity", :inverse_of => :owner
-            has_many :activities_as_recipient,  :class_name => "::PublicActivity::Activity", :inverse_of => :recipient
-          end
+          has_many :activities_as_recipient,
+            :class_name => "::PublicActivity::Activity",
+            :inverse_of => :recipient
         end
       end
     end

data/lib/public_activity/renderable.rb

@@ -53,6 +53,17 @@ module PublicActivity
     #   <p><%= a.created_at %></p>
     #   <%= yield %>
     #
+    # == Custom Layout Location
+    # You can customize the layout directory by supplying :layout_root
+    # or by using an absolute path.
+    #
+    # @example Declare custom layout location
+    #
+    #   # Both examples look for a layout in "app/views/custom/_layout.erb"
+    #
+    #    render_activity @activity, :layout_root => "custom"
+    #    render_activity @activity, :layout      => "/custom/layout"
+    #
     # = Creating a template
     # To use templates for formatting how the activity should render,
     # create a template based on activity key, for example:
@@ -64,6 +75,13 @@ module PublicActivity
     # directory structure will have to be deeper, for example:
     #   activity.article.comments.destroy => app/views/public_activity/articles/comments/_destroy.html.erb
     #
+    # == Custom Directory
+    # You can override the default `public_directory` template root with the :root parameter
+    #
+    # @example Custom template root
+    #    # look for templates inside of /app/views/custom instead of /app/views/public_directory
+    #    render_activity @activity, :root => "custom"
+    #
     # == Variables in templates
     # From within a template there are two variables at your disposal:
     # * activity (aliased as *a* for a shortcut)
@@ -76,42 +94,69 @@ module PublicActivity
     #     <%= distance_of_time_in_words_to_now(a.created_at) %>
     #   </p>
     def render(context, params = {})
-      partial_path = nil
+      partial_root  = params.delete(:root)         || 'public_activity'
+      partial_path  = nil
+      layout_root   = params.delete(:layout_root)  || 'layouts'
+
       if params.has_key? :display
-        # if i18n has been requested, let it render and bail
-        return context.render :text => self.text(params) if params[:display].to_sym == :"i18n"
-        partial_path = 'public_activity/'+params[:display].to_s
+        if params[:display].to_sym == :"i18n"
+          return context.render :text => self.text(params)
+        else
+          partial_path = File.join(partial_root, params[:display].to_s)
+        end
       end
 
-      controller = PublicActivity.get_controller
-      if layout = params.delete(:layout)
-        layout = layout.to_s
-        layout = layout[0,8] == "layouts/" ? layout : "layouts/#{layout}"
-      end
+      context.render(
+        params.merge({
+          :partial => prepare_partial(partial_root, partial_path),
+          :layout  => prepare_layout(layout_root, params.delete(:layout)),
+          :locals  => prepare_locals(params)
+        })
+      )
+    end
+
+    def prepare_partial(root, path)
+      path || self.template_path(self.key, root)
+    end
 
+    def prepare_locals(params)
       locals = params.delete(:locals) || Hash.new
 
-      params_indifferent = self.parameters.with_indifferent_access
-      params_indifferent.merge!(params)
+      controller  = PublicActivity.get_controller
+      prepared_params = prepare_parameters(params)
+      locals.merge(
+        {
+          :a              => self,
+          :activity       => self,
+          :controller     => controller,
+          :current_user   => controller.respond_to?(:current_user) ? controller.current_user : nil,
+          :p              => prepared_params,
+          :params         => prepared_params
+        }
+      )
+    end
+
+    def prepare_layout(root, layout)
+      if layout
+        path = layout.to_s
+        unless path.starts_with?(root) || path.starts_with?("/")
+          return File.join(root, path)
+        end
+      end
+      layout
+    end
 
-      context.render :partial => (partial_path || self.template_path(self.key)),
-        :layout => layout,
-        :locals => locals.merge(:a => self, :activity => self,
-           :controller => controller,
-           :current_user => controller.respond_to?(:current_user) ?
-                controller.current_user : nil ,
-           :p => params_indifferent, :params => params_indifferent)
+    def prepare_parameters(params)
+      @prepared_params ||= self.parameters.with_indifferent_access.merge(params)
     end
 
     protected
+
     # Builds the path to template based on activity key
-    # TODO: verify that attribute `key` is splitted by commas
-    #       and that the word before first comma is equal to
-    #       "activity"
-    def template_path(key)
+    def template_path(key, partial_root)
       path = key.split(".")
       path.delete_at(0) if path[0] == "activity"
-      path.unshift "public_activity"
+      path.unshift partial_root
       path.join("/")
     end
   end

data/lib/public_activity/roles/tracked.rb

@@ -29,10 +29,10 @@ module PublicActivity
     # @return [nil]
     def activity(options = {})
       rest = options.clone
-      self.activity_key = rest.delete(:key) if rest[:key]
-      self.activity_owner = rest.delete(:owner) if rest[:owner]
-      self.activity_params = rest.delete(:params) if rest[:params]
-      self.activity_recipient = rest.delete(:recipient) if rest[:recipient]
+      self.activity_key           = rest.delete(:key) if rest[:key]
+      self.activity_owner         = rest.delete(:owner) if rest[:owner]
+      self.activity_params        = rest.delete(:params) if rest[:params]
+      self.activity_recipient     = rest.delete(:recipient) if rest[:recipient]
       self.activity_custom_fields = rest if rest.count > 0
       nil
     end
@@ -133,50 +133,61 @@ module PublicActivity
       def tracked(opts = {})
         options = opts.clone
 
-        all_options = [:create, :update, :destroy]
+        include_default_actions(options)
 
-        if !options.has_key?(:skip_defaults) && !options[:only] && !options[:except]
-          include Creation
-          include Destruction
-          include Update
-        end
-        options.delete(:skip_defaults)
+        assign_globals       options
+        assign_hooks         options
+        assign_custom_fields options
 
-        if options[:except]
-          options[:only] = all_options - Array(options.delete(:except))
-        end
+        nil
+      end
 
-        if options[:only]
-          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
-          end
-          options.delete(:only)
+      def include_default_actions(options)
+        defaults = {
+          create:  Creation,
+          destroy: Destruction,
+          update:  Update
+        }
+
+        if options[:skip_defaults] == true
+          return
         end
 
-        if options[:owner]
-          self.activity_owner_global = options.delete(:owner)
+        modules = if options[:except]
+          defaults.except(*options[:except])
+        elsif options[:only]
+          defaults.slice(*options[:only])
+        else
+          defaults
         end
-        if options[:recipient]
-          self.activity_recipient_global = options.delete(:recipient)
+
+        modules.each do |key, value|
+          include value
         end
-        if options[:params]
-          self.activity_params_global = options.delete(:params)
+      end
+
+      def available_options
+        [:skip_defaults, :only, :except, :on, :owner, :recipient, :params].freeze
+      end
+
+      def assign_globals(options)
+        [:owner, :recipient, :params].each do |key|
+          if options[key]
+            self.send("activity_#{key}_global=".to_sym, options.delete(key))
+          end
         end
-        if options.has_key?(:on) and options[:on].is_a? Hash
-          self.activity_hooks = options.delete(:on).select {|_, v| v.is_a? Proc}.symbolize_keys
+      end
+
+      def assign_hooks(options)
+        if options[:on].is_a?(Hash)
+          self.activity_hooks = options[:on].select {|_, v| v.is_a? Proc}.symbolize_keys
         end
+      end
 
-        options.each do |k, v|
+      def assign_custom_fields(options)
+        options.except(*available_options).each do |k, v|
           self.activity_custom_fields_global[k] = v
         end
-
-        nil
       end
     end
   end

data/lib/public_activity/testing.rb

@@ -0,0 +1,35 @@
+# This file provides functionality for testing your code with public_activity
+# activated or deactivated.
+# This file should only be required in test/spec code!
+#
+# To enable PublicActivity testing capabilities do:
+#   require 'public_activity/testing'
+module PublicActivity
+  # Execute the code block with PublicActiviy active
+  #
+  # Example usage:
+  #   PublicActivity.with_tracking do
+  #     # your test code here
+  #   end
+  def self.with_tracking
+    current = PublicActivity.enabled?
+    PublicActivity.enabled = true
+    yield
+  ensure
+    PublicActivity.enabled = current
+  end
+
+  # Execute the code block with PublicActiviy deactive
+  #
+  # Example usage:
+  #   PublicActivity.without_tracking do
+  #     # your test code here
+  #   end
+  def self.without_tracking
+    current = PublicActivity.enabled?
+    PublicActivity.enabled = false
+    yield
+  ensure
+    PublicActivity.enabled = current
+  end
+end

data/lib/public_activity/version.rb

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

data/test/test_activity.rb

@@ -52,6 +52,13 @@ describe 'PublicActivity::Activity Rendering' do
       rendered.must_equal '1 2'
     end
 
+    it "pass all params to view context" do
+      view_context = mock('ViewContext')
+      PublicActivity.set_controller(nil)
+      view_context.expects(:render).with() {|params| params[:formats] == ['json']}
+      subject.render(view_context, :formats => ['json'])
+    end
+
     it "uses specified layout" do
       PublicActivity.set_controller(nil)
       subject.render(self, :layout => "activity")
@@ -63,5 +70,18 @@ describe 'PublicActivity::Activity Rendering' do
       subject.render(self, :layout => :activity)
       rendered.must_include "Here be the layouts"
     end
+
+    it "accepts a custom layout root" do
+      subject.render(self, :layout => :layout, :layout_root => "custom")
+      rendered.must_include "Here be the custom layouts"
+    end
+    it "accepts an absolute layout path" do
+      subject.render(self, :layout => '/custom/layout')
+      rendered.must_include "Here be the custom layouts"
+    end
+    it "accepts a template root" do
+      subject.render(self, :root => "custom")
+      rendered.must_include "Custom Template Root"
+    end
   end
 end

data/test/test_common.rb

@@ -94,7 +94,7 @@ describe PublicActivity::Common do
     activity.owner.must_equal @owner
   end
 
-  describe '#extract_key' do
+  describe '#prepare_key' do
     describe 'for class#activity_key method' do
       before do
         @article = article(:owner => :user).new(:user => @owner)
@@ -103,17 +103,17 @@ describe PublicActivity::Common do
       it 'assigns key to value of activity_key if set' do
         def @article.activity_key; "my_custom_key" end
 
-        @article.extract_key(:create, {}).must_equal "my_custom_key"
+        @article.prepare_key(:create, {}).must_equal "my_custom_key"
       end
 
       it 'assigns key based on class name as fallback' do
         def @article.activity_key; nil end
 
-        @article.extract_key(:create).must_equal "article.create"
+        @article.prepare_key(:create).must_equal "article.create"
       end
 
       it 'assigns key value from options hash' do
-        @article.extract_key(:create, :key => :my_custom_key).must_equal "my_custom_key"
+        @article.prepare_key(:create, :key => :my_custom_key).must_equal "my_custom_key"
       end
     end
 
@@ -126,7 +126,7 @@ describe PublicActivity::Common do
       end
 
       it 'assigns generates key from class name' do
-        @camel_case.extract_key(:create, {}).must_equal "camel_case.create"
+        @camel_case.prepare_key(:create, {}).must_equal "camel_case.create"
       end
     end
 
@@ -141,7 +141,7 @@ describe PublicActivity::Common do
       end
 
       it 'assigns key value from options hash' do
-        @namespaced_camel_case.extract_key(:create, {}).must_equal "my_namespace_camel_case.create"
+        @namespaced_camel_case.prepare_key(:create, {}).must_equal "my_namespace_camel_case.create"
       end
     end
   end

data/test/test_helper.rb

@@ -2,7 +2,7 @@ require "rubygems"
 require "bundler"
 Bundler.setup(:default, :test)
 
-unless ENV['NOCOV']
+if ENV['COV']
   require 'simplecov'
   SimpleCov.start do
     add_filter "/test/"
@@ -11,8 +11,9 @@ end
 $:.unshift File.expand_path('../../lib/', __FILE__)
 require 'active_support/testing/setup_and_teardown'
 require 'public_activity'
+require 'public_activity/testing'
+require 'pry'
 require 'minitest/autorun'
-require 'minitest/pride' if ENV['WITH_PRIDE'] or ENV['PRIDE']
 
 PublicActivity::Config.orm = (ENV['PA_ORM'] || :active_record)
 
@@ -121,4 +122,4 @@ class ViewSpec < MiniTest::Spec
   include ActiveSupport::Testing::SetupAndTeardown
   include ActionView::TestCase::Behavior
 end
-MiniTest::Spec.register_spec_type(/Rendering$/, ViewSpec)
+MiniTest::Spec.register_spec_type(/Rendering$/, ViewSpec)

data/test/test_testing.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+describe PublicActivity do
+
+  describe "self.with_tracking" do
+    it "enables tracking inside the block" do
+      PublicActivity.enabled = false
+
+      PublicActivity.with_tracking do
+        PublicActivity.enabled?.must_equal true
+      end
+    end
+
+    it "restores previous `enabled` state" do
+      PublicActivity.enabled = false
+      PublicActivity.with_tracking do
+        # something
+      end
+      PublicActivity.enabled?.must_equal false
+    end
+  end
+
+  describe "self.without_tracking" do
+    it "disables tracking inside the block" do
+      PublicActivity.enabled = true
+
+      PublicActivity.without_tracking do
+        PublicActivity.enabled?.must_equal false
+      end
+    end
+  end
+end

data/test/views/custom/_layout.erb

@@ -0,0 +1 @@
+<h2>Here be the custom layouts</h2><%= yield %>

data/test/views/custom/_test.erb

@@ -0,0 +1 @@
+Custom Template Root <%= activity.id %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: public_activity
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Piotrek Okoński
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-22 00:00:00.000000000 Z
+date: 2013-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -151,6 +151,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Easy activity tracking for your ActiveRecord models. Provides Activity
   model with details about actions performed by your users, like adding comments,
   responding etc.
@@ -195,6 +209,7 @@ files:
 - lib/public_activity/renderable.rb
 - lib/public_activity/roles/deactivatable.rb
 - lib/public_activity/roles/tracked.rb
+- lib/public_activity/testing.rb
 - lib/public_activity/utility/store_controller.rb
 - lib/public_activity/utility/view_helpers.rb
 - lib/public_activity/version.rb
@@ -214,8 +229,11 @@ files:
 - test/test_controller_integration.rb
 - test/test_generators.rb
 - test/test_helper.rb
+- test/test_testing.rb
 - test/test_tracking.rb
 - test/test_view_helpers.rb
+- test/views/custom/_layout.erb
+- test/views/custom/_test.erb
 - test/views/layouts/_activity.erb
 - test/views/public_activity/_test.erb
 homepage: https://github.com/pokonski/public_activity
@@ -237,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Easy activity tracking for ActiveRecord models
@@ -254,8 +272,11 @@ test_files:
 - test/test_controller_integration.rb
 - test/test_generators.rb
 - test/test_helper.rb
+- test/test_testing.rb
 - test/test_tracking.rb
 - test/test_view_helpers.rb
+- test/views/custom/_layout.erb
+- test/views/custom/_test.erb
 - test/views/layouts/_activity.erb
 - test/views/public_activity/_test.erb
 has_rdoc: