protocolist 0.8.1.beta → 0.9.0.beta

data/README.md

@@ -1,4 +1,4 @@
-#Protocolist [![Build Status](https://secure.travis-ci.org/welldan97/protocolist.png?branch=master)](http://travis-ci.org/welldan97/protocolist)
+#Protocolist [![Build Status](https://secure.travis-ci.org/welldan97/protocolist.png?branch=master)](http://travis-ci.org/welldan97/protocolist) [![Dependency Status](https://gemnasium.com/welldan97/protocolist.png)](https://gemnasium.com/welldan97/protocolist)
 
 Simple activity feeds solution for Rails applications. Gives a flexible way to build activity feeds infrastructure over it.
 
@@ -26,12 +26,12 @@ rake db:migrate
 Getting started
 ---------------
 
-Activity model has four attributes: subject("who did it"), activity_type("what
-they did"), object("what they did it to") and data(additional information). Subject will be
+Activity model has four attributes: actor("who did it"), activity_type("what
+they did"), target("what they did it to") and data(additional information). Subject will be
 set as current user by default.
 
 Protocolist expects you to have `current_user` method in a
-controller. See [[Changing Defaults]] to change this behavior.
+controller. See [Changing Defaults](https://github.com/welldan97/protocolist/wiki/Changing-Defaults) to change this behavior.
 
 If creation isn't possible it will silently skip it.
 
@@ -45,8 +45,8 @@ fires :create
 ```
 
 When "create" event will be triggered,  it will automatically create
-Activity with current user set as subject, `:create` as type,
-`self` as object and empty data.
+Activity with current user set as actor, `:create` as type,
+`self` as target and empty data.
 
 The more convenient usage:
 
@@ -72,11 +72,11 @@ The most flexible way is to use `fire` method:
 ```ruby
 def destroy_projects
     self.projects.destroy_all
-    fire :destroy_all, :object => false, :data => {:company_id => company_id}
+    fire :destroy_all, :target => false, :data => {:company_id => company_id}
 end
 ```
 
-If you run without `:object` option set, it will default to `self`.
+If you run without `:target` option set, it will default to `self`.
 
 Usage in controllers
 --------------------
@@ -98,7 +98,7 @@ fires :download, :only => [:download_report, :download_file, :download_map],
 ```
 
 The `fire` method can be used same way as in models, but also if type is not
-set, it will be set as `action_name`, and object will try to store `@model_instance`.
+set, it will be set as `action_name`, and target will try to store `@model_instance`.
 
 ```ruby
 def show
@@ -111,7 +111,7 @@ is the same as
 ```ruby
 def show
     @article = Article.find(params[:id])
-    fire :show, :object => @article
+    fire :show, :target => @article
 end
 ```
 

data/lib/generators/protocolist/install/USAGE

@@ -1 +1 @@
-Generates both the Activity class and the migration to create its table. The table will have subject, object, type and data columns.
+Generates both the Activity class and the migration to create its table. The table will have actor, target, type and data columns.

data/lib/generators/protocolist/install/install_generator.rb

@@ -11,9 +11,9 @@ module Protocolist
         migration_template "migration.rb", "db/migrate/create_activities"
         invoke "active_record:model", ['Activity'], :migration => false
         model_content = <<CONTENT
-  attr_accessible :activity_type, :object, :subject, :data
-  belongs_to :object, :polymorphic => true
-  belongs_to :subject, :polymorphic => true
+  attr_accessible :activity_type, :target, :actor, :data
+  belongs_to :target, :polymorphic => true
+  belongs_to :actor, :polymorphic => true
   serialize :data
 CONTENT
         inject_into_class('app/models/activity.rb', 'Activity', model_content) if File.exists?(File.join(destination_root, 'app/models/activity.rb'))

data/lib/generators/protocolist/install/templates/migration.rb

@@ -1,14 +1,14 @@
 class CreateActivities < ActiveRecord::Migration
   def change
     create_table :activities do |t|
-      t.references :subject, :polymorphic => true
-      t.references :object, :polymorphic => true
+      t.references :actor, :polymorphic => true
+      t.references :target, :polymorphic => true
       t.string :activity_type
       t.text :data
 
       t.timestamps
     end
-    add_index :activities, :subject_id
-    add_index :activities, :object_id
+    add_index :activities, :actor_id
+    add_index :activities, :target_id
   end
 end

data/lib/protocolist.rb

@@ -7,16 +7,16 @@ require "protocolist/railtie" if defined? Rails
 module Protocolist
 
   def self.fire activity_type, options={}
-    options = {:subject => @subject, :activity_type => activity_type}.merge options
-    @activity_class.create options if options[:subject] && @activity_class
+    options = {:actor => @actor, :activity_type => activity_type}.merge options
+    @activity_class.create options if options[:actor] && @activity_class
   end
 
-  def self.subject
-    @subject
+  def self.actor
+    @actor
   end
 
-  def self.subject= subject
-    @subject = subject
+  def self.actor= actor
+    @actor = actor
   end
 
   def self.activity_class

data/lib/protocolist/controller_additions.rb

@@ -35,15 +35,15 @@ module Protocolist
     end
 
     def fire activity_type=nil, options={}
-      options[:object] =  instance_variable_get("@#{self.controller_name.singularize}") if options[:object] == nil
-      options[:object] = nil if options[:object] == false
+      options[:target] =  instance_variable_get("@#{self.controller_name.singularize}") if options[:target] == nil
+      options[:target] = nil if options[:target] == false
       activity_type ||= action_name.to_sym
 
       Protocolist.fire activity_type, options
     end
 
     def initilize_protocolist
-      Protocolist.subject = current_user
+      Protocolist.actor = current_user
       Protocolist.activity_class = Activity
     end
   end

data/lib/protocolist/model_additions.rb

@@ -32,8 +32,8 @@ module Protocolist
     end
 
     def fire activity_type, options={}
-      options[:object] = self if options[:object] == nil
-      options[:object] = nil if options[:object] == false
+      options[:target] = self if options[:target] == nil
+      options[:target] = nil if options[:target] == false
 
       Protocolist.fire activity_type, options
     end

data/lib/protocolist/version.rb

@@ -1,3 +1,3 @@
 module Protocolist
-  VERSION = "0.8.1.beta"
+  VERSION = "0.9.0.beta"
 end

data/protocolist.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '~> 2.8.0'
-  s.add_development_dependency 'guard-rspec', '~> 0.6.0'
+  s.add_development_dependency 'rspec', '~> 2.9.0'
+  s.add_development_dependency 'guard-rspec', '~> 0.7.0'
   s.add_development_dependency 'supermodel'
   s.add_development_dependency 'railties', '~> 3.0'
 end

data/spec/protocolist/controller_additions_spec.rb

@@ -15,7 +15,7 @@ class FirestartersController
 
   include Protocolist::ControllerAdditions
   def explicit_use
-    fire :gogogo, :object => User.new(:name => 'Lisa'), :data => '<3 <3 <3'
+    fire :gogogo, :target => User.new(:name => 'Lisa'), :data => '<3 <3 <3'
   end
 
   def implicit_use
@@ -39,21 +39,21 @@ describe Protocolist::ControllerAdditions do
   end
 
   describe 'direct fire method call' do
-    it 'saves record with object and data when called explicitly' do
+    it 'saves record with target and data when called explicitly' do
       @controller.explicit_use
 
-      Activity.last.subject.name.should == 'Bill'
+      Activity.last.actor.name.should == 'Bill'
       Activity.last.activity_type.should == :gogogo
-      Activity.last.object.name.should == 'Lisa'
+      Activity.last.target.name.should == 'Lisa'
       Activity.last.data.should == '<3 <3 <3'
     end
 
-    it 'saves record with object and data when called implicitly' do
+    it 'saves record with target and data when called implicitly' do
       @controller.implicit_use
 
-      Activity.last.subject.name.should == 'Bill'
+      Activity.last.actor.name.should == 'Bill'
       Activity.last.activity_type.should == :quick_and_dirty_action_stub
-      Activity.last.object.name.should == 'Marge'
+      Activity.last.target.name.should == 'Marge'
     end
   end
 
@@ -65,9 +65,9 @@ describe Protocolist::ControllerAdditions do
         expect {
           callback_proc.call(@controller)
         }.to change{Activity.count}.by 1
-        Activity.last.subject.name.should == 'Bill'
+        Activity.last.actor.name.should == 'Bill'
         Activity.last.activity_type.should == :download
-        Activity.last.object.should_not be
+        Activity.last.target.should_not be
       end
       FirestartersController.send(:fires, :download)
     end
@@ -81,10 +81,10 @@ describe Protocolist::ControllerAdditions do
           callback_proc.call(@controller)
         }.to change{Activity.count}.by 1
 
-        Activity.last.subject.name.should == 'Bill'
+        Activity.last.actor.name.should == 'Bill'
         Activity.last.activity_type.should == :download
         Activity.last.data.should == 'les params'
-        Activity.last.object.should_not be
+        Activity.last.target.should_not be
       end
 
       FirestartersController.send(:fires, :download,

data/spec/protocolist/model_additions_spec.rb

@@ -12,7 +12,7 @@ class Firestarter < SuperModel::Base
   include Protocolist::ModelAdditions
 
   def delete
-    fire :delete, :object => false
+    fire :delete, :target => false
   end
 
   def myself
@@ -21,7 +21,7 @@ class Firestarter < SuperModel::Base
 
   def love_letter_for_mary
     user = User.create(:name => 'Mary')
-    fire :love_letter, :object => user, :data => '<3 <3 <3'
+    fire :love_letter, :target => user, :data => '<3 <3 <3'
   end
 end
 
@@ -49,7 +49,7 @@ end
 class ComplexFirestarter < SuperModel::Base
   include Protocolist::ModelAdditions
 
-  fires :yohoho, :on =>[:create, :destroy], :object => false, :data => :hi
+  fires :yohoho, :on =>[:create, :destroy], :target => false, :data => :hi
 
   def hi
     'Hi!'
@@ -59,8 +59,8 @@ end
 describe Protocolist::ModelAdditions do
   before :each do
     Activity.destroy_all
-    @subject = User.new(:name => 'Bill')
-    Protocolist.subject = @subject
+    @actor = User.new(:name => 'Bill')
+    Protocolist.actor = @actor
     Protocolist.activity_class = Activity
   end
 
@@ -69,32 +69,32 @@ describe Protocolist::ModelAdditions do
       @firestarter = Firestarter.new
     end
 
-    it 'saves record with object and data' do
+    it 'saves record with target and data' do
       expect {
         @firestarter.love_letter_for_mary
       }.to change{Activity.count}.by 1
-      Activity.last.subject.name.should == 'Bill'
+      Activity.last.actor.name.should == 'Bill'
       Activity.last.activity_type.should == :love_letter
-      Activity.last.object.name.should == 'Mary'
+      Activity.last.target.name.should == 'Mary'
       Activity.last.data.should == '<3 <3 <3'
     end
 
-    it 'saves record with self as object if object is not set' do
+    it 'saves record with self as target if target is not set' do
       expect {
         @firestarter.myself
       }.to change{Activity.count}.by 1
-      Activity.last.subject.name.should == 'Bill'
+      Activity.last.actor.name.should == 'Bill'
       Activity.last.activity_type.should == :myself
-      Activity.last.object.should == @firestarter
+      Activity.last.target.should == @firestarter
     end
 
-    it 'saves record without object if object set to false' do
+    it 'saves record without target if target set to false' do
       expect {
         @firestarter.delete
       }.to change{Activity.count}.by 1
-      Activity.last.subject.name.should == 'Bill'
+      Activity.last.actor.name.should == 'Bill'
       Activity.last.activity_type.should == :delete
-      Activity.last.object.should be_false
+      Activity.last.target.should be_false
     end
   end
 
@@ -103,9 +103,9 @@ describe Protocolist::ModelAdditions do
       expect {
         SimpleFirestarter.create(:name => 'Ted')
       }.to change{Activity.count}.by 1
-      Activity.last.subject.name.should == 'Bill'
+      Activity.last.actor.name.should == 'Bill'
       Activity.last.activity_type.should == :create
-      Activity.last.object.name.should == 'Ted'
+      Activity.last.target.name.should == 'Ted'
     end
 
     it 'saves record when called with complex options' do
@@ -115,9 +115,9 @@ describe Protocolist::ModelAdditions do
       expect {
           ComplexFirestarter.create(:name => 'Ted')
       }.to change{Activity.count}.by 1
-      Activity.last.subject.name.should == 'Bill'
+      Activity.last.actor.name.should == 'Bill'
       Activity.last.activity_type.should == :yohoho
-      Activity.last.object.should_not be
+      Activity.last.target.should_not be
       Activity.last.data.should == 'Hi!'
 
       #then destroy record
@@ -125,9 +125,9 @@ describe Protocolist::ModelAdditions do
       expect {
         ComplexFirestarter.last.destroy
       }.to change{Activity.count}.by 1
-      Activity.last.subject.name.should == 'Bill'
+      Activity.last.actor.name.should == 'Bill'
       Activity.last.activity_type.should == :yohoho
-      Activity.last.object.should_not be
+      Activity.last.target.should_not be
       Activity.last.data.should == 'Hi!'
     end
 

data/spec/protocolist_spec.rb

@@ -11,13 +11,13 @@ end
 describe Protocolist do
   before :each do
     Activity.destroy_all
-    @subject = User.new(:name => 'Bill')
-    Protocolist.subject = @subject
+    @actor = User.new(:name => 'Bill')
+    Protocolist.actor = @actor
     Protocolist.activity_class = Activity
   end
 
-  it 'should silently skip saving if subject is falsy' do
-    Protocolist.subject = nil
+  it 'should silently skip saving if actor is falsy' do
+    Protocolist.actor = nil
     expect {Protocolist.fire :alarm}.not_to change{Activity.count}
     expect {Protocolist.fire :alarm}.not_to raise_error
   end
@@ -31,24 +31,24 @@ describe Protocolist do
   it 'should save a simple record' do
     expect {Protocolist.fire :alarm}.to change{Activity.count}.by 1
 
-    Activity.last.subject.should == @subject
+    Activity.last.actor.should == @actor
     Activity.last.activity_type.should == :alarm
   end
 
   it 'should save a complex record' do
-    another_subject = User.new(:name => 'Bob')
-    object = User.new(:name => 'Mary')
+    another_actor = User.new(:name => 'Bob')
+    target = User.new(:name => 'Mary')
 
     expect {
       Protocolist.fire :alarm,
-      :subject => another_subject,
-      :object => object,
+      :actor => another_actor,
+      :target => target,
       :data => {:some_attr => :some_data}
     }.to change{Activity.count}.by 1
 
-    Activity.last.subject.name.should == 'Bob'
+    Activity.last.actor.name.should == 'Bob'
     Activity.last.activity_type.should == :alarm
-    Activity.last.object.name.should == 'Mary'
+    Activity.last.target.name.should == 'Mary'
     Activity.last.data[:some_attr].should == :some_data
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocolist
 version: !ruby/object:Gem::Version
-  version: 0.8.1.beta
+  version: 0.9.0.beta
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-30 00:00:00.000000000 Z
+date: 2012-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &81805600 !ruby/object:Gem::Requirement
+  requirement: &75671410 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,32 +21,32 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *81805600
+  version_requirements: *75671410
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &81805300 !ruby/object:Gem::Requirement
+  requirement: &75671120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *81805300
+  version_requirements: *75671120
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &81804800 !ruby/object:Gem::Requirement
+  requirement: &75670800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *81804800
+  version_requirements: *75670800
 - !ruby/object:Gem::Dependency
   name: supermodel
-  requirement: &81804580 !ruby/object:Gem::Requirement
+  requirement: &75670540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *81804580
+  version_requirements: *75670540
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &81804260 !ruby/object:Gem::Requirement
+  requirement: &75670090 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *81804260
+  version_requirements: *75670090
 description: ! 'Simple activity feeds solution for Rails applications. Gives a flexible
   way to build activity feeds infrastructure over it. '
 email: