protocolist 0.8.0.beta

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+dummy

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem 'pry'
+# Specify your gem's dependencies in protocolist.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+require 'guard/guard'
+
+guard :rspec, :all_on_start => false, :all_after_pass => false, :cli => '--fail-fast --format doc' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})                { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')             { "spec" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Dmitry Yakimov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,134 @@
+Protocolist
+===========
+
+Simple activity feeds solution for Rails applications. Gives a flexible way to build activity feeds infrastructure over it.
+
+Installation
+------------
+
+Add the gem to your Gemfile and run the `bundle install` command to install it.
+
+```ruby
+gem 'protocolist'
+```
+
+Run the generator to create Activity model and migration.
+
+```ruby
+rails generate protocolist:install
+```
+
+Run migration then:
+
+```ruby
+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
+set as current user by default.
+
+Protocolist expects you to have `current_user` method in a controller.
+̶S̶e̶e̶ ̶C̶h̶a̶n̶g̶i̶n̶g̶ ̶D̶e̶f̶a̶u̶l̶t̶s̶ ̶t̶o̶ ̶c̶h̶a̶n̶g̶e̶ ̶t̶h̶i̶s̶ ̶b̶e̶h̶a̶v̶i̶o̶r̶.̶
+
+Usage in models
+---------------
+
+The simplest way is just to write inside your model:
+
+```ruby
+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.
+
+The more convenient usage:
+
+```ruby
+fires :edit, :on => :update,
+             :data => :changes,
+             :if => 'changes.any?'
+```
+
+The event type will be `edit`. A proc, symbol a̶n̶d̶ ̶a̶ ̶s̶t̶r̶i̶n̶g̶ for data
+option represent a method, else types will be stored as is.
+
+The `unless` option also can be passed.
+
+The `on` option can be an array:
+
+```ruby
+fires :comment_activity, :on => [:create, :update, :destroy]
+```
+
+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}
+end
+```
+
+If you run without `:object` option set, it will default to `self`.
+
+Usage in controllers
+--------------------
+
+The simple one:
+
+```ruby
+fires :download
+```
+
+which will strike after download action.
+
+The customized one:
+
+```ruby
+fires :download, :only => [:download_report, :download_file, :download_map],
+                 :data => lambda{|c| c.params[:city] },
+                 :if => lambda{|c| c.response.status == 200 }
+```
+
+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`.
+
+```ruby
+def show
+    @article = Article.find(params[:id])
+    fire
+end
+```
+is the same as
+
+```ruby
+def show
+    @article = Article.find(params[:id])
+    fire :show, :object => @article
+end
+```
+
+Contributing
+------------
+I would appreciate any help with gem development: pull requests, issue
+posts, etc.
+
+
+Also there is probably a bunch of mistakes in English grammar/spelling. Any
+corrections are also appreciated, especially from native speakers.
+
+Thanks
+--------------
+Protocolist was inspired by
+[timeline_fu](https://github.com/jamesgolick/timeline_fu).  I used it,
+but its functionality wasn't enough for me, so I made my own with
+blackjack and stewardesses.
+
+
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/generators/protocolist/install/USAGE

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

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

@@ -0,0 +1,29 @@
+require 'rails/generators/active_record'
+
+module Protocolist
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def generate_activity_model
+        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
+  serialize :data
+CONTENT
+        inject_into_class('app/models/activity.rb', 'Activity', model_content) if File.exists?(File.join(destination_root, 'app/models/activity.rb'))
+
+
+      end
+
+      def self.next_migration_number(dirname) #:nodoc:
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+    end
+  end
+end

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

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

data/lib/protocolist.rb

@@ -0,0 +1,29 @@
+require "protocolist/version"
+require "protocolist/model_additions"
+require "protocolist/controller_additions"
+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
+  end
+
+  def self.subject
+    @@subject
+  end
+
+  def self.subject= subject
+    @@subject = subject
+  end
+
+  def self.activity_class
+    @@activity_class
+  end
+
+  def self.activity_class= activity_class
+    @@activity_class = activity_class
+  end
+end

data/lib/protocolist/controller_additions.rb

@@ -0,0 +1,50 @@
+module Protocolist
+  module ControllerAdditions
+    module ClassMethods
+      def fires activity_type, options={}
+        #options normalization
+        options[:only] ||= activity_type unless options[:except]
+
+        data_proc = if options[:data].respond_to?(:call)
+                      lambda{|controller| options[:data].call(controller)}
+                    elsif options[:data].class == Symbol
+                      lambda{|controller| controller.send(options[:data]) }
+                    else
+                      lambda{|record| options[:data] }
+                    end
+
+        options_for_callback = options.select{|k,v| [:if, :unless, :only, :except].include? k }
+
+        options_for_fire = options.reject{|k,v| [:if, :unless, :only, :except].include? k }
+
+        callback_proc = lambda{|controller|
+          controller.fire activity_type, options_for_fire.merge({:data => data_proc.call(controller)})
+        }
+
+        send(:after_filter, callback_proc, options_for_callback)
+      end
+
+
+      def self.extended base
+        base.send(:before_filter, :initilize_protocolist)
+      end
+    end
+
+    def self.included base
+      base.extend ClassMethods
+    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
+      activity_type ||= action_name.to_sym
+
+      Protocolist.fire activity_type, options
+    end
+
+    def initilize_protocolist
+      Protocolist.subject = current_user
+      Protocolist.activity_class = Activity
+    end
+  end
+end

data/lib/protocolist/model_additions.rb

@@ -0,0 +1,41 @@
+module Protocolist
+  module ModelAdditions
+    module ClassMethods
+      def fires activity_type, options={}
+        #options normalization
+        fires_on = Array(options[:on] || activity_type)
+
+        data_proc = if options[:data].respond_to?(:call)
+                      lambda{|record| options[:data].call(record)}
+                    elsif options[:data].class == Symbol
+                      lambda{|record| record.send(options[:data]) }
+                    else
+                      lambda{|record| options[:data] }
+                    end
+
+        options_for_callback = options.select{|k,v| [:if, :unless].include? k }
+
+        options_for_fire = options.reject{|k,v| [:if, :unless, :on].include? k }
+
+        callback_proc = lambda{|record|
+          record.fire activity_type, options_for_fire.merge({:data => data_proc.call(record)})
+        }
+
+        fires_on.each do |on|
+          send("after_#{on.to_s}".to_sym, callback_proc, options_for_callback)
+        end
+      end
+    end
+
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    def fire activity_type, options={}
+      options[:object] = self if options[:object] == nil
+      options[:object] = nil if options[:object] == false
+
+      Protocolist.fire activity_type, options
+    end
+  end
+end

data/lib/protocolist/railtie.rb

@@ -0,0 +1,14 @@
+module Protocolist
+  class Railtie < Rails::Railtie
+    initializer 'protocolist.model_additions' do
+      ActiveSupport.on_load :active_record do
+        include ModelAdditions
+      end
+    end
+    initializer 'protocolist.controller_additions' do
+      ActiveSupport.on_load :action_controller do
+        include ControllerAdditions
+      end
+    end
+  end
+end

data/lib/protocolist/version.rb

@@ -0,0 +1,3 @@
+module Protocolist
+  VERSION = "0.8.0.beta"
+end

data/protocolist.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "protocolist/version"
+
+Gem::Specification.new do |s|
+  s.name        = "protocolist"
+  s.version     = Protocolist::VERSION
+  s.authors     = ["Dmitry Yakimov"]
+  s.email       = ["welldan97@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Activity feeds solution for Rails.}
+  s.description = %q{Simple activity feeds solution for Rails applications. Gives a flexible way to build activity feeds infrastructure over it. }
+
+  s.rubyforge_project = "protocolist"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec', '~> 2.8.0'
+  s.add_development_dependency 'guard-rspec', '~> 0.6.0'
+  s.add_development_dependency 'supermodel'
+  s.add_development_dependency 'railties', '~> 3.0'
+end

data/spec/protocolist/controller_additions_spec.rb

@@ -0,0 +1,96 @@
+require "spec_helper"
+
+class User < SuperModel::Base
+
+end
+
+class Activity < SuperModel::Base
+
+end
+
+class FirestartersController
+  #stub before filter
+  def self.before_filter *args
+  end
+
+  include Protocolist::ControllerAdditions
+  def explicit_use
+    fire :gogogo, :object => User.new(:name => 'Lisa'), :data => '<3 <3 <3'
+  end
+
+  def implicit_use
+    @firestarter = User.new(:name => 'Marge')
+    fire
+  end
+end
+
+describe Protocolist::ControllerAdditions do
+  before :each do
+    Activity.destroy_all
+    user = User.new(:name => 'Bill')
+    @controller = FirestartersController.new
+
+    @controller.stub(:current_user){user}
+    @controller.stub(:controller_name){'firestarters'}
+    @controller.stub(:action_name){'quick_and_dirty_action_stub'}
+    @controller.stub(:params){'les params'}
+
+    @controller.initilize_protocolist
+  end
+
+  describe 'direct fire method call' do
+    it 'saves record with object and data when called explicitly' do
+      @controller.explicit_use
+
+      Activity.last.subject.name.should == 'Bill'
+      Activity.last.activity_type.should == :gogogo
+      Activity.last.object.name.should == 'Lisa'
+      Activity.last.data.should == '<3 <3 <3'
+    end
+
+    it 'saves record with object and data when called implicitly' do
+      @controller.implicit_use
+
+      Activity.last.subject.name.should == 'Bill'
+      Activity.last.activity_type.should == :quick_and_dirty_action_stub
+      Activity.last.object.name.should == 'Marge'
+    end
+  end
+
+  describe 'fires callback' do
+    it 'saves record when called with minimal options' do
+      FirestartersController.should_receive(:after_filter) do |callback_proc, options|
+        options[:only].should == :download
+
+        expect {
+          callback_proc.call(@controller)
+        }.to change{Activity.count}.by 1
+        Activity.last.subject.name.should == 'Bill'
+        Activity.last.activity_type.should == :download
+        Activity.last.object.should_not be
+      end
+      FirestartersController.send(:fires, :download)
+    end
+
+    it 'saves record when called with complex options' do
+      FirestartersController.should_receive(:after_filter) do |callback_proc, options|
+        options[:only].should == [:download_report, :download_file, :download_map]
+        options[:if].should == 'if condition'
+
+        expect {
+          callback_proc.call(@controller)
+        }.to change{Activity.count}.by 1
+
+        Activity.last.subject.name.should == 'Bill'
+        Activity.last.activity_type.should == :download
+        Activity.last.data.should == 'les params'
+        Activity.last.object.should_not be
+      end
+
+      FirestartersController.send(:fires, :download,
+                                  :only => [:download_report, :download_file, :download_map],
+                                  :data => lambda{|c| c.params },
+                                  :if => 'if condition')
+    end
+  end
+end

data/spec/protocolist/model_additions_spec.rb

@@ -0,0 +1,143 @@
+require "spec_helper"
+
+class User < SuperModel::Base
+
+end
+
+class Activity < SuperModel::Base
+
+end
+
+class Firestarter < SuperModel::Base
+  include Protocolist::ModelAdditions
+
+  def delete
+    fire :delete, :object => false
+  end
+
+  def myself
+    fire :myself
+  end
+
+  def love_letter_for_mary
+    user = User.create(:name => 'Mary')
+    fire :love_letter, :object => user, :data => '<3 <3 <3'
+  end
+end
+
+class SimpleFirestarter < SuperModel::Base
+  include Protocolist::ModelAdditions
+
+  fires :create
+end
+
+class ConditionalFirestarter < SuperModel::Base
+  include Protocolist::ModelAdditions
+
+  fires :i_will_be_saved, :on => :create, :if => :return_true_please
+  fires :and_i_won_t, :on => :create, :if => :return_false_please
+
+  def return_false_please
+    false
+  end
+
+  def return_true_please
+    true
+  end
+end
+
+class ComplexFirestarter < SuperModel::Base
+  include Protocolist::ModelAdditions
+
+  fires :yohoho, :on =>[:create, :destroy], :object => false, :data => :hi
+
+  def hi
+    'Hi!'
+  end
+end
+
+describe Protocolist::ModelAdditions do
+  before :each do
+    Activity.destroy_all
+    @subject = User.new(:name => 'Bill')
+    Protocolist.subject = @subject
+    Protocolist.activity_class = Activity
+  end
+
+  describe 'direct fire method call' do
+    before :each do
+      @firestarter = Firestarter.new
+    end
+
+    it 'saves record with object and data' do
+      expect {
+        @firestarter.love_letter_for_mary
+      }.to change{Activity.count}.by 1
+      Activity.last.subject.name.should == 'Bill'
+      Activity.last.activity_type.should == :love_letter
+      Activity.last.object.name.should == 'Mary'
+      Activity.last.data.should == '<3 <3 <3'
+    end
+
+    it 'saves record with self as object if object is not set' do
+      expect {
+        @firestarter.myself
+      }.to change{Activity.count}.by 1
+      Activity.last.subject.name.should == 'Bill'
+      Activity.last.activity_type.should == :myself
+      Activity.last.object.should == @firestarter
+    end
+
+    it 'saves record without object if object set to false' do
+      expect {
+        @firestarter.delete
+      }.to change{Activity.count}.by 1
+      Activity.last.subject.name.should == 'Bill'
+      Activity.last.activity_type.should == :delete
+      Activity.last.object.should be_false
+    end
+  end
+
+  describe 'fires callback' do
+    it 'saves record when called with minimal options' do
+      expect {
+        SimpleFirestarter.create(:name => 'Ted')
+      }.to change{Activity.count}.by 1
+      Activity.last.subject.name.should == 'Bill'
+      Activity.last.activity_type.should == :create
+      Activity.last.object.name.should == 'Ted'
+    end
+
+    it 'saves record when called with complex options' do
+
+      #first create record
+
+      expect {
+          ComplexFirestarter.create(:name => 'Ted')
+      }.to change{Activity.count}.by 1
+      Activity.last.subject.name.should == 'Bill'
+      Activity.last.activity_type.should == :yohoho
+      Activity.last.object.should_not be
+      Activity.last.data.should == 'Hi!'
+
+      #then destroy record
+
+      expect {
+        ComplexFirestarter.last.destroy
+      }.to change{Activity.count}.by 1
+      Activity.last.subject.name.should == 'Bill'
+      Activity.last.activity_type.should == :yohoho
+      Activity.last.object.should_not be
+      Activity.last.data.should == 'Hi!'
+    end
+
+    it 'saves checks conditions' do
+      expect {
+        ConditionalFirestarter.create(:name => 'Ted')
+      }.to change{Activity.count}.by 1
+      Activity.last.activity_type.should == :i_will_be_saved
+    end
+  end
+
+
+end

data/spec/protocolist_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+class User < SuperModel::Base
+
+end
+
+class Activity < SuperModel::Base
+
+end
+
+describe Protocolist do
+  before :each do
+    Activity.destroy_all
+    @subject = User.new(:name => 'Bill')
+    Protocolist.subject = @subject
+    Protocolist.activity_class = Activity
+  end
+
+  it 'should silently skip saving if subject is falsy' do
+    Protocolist.subject = nil
+    expect {Protocolist.fire :alarm}.not_to change{Activity.count}
+    expect {Protocolist.fire :alarm}.not_to raise_error
+  end
+
+  it 'should silently skip saving if activity_class is falsy' do
+    Protocolist.activity_class = nil
+    expect {Protocolist.fire :alarm}.not_to change{Activity.count}
+    expect {Protocolist.fire :alarm}.not_to raise_error
+  end
+
+  it 'should save a simple record' do
+    expect {Protocolist.fire :alarm}.to change{Activity.count}.by 1
+
+    Activity.last.subject.should == @subject
+    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')
+
+    expect {
+      Protocolist.fire :alarm,
+      :subject => another_subject,
+      :object => object,
+      :data => {:some_attr => :some_data}
+    }.to change{Activity.count}.by 1
+
+    Activity.last.subject.name.should == 'Bob'
+    Activity.last.activity_type.should == :alarm
+    Activity.last.object.name.should == 'Mary'
+    Activity.last.data[:some_attr].should == :some_data
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'protocolist'
+require 'supermodel'
+Bundler.require(:default)
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: protocolist
+version: !ruby/object:Gem::Version
+  version: 0.8.0.beta
+  prerelease: 6
+platform: ruby
+authors:
+- Dmitry Yakimov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &87740840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *87740840
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &87740470 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *87740470
+- !ruby/object:Gem::Dependency
+  name: supermodel
+  requirement: &87740210 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *87740210
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &87739830 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *87739830
+description: ! 'Simple activity feeds solution for Rails applications. Gives a flexible
+  way to build activity feeds infrastructure over it. '
+email:
+- welldan97@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/protocolist/install/USAGE
+- lib/generators/protocolist/install/install_generator.rb
+- lib/generators/protocolist/install/templates/migration.rb
+- lib/protocolist.rb
+- lib/protocolist/controller_additions.rb
+- lib/protocolist/model_additions.rb
+- lib/protocolist/railtie.rb
+- lib/protocolist/version.rb
+- protocolist.gemspec
+- spec/protocolist/controller_additions_spec.rb
+- spec/protocolist/model_additions_spec.rb
+- spec/protocolist_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: protocolist
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Activity feeds solution for Rails.
+test_files: []