activity_stream 0.0.2

data/.gitignore

@@ -0,0 +1,10 @@
+pkg/*
+*.gem
+.bundle
+.yardoc
+doc
+*.swp
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+*.DS_Store

data/.yardopts

@@ -0,0 +1,4 @@
+'app/**/*.rb'
+'lib/**/*.rb'
+-
+Readme.md

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in activity_stream.gemspec
+gemspec
+
+gem "sqlite3-ruby", :require => "sqlite3"

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    activity_stream (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (2.3.10)
+      actionpack (= 2.3.10)
+    actionpack (2.3.10)
+      activesupport (= 2.3.10)
+      rack (~> 1.1.0)
+    activerecord (2.3.10)
+      activesupport (= 2.3.10)
+    activeresource (2.3.10)
+      activesupport (= 2.3.10)
+    activesupport (2.3.10)
+    capybara (0.4.0)
+      celerity (>= 0.7.9)
+      culerity (>= 0.2.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (>= 0.0.27)
+      xpath (~> 0.1.2)
+    celerity (0.8.2)
+    childprocess (0.1.3)
+      ffi (~> 0.6.3)
+    culerity (0.2.12)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    json_pure (1.4.6)
+    mime-types (1.16)
+    nokogiri (1.4.3.1)
+    rack (1.1.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (2.3.10)
+      actionmailer (= 2.3.10)
+      actionpack (= 2.3.10)
+      activerecord (= 2.3.10)
+      activeresource (= 2.3.10)
+      activesupport (= 2.3.10)
+      rake (>= 0.8.3)
+    rake (0.8.7)
+    rspec (1.3.1)
+    rspec-rails (1.3.3)
+      rack (>= 1.0.0)
+      rspec (= 1.3.1)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.0.29)
+      childprocess (>= 0.0.7)
+      ffi (~> 0.6.3)
+      json_pure
+      rubyzip
+    sqlite3-ruby (1.3.2)
+    xpath (0.1.2)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activity_stream!
+  capybara
+  rails (~> 2.3.10)
+  rspec-rails (~> 1.3.0)
+  sqlite3-ruby

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new('rspec') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/Readme.md

@@ -0,0 +1,71 @@
+# ActivityStream (early alpha) #
+
+Activity Stream provides a simple DSL to define, create,
+and retrieve user activities.
+
+## Installation ##
+
+Add it to your Gemfile:
+
+    gem 'activity_stream'
+   
+Run the generator:
+
+    script/generate activity_stream
+    
+And migrate the database:
+
+    rake db:migrate
+
+## Usage ##
+
+### Defining Activities ###
+
+In `app/models/activities/example_action_activity.rb`:
+
+    Activity.define(:example_action) do
+      metadata(:target, :default => :actor)
+      metadata(:referrer)
+      icon('example_activity_icon.png')
+    end
+
+### Extending User ###
+
+In your User model:
+
+    class User < ActiveRecord::Base
+    
+      include ActivityStream::Actor
+      
+      def activity_stream_actors
+        [[User, 13], [User, 14], [Page, 9]]
+      end
+      
+    end
+
+### Retrieving Activities ###
+
+In your dashboard controller:
+
+    @activity_stream = current_user.activity_stream
+
+### Creating Activies ###
+
+When you want to create an activity:
+
+    current_user.create_activity(:example_action,
+                                 :target => @friend,
+                                 :referrer => @referrer)
+
+
+## Notes ##
+
+Currently designed for Rails 2.3.10, because the project
+that prompted its creation is that version. I can't guarantee
+that it will work in any other version of Rails.
+
+However, I do have other projects, that are Rails 3, that will
+benefit from a Rails 3 compatible version of activity_stream.
+Be on the lookout for updates!
+
+

data/activity_stream.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "activity_stream/version"
+
+Gem::Specification.new do |s|
+  s.name        = "activity_stream"
+  s.version     = ActivityStream::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Andrew Smith"]
+  s.email       = ["andrew@envylabs.com"]
+  s.homepage    = "http://rubygems.org/gems/activity_stream"
+  s.summary     = %q{Rails plugin to add activity streams for your users}
+  s.description = %q{Rails plugin to add activity streams for your users, highly opinionated.}
+
+  s.rubyforge_project = "activity_stream"
+
+  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-rails", "~> 1.3.0"
+  s.add_development_dependency "rails", "~> 2.3.10"
+  s.add_development_dependency "capybara"
+end

data/app/models/activity.rb

@@ -0,0 +1,46 @@
+class Activity < ActiveRecord::Base
+  
+  belongs_to :actor, :polymorphic => true
+  
+  # @param name [Symbol] (see ActivityStream::Definition#new)
+  # @return [ActivityStream::Definition] the new definitions
+  #
+  def self.define(name, &block)
+    definition = ActivityStream::Definition.new(name)
+    definition.instance_eval(&block)
+    ActivityStream::Definition.register(definition)
+  end
+  
+  named_scope :in_reverse_chronological_order, :order => 'occurred_at DESC'
+  
+  named_scope :in_chronological_order, :order => 'occurred_at ASC'
+
+  # @param actors [Array] An array of [ActorClass, actor_id] sets
+  #   or [ActorClass, [actor_id, actor_id, actor_id...]
+  #
+  named_scope :by_actors, lambda { |actors|
+    if actors.first.is_a?(Array)
+      conditions = actors.map do |(actor_type, actor_id)|
+        %{("activities"."actor_id" = #{actor_id.to_param} AND "activities"."actor_type" = '#{actor_type.to_param}')}
+      end
+      {:conditions => conditions.join(' OR ') }
+    elsif actors.first.is_a?(Class)
+      {:conditions => {:actor_id => actors.last, :actor_type => actors.first.to_param}}
+    else
+      {} # Not sure what to do here.
+    end
+  }
+  
+  serialize :metadata, ActivityStream::Metadata
+  
+  delegate :template, :icon, :to => :definition
+  
+  def metadata
+    self[:metadata] ||= ActivityStream::Metadata.new(self[:kind])
+  end
+  
+  def definition
+    ActivityStream::Definition.find_by_name(self[:kind])
+  end
+
+end

data/generators/activity_stream/activity_stream_generator.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
+# require File.expand_path(File.dirname(__FILE__) + "/lib/rake_commands.rb")
+
+class ActivityStreamGenerator < Rails::Generator::Base
+  
+  def manifest
+    record do |m|
+      
+      m.directory(File.join('app','models','activities'))
+      m.template('example_activity.rb', 'app/models/activities/example_activity.rb')
+      
+      user_model = 'app/models/user.rb'
+      if File.exists?(user_model)
+        m.insert_into(user_model, "include ActivityStream::Actor")
+      else
+        m.directory(File.join('app', 'models'))
+        m.file('user.rb', user_model)
+      end
+      
+      m.migration_template('migration.rb',
+                           'db/migrate',
+                           :migration_file_name => 'create_activity_stream_tables',
+                           :assigns => {:has_users => ActiveRecord::Base.connection.table_exists?(:users)})
+      
+    end
+  end
+  
+end

data/generators/activity_stream/lib/insert_commands.rb

@@ -0,0 +1,33 @@
+# Mostly pinched from http://github.com/ryanb/nifty-generators/tree/master
+
+Rails::Generator::Commands::Base.class_eval do
+  def file_contains?(relative_destination, line)
+    File.read(destination_path(relative_destination)).include?(line)
+  end
+end
+
+Rails::Generator::Commands::Create.class_eval do
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+    unless options[:pretend] || file_contains?(file, line)
+      gsub_file file, /^(class|module|.*Routes).*$/ do |match|
+        "#{match}\n  #{line}"
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def insert_into(file, line)
+    logger.remove "#{line} from #{file}"
+    unless options[:pretend]
+      gsub_file file, "\n  #{line}", ''
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+  end
+end

data/generators/activity_stream/templates/example_activity.rb

@@ -0,0 +1,6 @@
+# Activity.define(:example_activity) do
+#   icon 'example_activity_icon.png'
+#   metadata :detail
+#   metadata :target
+# end
+#   

data/generators/activity_stream/templates/migration.rb

@@ -0,0 +1,30 @@
+class CreateActivityStreamTables < ActiveRecord::Migration
+  def self.up
+    
+    create_table :activities do |t|
+      t.integer :actor_id
+      t.string :actor_type
+      t.string :kind
+      t.text :metadata
+      t.datetime :occurred_at
+    end
+    
+    add_index :activities, [:actor_id, :actor_type]
+    
+    <% unless has_users %>
+      create_table :users do |t|
+        t.string :name
+      end
+      
+    <% end %>
+  end
+
+  def self.down
+    <% unless has_users %>
+      drop_table :users
+    <% end %>
+    
+    drop_table :activities
+    
+  end
+end

data/generators/activity_stream/templates/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+  
+  include ActivityStream::Actor
+  
+end

data/lib/activity_stream.rb

@@ -0,0 +1,9 @@
+require 'activity_stream/definition'
+require 'activity_stream/actor'
+require 'activity_stream/metadata'
+require 'activity_stream/stream'
+require 'activity_stream/version'
+
+module ActivityStream
+  # Your code goes here...
+end

data/lib/activity_stream/activities_helper.rb

@@ -0,0 +1,15 @@
+module ActivityStream
+  
+  module ActivitiesHelper
+    
+    def render_activities(activities)
+      return nil if activities.empty?
+      activities.map do |activity|
+        _partial_name = activity.template
+        template = self.view_paths.find_template(%{activities/_#{_partial_name}}, :html)
+        template.render_partial(self, activity)
+      end.join('').html_safe
+    end
+  end
+  
+end

data/lib/activity_stream/actor.rb

@@ -0,0 +1,68 @@
+module ActivityStream
+  
+  # @example Definition
+  #   class User < ActiveRecord::Base
+  #
+  #     include ActivityStream::Actor
+  #
+  #     activity_stream(:friends, :actors => :friend_actors)
+  #     
+  #     def friend_actors
+  #       friend_ids.map{|id| [User, id]}
+  #     end
+  # 
+  #     def friend_ids
+  #       # get friend ids
+  #     end
+  #
+  #   end
+  #
+  # @example Usage
+  #   @user.activity_stream(:friends) # => <ActivityStream::Stream>
+  module Actor
+    
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.class_eval do
+        has_many :activities, :as => :actor
+        activity_stream(:all, :actors => :activity_stream_actors)
+      end
+    end
+    
+    # @param name [Symbol] An activity identifer defined by Activity.define
+    def create_activity(name)
+      
+    end
+
+    # Creates and returns an ActivityStream::Stream for the predefined
+    # list of actors. 
+    # @param name [Symbol] The key of a defined activity stream
+    def activity_stream(name)
+      ActivityStream::Stream.new(name, self, self.class.defined_streams[name])
+    end
+    
+    def activity_stream_actors
+      self.class.all.map{|actor| [actor.class, actor.id]}
+    end
+    
+    module ClassMethods
+      
+      # @attr_accessor defined_streams
+      attr_accessor :defined_streams
+      
+      # Creates an activity_stream instance method that fetches 
+      # all recent activity
+      # 
+      # @param name [Symbol] the name for the sub stream you wish to access
+      # @option opts (see ActivityStream::Stream#new)
+      def activity_stream(name, opts = {})
+        self.defined_streams ||= {}
+        self.defined_streams[name.to_sym] = opts
+        return nil
+      end
+      
+    end
+    
+  end
+  
+end