Stream 0.0.7 → 0.0.8

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 4
-:patch: 1
+:minor: 0
+:patch: 8

data/stream.gemspec

@@ -2,20 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{Stream}
-  s.version = "0.0.7"
+  s.version = "0.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gretchen Gapol"]
   s.date = %q{2011-06-27}
   s.description = %q{news feed}
   s.email = %q{ggapol@exist.com}
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
+  s.extra_rdoc_files = []
   s.files = [
     ".gitignore",
      "MIT-LICENSE",
-     "README.rdoc",
      "Rakefile",
      "VERSION.yml",
      "generators/stream/USAGE",
@@ -25,13 +22,10 @@ Gem::Specification.new do |s|
      "init.rb",
      "lib/stream.rb",
      "lib/stream/fires.rb",
-     "lib/stream/macros.rb",
      "lib/stream/matchers.rb",
      "stream.gemspec"
   ]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/gretch}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.1}
   s.summary = %q{news feed}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Stream
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -16,12 +16,10 @@ description: news feed
 email: ggapol@exist.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.rdoc
+extra_rdoc_files: []
 files:
 - .gitignore
 - MIT-LICENSE
-- README.rdoc
 - Rakefile
 - VERSION.yml
 - generators/stream/USAGE
@@ -31,15 +29,13 @@ files:
 - init.rb
 - lib/stream.rb
 - lib/stream/fires.rb
-- lib/stream/macros.rb
 - lib/stream/matchers.rb
 - stream.gemspec
 has_rdoc: true
 homepage: http://github.com/gretch
 licenses: []
 post_install_message: 
-rdoc_options:
-- --charset=UTF-8
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement

data/README.rdoc

@@ -1,102 +0,0 @@
-= TimelineFu
-
-Easily build timelines, much like GitHub's news feed.
-
-== Usage
-
-TimelineFu requires you to have a TimelineEvent model. 
-The simplest way is to use the generator.
-
-  $ script/generate timeline_fu && rake db:migrate
-        exists  db/migrate
-        create  db/migrate/20090333222034_create_timeline_events.rb
-        create  app/models/timeline_event.rb
-  # Migration blabber...
-
-Next step is to determine what generates an event in your various models.
-
-  class Post < ActiveRecord::Base
-    #...
-    belongs_to :author, :class_name => 'Person'
-    fires :new_post, :on    => :create,
-                     :actor => :author
-  end
-
-You can add 'fires' statements to as many models as you want on as many models
-as you want. 
-
-They are hooked for you after standard ActiveRecord events. In
-the previous example, it's an after_create on Posts. 
-
-=== Parameters for #fires
-
-You can supply a few parameters to fires, two of them are mandatory.
-- the first param is a custom name for the event type. It'll be your way of figuring out what events your reading back from the timeline_events table later.
-  - :new_post in the example
-
-The rest all fit neatly in an options hash.
-
-- :on => [ActiveRecord event] 
-  - mandatory. You use it to specify whether you want the event created after a create, update or destroy. You can also supply an array of events, e.g. [:create, :update].
-- :actor is your way of specifying who took this action.
-  - In the example, post.author is going to be this person.
-- :subject is automatically set to self, which is good most of the time.  You can however override it if you need to, using :subject.
-- :secondary_subject can let you specify something else that's related to the event. A comment to a blog post would be a good example.
-- :if => symbol or proc/lambda lets you put conditions on when a TimelineEvent is created. It's passed right to the after_xxx ActiveRecord event hook, so it's has the same behavior.
-
-Here's another example:
-
-  class Comment < ActiveRecord::Base
-    #...
-    belongs_to :commenter, :class_name => 'Person'
-    belongs_to :post
-    fires :new_comment, :on                 => :create,
-                        :actor              => :commenter,
-                        #implicit :subject  => self,
-                        :secondary_subject  => 'post',
-                        :if => lambda { |comment| comment.commenter != comment.post.author }
-  end
-
-=== TimelineEvent instantiation
-
-The ActiveRecord event hook will automatically instantiate a 
-TimelineEvent instance for you.
-It will receive the following parameters in #create!
-
-- event_type 
-  - "new_comment" in the comment example
-- actor 
-  - the commenter
-- subject
-  - the comment instance
-- secondary_subject
-  - the post instance
-
-The generated model stores most of its info as polymorphic relationships.
-
-  class TimelineEvent < ActiveRecord::Base
-    belongs_to :actor,              :polymorphic => true
-    belongs_to :subject,            :polymorphic => true
-    belongs_to :secondary_subject,  :polymorphic => true
-  end
-
-== How you actually get your timeline
-
-To get your timeline you'll probably have to create your own finder SQL or scopes 
-(if your situation is extremely simple). 
-
-TimelineFu is not currently providing anything to generate your timeline because 
-different situations will have wildly different requirements. Like access control 
-issues and actually just what crazy stuff you're cramming in that timeline.
-
-We're not saying it can't be done, just that we haven't done it yet. 
-Contributions are welcome :-)
-
-== Get it
-
-  # Gemfile
-  gem "timeline_fu"
-
-== License
-
-Copyright (c) 2008 James Golick, released under the MIT license

data/lib/stream/macros.rb

@@ -1,20 +0,0 @@
-module Stream
-  module Macros
-    def should_fire_event(event_type, opts = {})
-      should "fire #{event_type} on #{opts[:on]}" do
-        matcher = fire_event(event_type, opts)
-
-        assert_accepts matcher, self.class.name.gsub(/Test$/, '').constantize
-      end
-    end
-
-    def should_not_fire_event(event_type, opts = {})
-      should "fire #{event_type} on #{opts[:on]}" do
-        matcher = fire_event(event_type, opts)
-
-        assert_rejects matcher, self.class.name.gsub(/Test$/, '').constantize
-      end
-    end
-
-  end
-end