streamit 0.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Lin He
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,2 @@
+= Streamit (Under development)
+

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Streamit'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/generators/streamit_generator.rb

@@ -0,0 +1,35 @@
+class StreamitGenerator < Rails::Generators::NamedBase
+  
+  source_root File.expand_path("../templates", __FILE__)
+  
+  class_option :migration, :type => :boolean, :default => true
+  
+  def invoke_model
+    invoke "model", [name].concat(migration_columns),
+      :timestamps => false, :test_framework => false, :migration => options.migration?
+  end
+
+  def add_model_config
+    inject_into_class "app/models/#{file_name}.rb", class_name, <<-CONTENT
+  include Streamit::ORM::#{Rails::Generators.options[:rails][:orm].to_s.camelize}
+CONTENT
+  end
+
+  def add_application_config
+    inject_into_class "config/application.rb", "Application", <<-CONTENT
+    # Set stream store
+    config.streamit.set_store = lambda { ::#{class_name} }
+
+CONTENT
+  end
+  
+  def create_stream_view
+    copy_file "_stream.html.erb", "app/views/streamit/streams/_stream.html.erb"
+  end
+
+  protected
+
+  def migration_columns
+    %w(stream_type:string started_at:datetime actor_id:integer actor_type:string subject_id:integer subject_type:string receiver_id:integer receiver_type:string)
+  end
+end

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

@@ -0,0 +1,4 @@
+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 %>

data/lib/streamit/dsl.rb

@@ -0,0 +1,57 @@
+module Streamit
+  module DSL
+    extend ActiveSupport::Concern
+    
+    # stream :create, :actor => :watcher,
+    #                 :receiver => :watched_item
+    #
+    # stream :update, :attributes => :image_url, 
+    #
+    module ClassMethods
+      def stream(action, options={})
+        options.assert_valid_keys(:stream_type, :actor, :subject, :receiver, :attributes)
+        raise ArgumentError, ":create or :update required as first parameter" \
+          unless [:create, :update].any? {|sym| sym == action }
+        
+        table_name = self.model_name.downcase.pluralize
+        attributes = options[:attributes]
+        
+        attr_name = if action == :update
+          case attributes
+          when Array, nil
+            :default
+          when Symbol
+            attributes
+          end
+        end
+        
+        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?")
+            end
+          end
+          
+          Streamit.save_stream!(stream_options) if (action != :update || attr_changed)
+        end
+        
+        send(:"after_#{action}", method_name)
+      end
+    end
+    
+  end # DSL
+end # Streamit

data/lib/streamit/engine.rb

@@ -0,0 +1,17 @@
+module Streamit
+  class Engine < Rails::Engine
+    config.streamit = ActiveSupport::OrderedOptions.new
+    
+    initializer "streamit.active_record" do
+      ActiveSupport.on_load(:active_record) do
+        include Streamit::DSL
+      end
+    end
+    
+    initializer "streamit.set_store" do |app|
+      if app.config.streamit.set_store
+        Streamit.set_store(&app.config.streamit.set_store)
+      end
+    end
+  end
+end

data/lib/streamit/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  streamit:
+    users:
+      create: "registered"

data/lib/streamit/orm/active_record.rb

@@ -0,0 +1,23 @@
+module Streamit
+  module ORM
+    module ActiveRecord
+      extend  ActiveSupport::Concern
+      include Streamit::Store
+      
+      included do
+        belongs_to :actor,    :polymorphic => true
+        belongs_to :subject,  :polymorphic => true
+        belongs_to :receiver, :polymorphic => true
+        
+        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/store.rb

@@ -0,0 +1,20 @@
+module Streamit
+  module Store
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      def save_stream!(args)
+        store = new(args)
+        store.save_stream!
+      end
+    end
+    
+    def stream_type_in_words
+      I18n.t(stream_type)
+    end
+    
+    def save_stream!
+      raise NotImplementedError
+    end
+  end
+end

data/lib/streamit.rb

@@ -0,0 +1,30 @@
+require 'active_support/core_ext/hash'
+
+module Streamit
+  autoload :DSL,   'streamit/dsl'
+  autoload :Store, 'streamit/store'
+  
+  module ORM
+    autoload :ActiveRecord, 'streamit/orm/active_record'
+  end
+  
+  # Set which store to use.
+  #
+  #   Streamit.set_store { Stream }
+  #
+  def self.set_store(&block)
+    singleton_class.send :define_method, :store, &block
+  end
+
+  # Place holder for the store.
+  def self.store; end
+  
+  def self.save_stream!(args)
+    store.save_stream!(args)
+  end
+end
+
+require 'streamit/engine'
+
+require 'active_support/i18n'
+I18n.load_path << File.expand_path('../streamit/locales/en.yml', __FILE__)

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: streamit
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Lin He
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-07 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Provide feed stream like feature to applications
+email: 
+- he9lin@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/streamit_generator.rb
+- lib/generators/templates/_stream.html.erb
+- lib/streamit/dsl.rb
+- lib/streamit/engine.rb
+- lib/streamit/locales/en.yml
+- lib/streamit/orm/active_record.rb
+- lib/streamit/store.rb
+- lib/streamit.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provide feed stream like feature
+test_files: []
+