public_activity 0.3 → 0.3.1

data/README.md

@@ -19,24 +19,32 @@ or in your Gemfile:
 ## Usage
 
 Create migration for activities (in your Rails project):
+
     rails g public_activity:migration
     rake db:migrate
 
 Add 'tracked' to the model you want to keep track of:
+
     class Article < ActiveRecord::Base
       tracked
     end
+    
 And now, by default create/update/destroy activities are recorded in activities table. 
 To display them you can do a simple query:
+
     # some_controller.rb
     def index
       @activities = PublicActivity::Activity.all
     end
+    
 And in your views:
+
     <% for activity in @activities %>
       <%= activity.text %><br/>
     <% end %>
+    
 The only thing left is to add translations to your locale files, for example:
+
     en:
       activity:
         article:

data/lib/public_activity/common.rb

@@ -4,11 +4,26 @@ module PublicActivity
     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 = {})
+        self.activities.create(:key => key, :owner => owner, :parameters => params)
+      end
+
       private
-        # Creates activity based on supplied arguments
-        def create_activity(key, owner, params)
-          self.activities.create(:key => key, :owner => owner, :parameters => params)
-        end
         # Prepares settings used during creation of Activity record.
         # params passed directly to tracked model have priority over
         # settings specified in tracked() method

data/lib/public_activity/tracked.rb

@@ -57,7 +57,7 @@ module PublicActivity
     #   @article = Article.new
     #   @article.save
     #   @article.activities.last.key #=> "activity.article.create"
-    # By default, key looks like "activity.[class_name].[create|update|destroy]"
+    # By default, key looks like "activity.class_name.create|update|destroy"
     #
     # You can customize it, by setting your own key:
     #   @article = Article.new
@@ -87,14 +87,19 @@ 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#activity} method.
+      #   Everything specified here has a lower priority than parameters specified directly in {Tracked::InstanceMethods#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}
+      #   for a guide on how to manually record activities.
       def tracked(options = {})
         include Common
-        include Creation
-        include Destruction
+        if !options[:skip_defaults]
+          include Creation
+          include Destruction
+        end
             
         if options[:owner]
           self.activity_owner_global = options[:owner]

data/lib/public_activity/version.rb

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

metadata

@@ -1,72 +1,70 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: public_activity
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.3.1
   prerelease: 
-  version: "0.3"
 platform: ruby
-authors: 
-- "Piotrek Oko\xC5\x84ski"
-- "Kuba Oko\xC5\x84ski"
+authors:
+- Piotrek Okoński
+- Kuba Okoński
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-10 00:00:00 +02:00
+date: 2011-09-08 00:00:00.000000000 +02:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70011400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70011400
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70011140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: i18n
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70011140
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70010890 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.5.0
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70010890
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70010690 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-description: Smooth activity tracking for your ActiveRecord models. Provides Activity model with details about actions performed by your users, like adding comments, responding etc.
+  prerelease: false
+  version_requirements: *70010690
+description: Smooth activity tracking for your ActiveRecord models. Provides Activity
+  model with details about actions performed by your users, like adding comments,
+  responding etc.
 email: piotrek@okonski.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/generators/public_activity.rb
 - lib/generators/public_activity/migration/migration_generator.rb
 - lib/generators/public_activity/migration/templates/migration.rb
@@ -87,31 +85,28 @@ files:
 has_rdoc: true
 homepage: https://github.com/okonski/public_activity
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.1
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Smooth activity tracking for ActiveRecord models
-test_files: 
+test_files:
 - spec/spec_helper.rb
 - spec/version_spec.rb