public_activity 0.1

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+gemspec
+
+gem 'rails'
+gem 'yard'
+gem 'i18n'
+
+group :development, :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,85 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.5)
+      actionpack (= 3.0.5)
+      mail (~> 2.2.15)
+    actionpack (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mocha (0.9.12)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.5)
+      actionmailer (= 3.0.5)
+      actionpack (= 3.0.5)
+      activerecord (= 3.0.5)
+      activeresource (= 3.0.5)
+      activesupport (= 3.0.5)
+      bundler (~> 1.0)
+      railties (= 3.0.5)
+    railties (3.0.5)
+      actionpack (= 3.0.5)
+      activesupport (= 3.0.5)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+    yard (0.6.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha
+  rails
+  rspec
+  yard

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [name of plugin creator]
+
+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,44 @@
+# PublicActivity
+
+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.
+
+
+## Installation
+
+You can install this gem as you would any other gem:
+    gem install public_activity
+or in your Gemfile:
+    gem 'public_activity'
+
+## 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 activites 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:
+          create: 'Article has been created'
+          update: 'Someone has edited the article'
+
+This is only a basic example, refer to documentation for more options and customization!
+
+## License
+Copyright (c) 2011 Piotrek Okoński, released under the MIT license

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake'
+require 'yard'
+require 'yard/rake/yardoc_task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "./spec/*_spec.rb"
+end
+
+desc 'Generate documentation for the public_activity plugin.'
+YARD::Rake::YardocTask.new do |doc|
+  doc.files = ['lib/**/*.rb']
+end

data/lib/generators/public_activity.rb

@@ -0,0 +1,11 @@
+require 'rails/generators/named_base'
+
+module PublicActivity
+  module Generators
+    module Base
+      def source_root
+        @_public_activity_source_root ||= File.expand_path(File.join('../public_activity', generator_name, 'templates'), __FILE__)
+      end
+    end
+  end
+end

data/lib/generators/public_activity/migration/migration_generator.rb

@@ -0,0 +1,16 @@
+require 'generators/public_activity'
+require 'rails/generators/active_record'
+
+module PublicActivity
+  module Generators
+    class MigrationGenerator < ActiveRecord::Generators::Base
+      extend Base
+
+      argument :name, :type => :string, :default => 'create_activities'
+
+      def generate_files
+        migration_template 'migration.rb', "db/migrate/#{name}"
+      end
+    end
+  end
+end

data/lib/generators/public_activity/migration/templates/migration.rb

@@ -0,0 +1,16 @@
+class CreateActivities < ActiveRecord::Migration
+  def self.up
+    create_table :activities do |t|
+      t.belongs_to :trackable, :polymorphic => true
+      t.belongs_to :owner, :polymorphic => true
+      t.string  :key
+      t.text    :parameters
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :activities
+  end
+end

data/lib/public_activity.rb

@@ -0,0 +1,101 @@
+require 'rails'
+require 'active_support/dependencies'
+require 'active_record'
+# +public_activity+ keeps track of changes made to models
+# and allows for easy displaying of them.
+#
+# Basic usage requires adding one line to your models:
+#
+#   class Article < ActiveRecord::Base
+#     tracked
+#   end
+# 
+# And creating a table for activities, by doing this:
+#   rails generate public_activity:migration
+#   rake db:migrate
+#
+# Now when saved, public_activity will create 
+# an Activity record containing information about that changed/created
+# model.
+# == Displaying Activities:
+#
+# Minimal example would be:
+#
+#   <% for activity in PublicActivity::Activity.all %>
+#   <%= activity.text %><br/>
+#   <% end %>
+# Now you will need to add translations in your locale .yml, for the example
+# provided above that would be:
+#   en:
+#     activity:
+#       create: 'New article has been created'
+#       update: 'Someone modified the article'
+#
+# Check {PublicActivity::ClassMethods#tracked} for more details about customizing and specifing
+# ownership to users.
+module PublicActivity
+  extend ActiveSupport::Concern
+  extend ActiveSupport::Autoload
+  autoload :Activity
+  autoload :Tracked
+  autoload :Creation
+  autoload :VERSION
+  autoload :Common
+  
+  included do
+    class_attribute :activity_owner_global, :activity_params_global
+    self.activity_owner_global = nil
+    self.activity_params_global = {}
+    include Tracked
+  end  
+  
+  module ClassMethods
+    # Adds required callbacks for creating and updating
+    # tracked models and adds +activities+ relation for listing
+    # associated activities.
+    # 
+    # == Parameters:
+    # :owner::
+    #   You can pass a Symbol or a String with an attribute from
+    #   which public_activity should take +user id+ responsible for 
+    #   this activity.
+    #
+    #   For example:
+    #    tracked :owner => :author
+    #   will take +owner+ from tracked model's +author+ attribute.
+    #
+    #   If you need more complex logic, you can pass a Proc:
+    #    tracked :owner => Proc.new{ User.first }
+    # :params::
+    #   Accepts a Hash containing parameters you wish
+    #   to pass to every {Activity} created from this model.
+    #
+    #   For example, if you want to pass a parameter that
+    #   should be in every {Activity}, you can do this:
+    #    tracked :params => {:user_name => "Piotrek"}
+    #   These params are passed to i18n.translate
+    #   when using {PublicActivity::Activity#text}, which returns
+    #   already translated {Activity} message.
+    #   For more dynamic settings refer to {Activity} model 
+    #   documentation.
+    def tracked(options = {})
+      return if tracked?
+      include Creation
+      include Common
+      
+      if options[:owner]
+        self.activity_owner_global = options[:owner]
+      end
+      if options[:params]
+        self.activity_params_global = options[:params]
+      end
+      has_many :activities, :class_name => "PublicActivity::Activity", :as => :trackable
+      
+      
+      
+    end
+  end
+
+end
+
+ActiveRecord::Base.send :include, PublicActivity

data/lib/public_activity/activity.rb

@@ -0,0 +1,42 @@
+require 'active_record'
+require 'i18n'
+module PublicActivity
+  # The ActiveRecord model containing 
+  # details about recorded activity.
+  class Activity < ActiveRecord::Base
+    # Define polymorphic association to the parent
+    belongs_to :trackable, :polymorphic => true
+    # Define ownership to a resource responsible for this activity
+    belongs_to :owner, :polymorphic => true
+    # Serialize parameters Hash
+    serialize :parameters, Hash
+    
+    # Virtual attribute returning already
+    # translated key with params passed
+    # to i18n.translate function
+    # == 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"
+    # And in controller:
+    #
+    #   def create
+    #     @article = Article.new
+    #     @article.title = "Rails 3.0.5 released!"
+    #     @article.activity_params = {:title => @article.title}
+    #     @article.save
+    #   end
+    #
+    # Now when you list articles, you should see:
+    #   @article.activities.last.text #=> "Someone has created an article 'Rails 3.0.5 released!'"
+    def text
+      I18n.t(key, parameters || {})
+    end
+  end  
+end

data/lib/public_activity/common.rb

@@ -0,0 +1,29 @@
+module PublicActivity
+  module Common
+    extend ActiveSupport::Concern
+    
+    module InstanceMethods
+      # Prepare settings used during creation of Activity record.
+      # params passed directly to tracked model have priority over
+      # settings specified in tracked() method
+      def prepare_settings
+        # user responsible for the activity
+        if self.activity_owner
+          owner = self.activity_owner
+        else
+          case self.activity_owner_global
+            when Symbol, String 
+              owner = self[self.class.activity_owner_global]
+            when Proc
+              owner = self.class.activity_owner_global.call           
+          end
+        end
+        #customizable parameters
+        parameters = self.class.activity_params_global
+        parameters.merge! self.activity_params if self.activity_params      
+        return {:owner => owner, :parameters => parameters}
+      end
+      
+    end
+  end
+end

data/lib/public_activity/creation.rb

@@ -0,0 +1,30 @@
+module PublicActivity
+  module Creation
+    extend ActiveSupport::Concern
+    
+    included do
+      after_create :activity_on_create
+      after_update :activity_on_update
+    end   
+    
+    module InstanceMethods
+      private
+        # Creates activity based on supplied arguments
+        def create_activity(key, owner, params)
+          self.activities.create(:key => key, :owner => owner, :parameters => params)
+        end
+        
+        # Creates activity upon creation of the tracked model
+        def activity_on_create
+          settings = prepare_settings
+          create_activity("activity."+self.class.name.downcase+".create", settings[:owner], settings[:parameters])
+        end
+        
+        # Creates activity upon modification of the tracked model
+        def activity_on_update
+          settings = prepare_settings
+          create_activity("activity."+self.class.name.downcase+".update", settings[:owner], settings[:parameters])
+        end
+    end
+  end
+end

data/lib/public_activity/tracked.rb

@@ -0,0 +1,84 @@
+module PublicActivity
+  # Add a flag to determine whether a model class is being tracked
+  module Tracked
+    extend ActiveSupport::Concern
+
+    # Set or get parameters that will be passed to {Activity} when saving
+    #
+    # == Usage:
+    # In model:
+    #
+    #   class Article < ActiveRecord::Base
+    #     tracked
+    #   end 
+    #
+    # In controller
+    #   @article = Article.new
+    #   @article.activity_params = {:article_title => @article.title}
+    #   @article.save
+    # This way you can pass strings that should remain constant, even when {Article}
+    # changes after creating this {Activity}.
+    attr_accessor :activity_params
+    @activity_params = {}
+    # Set or get user id responsible for the {Activity}.
+    # Same rules apply like with the other attributes described.
+    #
+    # == Usage:
+    # In model:
+    #
+    #   class Article < ActiveRecord::Base
+    #     tracked
+    #   end 
+    # Controller:
+    #
+    #   @article = Article.new
+    #   @article.activity_owner = current_user #where current_user is an object of logged in user
+    #   @article.save
+    #   @article.activities.last.user #=> Returns User object
+    attr_accessor :activity_owner
+    @activity_owner = nil
+    # Set or get custom i18n key passed to {Activity}
+    #
+    # == Usage:
+    # In model:
+    #
+    #   class Article < ActiveRecord::Base
+    #     tracked
+    #   end 
+    #
+    # In controller:
+    #
+    #   @article = Article.new
+    #   @article.save
+    #   @article.activities.last.key #=> "activity.article.create"
+    # By default, key looks like "activity.{class_name}.{create|update}"
+    #
+    # You can customize it, by setting your own key:
+    #   @article = Article.new
+    #   @article.activity_key = "my.custom.article.key"
+    #   @article.save
+    #   @article.activities.last.key #=> "my.custom.article.key"
+    attr_accessor :activity_key
+    @activity_key = nil
+    # Overrides the +tracked+ method to first define the +tracked?+ class method before
+    # deferring to the original +tracked+.
+    module ClassMethods
+      def tracked(*args)
+        super(*args)
+
+        class << self
+          def tracked?
+            true
+          end
+        end
+      end
+
+      # For ActiveRecord::Base models that do not call the +tracked+ method, the +tracked?+
+      # will return false
+      def tracked?
+        false
+      end
+    end
+
+  end
+end

data/lib/public_activity/version.rb

@@ -0,0 +1,3 @@
+module PublicActivity
+  VERSION = '0.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+Bundler.setup(:default, :test)
+require File.expand_path('lib/public_activity.rb')
+
+Dir[File.expand_path('support/*')].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+

data/spec/version_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe PublicActivity, 'VERSION' do
+  it 'is present' do
+    PublicActivity::VERSION.should_not be_nil
+  end
+    
+  it 'is frozen' do
+    PublicActivity::VERSION.frozen?.should be(true)
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: public_activity
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.1"
+platform: ruby
+authors: 
+- "Piotrek Oko\xC5\x84ski"
+- "Kuba Oko\xC5\x84ski"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    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 
+    none: false
+    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 
+    none: false
+    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 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Smooth acitivity 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: 
+- lib/generators/public_activity.rb
+- lib/generators/public_activity/migration/migration_generator.rb
+- lib/generators/public_activity/migration/templates/migration.rb
+- lib/public_activity.rb
+- lib/public_activity/activity.rb
+- lib/public_activity/common.rb
+- lib/public_activity/creation.rb
+- lib/public_activity/tracked.rb
+- lib/public_activity/version.rb
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- README.md
+- MIT-LICENSE
+- spec/spec_helper.rb
+- spec/version_spec.rb
+has_rdoc: true
+homepage: https://github.com/okonski/public_activity
+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: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Smooth acitivity tracking for ActiveRecord models
+test_files: 
+- spec/spec_helper.rb
+- spec/version_spec.rb