activity_stream 0.0.2 → 0.0.3

data/Gemfile

@@ -3,4 +3,5 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in activity_stream.gemspec
 gemspec
 
-gem "sqlite3-ruby", :require => "sqlite3"
+gem "sqlite3-ruby", :require => "sqlite3"
+gem "ruby-debug"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activity_stream (0.0.1)
+    activity_stream (0.0.3)
 
 GEM
   remote: http://rubygems.org/
@@ -28,10 +28,12 @@ GEM
     celerity (0.8.2)
     childprocess (0.1.3)
       ffi (~> 0.6.3)
+    columnize (0.3.1)
     culerity (0.2.12)
     ffi (0.6.3)
       rake (>= 0.8.7)
     json_pure (1.4.6)
+    linecache (0.43)
     mime-types (1.16)
     nokogiri (1.4.3.1)
     rack (1.1.0)
@@ -49,6 +51,11 @@ GEM
     rspec-rails (1.3.3)
       rack (>= 1.0.0)
       rspec (= 1.3.1)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
     rubyzip (0.9.4)
     selenium-webdriver (0.0.29)
       childprocess (>= 0.0.7)
@@ -67,4 +74,5 @@ DEPENDENCIES
   capybara
   rails (~> 2.3.10)
   rspec-rails (~> 1.3.0)
+  ruby-debug
   sqlite3-ruby

data/app/models/activity_stream/activity.rb

@@ -0,0 +1,77 @@
+module ActivityStream
+  
+  class Activity < ActiveRecord::Base
+  
+    belongs_to :actor, :polymorphic => true
+  
+    before_save :ensure_occurred_at_set
+  
+    # @param name [Symbol] (see ActivityStream::Definition#new)
+    # @return [ActivityStream::Definition] the new definitions
+    #
+    def self.define(name, &block)
+      definition = ActivityStream::DefinitionProxy.new(name)
+      definition.instance_eval(&block)
+      ActivityStream::Definition.register(definition)
+    end
+  
+    def self.new_with_name_and_metadata(name, metadata = {})
+      new(:kind => name.to_s, :metadata => metadata)
+    end
+  
+    named_scope :in_reverse_chronological_order, :order => 'occurred_at DESC'
+  
+    named_scope :in_chronological_order, :order => 'occurred_at ASC'
+
+    # @param actors [Array] An array of [ActorClass, actor_id] sets
+    #   or [ActorClass, [actor_id, actor_id, actor_id...]
+    #
+    named_scope :by_actors, lambda { |actors|
+      if actors.first.is_a?(Array)
+        conditions = actors.map do |(actor_type, actor_id)|
+          %{("activities"."actor_id" = #{actor_id.to_param} AND "activities"."actor_type" = '#{actor_type.to_param}')}
+        end
+        {:conditions => conditions.join(' OR ') }
+      elsif actors.first.is_a?(Class)
+        {:conditions => {:actor_id => actors.last, :actor_type => actors.first.to_param}}
+      else
+        {} # Not sure what to do here.
+      end
+    }
+  
+    serialize :metadata, ActivityStream::Metadata
+  
+    delegate :template, :icon_path, :to => :definition
+  
+    def metadata
+      self[:metadata] ||= ActivityStream::Metadata.new(self[:kind])
+    end
+  
+    def metadata=(new_data = {})
+      new_data = new_data.presence || {}
+      occurred_at = new_data.delete(:occurred_at)
+      new_data.each do |key, value|
+        metadata.store(key, value)
+      end
+    end
+  
+    def definition
+      ActivityStream::Definition.find_by_name(self[:kind])
+    end
+  
+    def kind=(val)
+      write_attribute(:kind, val.to_s)
+    end
+  
+    def kind
+      read_attribute(:kind).to_sym
+    end
+  
+    private
+  
+    def ensure_occurred_at_set
+      self.occurred_at ||= Time.now
+    end
+
+  end
+end

data/generators/activity_stream/activity_stream_generator.rb

@@ -6,8 +6,8 @@ class ActivityStreamGenerator < Rails::Generator::Base
   def manifest
     record do |m|
       
-      m.directory(File.join('app','models','activities'))
-      m.template('example_activity.rb', 'app/models/activities/example_activity.rb')
+      m.directory(File.join('config','initializers'))
+      m.template('initializer.rb', 'config/initializers/activity_stream.rb')
       
       user_model = 'app/models/user.rb'
       if File.exists?(user_model)

data/lib/activity_stream/actor.rb

@@ -25,23 +25,25 @@ module ActivityStream
       base.extend(ClassMethods)
       base.class_eval do
         has_many :activities, :as => :actor
-        activity_stream(:all, :actors => :activity_stream_actors)
+        activity_stream(:default, :actors => :followed_actors)
       end
     end
     
     # @param name [Symbol] An activity identifer defined by Activity.define
-    def create_activity(name)
-      
+    def publish_activity(name, metadata = {})
+      activity = ::Activity.new_with_name_and_metadata(name, metadata)
+      self.activities << activity
+      activity
     end
 
     # Creates and returns an ActivityStream::Stream for the predefined
     # list of actors. 
     # @param name [Symbol] The key of a defined activity stream
-    def activity_stream(name)
+    def activity_stream(name = :default)
       ActivityStream::Stream.new(name, self, self.class.defined_streams[name])
     end
-    
-    def activity_stream_actors
+    # Override this to change the default actors 
+    def followed_actors
       self.class.all.map{|actor| [actor.class, actor.id]}
     end
     

data/lib/activity_stream/definition.rb

@@ -2,51 +2,35 @@ require 'active_support/core_ext/array/extract_options'
 
 module ActivityStream
   
-  def definitions
-    @@definitions ||= []
-  end
-  
+  # Defines a type of activity. You don't actually interact with this class directly.
   class Definition
 
-    attr_reader :name
-    
-    # @param name [Symbol] the unique name of the Activity 
-    def initialize(name)
-      @name = name.to_sym
-      @metadata = {}
-    end
-    
-    # @param filename [String] the icon's name inside of the 
-    #  `public/images/activity_stream/icons` directory
-    def icon(filename)
-      @icon = filename
-    end
-    
-    # @overload metadata
-    #   @return [Hash] A hash of defined metadata
-    # @overload metadata(name, opts = {})
-    #   @param name [Symbol] the unique name for the metadata attribute
-    #   @option opts :default The default value for that metadata
-    def metadata(*args)
-      if args.empty?
-        @metadata
-      else
-        opts = args.extract_options!
-        @metadata[args.first.to_sym] = opts
-      end
+    attr_reader :name, :icon, :metadata, :template
+
+    # @param proxy [ActivityStream::DefinitionProxy] A constructed proxy that
+    #   will set the values for this Definition
+    def initialize(proxy)
+      @name = proxy[:name]
+      @metadata = proxy[:metadata] || {}
+      @template = proxy[:template] || 'activity'
+      @icon = proxy[:icon] || 'activity_icon.png'
     end
     
-    #
-    def template
-      'activity'
+    def icon_path
+      'activity_stream/icons/%s' % self.icon
     end
-    
+
     class << self 
       # @param definition [Definition] The definition to be made available
       # @return [Definition] Returns the registered definition
       def register(definition)
-        self.all << definition
-        definition
+        definition = new(definition) if definition.is_a? DefinitionProxy
+        if definition.is_a? Definition
+          self.all << definition
+          definition
+        else
+          false
+        end
       end
 
       # List of registered definitions
@@ -58,15 +42,15 @@ module ActivityStream
       #   end
       #   ActivityStream::Definition.all
       def all
-        @@definitions ||= []
+        @definitions ||= []
       end
       
       # Find a registered definition by its symbolic name
       # @param name [Symbol] the name to find
       # @return [ActivityStream::Definition]
       def find_by_name(name)
-        unless definition = all.find{|d| d.name == name.to_sym}
-          raise ActivityStream::UndefinedActivity, "Could not find a definition for `#{name}`"
+        unless definition = all.find{|definition| definition.name == name.to_sym}
+          raise UndefinedActivity, "Could not find a definition for `#{name}`"
         else
           definition
         end

data/lib/activity_stream/definition_proxy.rb

@@ -0,0 +1,49 @@
+module ActivityStream
+  
+  # Provides a DSL to define an Activity. It is used in Activity.define
+  class DefinitionProxy
+    
+    # @param name [Symbol] The name of the activity
+    def initialize(name)
+      @attributes = {
+        :name => name.to_sym,
+        :icon => 'activity_icon.png',
+        :metadata => {},
+        :template => 'activity'
+      }
+    end
+    
+    # Define the activity's icon
+    # @param filename [String] the icon's name inside of the 
+    #   `public/images/activity_stream/icons` directory
+    def icon(filename)
+      @attributes.store(:icon, filename)
+    end
+    
+    # Define metadata for the activity
+    # @param name [Symbol] the unique name for the metadata attribute
+    # @option opts :default The default value for that metadata
+    # @option opts [Boolean] :required (false) Mark this metadata as required
+    def metadata(*args)
+      opts = args.extract_options!
+      args.each do |name|
+        self.add_metadata(name, opts)
+      end
+    end
+    
+    # Define a custom template 
+    # @param name [String] the name of the template for this Activity.
+    #   Should be located in `app/views/activities/*`
+    def template(template_name)
+      @attributes.store(template_name)
+    end
+    
+    delegate :[], :to => :@attributes
+    
+    def add_metadata(name, opts = {})
+      @attributes[:metadata][name] = opts
+    end
+    
+  end
+  
+end

data/lib/activity_stream/metadata.rb

@@ -1,15 +1,56 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/object/singleton_class'
+
 module ActivityStream
   
+  # Storage for an activities metadata.
   class Metadata
     
+    attr_reader :data
+    
     def initialize(definition_name)
-      
+      @definition_name = definition_name
+      @data = {}
+    end
+
+    delegate :merge, :store, :to => :data
+
+    def definition
+      @definition ||= Definition.find_by_name(@definition_name)
+    end
+    
+    def to_yaml_properties
+      ["@data","@definition_name"]
+    end
+
+    def valid?
+      # TODO: Check definition for required keys, and loop through the
+      #       values in @data to see what is missing
+      true
+    end
+
+    def method_missing(method_name)
+      case method_name
+      when *definition.metadata.keys
+        @data[method_name]
+      else
+        super
+      end
     end
+
+    private
     
-    def store
-      @store ||= {}
+    def define_metadata_method(name)
+      self.singleton_class.class_eval do
+        define_method(name) do
+          self.data[name]
+        end
+        define_method(:"#{name.to_s}=") do |value|
+          self.data[name]= value
+        end
+      end
     end
     
   end
   
-end
+end

data/lib/activity_stream/stream.rb

@@ -12,11 +12,13 @@ module ActivityStream
       @collection = initialize_collection(opts[:actors])
     end
     
+    # @param reload [Boolean] Return to the database for new activities
+    # @return the activities for the collection of actors
     def activities(reload = false)
       if @activities && !reload
         @activities 
       else 
-        @activities = Activity.by_actors(@collection)
+        @activities = ::Activity.by_actors(@collection)
       end
     end
     

data/lib/activity_stream/version.rb

@@ -1,3 +1,3 @@
 module ActivityStream
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/lib/metadata_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe ActivityStream::Metadata do
+
+  let(:metadata) { ActivityStream::Metadata.new(:example_action) }
+  
+  before(:each) do
+    Activity.define(:example_action) do
+      metadata(:one_data)
+      metadata(:two_data)
+    end
+  end
+  
+  after(:each) do
+    ActivityStream::Definition.all.delete(:example_action)
+  end
+  
+  it 'should be initialized with a definition name' do
+    ActivityStream::Metadata.new(:example_action)
+  end
+  
+  context 'data storage' do
+    
+    it 'should accept new data' do
+      metadata.store(:one_data, 1)
+    end
+    
+    it 'should retrieve previously set data' do
+      metadata.store(:two_data, 2)
+      metadata.data[:two_data].should be(2)
+    end
+    
+  end
+  
+  context 'definition' do
+    
+    it 'should return one' do
+      metadata.definition.should be_a(ActivityStream::Definition)
+    end
+    
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: activity_stream
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Andrew Smith
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-02 00:00:00 -04:00
+date: 2010-11-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,16 +81,17 @@ files:
 - Rakefile
 - Readme.md
 - activity_stream.gemspec
-- app/models/activity.rb
+- app/models/activity_stream/activity.rb
 - generators/activity_stream/activity_stream_generator.rb
 - generators/activity_stream/lib/insert_commands.rb
-- generators/activity_stream/templates/example_activity.rb
+- generators/activity_stream/templates/initializer.rb
 - generators/activity_stream/templates/migration.rb
 - generators/activity_stream/templates/user.rb
 - lib/activity_stream.rb
 - lib/activity_stream/activities_helper.rb
 - lib/activity_stream/actor.rb
 - lib/activity_stream/definition.rb
+- lib/activity_stream/definition_proxy.rb
 - lib/activity_stream/errors.rb
 - lib/activity_stream/metadata.rb
 - lib/activity_stream/stream.rb
@@ -149,6 +150,7 @@ files:
 - spec/integration/activity_model_spec.rb
 - spec/lib/actor_spec.rb
 - spec/lib/definition_spec.rb
+- spec/lib/metadata_spec.rb
 - spec/lib/stream_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -239,5 +241,6 @@ test_files:
 - spec/integration/activity_model_spec.rb
 - spec/lib/actor_spec.rb
 - spec/lib/definition_spec.rb
+- spec/lib/metadata_spec.rb
 - spec/lib/stream_spec.rb
 - spec/spec_helper.rb

data/app/models/activity.rb

@@ -1,46 +0,0 @@
-class Activity < ActiveRecord::Base
-  
-  belongs_to :actor, :polymorphic => true
-  
-  # @param name [Symbol] (see ActivityStream::Definition#new)
-  # @return [ActivityStream::Definition] the new definitions
-  #
-  def self.define(name, &block)
-    definition = ActivityStream::Definition.new(name)
-    definition.instance_eval(&block)
-    ActivityStream::Definition.register(definition)
-  end
-  
-  named_scope :in_reverse_chronological_order, :order => 'occurred_at DESC'
-  
-  named_scope :in_chronological_order, :order => 'occurred_at ASC'
-
-  # @param actors [Array] An array of [ActorClass, actor_id] sets
-  #   or [ActorClass, [actor_id, actor_id, actor_id...]
-  #
-  named_scope :by_actors, lambda { |actors|
-    if actors.first.is_a?(Array)
-      conditions = actors.map do |(actor_type, actor_id)|
-        %{("activities"."actor_id" = #{actor_id.to_param} AND "activities"."actor_type" = '#{actor_type.to_param}')}
-      end
-      {:conditions => conditions.join(' OR ') }
-    elsif actors.first.is_a?(Class)
-      {:conditions => {:actor_id => actors.last, :actor_type => actors.first.to_param}}
-    else
-      {} # Not sure what to do here.
-    end
-  }
-  
-  serialize :metadata, ActivityStream::Metadata
-  
-  delegate :template, :icon, :to => :definition
-  
-  def metadata
-    self[:metadata] ||= ActivityStream::Metadata.new(self[:kind])
-  end
-  
-  def definition
-    ActivityStream::Definition.find_by_name(self[:kind])
-  end
-
-end