streamit 0.0.5 → 0.0.6

data/Gemfile

@@ -7,4 +7,8 @@ gem "sqlite3-ruby", :require => "sqlite3"
 gem "mocha", ">= 0.9.10"
 gem "shoulda-context", "1.0.0.beta1"
 gem "launchy", ">= 0.3.7"
-gem "timecop", ">= 0.3.5"
+gem "timecop", ">= 0.3.5"
+
+gem "mongo_mapper", "~> 0.9.1"
+gem "mongo", "~> 1.3.1"
+gem 'bson_ext', "~> 1.3.1"

data/README.rdoc

@@ -1,2 +1,34 @@
 = Streamit (Under development)
 
+Provides feed stream like feature to rails apps
+
+class Stream
+  include MongoMapper::Document
+  include Streamit::ORM::MongoMapper
+end
+
+# "he9lin started watching auction ipad a minute ago"
+#
+# en:
+#   streamit:
+#     watching:
+#       create: "started watching"
+#
+class Watching < ActiveRecord::Base
+  belongs_to :watcher,      :class_name => "User", :foreign_key => "user_id"
+  belongs_to :watched_item, :class_name => "Item", :foreign_key => "item_id"
+  
+  stream :create, :actor    => :watcher,
+                  :receiver => :watched_item
+end
+
+# "he9lin edited profile image just now"
+#
+# en:
+#   users:
+#     update:
+#       image_url: "edited profile image"
+#
+class User < ActiveRecord::Base
+  stream :update, :attributes => :image_url
+end

data/TODO

@@ -1,35 +1,4 @@
 TODO: 
-- use background job like tool to process creating of streams
-- customizable views
-- cleanup old streams
-- add more detailed documentation
 
-class Streamit::Stream < ActiveRecord::Base
-  belongs_to :actor,    :polymorphic => true
-  belongs_to :subject,  :polymorphic => true
-  belongs_to :receiver, :polymorphic => true
-end
-
-# "he9lin started watching auction ipad 001 a minute ago"
-#
-# en:
-#   streamit:
-#     watching:
-#       create: "started watching"
-
-class Watching < ActiveRecord::Base
-  belongs_to :watcher,      :class_name => "User", :foreign_key => "user_id"
-  belongs_to :watched_item, :class_name => "Item", :foreign_key => "item_id"
-  
-  stream :create, :actor => :watcher,
-                  :receiver => :watched_item
-end
-
-# "he9lin just edited profile image just now"
-#
-# stream:
-#   stream_type: 'user.update.image_url'
-#
-class User < ActiveRecord::Base
-  stream :update, :attributes => :image_url
-end
+Support json format
+Refactor

data/app/controllers/streamit/streams_controller.rb

@@ -15,9 +15,14 @@ class Streamit::StreamsController < ApplicationController
 private
   
   def process_params
-    @streams = [:ago, :after, :limit].inject(store.scoped) do |scp, sym|
-      scp = scp.send(sym, params[sym]) if params[sym]
-      scp
+    @streams = [:ago, :limit].inject(store) do |memo, sym|
+      case sym
+      when :limit
+        params[sym] ? memo.send(sym, params[sym].to_i) : memo 
+      else
+        params[sym] ? memo.send(sym, params[sym]) : memo
+      end
     end
   end
+  
 end

data/app/views/streamit/streams/fetch.html.erb

@@ -1 +1 @@
-<%= render @streams %>
+<%= render @streams.all %>

data/lib/generators/streamit_generator.rb

@@ -26,6 +26,10 @@ CONTENT
   def create_stream_view
     copy_file "_stream.html.erb", "app/views/streamit/streams/_stream.html.erb"
   end
+  
+  def create_initializer
+    copy_file "streamit.rb", "app/config/initializers/streamit.rb"
+  end
 
   protected
 

data/lib/generators/templates/_stream.html.erb

@@ -1,4 +1,3 @@
-TODO:
 <%= content_tag_for(:li, stream) do %>
   <%= stream.actor %> <%= stream.stream_type_in_words %> <%= stream.subject %> to <%= stream.receiver %> <%= time_ago_in_words(stream.started_at) %> ago
-<% end %>
+<% end %>

data/lib/generators/templates/streamit.rb

@@ -0,0 +1,3 @@
+Streamit.setup do |config|
+  require 'streamit/orm/mongo_mapper'
+end

data/lib/streamit.rb

@@ -1,11 +1,15 @@
 require 'active_support/core_ext/hash'
+require "mongo_mapper"
+
+# We are required to choose a database name
+MongoMapper.database = "streamit-#{Rails.env}"
 
 module Streamit
   autoload :DSL,   'streamit/dsl'
   autoload :Store, 'streamit/store'
   
-  module ORM
-    autoload :ActiveRecord, 'streamit/orm/active_record'
+  def self.setup
+    yield self
   end
   
   # Set which store to use.
@@ -20,8 +24,30 @@ module Streamit
   def self.store; end
   
   def self.save_stream!(args)
-    store.save_stream!(args)
+    # insert to queue
+    self.queue << args
+  end
+  
+  # Queue related methods
+  def self.finish!
+    queue << nil
+    thread.join
+    @thread = nil
+    thread
   end
+  
+  def self.queue
+    @queue ||= Queue.new
+  end
+  
+  def self.thread
+    @thread ||= Thread.new do
+      while args = queue.pop
+        store.save_stream!(args)
+      end
+    end
+  end 
+  
 end
 
 require 'streamit/engine'

data/lib/streamit/dsl.rb

@@ -1,7 +1,11 @@
 module Streamit
   module DSL
     extend ActiveSupport::Concern
-    
+
+    # A class method for ActiveRecord models
+    #
+    # Sample usage:
+    #
     # stream :create, :actor => :watcher,
     #                 :receiver => :watched_item
     #
@@ -9,7 +13,7 @@ module Streamit
     #
     module ClassMethods
       def stream(action, options={})
-        options.assert_valid_keys(:stream_type, :actor, :subject, :receiver, :attributes)
+        options.assert_valid_keys(:actor, :subject, :receiver, :attributes)
         raise ArgumentError, ":create or :update required as first parameter" \
           unless [:create, :update].any? {|sym| sym == action }
         
@@ -27,26 +31,38 @@ module Streamit
         
         stream_type = attr_name.nil? ? "streamit.#{table_name}.#{action}" :
                                        "streamit.#{table_name}.#{action}.#{attr_name}"
-        
+                                       
         method_name = :"_#{stream_type.gsub('.', '_')}"
+        
         define_method(method_name) do
           stream_options = [:actor, :receiver, :subject].inject({}) do |memo, sym|
             memo[sym] = options[sym] ? send(options[sym]) : (sym == :actor ? self : nil)
             memo
           end.merge(:stream_type => stream_type, :started_at => Time.now)
 
-          attr_changed = if action == :update
-            case attributes
-            when nil
-              changed?
-            when Array
-              attributes.any? { |attr| send(:"#{attr}_changed?") }
-            when Symbol
-              send(:"#{attributes}_changed?")
+          if (action != :update || instance_variable_get("@attr_changed"))
+            Streamit.save_stream!(stream_options)
+          end
+            
+          instance_variable_set("@attr_changed", false)
+        end
+        
+        if action == :update
+          before_update_method_name = "_before#{method_name}"
+          define_method(before_update_method_name) do
+            attr_changed = if action == :update
+              case attributes
+              when nil
+                changed?
+              when Array
+                attributes.any? { |attr| send(:"#{attr}_changed?") }
+              when Symbol
+                send(:"#{attributes}_changed?")
+              end
             end
+            instance_variable_set("@attr_changed", attr_changed)
           end
-          
-          Streamit.save_stream!(stream_options) if (action != :update || attr_changed)
+          send(:"before_update", before_update_method_name)
         end
         
         send(:"after_#{action}", method_name)
@@ -54,4 +70,4 @@ module Streamit
     end
     
   end # DSL
-end # Streamit
+end # Streamit

data/lib/streamit/orm/active_record.rb

@@ -11,13 +11,11 @@ module Streamit
         
         default_scope order("started_at DESC")
         scope :ago,   lambda { |num| where ["started_at > ?", Time.now - num.to_i.seconds] }
-        scope :after, lambda { |id| where("id > #{id}") }
       end
       
       def save_stream!
         save!
       end
     end
-    
   end
 end

data/lib/streamit/orm/mongo_mapper.rb

@@ -0,0 +1,23 @@
+module Streamit
+  module ORM
+    module MongoMapper
+      extend  ActiveSupport::Concern
+      include Streamit::Store
+      
+      included do
+        key :stream_type, String
+        key :started_at, Time
+
+        belongs_to :actor,    :polymorphic => true
+        belongs_to :subject,  :polymorphic => true
+        belongs_to :receiver, :polymorphic => true
+        
+        scope :ago,   lambda { |num| where(:started_at.gt => Time.now - num.to_i.seconds) }
+      end
+      
+      def save_stream!
+        save!
+      end
+    end
+  end
+end

data/test/dummy/app/models/stream.rb

@@ -1,3 +1,4 @@
-class Stream < ActiveRecord::Base
-  include Streamit::ORM::ActiveRecord
+class Stream
+  include MongoMapper::Document
+  include Streamit::ORM::MongoMapper
 end

data/test/dummy/config/initializers/streamit.rb

@@ -0,0 +1,3 @@
+Streamit.setup do |config|
+  require 'streamit/orm/mongo_mapper'
+end

data/test/dummy/config/locales/en.yml

@@ -1,6 +1,3 @@
-# Sample localization file for English. Add more files in this directory for other locales.
-# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
-
 en:
   streamit:
     users:

data/test/integration/navigation_test.rb

@@ -1,17 +1,25 @@
 require 'test_helper'
 
 class NavigationTest < ActiveSupport::IntegrationCase
+
+  def wait_and_finish
+    Streamit.finish!
+  end
   
   def register_new_user
     visit "/users/new"
     fill_in "Name", :with => "davis"
     click_button "Create User"
+    wait_and_finish
   end
   
-  should "fetch recent streams" do
+  should "fetch limited number of streams" do
+    register_new_user
+    register_new_user
     register_new_user
     register_new_user
-    visit "/streamit/fetch"
+    wait_and_finish
+    visit "/streamit/fetch?limit=2"
     assert page.has_selector?("li.stream", :count => 2), "Expected 2 streams, Got:\n#{page.body.inspect}"
   end
   
@@ -21,15 +29,20 @@ class NavigationTest < ActiveSupport::IntegrationCase
     end
     register_new_user
     register_new_user
+    wait_and_finish
     visit "/streamit/fetch?ago=30"
     assert page.has_selector?("li.stream", :count => 2), "Expected 2 streams, Got:\n#{page.body.inspect}"
   end
   
-  should "fetch streams from after an id" do
+  should "fetch limited number of streams in last ? seconds" do
+    Timecop.freeze(Time.now - 30.seconds) do
+      register_new_user
+    end
     register_new_user
     register_new_user
     register_new_user
-    visit "/streamit/fetch?after=#{Stream.last.id}"
+    wait_and_finish
+    visit "/streamit/fetch?ago=30&limit=2"
     assert page.has_selector?("li.stream", :count => 2), "Expected 2 streams, Got:\n#{page.body.inspect}"
   end
 

data/test/streamit_test.rb

@@ -5,6 +5,10 @@ class StreamitTest < ActiveSupport::TestCase
     Streamit.store
   end
   
+  def wait_and_finish
+    Streamit.finish!
+  end
+  
   context "when user watches an item" do
     setup do
       TestWatching.class_eval do
@@ -15,6 +19,7 @@ class StreamitTest < ActiveSupport::TestCase
     
     should "create a stream if watching is created successfully" do
       @watch.save
+      wait_and_finish
       stream = stream_store.last
       assert_not_nil stream
       assert_equal "streamit.testwatchings.create",  stream.stream_type
@@ -27,7 +32,7 @@ class StreamitTest < ActiveSupport::TestCase
       TestWatching.class_eval do
         before_create { return false }
       end
-      assert_no_difference("stream_store.count") { @watch.save }
+      assert_no_difference("stream_store.count") { @watch.save; wait_and_finish }
     end
   end
   
@@ -44,6 +49,7 @@ class StreamitTest < ActiveSupport::TestCase
         stream :create
       end
       @user.save
+      wait_and_finish
       stream = stream_store.last
       assert_not_nil stream
       assert_equal "streamit.testusers.create", stream.stream_type
@@ -55,6 +61,7 @@ class StreamitTest < ActiveSupport::TestCase
     context "when user updates her attributes" do
       setup do
         @user.save
+        wait_and_finish
       end
 
       should "create a stream the attribute specified has changed" do
@@ -63,6 +70,7 @@ class StreamitTest < ActiveSupport::TestCase
         end
         @user.image_url = "image"
         @user.save
+        wait_and_finish
         stream = stream_store.last
         assert_not_nil stream
         assert_equal "streamit.testusers.update.image_url", stream.stream_type
@@ -77,6 +85,7 @@ class StreamitTest < ActiveSupport::TestCase
         end
         @user.name = "davis"
         @user.save
+        wait_and_finish
         stream = stream_store.last
         assert_not_nil stream
         assert_equal "streamit.testusers.update.default", stream.stream_type
@@ -91,6 +100,7 @@ class StreamitTest < ActiveSupport::TestCase
         end
         @user.name = "davis"
         @user.save
+        wait_and_finish
         stream = stream_store.last
         assert_not_nil stream
         assert_equal "streamit.testusers.update.default", stream.stream_type
@@ -109,6 +119,7 @@ class StreamitTest < ActiveSupport::TestCase
         end
         @user.image_url = "image"
         @user.save
+        wait_and_finish
         assert_equal 0, stream_store.count
       end
     end

data/test/test_helper.rb

@@ -19,4 +19,8 @@ Capybara.default_selector = :css
 ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
 
 # Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+class ActiveSupport::TestCase
+  setup { Streamit.store.delete_all }
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Lin He
@@ -38,11 +38,13 @@ files:
 - lib/streamit.rb
 - lib/generators/streamit_generator.rb
 - lib/generators/templates/_stream.html.erb
+- lib/generators/templates/streamit.rb
 - lib/streamit/dsl.rb
 - lib/streamit/engine.rb
 - lib/streamit/store.rb
 - lib/streamit/locales/en.yml
 - lib/streamit/orm/active_record.rb
+- lib/streamit/orm/mongo_mapper.rb
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/users_controller.rb
 - test/dummy/app/models/stream.rb
@@ -64,6 +66,7 @@ files:
 - test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/streamit.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/db/migrate/20110204210955_create_users.rb
 - test/dummy/db/migrate/20110204210910_create_items.rb
@@ -137,6 +140,7 @@ test_files:
 - test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/streamit.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/db/migrate/20110204210955_create_users.rb
 - test/dummy/db/migrate/20110204210910_create_items.rb