activity_feed 2.3.0 → 3.0.0

data/CHANGELOG.markdown

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 3.0.0 (2013-07-12)
+
+* Allow for bulk-loading of feed items. The `ActivityFeed.item_loader`
+  has been renamed to `ActivityFeed.items_loader`. The only difference
+  is that the proc is now passed an array of IDs, rather than an
+  individual ID.
+* Updated `item_loader` references to `items_loader` throughout internal
+  documentation and README.
+* Added `expire_feed_in` method alias for `expire_feed`.
+
 ## 2.3.0 (2013-05-03)
 
 * Added `check_item?(user_id, item_id, aggregate = ActivityFeed.aggregate)` to see if an item is in an activity feed.

data/README.markdown

@@ -42,7 +42,9 @@ end
 
 ### Advanced configuration options
 
-* `item_loader`: ActivityFeed supports loading items from your ORM (e.g. ActiveRecord) or your ODM (e.g. Mongoid) when a page for a user's activity feed is requested. This option should be set to a Proc that will be called passing the item ID as its only argument.
+* `items_loader`: ActivityFeed supports loading items from your ORM (e.g. ActiveRecord) or your ODM (e.g. Mongoid) when a page for a user's activity feed is requested. This option should be set to a Proc that will be called passing the item IDs as its only argument.
+
+NOTE: The following examples developing an activity feed with Mongoid using Mongoid 3.x.
 
 For example:
 
@@ -68,15 +70,20 @@ module ActivityFeed
       field :icon, type: String
       field :sticky, type: Boolean
 
-      index :user_id
+      index({ user_id: 1 }
 
       after_save :update_item_in_activity_feed
+      after_destroy :remove_item_from_activity_feed
 
       private
 
       def update_item_in_activity_feed
         ActivityFeed.update_item(self.user_id, self.id, self.updated_at.to_i)
       end
+
+      def remove_item_from_activity_feed
+        ActivityFeed.remove_item(self.user_id, self.id)
+      end
     end
   end
 end
@@ -85,7 +92,7 @@ end
 You would add the following option where you are configuring ActivityFeed as follows:
 
 ```ruby
-ActivityFeed.item_loader = Proc.new { |id| ActivityFeed::Mongoid::Item.find(id) }
+ActivityFeed.items_loader = Proc.new { |ids| ActivityFeed::Mongoid::Item.where(:id.in => ids).order_by(updated_at: :desc).to_a }
 ```
 
 If you need to handle any exceptions when loading activity feed items, please do this in the Proc.
@@ -103,9 +110,7 @@ activity feed.
 # Configure Mongoid
 require 'mongoid'
 
-Mongoid.configure do |config|
-  config.master = Mongo::Connection.new.db("activity_feed_gem_test")
-end
+Mongoid.load!("/path/to/your/mongoid.yml", :production)
 
 # Create a class for activity feed items
 module ActivityFeed
@@ -125,7 +130,7 @@ module ActivityFeed
       field :icon, type: String
       field :sticky, type: Boolean
 
-      index :user_id
+      index({ user_id: 1 }
 
       after_save :update_item_in_activity_feed
       after_destroy :remove_item_from_activity_feed
@@ -152,7 +157,7 @@ ActivityFeed.configure do |configuration|
   configuration.aggregate = false
   configuration.aggregate_key = 'aggregate'
   configuration.page_size = 25
-  configuration.item_loader = Proc.new { |id| ActivityFeed::Mongoid::Item.find(id) }
+  configuration.items_loader = Proc.new { |ids| ActivityFeed::Mongoid::Item.where(:id.in => ids).order_by(updated_at: :desc).to_a }
 end
 
 # Create a couple of activity feed items
@@ -193,9 +198,7 @@ feed = ActivityFeed.feed('david', 1)
 # Configure Mongoid
 require 'mongoid'
 
-Mongoid.configure do |config|
-  config.master = Mongo::Connection.new.db("activity_feed_gem_test")
-end
+Mongoid.load!("/path/to/your/mongoid.yml", :production)
 
 # Create a class for activity feed items
 module ActivityFeed
@@ -234,7 +237,7 @@ ActivityFeed.configure do |configuration|
   configuration.aggregate = true
   configuration.aggregate_key = 'aggregate'
   configuration.page_size = 25
-  configuration.item_loader = Proc.new { |id| ActivityFeed::Mongoid::Item.find(id) }
+  configuration.items_loader = Proc.new { |ids| ActivityFeed::Mongoid::Item.where(:id.in => ids).order_by(updated_at: :desc).to_a }
 end
 
 # Create activity feed items for a couple of users and aggregate the activity feed items from the second user in the first user's activity feed
@@ -300,6 +303,7 @@ ActivityFeed.total_items_in_feed(user_id, aggregate = ActivityFeed.aggregate)
 ActivityFeed.total_items(user_id, aggregate = ActivityFeed.aggregate)
 ActivityFeed.trim_feed(user_id, starting_timestamp, ending_timestamp, aggregate = ActivityFeed.aggregate)
 ActivityFeed.expire_feed(user_id, seconds, aggregate = ActivityFeed.aggregate)
+ActivityFeed.expire_feed_in(user_id, seconds, aggregate = ActivityFeed.aggregate)
 ActivityFeed.expire_feed_at(user_id, timestamp, aggregate = ActivityFeed.aggregate)
 ActivityFeed.remove_feeds(user_id)
 ```

data/lib/activity_feed/configuration.rb

@@ -4,8 +4,10 @@ module ActivityFeed
     # Redis instance.
     attr_accessor :redis
 
-    # Proc that will be called for loading an item from an ORM (e.g. ActiveRecord) or ODM (e.g. Mongoid). Proc will be called with the ID of the item from the feed.
-    attr_accessor :item_loader
+    # Proc that will be called for loading items from an
+    # ORM (e.g. ActiveRecord) or ODM (e.g. Mongoid). Proc
+    # will be called with the IDs of the items from the feed.
+    attr_accessor :items_loader
 
     # ActivityFeed namespace for Redis.
     attr_writer :namespace
@@ -19,7 +21,8 @@ module ActivityFeed
     # Page size to be used when paging through the activity feed.
     attr_writer :page_size
 
-    # Yield self to be able to configure ActivityFeed with block-style configuration.
+    # Yield self to be able to configure ActivityFeed with
+    # block-style configuration.
     #
     # Example:
     #
@@ -56,7 +59,7 @@ module ActivityFeed
     end
 
     # Default page size.
-    # 
+    #
     # @return the page size or the default of 25 if not set.
     def page_size
       @page_size ||= 25

data/lib/activity_feed/feed.rb

@@ -1,7 +1,7 @@
 module ActivityFeed
   module Feed
     # Retrieve a page from the activity feed for a given +user_id+. You can configure
-    # +ActivityFeed.item_loader+ with a Proc to retrieve an item from, for example,
+    # +ActivityFeed.items_loader+ with a Proc to retrieve items from, for example,
     # your ORM (e.g. ActiveRecord) or your ODM (e.g. Mongoid), and have the page
     # returned with loaded items rather than item IDs.
     #
@@ -12,22 +12,12 @@ module ActivityFeed
     # @return page from the activity feed for a given +user_id+.
     def feed(user_id, page, aggregate = ActivityFeed.aggregate)
       feederboard = ActivityFeed.feederboard_for(user_id, aggregate)
-      feed = feederboard.leaders(page, :page_size => ActivityFeed.page_size).inject([]) do |feed_items, feed_item|
-        item = if ActivityFeed.item_loader
-          ActivityFeed.item_loader.call(feed_item[:member])
-        else
-          feed_item[:member]
-        end
-
-        feed_items << item unless item.nil?
-        feed_items
-      end
-
-      feed.nil? ? [] : feed
+      feed_items = feederboard.leaders(page, :page_size => ActivityFeed.page_size)
+      load_feed_items(feed_items)
     end
 
     # Retrieve the entire activity feed for a given +user_id+. You can configure
-    # +ActivityFeed.item_loader+ with a Proc to retrieve an item from, for example,
+    # +ActivityFeed.items_loader+ with a Proc to retrieve items from, for example,
     # your ORM (e.g. ActiveRecord) or your ODM (e.g. Mongoid), and have the page
     # returned with loaded items rather than item IDs.
     #
@@ -37,23 +27,13 @@ module ActivityFeed
     # @return the full activity feed for a given +user_id+.
     def full_feed(user_id, aggregate = ActivityFeed.aggregate)
       feederboard = ActivityFeed.feederboard_for(user_id, aggregate)
-      feed = feederboard.leaders(1, :page_size => feederboard.total_members).inject([]) do |feed_items, feed_item|
-        item = if ActivityFeed.item_loader
-          ActivityFeed.item_loader.call(feed_item[:member])
-        else
-          feed_item[:member]
-        end
-
-        feed_items << item unless item.nil?
-        feed_items
-      end
-
-      feed.nil? ? [] : feed
+      feed_items = feederboard.leaders(1, :page_size => feederboard.total_members)
+      load_feed_items(feed_items)
     end
 
     # Retrieve a page from the activity feed for a given +user_id+ between a
     # +starting_timestamp+ and an +ending_timestamp+. You can configure
-    # +ActivityFeed.item_loader+ with a Proc to retrieve an item from, for example,
+    # +ActivityFeed.items_loader+ with a Proc to retrieve items from, for example,
     # your ORM (e.g. ActiveRecord) or your ODM (e.g. Mongoid), and have the feed data
     # returned with loaded items rather than item IDs.
     #
@@ -65,18 +45,8 @@ module ActivityFeed
     # @return feed items from the activity feed for a given +user_id+ between the +starting_timestamp+ and +ending_timestamp+.
     def feed_between_timestamps(user_id, starting_timestamp, ending_timestamp, aggregate = ActivityFeed.aggregate)
       feederboard = ActivityFeed.feederboard_for(user_id, aggregate)
-      feed = feederboard.members_from_score_range(starting_timestamp, ending_timestamp).inject([]) do |feed_items, feed_item|
-        item = if ActivityFeed.item_loader
-          ActivityFeed.item_loader.call(feed_item[:member])
-        else
-          feed_item[:member]
-        end
-
-        feed_items << item unless item.nil?
-        feed_items
-      end
-
-      feed.nil? ? [] : feed
+      feed_items = feederboard.members_from_score_range(starting_timestamp, ending_timestamp)
+      load_feed_items(feed_items)
     end
 
     # Return the total number of pages in the activity feed.
@@ -133,6 +103,8 @@ module ActivityFeed
       ActivityFeed.redis.expire(ActivityFeed.feed_key(user_id, aggregate), seconds)
     end
 
+    alias_method :expire_feed_in, :expire_feed
+
     # Expire an activity feed at a given timestamp.
     #
     # @param user_id [String] User ID.
@@ -141,5 +113,22 @@ module ActivityFeed
     def expire_feed_at(user_id, timestamp, aggregate = ActivityFeed.aggregate)
       ActivityFeed.redis.expireat(ActivityFeed.feed_key(user_id, aggregate), timestamp)
     end
+
+    private
+
+    # Load feed items from the `ActivityFeed.items_loader` if available,
+    # otherwise return the individual members from the feed items.
+    #
+    # @param feed_items [Array] Array of hash feed items as `[{:member=>"5", :rank=>1, :score=>1373564960.0}, ...]`
+    #
+    # @return Array of feed items
+    def load_feed_items(feed_items)
+      feed_item_ids = feed_items.collect { |feed_item| feed_item[:member] }
+      if ActivityFeed.items_loader
+        ActivityFeed.items_loader.call(feed_item_ids)
+      else
+        feed_item_ids
+      end
+    end
   end
 end

data/lib/activity_feed/version.rb

@@ -1,3 +1,3 @@
 module ActivityFeed
-  VERSION = "2.3.0"
+  VERSION = '3.0.0'
 end

data/spec/activity_feed/feed_spec.rb

@@ -205,8 +205,8 @@ describe ActivityFeed::Feed do
   describe 'ORM or ODM loading' do
     describe 'ActiveRecord' do
       it 'should be able to load an item via ActiveRecord when requesting a feed' do
-        ActivityFeed.item_loader = Proc.new do |id|
-          ActivityFeed::ActiveRecord::Item.find(id)
+        ActivityFeed.items_loader = Proc.new do |ids|
+          ActivityFeed::ActiveRecord::Item.find(ids)
         end
 
         feed = ActivityFeed.feed('david', 1)
@@ -228,7 +228,9 @@ describe ActivityFeed::Feed do
 
     describe 'Mongoid' do
       it 'should be able to load an item via Mongoid when requesting a feed' do
-        ActivityFeed.item_loader = Proc.new { |id| ActivityFeed::Mongoid::Item.find(id) }
+        ActivityFeed.items_loader = Proc.new do |ids|
+          ActivityFeed::Mongoid::Item.find(ids)
+        end
 
         feed = ActivityFeed.feed('david', 1)
         feed.length.should eql(0)
@@ -249,8 +251,8 @@ describe ActivityFeed::Feed do
     end
   end
 
-  describe '#expire_feed' do
-    it 'should set an expiration on an activity feed' do
+  describe '#expire_feed and #expire_feed_in' do
+    it 'should set an expiration on an activity feed using #expire_feed' do
       add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE)
 
       ActivityFeed.expire_feed('david', 10)
@@ -259,6 +261,16 @@ describe ActivityFeed::Feed do
         ttl.should be <= 10
       end
     end
+
+    it 'should set an expiration on an activity feed using #expire_feed_in' do
+      add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE)
+
+      ActivityFeed.expire_feed_in('david', 10)
+      ActivityFeed.redis.ttl(ActivityFeed.feed_key('david')).tap do |ttl|
+        ttl.should be > 1
+        ttl.should be <= 10
+      end
+    end
   end
 
   describe '#expire_feed_at' do

data/spec/spec_helper.rb

@@ -17,7 +17,7 @@ RSpec.configure do |config|
     DatabaseCleaner.clean
 
     ActivityFeed.configure do |configuration|
-      configuration.item_loader = nil
+      configuration.items_loader = nil
       configuration.aggregate = false
       configuration.redis = Redis.new(:db => 15)
     end

data/spec/version_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'ActivityFeed::VERSION' do
-  it "should be the correct version" do
-    ActivityFeed::VERSION.should == '2.3.0'
+  it 'should be the correct version' do
+    ActivityFeed::VERSION.should == '3.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activity_feed
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-03 00:00:00.000000000 Z
+date: 2013-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -216,7 +216,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4479539862674226365
+      hash: 3361752817333604694
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4479539862674226365
+      hash: 3361752817333604694
 requirements: []
 rubyforge_project: activity_feed
 rubygems_version: 1.8.25