public_activity 0.3.1 → 0.3.2

data/Gemfile

@@ -4,8 +4,10 @@ gemspec
 
 gem 'rails'
 gem 'yard'
-gem 'i18n'
+gem 'pusher'
 
 group :development, :test do
   gem 'rspec'
+  gem 'sqlite3'
+  gem 'rspec-rails'
 end

data/README.md

@@ -1,4 +1,4 @@
-# PublicActivity
+# PublicActivity ![Build Status](http://travis-ci.org/sbower/public_activity.png)
 
 public_activity provides smooth acitivity 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.
@@ -28,6 +28,20 @@ Add 'tracked' to the model you want to keep track of:
     class Article < ActiveRecord::Base
       tracked
     end
+
+To default the owner to the current user (optional)
+    
+    #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:
@@ -43,15 +57,18 @@ And in your views:
       <%= activity.text %><br/>
     <% end %>
     
-The only thing left is to add translations to your locale files, for example:
+The only thing left is to add templates (config/pba.yml), for example:
 
-    en:
       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 rail initializer.
+
+    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!
 ## Documentation
 

data/Rakefile

@@ -1,8 +1,11 @@
+require "bundler/gem_tasks"
 require 'rake'
 require 'yard'
 require 'yard/rake/yardoc_task'
 require 'rspec/core/rake_task'
 
+task :default => :spec
+
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = "./spec/*_spec.rb"
 end

data/lib/public_activity.rb

@@ -1,6 +1,7 @@
 require 'active_support/concern'
 require 'active_support/dependencies'
 require 'active_record'
+require 'pusher'
 # +public_activity+ keeps track of changes made to models
 # and allows for easy displaying of them.
 #
@@ -41,13 +42,14 @@ module PublicActivity
   autoload :Activity
   autoload :Tracked
   autoload :Creation
+  autoload :Update  
   autoload :Destruction
   autoload :VERSION
   autoload :Common
   
   included do
     include Tracked
-    include Activist
+    include Activist 
   end  
 end
 

data/lib/public_activity/activity.rb

@@ -1,5 +1,5 @@
 require 'active_record'
-require 'i18n'
+
 module PublicActivity
   # The ActiveRecord model containing 
   # details about recorded activity.
@@ -11,22 +11,21 @@ module PublicActivity
     # Serialize parameters Hash
     serialize :parameters, Hash
     
-    # Virtual attribute returning already
-    # translated key with params passed
-    # 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.
+    class_attribute :template
+    
+    # Virtual attribute returning text description of the activity
+    # using basic ERB templating
     #
     # == Example:
     #
     # Let's say you want to show article's title inside Activity message.
     #
-    #   #config/locales/en.yml
-    #   en:
-    #     activity:
-    #         article:
-    #           create: "Someone has created an article '%{title}'"
-    #           update: "Article '%{title}' has been modified"
-    #           destroy: "Someone deleted article '%{title}'!"
+    #   #config/pba.yml
+    # activity:
+    #   article:
+    #     create: "New <%= trackable.name %> article has been created"
+    #     update: 'Someone modified the article'
+    #     destroy: 'Someone deleted the article!'
     #
     # And in controller:
     #
@@ -40,8 +39,33 @@ 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(params = {})
-      parameters.merge! params
-      I18n.t(key, parameters || {})
+      begin
+        erb_template = resolveTemplate(key)
+        if !erb_template.nil? 
+          parameters.merge! params
+          renderer = ERB.new(erb_template)
+          renderer.result(binding)
+        else
+          "Template not defined"
+        end
+      rescue
+        "Template not defined"
+      end
+    end
+    
+    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
+        end
+       res
     end
   end  
 end

data/lib/public_activity/common.rb

@@ -19,8 +19,16 @@ module PublicActivity
       # [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)
+      def create_activity(key, owner = nil, params = {})   
+        
+        if owner.nil? && ((defined? User) != nil) && User.respond_to?(:current_user)  
+          owner = User.current_user
+        end
+            
+        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})
+        end
       end
 
       private

data/lib/public_activity/creation.rb

@@ -5,7 +5,6 @@ module PublicActivity
 
     included do
       after_create :activity_on_create
-      after_update :activity_on_update
     end   
     # Handlers responsible for creating Activities.
     module InstanceMethods
@@ -15,12 +14,6 @@ module PublicActivity
           settings = prepare_settings
           create_activity(settings[:key] || "activity."+self.class.name.parameterize('_')+".create", settings[:owner], settings[:parameters])
         end
-        
-        # Creates activity upon modification of the tracked model
-        def activity_on_update
-          settings = prepare_settings
-          create_activity(settings[:key] || "activity."+self.class.name.parameterize('_')+".update", settings[:owner], settings[:parameters])
-        end
     end
   end
 end

data/lib/public_activity/tracked.rb

@@ -96,9 +96,29 @@ module PublicActivity
       #   for a guide on how to manually record activities.
       def tracked(options = {})
         include Common
-        if !options[:skip_defaults]
+        
+        all_options = [:create, :update, :destroy]
+        
+        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
+            end
         end
             
         if options[:owner]

data/lib/public_activity/update.rb

@@ -0,0 +1,19 @@
+module PublicActivity
+  # Handles creation of Activities upon destruction and update of tracked model.
+  module Update
+    extend ActiveSupport::Concern
+
+    included do
+      after_update :activity_on_update
+    end   
+    # Handlers responsible for updating Activities.
+    module InstanceMethods
+      private       
+        # Creates activity upon modification of the tracked model
+        def activity_on_update
+          settings = prepare_settings
+          create_activity(settings[:key] || "activity."+self.class.name.parameterize('_')+".update", settings[:owner], settings[:parameters])
+        end
+    end
+  end
+end

data/lib/public_activity/version.rb

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

data/spec/db/database.yml

@@ -0,0 +1,18 @@
+sqlite3:
+  adapter: <%= "jdbc" if defined? JRUBY_VERSION %>sqlite3
+  database: awesome_nested_set.sqlite3.db
+sqlite3mem:
+  adapter: <%= "jdbc" if defined? JRUBY_VERSION %>sqlite3
+  database: ":memory:"
+postgresql:
+  adapter: postgresql
+  username: postgres
+  password: postgres
+  database: public_activity_plugin_test
+  min_messages: ERROR
+mysql:
+  adapter: mysql2
+  host: localhost
+  username: root
+  password:
+  database: public_activity_plugin_test

data/spec/db/schema.rb

@@ -0,0 +1,27 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :categories, :force => true do |t|
+    t.column :name, :string
+  end
+
+  create_table :departments, :force => true do |t|
+    t.column :name, :string
+  end
+
+  create_table :notes, :force => true do |t|
+    t.column :body, :text
+    t.column :category_id, :integer
+  end
+  
+  create_table :activities, :force => true do |t|
+      t.integer  :trackable_id
+      t.string   :trackable_type
+      t.integer  :owner_id
+      t.string   :owner_type
+      t.string   :key
+      t.text     :parameters
+      t.datetime :created_at
+      t.datetime :updated_at
+  end
+    
+end

data/spec/fixtures/categories.yml

@@ -0,0 +1,18 @@
+cat1:
+  id: 1
+  name: Category 1
+cat2:
+  id: 2
+  name: Category 2
+cat3:
+  id: 3
+  name: Category 3
+cat4:
+  id: 4
+  name: Category 4
+cat5:
+  id: 5
+  name: Category 5
+cat6:
+  id: 6
+  name: Category 6

data/spec/fixtures/departments.yml

@@ -0,0 +1,3 @@
+top:
+  id: 1
+  name: Dept 1

data/spec/fixtures/notes.yml

@@ -0,0 +1,8 @@
+note1:
+  id: 1
+  body: Note 1
+  category_id: 1
+note2:
+  id: 2
+  body: Note 2
+  category_id: 200  

data/spec/public_activity_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+describe "public_activity" do
+  before(:all) do
+    self.class.fixtures :categories, :departments, :notes
+  end
+  
+  describe "tracked" do
+    
+    it "should create a record in activity table" do
+      #we should have no records
+      PublicActivity::Activity.count.should == 0
+    
+      lambda do
+        category = Category.create(:name => "test cat")
+        activity = PublicActivity::Activity.last
+        activity.trackable_id.should == category.id
+      end.should change(PublicActivity::Activity, :count).by(1)
+    end
+    
+    describe "activity model" do
+      before(:each) do
+        @category = Category.create(:name => "test cat")
+      end
+  
+      it "should have a nil owner" do
+        activity = PublicActivity::Activity.last
+        activity.owner.should be_nil
+      end
+  
+      it "should have an owner" do
+        department = Department.create(:name => "test dept")
+        @category.activity_owner = department
+        @category.save
+    
+        activity = PublicActivity::Activity.last
+        activity.owner.should_not be_nil
+      end
+      
+      it "should have activites" do
+         @category.activities.should_not be_nil
+      end
+      
+      it "should translate" do
+        @category.activities.last.text.should_not be_nil
+        @category.activities.last.text.should == "New test cat category has been created"
+      end
+      
+      it "should track deletes" do
+        lambda do
+          @category.destroy
+          @category.activities.last.text.should == "Someone deleted the category!"
+        end.should change(PublicActivity::Activity, :count).by(1)  
+      end
+      
+      it "should track updates" do
+        lambda do
+          @category.name = "new cat"
+          @category.save
+          @category.activities.last.text.should == "Someone modified the category"
+        end.should change(PublicActivity::Activity, :count).by(1)  
+      end
+      
+      it "should evaluate associations" do
+        note = Note.find(1)
+        note.body = "New Test"
+        note.save
+        note.activities.last.text.should == "Someone modified note New Test with category Category 1"
+      end
+    end
+    
+    describe "tracked options" do
+      it "should not track destroy for note (only)" do
+        lambda do
+         note = Note.find(1)
+         note.destroy
+        end.should change(PublicActivity::Activity, :count).by(0)
+      end
+      
+      it "should not track create for department (except)" do
+        lambda do
+         dept = Department.find(1)
+         dept.name = "new name"
+         dept.save
+        end.should change(PublicActivity::Activity, :count).by(1)
+        
+        lambda do
+         dept = Department.find(1)
+         dept.destroy
+        end.should change(PublicActivity::Activity, :count).by(1)     
+           
+        lambda do
+         dept = Department.new
+         dept.name = "some name"
+         dept.save
+        end.should change(PublicActivity::Activity, :count).by(0)   
+             
+      end
+    end
+  end
+  
+  describe "activist" do
+    
+    before(:each) do
+      @category = Category.create(:name => "test cat")
+      @department = Department.create(:name => "test dept")
+      @category.activity_owner = @department
+      @category.save
+    end
+    
+    it "should have activites" do
+      @department.activities.should_not be_nil
+    end
+  end
+  
+  describe "template failures" do
+    it "should not die on nil" do
+      PublicActivity::Activity.template = nil
+      @category = Category.create(:name => "test cat")
+      @category.activities.last.text.should == "Template not defined"
+    end
+    
+    it "should evaluate associations" do
+      note = Note.find(2)
+      note.body = "New Test"
+      note.save
+      note.activities.last.text.should == "Template not defined"
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,34 @@
-Bundler.setup(:default, :test)
-require File.expand_path('lib/public_activity.rb')
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+plugin_test_dir = File.dirname(__FILE__)
 
-Dir[File.expand_path('support/*')].each {|f| require f}
+require 'rubygems'
+require 'bundler/setup'
 
+require 'rspec'
+require 'logger'
+
+require 'active_support'
+require 'active_model'
+require 'active_record'
+require 'action_controller'
+
+require 'public_activity'
+PublicActivity::Activity.template = YAML.load_file(plugin_test_dir + "/support/pba.yml")
+
+ActiveRecord::Base.logger = Logger.new(plugin_test_dir + "/debug.log")
+
+require 'yaml'
+require 'erb'
+ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(plugin_test_dir + "/db/database.yml")).result)
+ActiveRecord::Base.establish_connection(ENV["DB"] || "sqlite3mem")
+ActiveRecord::Migration.verbose = false
+load(File.join(plugin_test_dir, "db", "schema.rb"))
+I18n.load_path += Dir[plugin_test_dir + "/support/en.yml"]
+
+require 'support/models'
+
+require 'rspec/rails'
 RSpec.configure do |config|
-  config.mock_with :rspec
+  config.fixture_path = "#{plugin_test_dir}/fixtures"
+  config.use_transactional_fixtures = true
 end
-

data/spec/support/en.yml

@@ -0,0 +1,6 @@
+en:
+  activity:
+    category:
+      create: 'New category has been created'
+      update: 'Someone modified the category'
+      destroy: 'Someone deleted the category!'

data/spec/support/models.rb

@@ -0,0 +1,14 @@
+class Department < ActiveRecord::Base
+  tracked(:except => [:create])
+  activist
+end
+
+class Category < ActiveRecord::Base
+  tracked(:only =>  [:create, :update, :destroy])
+  validates_presence_of :name
+end
+
+class Note < ActiveRecord::Base
+  tracked(:only =>  [:update])
+  belongs_to :category
+end

data/spec/support/pba.yml

@@ -0,0 +1,9 @@
+activity:
+  category:
+    create: "New <%= trackable.name %> category has been created"
+    update: 'Someone modified the category'
+    destroy: 'Someone deleted the category!'
+  note:
+    create: "New note <%= trackable.body %> has been created"
+    update: 'Someone modified note <%= trackable.body %> with category <%= trackable.category.name %>'
+    destroy: 'Someone deleted the note!'

data/spec/version_spec.rb

@@ -5,7 +5,7 @@ describe PublicActivity, 'VERSION' do
     PublicActivity::VERSION.should_not be_nil
   end
     
-  it 'is frozen' do
-    PublicActivity::VERSION.frozen?.should be(true)
-  end
+  #it 'is frozen' do
+  #  PublicActivity::VERSION.frozen?.should be(true)
+  #end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: public_activity
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,12 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-08 00:00:00.000000000 +02:00
-default_executable: 
+date: 2012-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70011400 !ruby/object:Gem::Requirement
+  requirement: &74294530 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +22,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70011400
+  version_requirements: *74294530
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70011140 !ruby/object:Gem::Requirement
+  requirement: &74293790 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +33,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70011140
+  version_requirements: *74293790
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70010890 !ruby/object:Gem::Requirement
+  requirement: &74287740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +44,21 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70010890
+  version_requirements: *74287740
+- !ruby/object:Gem::Dependency
+  name: pusher
+  requirement: &74287260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *74287260
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70010690 !ruby/object:Gem::Requirement
+  requirement: &74286440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,7 +66,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70010690
+  version_requirements: *74286440
 description: Smooth activity tracking for your ActiveRecord models. Provides Activity
   model with details about actions performed by your users, like adding comments,
   responding etc.
@@ -75,15 +85,24 @@ files:
 - lib/public_activity/creation.rb
 - lib/public_activity/destruction.rb
 - lib/public_activity/tracked.rb
+- lib/public_activity/update.rb
 - lib/public_activity/version.rb
 - Gemfile
 - Rakefile
 - README.md
 - MIT-LICENSE
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/fixtures/categories.yml
+- spec/fixtures/departments.yml
+- spec/fixtures/notes.yml
+- spec/public_activity_spec.rb
 - spec/spec_helper.rb
+- spec/support/en.yml
+- spec/support/models.rb
+- spec/support/pba.yml
 - spec/version_spec.rb
-has_rdoc: true
-homepage: https://github.com/okonski/public_activity
+homepage: https://github.com/pokonski/public_activity
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -103,10 +122,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Smooth activity tracking for ActiveRecord models
 test_files:
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/fixtures/categories.yml
+- spec/fixtures/departments.yml
+- spec/fixtures/notes.yml
+- spec/public_activity_spec.rb
 - spec/spec_helper.rb
+- spec/support/en.yml
+- spec/support/models.rb
+- spec/support/pba.yml
 - spec/version_spec.rb
+has_rdoc: