extraextra 0.3.0 → 1.0.0

data/Gemfile

@@ -1,12 +1,12 @@
 source "http://rubygems.org"
 
 # gem "candy" #not for now
-gem "mongo"
-gem "bson_ext"
-gem "jeweler"
-gem "rake"
+gem "mongo", "~>1.0.8"
+gem "bson_ext", "~>1.0.7"
+gem "jeweler", "~>1.4.0"
+gem "rake", "~>0.8.7"
 
 group :test do
-  gem "rspec"
-  gem "factory_girl"
+  gem "rspec", "~>1.3.0"
+  gem "factory_girl", "~>1.3.2"
 end

data/Gemfile.lock

@@ -22,9 +22,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bson_ext
-  factory_girl
-  jeweler
-  mongo
-  rake
-  rspec
+  bson_ext (~> 1.0.7)
+  factory_girl (~> 1.3.2)
+  jeweler (~> 1.4.0)
+  mongo (~> 1.0.8)
+  rake (~> 0.8.7)
+  rspec (~> 1.3.0)

data/README.rdoc

@@ -1,13 +1,8 @@
 = EXTRA! EXTRA! READ ALL ABOUT IT!
 
-Need to add a news feed to your application? EXTRA! EXTRA! is just the Gem 
-for you! This is a common need for many social applications. EXTRA! EXTRA! 
-uses MongoDB to give you super fast, super convenient feeds.
+Need to add a news feed to your application? EXTRA! EXTRA! is just the Gem for you! This is a common need for many social applications. EXTRA! EXTRA! uses MongoDB to give you super fast, super convenient feeds.
 
-== Quick Note
-
-Not all of this works yet. This is just a prerelease. README driven
-development FTW!
+Oh, and when I say "news feed", think "activity feed," not RSS. The stuff that's on the dashboard of every social app ever.
 
 == Install
 
@@ -29,14 +24,12 @@ It can be cloned via
 
 == Requirements
 
-* *Ruby-1.9* Sorry for you 1.8 people, 1.9 is the current version of Ruby.
-I test with 1.9.2.
-* *mongo* If you're going to use MongoDB...
+* Ruby 1.9: Sorry for you 1.8 people, 1.9 is the current version of Ruby. I test with 1.9.2.
+* mongo: If you're going to use MongoDB...
 
 == Usage
 
-The first thing you'll need to do is configure EXTRA! EXTRA! to connect to
-your MongoDB:
+The first thing you'll need to do is configure EXTRA! EXTRA! to connect to your MongoDB:
 
     Extra::Extra.source :host => "localhost", :port => "1337"
 
@@ -52,8 +45,7 @@ or
 
     $ Extra::Extra.the_scoop user
 
-This returns an array of Extra objects. To find out more about a particular 
-Extra:
+This returns an array of Extra objects. To find out more about a particular Extra:
 
     $ extra = Extra::Extra::! :sports, user, "hit a home run!"
 
@@ -70,17 +62,13 @@ Extra:
     $ extra.to_s
      => "Steve hit a home run"
 
-Two things: 'who' instantiates the object by sending it the find message, 
-passing an id. So that has to be defined in your user object. Secondly, the 
-name in to_s comes from user#username. If you use something else... I'll 
-provide a way to override these eventually.
+Two things: 'who' instantiates the object by sending it the find message, passing an id. So that has to be defined in your user object. Secondly, the name in to_s comes from user#username. If you use something else... I'll provide a way to override these eventually.
 
 To only see breaking news:
 
     $ Extra::Extra.breaking_news
 
-This will filter out only the news in the 'breaking' category. You can pass an 
-optional user:
+This will filter out only the news in the 'breaking' category. You can pass an optional user:
 
     $ Extra::Extra.breaking_news user
 
@@ -90,7 +78,7 @@ To find out what interesting things a users's friends have done:
 
     $ Extra::Extra.scope_the_scene user
 
-This also takes an optional user, just like *_news.
+This also takes a user, just like *_news.
 
 To define what who you're friends with, make a method on your user model
 named my_peeps. For a (hypothetical) example:
@@ -104,6 +92,16 @@ named my_peeps. For a (hypothetical) example:
 The my_peeps method should return an Array of ids. This method will be 
 called during scope_the_scene to determine what results get returned.
 
+== Roadmap
+
+1.0.0 was the release that implements the most basic functionality that I needed. I plan on integrating EXTRA! EXTRA! into a few of my projects, and seeing what could be useful. But here's a few things that are rolling around in my brain:
+
+* Limits on most queries. This'll probably get added real quick.
+* Generators for Rails that cover common use cases.
+* Possibly allowing for extra metadata to be attached to each Extra.
+
+We'll just roll with the punches. I'd love to hear some ideas.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.3.0
+1.0.0

data/extraextra.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{extraextra}
-  s.version = "0.3.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Steve Klabnik"]

data/lib/extra/extra.rb

@@ -86,7 +86,16 @@ module Extra
         collection.find(params).collect{|args| Extra.new args }
       end
 
-    end
+      # gets friend stuff
+      def scope_the_scene user
+        params = {
+          who_id: {"$in" => user.my_peeps},
+          who_class: user.class.to_s
+        }
+        collection.find(params).collect{|args| Extra.new args }
+      end
+
+    end #end the class << self
 
   end
 end

data/spec/extraextra_spec.rb

@@ -89,7 +89,7 @@ describe Extra::Extra do
 
     it "should filter some breaking news with a user" do
       steve = Factory(:user)
-      nobody = Factory(:user, :id => "2", :username => "nobody")
+      nobody = Factory(:user, :id => 2, :username => "nobody")
       Extra::Extra.source
       extra = Extra::Extra::! :breaking, steve, "hit a home run"
       extra = Extra::Extra::! :breaking, nobody, "hit a home run"
@@ -98,4 +98,25 @@ describe Extra::Extra do
     end
 
   end
+
+  describe "self#scope_the_scene" do
+    it "should exist" do
+      Extra::Extra.respond_to?(:scope_the_scene).should == true
+    end
+
+    it "should properly filter news" do
+      steve = Factory(:user)
+      maria = Factory(:user, :id => 2, :username => "maria")
+      nobody = Factory(:user, :id => 3, :username => "nobody")
+      steve.friends = [2]
+      Extra::Extra.source
+      extra = Extra::Extra::! :breaking, nobody, "hit a home run"
+      extra = Extra::Extra::! :breaking, nobody, "hit a home run"
+      extra = Extra::Extra::! :breaking, maria, "hit a home run"
+      extra = Extra::Extra::! :breaking, maria, "hit a home run"
+      extra = Extra::Extra::! :breaking, maria, "hit a home run"
+
+      Extra::Extra.scope_the_scene(steve).length.should == 3
+    end
+  end
 end

data/spec/factories/user.rb

@@ -2,9 +2,17 @@
 class User
   attr_accessor :id
   attr_accessor :username
+  attr_accessor :friends
 
   def save!; end
-  def self.find(id); User.new(:id => id, :username => "somebody") end
+
+  def self.find(id)
+    User.new(:id => id, :username => "somebody", :friends => [])
+  end
+
+  def my_peeps
+    friends
+  end
 
 end
 

metadata

@@ -3,10 +3,10 @@ name: extraextra
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 3
   - 0
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Steve Klabnik
@@ -87,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1378414745553800960
+      hash: 4230050462933773545
       segments: 
       - 0
       version: "0"