public_activity 0.4.1 → 0.5.0

data/README.md

@@ -7,7 +7,11 @@ Simply put: it records what has been changed or edited and gives you the ability
 
 Here is a simple example showing what this gem is about:
 
-![Example usage](http://i.imgur.com/uGPSm.png)
+![Example usage](http://i.imgur.com/q0TVx.png)
+
+### Online demo
+
+You can see an actual application using this gem here: http://public-activity-example.herokuapp.com/feed
 
 ## Upgrading to 0.4
 
@@ -23,7 +27,9 @@ You can install `public_activity` as you would any other gem:
 
 or in your Gemfile:
 
-    gem 'public_activity'
+```ruby
+gem 'public_activity'
+```
 
 ### Database setup
 
@@ -132,5 +138,10 @@ There are a couple of major differences between 0.3 and 0.4 version. To upgrade,
 
 For more customization go [here](http://rubydoc.info/gems/public_activity/index)
 
+## Useful examples
+
+* [[How to] Set the Activity's owner to current_user by default](https://github.com/pokonski/public_activity/wiki/%5BHow-to%5D-Set-the-Activity's-owner-to-current_user-by-default)
+
+
 ## License
 Copyright (c) 2012 Piotrek Okoński, released under the MIT license

data/UPGRADING

@@ -5,4 +5,4 @@
 public_activity 0.4.0 brings major changes compared to 0.3.X versions,
 please read https://github.com/pokonski/public_activity#upgrading 
 to learn about all the changes you need to apply to properly
-upgrade your applications.
+upgrade your applications.

data/lib/public_activity.rb

@@ -12,6 +12,7 @@ module PublicActivity
   extend ActiveSupport::Autoload
   autoload :Activist
   autoload :Activity
+  autoload :Config
   autoload :Tracked
   autoload :Creation
   autoload :Update
@@ -19,6 +20,27 @@ module PublicActivity
   autoload :VERSION
   autoload :Common
 
+  # Switches PublicActivity on or off.
+  # @param value [Boolean]
+  # @since 0.5.0
+  def self.enabled=(value)
+    PublicActivity.config.enabled = value
+  end
+
+  # Returns `true` if PublicActivity is on, `false` otherwise.
+  # Enabled by default.
+  # @return [Boolean]
+  # @since 0.5.0
+  def self.enabled?
+    !!PublicActivity.config.enabled
+  end
+
+  # Returns PublicActivity's configuration object.
+  # @since 0.5.0
+  def self.config
+    @@config ||= PublicActivity::Config.instance
+  end
+
   # Module to be included in ActiveRecord models. Adds required functionality.
   module Model
     extend ActiveSupport::Concern

data/lib/public_activity/activity.rb

@@ -89,7 +89,7 @@ module PublicActivity
     # == Variables in templates
     # From within a template there are two variables at your disposal:
     # * activity (aliased as *a* for a shortcut)
-    # * params   (aliased as *p*) [converted into a {HashWithIndifferentAccess}]
+    # * params   (aliased as *p*) [converted into a HashWithIndifferentAccess]
     #
     # @example Template for key: _activity.article.create_ (erb)
     #   <p>

data/lib/public_activity/common.rb

@@ -78,6 +78,7 @@ module PublicActivity
     #   @option options [Hash] :params Parameters, see
     #     {PublicActivity.resolve_value}
     def create_activity(*args)
+      return unless self.public_activity_enabled?
       options = prepare_settings(*args)
 
       if call_hook_safe(options[:key].split('.').last)

data/lib/public_activity/config.rb

@@ -0,0 +1,12 @@
+module PublicActivity
+  # Class used to initialize configuration object.
+  class Config
+    include Singleton
+    attr_accessor :enabled
+
+    def initialize
+      # Indicates whether PublicActivity is enabled globally
+      @enabled         = true
+    end
+  end
+end

data/lib/public_activity/store_controller.rb

@@ -1,6 +1,7 @@
 module PublicActivity
   # @private
   @@controllers = Hash.new
+  # Lambda called after the thread is destroyed.
   Finalizer = lambda { |id|
     @@controllers.delete id
   }

data/lib/public_activity/tracked.rb

@@ -5,11 +5,12 @@ module PublicActivity
 
     included do
       class_attribute :activity_owner_global, :activity_recipient_global,
-                      :activity_params_global, :activity_hooks
-      self.activity_owner_global     = nil
-      self.activity_recipient_global = nil
-      self.activity_params_global    = {}
-      self.activity_hooks            = {}
+                      :activity_params_global, :activity_hooks, :public_activity_enabled_for_model
+      self.activity_owner_global             = nil
+      self.activity_recipient_global         = nil
+      self.activity_params_global            = {}
+      self.activity_hooks                    = {}
+      self.public_activity_enabled_for_model = true
     end
 
     # @!group Global options
@@ -286,6 +287,25 @@ module PublicActivity
           nil
         end
       end
+
+      # Switches public_activity off for this class
+      def public_activity_off
+        self.public_activity_enabled_for_model = false
+      end
+
+      # Switches public_activity on for this class
+      def public_activity_on
+        self.public_activity_enabled_for_model = true
+      end
+    end
+
+    # Returns true if PublicActivity is enabled
+    # globally and for this class.
+    # @return [Boolean]
+    # @api private
+    # @since 0.5.0
+    def public_activity_enabled?
+      PublicActivity.enabled? && self.class.public_activity_enabled_for_model
     end
 
     # Shortcut for {Tracked::ClassMethods#get_hook}

data/lib/public_activity/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: public_activity
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-15 00:00:00.000000000 Z
+date: 2012-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &81298800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,15 +22,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.0
+  version_requirements: *81298800
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &81297860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,15 +33,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.0
+  version_requirements: *81297860
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &81295830 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,15 +44,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.0
+  version_requirements: *81295830
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &81295360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -70,15 +55,10 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.5.0
+  version_requirements: *81295360
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &81128560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -86,15 +66,10 @@ dependencies:
         version: 0.6.4
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.6.4
+  version_requirements: *81128560
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &81127100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -102,15 +77,10 @@ dependencies:
         version: '1.1'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.1'
+  version_requirements: *81127100
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &81126290 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -118,15 +88,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0.9'
+  version_requirements: *81126290
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &81125640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -134,15 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *81125640
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &81124540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -150,15 +110,10 @@ dependencies:
         version: 0.12.1
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.12.1
+  version_requirements: *81124540
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &81121440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -166,12 +121,7 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.0
+  version_requirements: *81121440
 description: Smooth activity tracking for your ActiveRecord models. Provides Activity
   model with details about actions performed by your users, like adding comments,
   responding etc.
@@ -191,6 +141,7 @@ files:
 - lib/public_activity/activist.rb
 - lib/public_activity/activity.rb
 - lib/public_activity/common.rb
+- lib/public_activity/config.rb
 - lib/public_activity/creation.rb
 - lib/public_activity/destruction.rb
 - lib/public_activity/store_controller.rb
@@ -208,7 +159,7 @@ licenses: []
 post_install_message: ! "##################################################\n#  NOTE
   FOR UPGRADING FROM PRE-0.4.0 VERSION     #\n##################################################\n\npublic_activity
   0.4.0 brings major changes compared to 0.3.X versions,\nplease read https://github.com/pokonski/public_activity#upgrading
-  \nto learn about all the changes you need to apply to properly\nupgrade your applications."
+  \nto learn about all the changes you need to apply to properly\nupgrade your applications.\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -226,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Smooth activity tracking for ActiveRecord models