public_activity 1.1.0 → 1.4.0

data/test/test_tracking.rb

@@ -0,0 +1,378 @@
+require 'test_helper'
+
+describe PublicActivity::Tracked do
+  describe 'defining instance options' do
+    subject { article.new }
+    let :options do
+      { :key => 'key',
+        :params => {:a => 1},
+        :owner => User.create,
+        :recipient => User.create }
+    end
+    before(:each) { subject.activity(options) }
+    let(:activity){ subject.save; subject.activities.last }
+
+    specify { subject.activity_key.must_be_same_as    options[:key] }
+    specify { activity.key.must_equal                 options[:key] }
+
+    specify { subject.activity_owner.must_be_same_as  options[:owner] }
+    specify { activity.owner.must_equal               options[:owner] }
+
+    specify { subject.activity_params.must_be_same_as options[:params] }
+    specify { activity.parameters.must_equal          options[:params] }
+
+    specify { subject.activity_recipient.must_be_same_as options[:recipient] }
+    specify { activity.recipient.must_equal              options[:recipient] }
+  end
+
+  it 'can be tracked and be an activist at the same time' do
+    case PublicActivity.config.orm
+      when :mongoid
+        class ActivistAndTrackedArticle
+          include Mongoid::Document
+          include Mongoid::Timestamps
+          include PublicActivity::Model
+
+          belongs_to :user
+
+          field :name, type: String
+          field :published, type: Boolean
+          tracked
+          activist
+        end
+      when :mongo_mapper
+        class ActivistAndTrackedArticle
+          include MongoMapper::Document
+          include PublicActivity::Model
+
+          belongs_to :user
+
+          key :name, String
+          key :published, Boolean
+          tracked
+          activist
+          timestamps!
+        end
+      when :active_record
+        class ActivistAndTrackedArticle < ActiveRecord::Base
+          self.table_name = 'articles'
+          include PublicActivity::Model
+          tracked
+          activist
+
+          if ::ActiveRecord::VERSION::MAJOR < 4
+            attr_accessible :name, :published, :user
+          end
+          belongs_to :user
+        end
+    end
+
+    art = ActivistAndTrackedArticle.new
+    art.save
+    art.activities.last.trackable_id.must_equal art.id
+    art.activities.last.owner_id.must_equal nil
+  end
+
+  describe 'custom fields' do
+    describe 'global' do
+      it 'should resolve symbols' do
+        a = article(nonstandard: :name).new(name: 'Symbol resolved')
+        a.save
+        a.activities.last.nonstandard.must_equal 'Symbol resolved'
+      end
+
+      it 'should resolve procs' do
+        a = article(nonstandard: proc {|_, model| model.name}).new(name: 'Proc resolved')
+        a.save
+        a.activities.last.nonstandard.must_equal 'Proc resolved'
+      end
+    end
+
+    describe 'instance' do
+      it 'should resolve symbols' do
+        a = article.new(name: 'Symbol resolved')
+        a.activity nonstandard: :name
+        a.save
+        a.activities.last.nonstandard.must_equal 'Symbol resolved'
+      end
+
+      it 'should resolve procs' do
+        a = article.new(name: 'Proc resolved')
+        a.activity nonstandard: proc {|_, model| model.name}
+        a.save
+        a.activities.last.nonstandard.must_equal 'Proc resolved'
+      end
+    end
+  end
+
+  it 'should reset instance options on successful create_activity' do
+    a = article.new
+    a.activity key: 'test', params: {test: 1}
+    a.save
+    a.activities.count.must_equal 1
+    ->{a.create_activity}.must_raise PublicActivity::NoKeyProvided
+    a.activity_params.must_be_empty
+    a.activity key: 'asd'
+    a.create_activity
+    ->{a.create_activity}.must_raise PublicActivity::NoKeyProvided
+  end
+
+  it 'should not accept global key option' do
+    # this example tests the lack of presence of sth that should not be here
+    a = article(key: 'asd').new
+    a.save
+    ->{a.create_activity}.must_raise PublicActivity::NoKeyProvided
+    a.activities.count.must_equal 1
+  end
+
+  it 'should not change global custom fields' do
+    a = article(nonstandard: 'global').new
+    a.activity nonstandard: 'instance'
+    a.save
+    a.class.activity_custom_fields_global.must_equal nonstandard: 'global'
+  end
+
+  describe 'disabling functionality' do
+    it 'allows for global disable' do
+      PublicActivity.enabled = false
+      activity_count_before = PublicActivity::Activity.count
+
+      @article = article().new
+      @article.save
+      PublicActivity::Activity.count.must_equal activity_count_before
+
+      PublicActivity.enabled = true
+    end
+
+    it 'allows for class-wide disable' do
+      activity_count_before = PublicActivity::Activity.count
+
+      klass = article
+      klass.public_activity_off
+      @article = klass.new
+      @article.save
+      PublicActivity::Activity.count.must_equal activity_count_before
+
+      klass.public_activity_on
+      @article.save
+      PublicActivity::Activity.count.must_be :>, activity_count_before
+    end
+  end
+
+  describe '#tracked' do
+    subject { article(options) }
+    let(:options) { {} }
+
+    it 'allows skipping the tracking on CRUD actions' do
+      case PublicActivity.config.orm
+        when :mongoid
+          art = Class.new do
+            include Mongoid::Document
+            include Mongoid::Timestamps
+            include PublicActivity::Model
+
+            belongs_to :user
+
+            field :name, type: String
+            field :published, type: Boolean
+            tracked :skip_defaults => true
+          end
+        when :mongo_mapper
+          art = Class.new do
+            include MongoMapper::Document
+            include PublicActivity::Model
+
+            belongs_to :user
+
+            key :name, String
+            key :published, Boolean
+            tracked :skip_defaults => true
+
+            timestamps!
+          end
+        when :active_record
+          art = article(:skip_defaults => true)
+      end
+
+      art.must_include PublicActivity::Common
+      art.wont_include PublicActivity::Creation
+      art.wont_include PublicActivity::Update
+      art.wont_include PublicActivity::Destruction
+    end
+
+    describe 'default options' do
+      subject { article }
+
+      specify { subject.must_include PublicActivity::Creation }
+      specify { subject.must_include PublicActivity::Destruction }
+      specify { subject.must_include PublicActivity::Update }
+
+      specify { subject._create_callbacks.select do |c|
+        c.kind.eql?(:after) && c.filter == :activity_on_create
+      end.wont_be_empty }
+
+      specify { subject._update_callbacks.select do |c|
+        c.kind.eql?(:after) && c.filter == :activity_on_update
+      end.wont_be_empty }
+
+      specify { subject._destroy_callbacks.select do |c|
+        c.kind.eql?(:before) && c.filter == :activity_on_destroy
+      end.wont_be_empty }
+    end
+
+    it 'accepts :except option' do
+      case PublicActivity.config.orm
+        when :mongoid
+          art = Class.new do
+            include Mongoid::Document
+            include Mongoid::Timestamps
+            include PublicActivity::Model
+
+            belongs_to :user
+
+            field :name, type: String
+            field :published, type: Boolean
+            tracked :except => [:create]
+          end
+        when :mongo_mapper
+          art = Class.new do
+            include MongoMapper::Document
+            include PublicActivity::Model
+
+            belongs_to :user
+
+            key :name, String
+            key :published, Boolean
+            tracked :except => [:create]
+
+            timestamps!
+          end
+        when :active_record
+          art = article(:except => [:create])
+      end
+
+      art.wont_include PublicActivity::Creation
+      art.must_include PublicActivity::Update
+      art.must_include PublicActivity::Destruction
+    end
+
+    it 'accepts :only option' do
+      case PublicActivity.config.orm
+        when :mongoid
+          art = Class.new do
+            include Mongoid::Document
+            include Mongoid::Timestamps
+            include PublicActivity::Model
+
+            belongs_to :user
+
+            field :name, type: String
+            field :published, type: Boolean
+
+            tracked :only => [:create, :update]
+          end
+        when :mongo_mapper
+          art = Class.new do
+            include MongoMapper::Document
+            include PublicActivity::Model
+
+            belongs_to :user
+
+            key :name, String
+            key :published, Boolean
+
+            tracked :only => [:create, :update]
+          end
+        when :active_record
+          art = article({:only => [:create, :update]})
+      end
+
+      art.must_include PublicActivity::Creation
+      art.wont_include PublicActivity::Destruction
+      art.must_include PublicActivity::Update
+    end
+
+    it 'accepts :owner option' do
+      owner = mock('owner')
+      subject.tracked(:owner => owner)
+      subject.activity_owner_global.must_equal owner
+    end
+
+    it 'accepts :params option' do
+      params = {:a => 1}
+      subject.tracked(:params => params)
+      subject.activity_params_global.must_equal params
+    end
+
+    it 'accepts :on option' do
+      on = {:a => lambda{}, :b => proc {}}
+      subject.tracked(:on => on)
+      subject.activity_hooks.must_equal on
+    end
+
+    it 'accepts :on option with string keys' do
+      on = {'a' => lambda {}}
+      subject.tracked(:on => on)
+      subject.activity_hooks.must_equal on.symbolize_keys
+    end
+
+    it 'accepts :on values that are procs' do
+      on = {:unpassable => 1, :proper => lambda {}, :proper_proc => proc {}}
+      subject.tracked(:on => on)
+      subject.activity_hooks.must_include :proper
+      subject.activity_hooks.must_include :proper_proc
+      subject.activity_hooks.wont_include :unpassable
+    end
+
+    describe 'global options' do
+      subject { article(recipient: :test, owner: :test2, params: {a: 'b'}) }
+
+      specify { subject.activity_recipient_global.must_equal :test }
+      specify { subject.activity_owner_global.must_equal :test2    }
+      specify { subject.activity_params_global.must_equal(a: 'b')  }
+    end
+  end
+
+  describe 'activity hooks' do
+    subject { s = article; s.activity_hooks = {:test => hook}; s }
+    let(:hook) { lambda {} }
+
+    it 'retrieves hooks' do
+      assert_same hook, subject.get_hook(:test)
+    end
+
+    it 'retrieves hooks by string keys' do
+      assert_same hook, subject.get_hook('test')
+    end
+
+    it 'returns nil when no matching hook is present' do
+      nil.must_be_same_as subject.get_hook(:nonexistent)
+    end
+
+    it 'allows hooks to decide if activity should be created' do
+      subject.tracked
+      @article = subject.new(:name => 'Some Name')
+      PublicActivity.set_controller(mock('controller'))
+      pf = proc { |model, controller|
+        controller.must_be_same_as PublicActivity.get_controller
+        model.name.must_equal 'Some Name'
+        false
+      }
+      pt = proc { |model, controller|
+        controller.must_be_same_as PublicActivity.get_controller
+        model.name.must_equal 'Other Name'
+        true # this will save the activity with *.update key
+      }
+      @article.class.activity_hooks = {:create => pf, :update => pt, :destroy => pt}
+
+      @article.activities.to_a.must_be_empty
+      @article.save # create
+      @article.name = 'Other Name'
+      @article.save # update
+      @article.destroy # destroy
+
+      @article.activities.count.must_equal 2
+      @article.activities.first.key.must_equal 'article.update'
+    end
+  end
+end

data/test/test_view_helpers.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+describe 'ViewHelpers Rendering' do
+  include PublicActivity::ViewHelpers
+
+  # is this a proper test?
+  it 'provides render_activity helper' do
+    activity = mock('activity')
+    activity.stubs(:is_a?).with(PublicActivity::Activity).returns(true)
+    activity.expects(:render).with(self, {})
+    render_activity(activity)
+  end
+
+  it 'handles multiple activities' do
+    activity = mock('activity')
+    activity.expects(:render).with(self, {})
+    render_activities([activity])
+  end
+
+  it 'flushes content_for between partials renderes' do
+    @view_flow = mock('view_flow')
+    @view_flow.expects(:set).twice.with('name', ActiveSupport::SafeBuffer.new)
+
+    single_content_for('name', 'content')
+    @name.must_equal 'name'
+    @content.must_equal 'content'
+    single_content_for('name', 'content2')
+    @name.must_equal 'name'
+    @content.must_equal 'content2'
+  end
+
+  def content_for(name, content, &block)
+    @name = name
+    @content = content
+  end
+end

data/test/views/layouts/_activity.erb

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

data/test/views/public_activity/_test.erb

@@ -0,0 +1,8 @@
+<% if defined?(two) == 'local-variable' %>
+<% # output local_variable if defined %>
+<%= two %>
+<% else %>
+<strong><%= p[:one] %>, <%= params['two'] %></strong>
+<em><%= a.key %>, <%= activity.id %></em>
+<%= current_user %>
+<% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: public_activity
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Piotrek Okoński
@@ -9,36 +9,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-08 00:00:00.000000000 Z
+date: 2013-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -54,19 +54,103 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Easy activity tracking for your ActiveRecord models. Provides Activity
   model with details about actions performed by your users, like adding comments,
   responding etc.
@@ -98,6 +182,11 @@ files:
 - lib/public_activity/orm/active_record/activity.rb
 - lib/public_activity/orm/active_record/adapter.rb
 - lib/public_activity/orm/active_record/trackable.rb
+- lib/public_activity/orm/mongo_mapper.rb
+- lib/public_activity/orm/mongo_mapper/activist.rb
+- lib/public_activity/orm/mongo_mapper/activity.rb
+- lib/public_activity/orm/mongo_mapper/adapter.rb
+- lib/public_activity/orm/mongo_mapper/trackable.rb
 - lib/public_activity/orm/mongoid.rb
 - lib/public_activity/orm/mongoid/activist.rb
 - lib/public_activity/orm/mongoid/activity.rb
@@ -113,14 +202,26 @@ files:
 - Rakefile
 - README.md
 - MIT-LICENSE
-- UPGRADING
+- test/migrations/001_create_activities.rb
+- test/migrations/002_create_articles.rb
+- test/migrations/003_create_users.rb
+- test/migrations/004_add_nonstandard_to_activities.rb
+- test/mongo_mapper.yml
+- test/mongoid.yml
+- test/test_activist.rb
+- test/test_activity.rb
+- test/test_common.rb
+- test/test_controller_integration.rb
+- test/test_generators.rb
+- test/test_helper.rb
+- test/test_tracking.rb
+- test/test_view_helpers.rb
+- test/views/layouts/_activity.erb
+- test/views/public_activity/_test.erb
 homepage: https://github.com/pokonski/public_activity
 licenses: []
 metadata: {}
-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.\n"
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -136,9 +237,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: Easy activity tracking for ActiveRecord models
-test_files: []
+test_files:
+- test/migrations/001_create_activities.rb
+- test/migrations/002_create_articles.rb
+- test/migrations/003_create_users.rb
+- test/migrations/004_add_nonstandard_to_activities.rb
+- test/mongo_mapper.yml
+- test/mongoid.yml
+- test/test_activist.rb
+- test/test_activity.rb
+- test/test_common.rb
+- test/test_controller_integration.rb
+- test/test_generators.rb
+- test/test_helper.rb
+- test/test_tracking.rb
+- test/test_view_helpers.rb
+- test/views/layouts/_activity.erb
+- test/views/public_activity/_test.erb
 has_rdoc: 

data/UPGRADING

@@ -1,8 +0,0 @@
-##################################################
-#  NOTE FOR UPGRADING FROM PRE-0.4.0 VERSION     #
-##################################################
-
-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.