extraextra 0.1.1 → 0.1.2

data/Gemfile

@@ -8,4 +8,5 @@ gem "rake"
 
 group :test do
   gem "rspec"
+  gem "factory_girl"
 end

data/Gemfile.lock

@@ -3,6 +3,7 @@ GEM
   specs:
     bson (1.0.7)
     bson_ext (1.0.7)
+    factory_girl (1.3.2)
     gemcutter (0.6.1)
     git (1.2.5)
     jeweler (1.4.0)
@@ -22,6 +23,7 @@ PLATFORMS
 
 DEPENDENCIES
   bson_ext
+  factory_girl
   jeweler
   mongo
   rake

data/README.rdoc

@@ -56,15 +56,15 @@ This returns an array of Extra objects. To find out more about a particular
 
     $ extra = Extra::Extra::! :sports, user, "hit a home run!"
 
-    $ extra.who?
+    $ extra.who
      => #<User:0x0000010089ea80> 
-    $ extra.what?
+    $ extra.what
      => "hit a home run"
-    $ extra.where?
+    $ extra.where
      => nil # currently undecided
-    $ extra.when?
+    $ extra.when
      => 1283311813 
-    $ extra.how?
+    $ extra.how
      => nil # currently undecided
     $ extra.to_s
      => "Steve hit a home run"

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/extraextra.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{extraextra}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Steve Klabnik"]
@@ -14,7 +14,6 @@ Gem::Specification.new do |s|
   s.email = %q{steve@steveklabnik.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.md",
      "README.rdoc"
   ]
   s.files = [
@@ -23,7 +22,6 @@ Gem::Specification.new do |s|
      "Gemfile",
      "Gemfile.lock",
      "LICENSE",
-     "README.md",
      "README.rdoc",
      "Rakefile",
      "VERSION",
@@ -31,6 +29,7 @@ Gem::Specification.new do |s|
      "lib/extra/extra.rb",
      "lib/extraextra.rb",
      "spec/extraextra_spec.rb",
+     "spec/factories/user.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "test.rb"
@@ -42,6 +41,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Super simple news feeds powered by MongoDB.}
   s.test_files = [
     "spec/extraextra_spec.rb",
+     "spec/factories/user.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/extra/extra.rb

@@ -3,12 +3,29 @@ include Mongo
 
 module Extra
 
+  # Extra is the main class in Extra! Extra! It's what gets returned from
+  # queries, and is the main interface to the entire system. 
   class Extra
 
+    attr_accessor :category,
+                  :who_id, 
+                  :who_name,
+                  :who_class,
+                  :what,
+                  :when
+
+    # For now, this is just a simple sentence describing what happened.
+    # We'll see if something more complex makes sense later.
+    def to_s
+      "#{who_name} #{what}"
+    end
 
     class << self
       attr_accessor :db, :collection
 
+      # The source method is used to set up the connection to MongoDB. Right now
+      # it has to be called by the user before doing anything else, which sucks.
+      # I'll probably add in something to make it autoconnect soon.
       def source opts={}
         opts[:host] ||= "localhost"
         opts[:port] ||= 27017
@@ -16,20 +33,29 @@ module Extra
         self.collection = db["extras"]
       end
 
+      # Extra::Extra.! is the method used to report what's going on. It takes a
+      # symbol for a category, the user who did whatever's newsworthy, and some
+      # text that describes what happened.
       def !(category, user, text)
-        collection.insert category: category,
-                           who_id: user.id,
-                           who_name: user.username,
-                           who_class: user.class.to_s,
-                           what: text,
-                           when: Time.now.to_s
+
+        args = {
+          category: category,
+          who_id: user.id,
+          who_name: user.username,
+          who_class: user.class.to_s,
+          what: text,
+          when: Time.now.to_s 
+        }
+        collection.insert args
+        Extra.new args
       end
 
+      # This method returns all Extras that are associated with a given person.
       def read_all_about_it user
         
         collection.find(who_id: user.id,
                         who_class: user.class.to_s
-                       ).to_a
+                       ).collect{|args| Extra.new args }
         
       end
     end

data/spec/extraextra_spec.rb

@@ -10,8 +10,8 @@ describe Extra::Extra do
       obj = mock("Connection")
       db = mock("db")
       db.should_receive(:[])
-      obj.should_receive(:db).with("extraextra").and_return(db)
-      Mongo::Connection.should_receive(:new).with("localhost", 1337).and_return(obj)
+      obj.should_receive(:db).with("extraextra").twice.and_return(db)
+      Mongo::Connection.should_receive(:new).twice.and_return(obj)
       Extra::Extra.should_receive(:db=).and_return(db)
       Extra::Extra.should_receive(:db).and_return(db)
       
@@ -39,14 +39,20 @@ describe Extra::Extra do
     end
 
     it "should return Extras for the user" do
-      user = mock("User", :id => 1, :class => "User")
-      extra = mock("Extra")
-      collection = mock("collection")
-      collection.should_receive(:find).with(:who_id=>1, :who_class=>"User").and_return([extra])
-      Extra::Extra.should_receive(:collection).and_return(collection)
+      user = Factory(:user)
+      Extra::Extra.source
+      extra = Extra::Extra::! :breaking, user, "hit a home run"
       
       extras = Extra::Extra.read_all_about_it(user)
-      extras.should == [extra]
+      extras.length.should == 1
+      ex = extras.first
+      ex.category.should == extra.category
+      ex.who_id.should == extra.who_id
+      ex.who_name.should == extra.who_name
+      ex.who_class.should == extra.who_class
+      ex.what.should == extra.what
+      ex.when.should == extra.when
+      ex.to_s.should == extra.to_s
     end
   end
 end

data/spec/factories/user.rb

@@ -0,0 +1,13 @@
+# we just want a dummy user
+class User
+
+  def save!; end
+  def id=(id); end
+  def id; 1 end
+  def username=(username); end
+  def username; "steve" end
+
+end
+
+Factory.define :user do |u|
+end

data/spec/spec_helper.rb

@@ -3,7 +3,24 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'extraextra'
 require 'spec'
 require 'spec/autorun'
+require 'factory_girl'
+
+Dir.glob(File.join(File.dirname(__FILE__), '/factories/*.rb')).each do |factory|
+  require factory
+end
+
 
 Spec::Runner.configure do |config|
+
+  config.mock_with :rspec
+
+  config.after(:each) do
+
+    db   = Connection.new.db('extraextra')
+    unless db.class.to_s == "Spec::Mocks::Mock" 
+    coll = db.collection('extras')
+      coll.remove
+    end
+  end
   
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Steve Klabnik
@@ -55,7 +55,6 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.md
 - README.rdoc
 files: 
 - .document
@@ -63,7 +62,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.md
 - README.rdoc
 - Rakefile
 - VERSION
@@ -71,6 +69,7 @@ files:
 - lib/extra/extra.rb
 - lib/extraextra.rb
 - spec/extraextra_spec.rb
+- spec/factories/user.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - test.rb
@@ -88,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1570624595924975839
+      hash: 3599394924060512683
       segments: 
       - 0
       version: "0"
@@ -109,4 +108,5 @@ specification_version: 3
 summary: Super simple news feeds powered by MongoDB.
 test_files: 
 - spec/extraextra_spec.rb
+- spec/factories/user.rb
 - spec/spec_helper.rb

data/README.md

@@ -1,107 +0,0 @@
-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.
-
-## Quick Note ###############################################################
-
-Not all of this works yet. This is just a prerelease. README driven
-development FTW!
-
-## Install ##################################################################
-
-EXTRA! EXTRA! will be distributed via Rubygems, so just 
-
-    $ gem install extraextra
-
-and you'll be reading the news in no time!
-
-## Source ###################################################################
-
-The source of EXTRA! EXTRA! is on GitHub, and can be found here:
-
-    http://github.com/steveklabnik/extraextra
-
-It can be cloned via
-
-    $ git clone git://github.com/steveklabnik/extraextra.git
-
-## Requirements #############################################################
-
-* **Ruby 1.9** Sorry for you 1.8 people, 1.9 is the current version of Ruby.
-* **mongo** If you're going to use MongoDB...
-
-## Usage ####################################################################
-
-The first thing you'll need to do is configure EXTRA! EXTRA! to use your 
-MongoDB installation. 
-
-    Extra::Extra.source :host => "localhost", :port => "1337"
-
-To record something newsworthy, just do this:
-
-    $ Extra::Extra::! :breaking, user, "has just done something awesome!"
-
-To find out what interesting things a particular user has done:
-
-    $ Extra::Extra.read_all_about_it user
-
-or
-
-    $ Extra::Extra.the_scoop user
-
-This returns an array of Extra objects. To find out more about a particular
- Extra:
-
-    $ extra = Extra::Extra::! :sports, user, "hit a home run!"
-
-    $ extra.who?
-     => #<User:0x0000010089ea80> 
-    $ extra.what?
-     => "hit a home run"
-    $ extra.where?
-     => nil # currently undecided
-    $ extra.when?
-     => 1283311813 
-    $ extra.how?
-     => nil # currently undecided
-    $ extra.to_s
-     => "Steve hit a home run"
-
-The name in to_s comes from user#username. If you use something else... 
-I'll provide a way to override this eventually.
-
-To only see breaking news:
-
-    $ user.breaking_news
-
-This will filter out only the news in the 'breaking' category.
-
-To find out what interesting things a users's friends have done:
-
-    $ user.scope_the_scene
-
-To define what who you're friends with, make a method on your user model
-named my_peeps. For a (hypothetical) example:
-
-    class User
-      def my_peeps
-        User.friends.collect(&:id)
-      end
-    end
-
-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.
-
-## Contributing #############################################################
-
-Fork, commit, pull request. Bonus points for topic branches and great commit
-messages.
-
-In particular, I will accept most patches that add good aliases for methods.
-
-## This is just a cleverly named logging framework ##########################
-
-No, it's not. Shut up.