chalk_dust 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/db.sqlite3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - '1.9.2'
+  - '1.9.3'
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chalk_dust.gemspec
+gemspec
+
+# These are development dependencies
+
+platforms :jruby do
+  gem "activerecord-jdbcsqlite3-adapter"
+end
+
+platforms :ruby do
+  gem "sqlite3-ruby"
+end

data/Guardfile

@@ -0,0 +1,7 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')        { "spec" }
+  watch(%r{^spec/support/(.+)\.rb$})  { "spec" }
+end
+

data/README.md

@@ -0,0 +1,124 @@
+# ChalkDust
+
+ChalkDust can be used to build activty feeds such as followings and friendships
+by allowing models to subscribe to activity feeds published by other models.
+
+Every time an activity occurs it is copied to all subscribers of the target of
+that activity. This creates an activty feed per subscriber (more data) which
+scales better and allows additional features such as feed to delete/hide
+activity items.
+
+[![Code Climate](https://codeclimate.com/github/krisleech/chalk-dust.png)](https://codeclimate.com/github/krisleech/chalk-dust)
+[![Build Status](https://travis-ci.org/krisleech/chalk-dust.png)](https://travis-ci.org/krisleech/chalk-dust)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'chalk_dust'
+
+## Usage
+
+### Subscribing
+
+A subscription connects two objects, e.g "Sam" follows "My first blog post"
+
+```ruby
+ChalkDust.subscribe(user, :to => post)
+```
+
+```ruby
+ChalkDust.subscribers_of(post) # => [user, post]
+```
+
+#### Self-subscribing
+
+Typically you will want to self-subscribe models on creation to themseleves so
+an activity feed is built for the model itself.
+
+```ruby
+ChalkDust.self_subscribe(user)
+# or
+ChalkDust.subscribe(user, :to => user)
+```
+
+#### Undirected subscriptions
+
+All subscriptions are directed. You can create a two way subscription, e.g a
+friendship, as follows:
+
+```ruby
+ChalkDust.subscribe(bob, :to => alice, :undirected => true)
+# or
+ChalkDust.subscribe(bob,   :to => alice)
+ChalkDust.subscribe(alice, :to => bob)
+```
+
+### Publishing activity
+
+Describes an event where X (performer) did Y (activity) to Z (target).
+
+```ruby
+ChalkDust.publish_event(user, 'added', comment)
+```
+
+If the activity should be published to the feed of an object other 
+than the target then it can be either be passed as an additional argument or
+provided as a method called `activity_root`.
+
+```ruby
+ChalkDust.publish_event(user, 'added', comment, :root => comment.post)
+```
+
+or
+
+(TODO)
+```ruby
+class Comment < ActiveRecord::Base
+  belongs_to :post
+
+  def activity_root
+    post
+  end
+end
+```
+
+### Activity Feeds
+
+```ruby
+ChalkDust.activity_feed_for(user, :since => 2.weeks.ago)
+ChalkDust.activity_feed_for(post, :since => 2.weeks.ago)
+```
+
+## Contributing
+
+Contributions welcome, please fork and send a pull request.
+
+## Thanks
+
+Thanks to Igor @ Lifetrip Limited for allowing this code to be open sourced.
+
+## License
+
+Copyright (c) 2013 Lifetrip Limited
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/chalk_dust.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/chalk_dust/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Kris Leech"]
+  gem.email         = ["kris.leech@gmail.com"]
+  gem.description   = %q{Subscribe to and build activity feeds for your models, for example followings and friendships}
+  gem.summary       = %q{Subscribe to and build activity feeds for your models, for example followings and friendships}
+  gem.homepage      = "https://github.com/krisleech/chalk-dust"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "chalk_dust"
+  gem.require_paths = ["lib"]
+  gem.version       = ChalkDust::VERSION
+
+  gem.add_dependency "activerecord", "~> 3.0"
+
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rspec", "~> 2.3"
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'guard-rspec'
+end

data/lib/chalk_dust.rb

@@ -0,0 +1,63 @@
+require "chalk_dust/version"
+
+module ChalkDust
+  class Connection < ActiveRecord::Base
+    belongs_to :publisher,  :polymorphic => true
+    belongs_to :subscriber, :polymorphic => true
+
+    def self.subscribers_of(publisher)
+      where(:publisher_id => publisher.id,
+            :publisher_type => publisher.class.to_s).map(&:subscriber)
+    end
+  end
+
+  class ActivityItem < ActiveRecord::Base
+    belongs_to :performer, :polymorphic => true
+    belongs_to :target,    :polymorphic => true
+    belongs_to :owner,     :polymorphic => true
+
+    validates :event, :presence => true
+
+    def self.for_owner(owner)
+      where(:owner_id => owner.id,
+            :owner_type => owner.class.to_s)
+    end
+
+    def self.since(time)
+      where("created_at >= ?", time)
+    end
+  end
+
+  def self.subscribe(subscriber, options)
+    publisher  = options.fetch(:to)
+    undirected = options.fetch(:undirected, false)
+    Connection.create(:subscriber => subscriber, :publisher => publisher)
+    Connection.create(:subscriber => publisher,  :publisher => subscriber) if undirected
+  end
+
+  def self.subscribers_of(publisher)
+    Connection.subscribers_of(publisher)
+  end
+
+  def self.self_subscribe(publisher_subscriber)
+    subscribe(publisher_subscriber, :to => publisher_subscriber)
+  end
+
+  # publishes an event where X (performer) did Y (event) to Z (target) to every
+  # subscriber of the target
+  def self.publish_event(performer, event, target, options = {})
+    root_publisher = options.fetch(:root, target)
+    subscribers_of(root_publisher).map do |subscriber|
+      ActivityItem.create(:performer => performer,
+                          :event     => event,
+                          :target    => target,
+                          :owner     => subscriber)
+    end
+  end
+
+  def self.activity_feed_for(subscriber, options = {})
+    activity_items = ActivityItem.for_owner(subscriber)
+    activity_items = activity_items.since(options[:since]) if options[:since].present?
+    activity_items
+  end
+end

data/lib/chalk_dust/version.rb

@@ -0,0 +1,3 @@
+module ChalkDust
+  VERSION = "0.0.1"
+end

data/spec/lib/chalk_dust/activity_feeds_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe 'activity feeds' do
+  before(:each) do
+    ChalkDust::ActivityItem.delete_all
+  end
+
+  describe '.activity_feed_for' do
+    it 'returns activity feed for given object' do
+      kris    = User.create!
+      lindsey = User.create!
+      hallie  = User.create!
+      post    = Post.create!
+      comment = Comment.create!
+
+      activity_item_1 = ChalkDust::ActivityItem.create(:performer => kris,
+                          :event     => 'editted',
+                          :target    => post,
+                          :owner     => hallie)
+
+      activity_item_2 = ChalkDust::ActivityItem.create(:performer => lindsey,
+                          :event     => 'added',
+                          :target    => comment,
+                          :owner     => hallie)
+
+      activity_items = ChalkDust.activity_feed_for(hallie)
+      activity_items.should == [activity_item_1, activity_item_2]
+    end
+
+    describe 'options' do
+      it ':since limits to activities created since the given date' do
+        kris    = User.create!
+        lindsey = User.create!
+        hallie  = User.create!
+        post    = Post.create!
+        comment = Comment.create!
+
+        activity_item_1 = ChalkDust::ActivityItem.create(:performer => kris,
+                            :event     => 'editted',
+                            :target    => post,
+                            :owner     => hallie,
+                            :created_at => 2.months.ago)
+
+        activity_item_2 = ChalkDust::ActivityItem.create(:performer => lindsey,
+                            :event     => 'added',
+                            :target    => comment,
+                            :owner     => hallie)
+
+        activity_items = ChalkDust.activity_feed_for(hallie, :since => Time.now - 1.week)
+        activity_items.should == [activity_item_2]
+      end
+    end
+  end
+end
+

data/spec/lib/chalk_dust/publishing_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe 'publishing' do
+  before(:each) do
+    ChalkDust::Connection.delete_all
+    ChalkDust::ActivityItem.delete_all
+  end
+
+  describe '.publish_event' do
+    it 'creates an event for every subscriber' do
+      kris    = User.create!
+      lindsey = User.create!
+      hallie  = User.create!
+      post    = Post.create!
+
+      ChalkDust::Connection.create(:subscriber => kris,    :publisher => post)
+      ChalkDust::Connection.create(:subscriber => lindsey, :publisher => post)
+
+      activity_items = ChalkDust.publish_event(kris, 'editted', post)
+
+      activity_items.size.should == 2
+
+      activity_item = activity_items.first
+      activity_item.performer.should == kris
+      activity_item.event.should == 'editted'
+      activity_item.target.should == post
+      activity_item.owner.should == kris
+
+      activity_item = activity_items.last
+      activity_item.performer.should == kris
+      activity_item.event.should == 'editted'
+      activity_item.target.should == post
+      activity_item.owner.should == lindsey
+    end
+
+    describe 'options' do
+      describe ':root' do
+        it 'sets the root object of the target' do
+          kris    = User.create!
+          lindsey = User.create!
+          post    = Post.create!
+          comment = Comment.create!(:post => post)
+
+          ChalkDust::Connection.create(:subscriber => lindsey, :publisher => post)
+
+          activity_items = ChalkDust.publish_event(kris, 'added', comment, :root => comment.post)
+
+          activity_items.size.should == 1
+
+          activity_item = activity_items.first
+          activity_item.performer.should == kris
+          activity_item.event.should == 'added'
+          activity_item.target.should == comment
+          activity_item.owner.should == lindsey
+        end
+      end
+    end
+
+    # pending 'target root can be set by the `activity_root` method on the target'
+  end
+end
+

data/spec/lib/chalk_dust/subscribing_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe ChalkDust do
+  before(:each) { ChalkDust::Connection.delete_all }
+
+  describe 'subscribing' do
+    it '.subscribe connects two objects' do
+      user = User.create!
+      post = Post.create!
+
+      ChalkDust.subscribe(user, :to => post)
+
+      connection = ChalkDust::Connection.first
+      connection.subscriber.should == user
+      connection.publisher.should == post
+    end
+
+    it '.self_subscribe connects object to itself' do
+      user = User.create!
+
+      ChalkDust.self_subscribe(user)
+
+      connection = ChalkDust::Connection.first
+      connection.subscriber.should == user
+      connection.publisher.should == user
+    end
+
+    describe 'options' do
+      it ':undirected subscribes in both directions' do
+        bob = User.create!
+        alice = User.create!
+
+        ChalkDust.subscribe(bob, :to => alice, :undirected => true)
+
+        ChalkDust::Connection.count.should == 2
+
+        connection_1 = ChalkDust::Connection.first
+        connection_1.subscriber.should == bob
+        connection_1.publisher.should  == alice
+
+        connection_2 = ChalkDust::Connection.last
+        connection_2.subscriber.should == alice
+        connection_2.publisher.should  == bob
+      end
+    end
+  end
+
+  describe 'fetching subscriptions' do
+    it '.subscriptions_of returns subscribers to given object' do
+      user = User.create!
+      post = Post.create!
+
+      ChalkDust::Connection.create!(:subscriber => user, :publisher => post)
+
+      ChalkDust.subscribers_of(post).should == [user]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'active_record'
+require 'chalk_dust'
+
+adapter = RUBY_PLATFORM == "java" ? 'jdbcsqlite3' : 'sqlite3'
+
+ActiveRecord::Base.establish_connection(:adapter => adapter,
+                                       :database => File.dirname(__FILE__) + "/db.sqlite3")
+
+load File.dirname(__FILE__) + '/support/schema.rb'
+
+require 'support/models'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/spec/support/models.rb

@@ -0,0 +1,12 @@
+class User < ActiveRecord::Base
+  has_many :comments
+end
+
+class Post < ActiveRecord::Base
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+  belongs_to :user
+end

data/spec/support/schema.rb

@@ -0,0 +1,48 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, :force => true do |t|
+    t.integer :id
+    t.string  :name
+    t.string :email
+    t.timestamps
+  end
+
+  create_table :posts, :force => true do |t|
+    t.integer :id
+    t.string  :title
+    t.string :body
+    t.timestamps
+  end
+
+  create_table :comments, :force => true do |t|
+    t.integer :id
+    t.integer :user_id
+    t.integer :post_id
+    t.string  :body
+    t.timestamps
+  end
+
+  create_table :connections, :force => true do |t|
+    t.integer :subscriber_id
+    t.string  :subscriber_type
+    t.integer :publisher_id
+    t.string  :publisher_type
+    t.timestamps
+  end
+
+  create_table :activity_items, :force => true do |t|
+    t.integer :performer_id
+    t.string  :performer_type
+
+    t.string  :event
+
+    t.integer :target_id
+    t.string  :target_type
+
+    t.integer :owner_id
+    t.string  :owner_type
+
+    t.timestamps
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: chalk_dust
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kris Leech
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Subscribe to and build activity feeds for your models, for example followings
+  and friendships
+email:
+- kris.leech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- chalk_dust.gemspec
+- lib/chalk_dust.rb
+- lib/chalk_dust/version.rb
+- spec/lib/chalk_dust/activity_feeds_spec.rb
+- spec/lib/chalk_dust/publishing_spec.rb
+- spec/lib/chalk_dust/subscribing_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: https://github.com/krisleech/chalk-dust
+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'
+      segments:
+      - 0
+      hash: -4022978035697313999
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4022978035697313999
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Subscribe to and build activity feeds for your models, for example followings
+  and friendships
+test_files:
+- spec/lib/chalk_dust/activity_feeds_spec.rb
+- spec/lib/chalk_dust/publishing_spec.rb
+- spec/lib/chalk_dust/subscribing_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb