seymour 0.0.3 → 0.0.4

data/README.md

@@ -64,5 +64,6 @@ activity.distribute
 
 ## Background
 
-This library is based on the feed architecture used to distribute activity items at [Weplay](http://weplay.com). Weplay supports activity distribution to a variety of feeds: user dashboards, game day comment pages, global points leaders, etc.
+This library is based on the feed architecture used to distribute activity items at [Weplay](http://weplay.com). Weplay supports activity distribution to a variety of feeds: user dashboards, game day comment pages, global points leaders, etc. The html for each activity item is pre-rendered in a background job. To build a user's dashboard activities, the activity feed needs only to select the activities at the top of the list and output the pre-rendered html for each item, reducing the extra includes and joins needed in-process.
+
 

data/Rakefile

@@ -25,3 +25,20 @@ load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
 
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end
+
+desc "Run the specs"
+task :default => ["spec"]

data/lib/seymour.rb

@@ -5,7 +5,7 @@ require "seymour/activity_feed"
 require "seymour/acts_as_activity"
 require "seymour/distributable"
 require "seymour/renderable"
-require "seymour/render_controller"
+# require "seymour/render_controller"
 
 module Seymour
   extend self

data/lib/seymour/activity_feed.rb

@@ -7,7 +7,7 @@ module Seymour
       @@feed_classes = []
 
       def distribute(activity)
-        activity.feeds.map { |feed| feed.push(activity) }
+        activity.distribute
       end
 
       def inherited(subclass)
@@ -17,7 +17,6 @@ module Seymour
       def feed_classes
         @@feed_classes
       end
-
     end
 
     def initialize(owner)

data/lib/seymour/batched_user_enumerator.rb

@@ -0,0 +1,21 @@
+class BatchedUserEnumerator
+  def initialize(find_in_batches_options)
+    @find_in_batches_options = find_in_batches_options
+  end
+  
+  def self.for_ids(ids)
+    return [] if ids.empty?
+    self.new(:conditions => ['id in (?)', ids])
+  end
+  
+  def each
+    User.find_in_batches(@find_in_batches_options) do |users|
+      User.send(:with_exclusive_scope) do
+        users.each do |user|
+          yield user
+        end
+      end
+    end
+    self
+  end
+end

data/lib/seymour/distributable.rb

@@ -7,36 +7,60 @@ module Seymour
     end
 
     module ClassMethods
+      DEFAULT_BATCH_SIZE = 500
+
       attr_accessor :audience_names, :feed_class_names
 
       def audience(*names)
         options = names.extract_options!
         names.each do |name|
-          feed_name = options[:feed] || "#{name.downcase.to_s.singularize}_feed".camelize
-          audience_to_feed_classes[name] = feed_name
+          feed_name = options.delete(:feed) || "#{name.downcase.to_s.singularize}_feed".camelize
+          audience_mappings[name] = [feed_name, options]
         end
       end
 
       def audience_names
-        audience_to_feed_classes.keys
+        audience_mappings.keys
       end
 
       def feed_class_names
-        audience_to_feed_classes.values
+        audience_mappings.values.map(&:first)
       end
 
       def feeds_for(activity)
-        audience_to_feed_classes.map do |audience_name, feed_class_name|
-          activity.send(audience_name).map do |member|
-            feed_class_name.constantize.new(member)
-          end
-        end.flatten
+        tap_feeds_for(activity)
+      end
+
+      def distribute(activity)
+        tap_feeds_for(activity) { |feed| feed.push(activity) }
       end
 
       private
 
-      def audience_to_feed_classes
-        @audience_to_feed_classes ||= {}
+      def tap_feeds_for(activity, &block)
+        [].tap do |feeds|
+          audience_mappings.each do |audience_name, mapping|
+            feed_class_name, options = mapping
+            try_find_each(activity.send(audience_name), options) do |member|
+              feed = feed_class_name.constantize.new(member)
+              yield feed if block_given?
+              feeds << feed
+            end
+          end
+        end
+      end
+
+      def audience_mappings
+        @audience_mappings ||= {}
+      end
+
+      def try_find_each(activity_audience, options = {}, &block)
+        if defined? activity_audience.find_each
+          options[:batch_size] ||= DEFAULT_BATCH_SIZE
+          activity_audience.find_each(options) &block
+        else
+          activity_audience.each &block
+        end
       end
 
     end
@@ -44,7 +68,7 @@ module Seymour
     module InstanceMethods
 
       def distribute
-        feeds.map { |feed| feed.push(self) }
+        self.class.distribute(self)
       end
 
       def feeds

data/lib/seymour/renderable.rb

@@ -22,7 +22,7 @@ module Seymour
           { "REQUEST_URI" => "", "SERVER_NAME" => '' }.merge(env))
 
         controller_class = "#{controller_name}_controller".classify.constantize
-        # status, headers, response = controller_class.action(action_name.to_sym).call(env)
+
         status, headers, response = controller_class.action(action_name.to_sym).call(env)
         raise RenderError.new("#{controller_name}##{action_name}") unless status.to_i == 200
         response.body

data/lib/seymour/version.rb

@@ -1,3 +1,3 @@
 module Seymour
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/dummy/app/models/activities/test_activity.rb

@@ -1,6 +1,10 @@
 class TestActivity < Activity
   audience :events
-  audience :authors, :feed => "UserFeed"
+  audience :users, :feed => "UserFeed"
+
+  def users
+    [actor] + authors
+  end
 
   def events
     []

data/spec/dummy/app/models/event.rb

@@ -1,5 +1,4 @@
 class Event < ActiveRecord::Base
-
   has_many :attendees, :class_name => "User"
-
+  has_many :comments
 end

data/spec/dummy/lib/seymour/admin_feed.rb

@@ -0,0 +1,2 @@
+class AdminFeed < Seymour::ActivityFeed
+end

data/spec/seymour/activity_feed_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 describe Seymour::ActivityFeed do
 
-  let(:owner) { mock("User", :id => 123) }
-  let(:feed) { Seymour::ActivityFeed.new(owner) }
+  let(:owner) { mock_model(User) }
+  let(:feed)  { Seymour::ActivityFeed.new(owner) }
 
   describe "class methods" do
     describe "feed_classes" do
@@ -13,13 +13,9 @@ describe Seymour::ActivityFeed do
     end
 
     describe "distribute" do
-      it "should push given activity to activities destination feeds" do
-        event_feed  = EventFeed.new(mock_model("Event"))
-        activity    = mock_model("Activity")
-
-        activity.should_receive(:feeds).and_return([event_feed])
-        event_feed.should_receive(:push).with(activity)
-
+      it "should call activity distribute on activity" do
+        activity    = mock_model(Activity)
+        activity.should_receive(:distribute)
         Seymour::ActivityFeed.distribute(activity)
       end
     end
@@ -32,17 +28,40 @@ describe Seymour::ActivityFeed do
   end
 
   describe "push" do
-    it "adds id of given activity to activity_ids" do
-      feed.push mock("Activity", :id => 456)
-      feed.activity_ids.should == [456]
+    it "prepends id of given activity to activity_ids" do
+      feed.push mock_model(Activity, :id => 123)
+      feed.activity_ids.should == [123]
+
+      feed.push mock_model(Activity, :id => 456)
+      feed.activity_ids.should == [456, 123]
     end
 
+    it "new feed with same owner pushes to same list" do
+      new_feed = Seymour::ActivityFeed.new(owner)
+
+      feed.push mock_model(Activity, :id => 123)
+      new_feed.push mock_model(Activity, :id => 456)
+
+      feed.activity_ids.should == [456, 123]
+      new_feed.activity_ids.should == [456, 123]
+    end
+
+    it "new feed with different owner pushes to different list" do
+      new_owner = mock_model(User)
+      new_feed = Seymour::ActivityFeed.new(new_owner)
+
+      feed.push mock_model(Activity, :id => 123)
+      new_feed.push mock_model(Activity, :id => 456)
+
+      feed.activity_ids.should == [123]
+      new_feed.activity_ids.should == [456]
+    end
   end
 
   describe "remove" do
-    it "removes id from list" do
-      activity_1 = mock("Activity", :id => 456)
-      activity_2 = mock("Activity", :id => 789)
+    it "removes activity from list by id" do
+      activity_1 = mock_model(Activity, :id => 456)
+      activity_2 = mock_model(Activity, :id => 789)
       feed.push activity_1
       feed.push activity_2
 
@@ -52,6 +71,19 @@ describe Seymour::ActivityFeed do
     end
   end
 
+  describe "remove_id" do
+    it "removes activity_id from list" do
+      activity_1 = mock_model(Activity, :id => 456)
+      activity_2 = mock_model(Activity, :id => 789)
+      feed.push activity_1
+      feed.push activity_2
+
+      feed.remove_id activity_1.id
+
+      feed.activity_ids.should == [activity_2.id]
+    end
+  end
+
   describe "owner" do
     it "should return given owner" do
       feed.owner.should == owner

data/spec/seymour/distributable_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe Seymour::Distributable do
+
+  class DistributableActivity
+    include Seymour::Distributable
+    audience :users, :admin
+    audience :events, :batch_size => 100
+    audience :soccer_teams, :feed => "TeamFeed"
+
+    attr_accessor :users, :admin, :soccer_teams, :events
+  end
+
+  describe "class methods" do
+    describe "audience" do
+      it "should list audience names" do
+        audience_names = DistributableActivity.audience_names
+        audience_names.should include(:users)
+        audience_names.should include(:admin)
+        audience_names.should include(:soccer_teams)
+        audience_names.should include(:events)
+      end
+
+      it "should list activity feed classes" do
+        feed_class_names = DistributableActivity.feed_class_names
+        feed_class_names.should include('UserFeed')
+        feed_class_names.should include('AdminFeed')
+        feed_class_names.should include('TeamFeed')
+        feed_class_names.should include('EventFeed')
+      end
+
+    end
+
+    describe "feeding" do
+      let(:activity) { DistributableActivity.new }
+
+      before(:each) do
+        activity.soccer_teams = []
+        activity.events = []
+        @user   = mock_model(User)
+        @admin  = mock_model(User)
+        activity.users = [@user]
+        activity.admin = [@admin]
+      end
+
+      describe "feeds_for" do
+        it "should build feed for each audience member" do
+          DistributableActivity.feeds_for(activity).size.should == 2
+        end
+
+        it "should assign owner to correct feed type" do
+          feed_1, feed_2 = DistributableActivity.feeds_for(activity)
+          feed_1.should be_a(UserFeed)
+          feed_1.owner.should == @user
+          feed_2.should be_a(AdminFeed)
+          feed_2.owner.should == @admin
+        end
+
+        it "should use default batch size if iterating on arel scope" do
+          activity.users = User.scoped
+          activity.users.should_receive(:find_each).with(:batch_size => 500)
+          DistributableActivity.feeds_for(activity)
+        end
+
+        it "should use specified batch size if iterating on arel scope" do
+          activity.events = Event.scoped
+          activity.events.should_receive(:find_each).with(:batch_size => 100)
+          DistributableActivity.feeds_for(activity)
+        end
+      end
+
+      describe "distribute" do
+        it "should push activity to each feed" do
+          feed = UserFeed.new(mock_model(User))
+          DistributableActivity.stub!(:tap_feeds_for).with(activity).and_yield(feed)
+          feed.should_receive(:push).with(activity)
+          DistributableActivity.distribute(activity)
+        end
+      end
+    end
+
+  end
+
+  describe "instance methods" do
+    describe "distribute" do
+      it "should push itself to audience feeds" do
+        activity = DistributableActivity.new
+        feed = UserFeed.new(mock_model(User))
+        DistributableActivity.stub!(:tap_feeds_for).with(activity).and_yield(feed)
+        feed.should_receive(:push).with(activity)
+        activity.distribute
+      end
+    end
+  end
+end

data/spec/seymour/{acts_as_activity_spec.rb → dummy/test_activity_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Seymour::ActsAsActivity do
+describe "TestActivity" do
 
   describe "TestActivity in dummy app" do
     let(:activity)  { Factory(:test_activity) }
@@ -14,16 +14,14 @@ describe Seymour::ActsAsActivity do
 
     describe "distribute" do
       it "should push activity to audiences" do
-        feed = mock(UserFeed)
-        TestActivity.stub!(:feeds_for).and_return([feed])
-        feed.should_receive(:push).with(activity)
         activity.distribute
+        UserFeed.new(activity.actor).activity_ids.should == [activity.id]
       end
     end
 
     describe "feeds" do
       before(:each) do
-        activity.stub!(:authors).and_return([])
+        activity.stub!(:users).and_return([])
         activity.stub!(:events).and_return([])
       end
 
@@ -38,7 +36,7 @@ describe Seymour::ActsAsActivity do
       it "should create user feed for each author" do
         user_1 = mock_model(User)
         user_2 = mock_model(User)
-        activity.should_receive(:authors).and_return [user_1, user_2]
+        activity.should_receive(:users).and_return [user_1, user_2]
         user_feed_1 = mock(UserFeed)
         user_feed_2 = mock(UserFeed)
         UserFeed.should_receive(:new).ordered.with(user_1).and_return(user_feed_1)
@@ -49,19 +47,5 @@ describe Seymour::ActsAsActivity do
         feeds.should include(user_feed_2)
       end
     end
-
-    describe "class methods" do
-      describe "audience" do
-        it "should add events and authors audience names" do
-          TestActivity.audience_names.should include(:events)
-          TestActivity.audience_names.should include(:authors)
-        end
-
-        it "should set up feed class names" do
-          TestActivity.feed_class_names.should include("UserFeed")
-          TestActivity.feed_class_names.should include("EventFeed")
-        end
-      end
-    end
   end
 end

data/spec/seymour/renderable_spec.rb

@@ -1,9 +1,14 @@
 require 'spec_helper'
 
 describe Seymour::Renderable do
+
+  class RenderableActivity
+    include Seymour::Renderable
+  end
+
   describe "render" do
     let(:response) { mock(ActionDispatch::Response, :body => 'Lots of activity going on') }
-    let(:activity) { Factory(:test_activity) }
+    let(:activity) { RenderableActivity.new }
 
     before(:each) do
       ok_rack_response = lambda { |env| ['200', {}, response ] }

data/spec/spec_helper.rb

@@ -3,7 +3,11 @@ ENV["RAILS_ENV"] ||= 'test'
 
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 require 'rspec/rails'
-require "rails/test_help"
+# require "rails/test_help"
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files 
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 dir = File.dirname(File.expand_path(__FILE__))
 $LOAD_PATH.unshift dir + '/../lib'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seymour
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-17 00:00:00.000000000Z
+date: 2011-10-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70109574033260 !ruby/object:Gem::Requirement
+  requirement: &70358103560780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *70109574033260
+  version_requirements: *70358103560780
 - !ruby/object:Gem::Dependency
   name: redis-namespace
-  requirement: &70109574031400 !ruby/object:Gem::Requirement
+  requirement: &70358103559520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70109574031400
+  version_requirements: *70358103559520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70109574029860 !ruby/object:Gem::Requirement
+  requirement: &70358103557760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109574029860
+  version_requirements: *70358103557760
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70109574025400 !ruby/object:Gem::Requirement
+  requirement: &70358103556520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109574025400
+  version_requirements: *70358103556520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70109574024660 !ruby/object:Gem::Requirement
+  requirement: &70358103555440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109574024660
+  version_requirements: *70358103555440
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70109574023780 !ruby/object:Gem::Requirement
+  requirement: &70358103554120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109574023780
+  version_requirements: *70358103554120
 - !ruby/object:Gem::Dependency
   name: steak
-  requirement: &70109574022240 !ruby/object:Gem::Requirement
+  requirement: &70358103552600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109574022240
+  version_requirements: *70358103552600
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70109574021020 !ruby/object:Gem::Requirement
+  requirement: &70358103551580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109574021020
+  version_requirements: *70358103551580
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &70109574019820 !ruby/object:Gem::Requirement
+  requirement: &70358103549920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109574019820
+  version_requirements: *70358103549920
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
-  requirement: &70109574018420 !ruby/object:Gem::Requirement
+  requirement: &70358103548340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109574018420
+  version_requirements: *70358103548340
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70109574016740 !ruby/object:Gem::Requirement
+  requirement: &70358103546000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109574016740
+  version_requirements: *70358103546000
 description: Activity feed distribution for Rails applications
 email:
 - rosskaff@gmail.com
@@ -142,15 +142,16 @@ files:
 - app/assets/javascripts/seymour/application.js
 - app/assets/stylesheets/seymour/application.css
 - app/controllers/seymour/application_controller.rb
+- app/controllers/seymour/render_controller.rb
 - app/helpers/seymour/application_helper.rb
 - app/views/layouts/seymour/application.html.erb
 - config/routes.rb
 - lib/seymour/activity_feed.rb
 - lib/seymour/acts_as_activity.rb
+- lib/seymour/batched_user_enumerator.rb
 - lib/seymour/distributable.rb
 - lib/seymour/engine.rb
 - lib/seymour/redis.rb
-- lib/seymour/render_controller.rb
 - lib/seymour/renderable.rb
 - lib/seymour/version.rb
 - lib/seymour.rb
@@ -197,6 +198,7 @@ files:
 - spec/dummy/db/migrate/20111015001158_create_comments.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/lib/assets/.gitkeep
+- spec/dummy/lib/seymour/admin_feed.rb
 - spec/dummy/lib/seymour/event_feed.rb
 - spec/dummy/lib/seymour/player_feed.rb
 - spec/dummy/lib/seymour/user_feed.rb
@@ -209,7 +211,8 @@ files:
 - spec/dummy/spec/factories.rb
 - spec/redis-spec.conf
 - spec/seymour/activity_feed_spec.rb
-- spec/seymour/acts_as_activity_spec.rb
+- spec/seymour/distributable_spec.rb
+- spec/seymour/dummy/test_activity_spec.rb
 - spec/seymour/redis_spec.rb
 - spec/seymour/renderable_spec.rb
 - spec/seymour_spec.rb
@@ -229,7 +232,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 17470921223917954
+      hash: -259286616321666436
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -238,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 17470921223917954
+      hash: -259286616321666436
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -285,6 +288,7 @@ test_files:
 - spec/dummy/db/migrate/20111015001158_create_comments.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/lib/assets/.gitkeep
+- spec/dummy/lib/seymour/admin_feed.rb
 - spec/dummy/lib/seymour/event_feed.rb
 - spec/dummy/lib/seymour/player_feed.rb
 - spec/dummy/lib/seymour/user_feed.rb
@@ -297,7 +301,8 @@ test_files:
 - spec/dummy/spec/factories.rb
 - spec/redis-spec.conf
 - spec/seymour/activity_feed_spec.rb
-- spec/seymour/acts_as_activity_spec.rb
+- spec/seymour/distributable_spec.rb
+- spec/seymour/dummy/test_activity_spec.rb
 - spec/seymour/redis_spec.rb
 - spec/seymour/renderable_spec.rb
 - spec/seymour_spec.rb