tyler-makes_events 0.6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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.textile

@@ -0,0 +1,41 @@
+h1. MakesEvents
+
+
+h2. Overview
+
+MakesEvents makes it easy to create running logs of user activity.  Why would you want to do that?  Well, the reason I made it is because I wanted a Facebook-like feed of recent user activity on a particular site (heavyink.com).  The naive first-pass implementation involved grabbing the records from the last x days for a particular user from a variety of tables. (Something like 20.)  This obviously would not scale.  What you'd actually want to do is just note particular user activity in a single table so you can just select from there and be done with it.
+
+
+h2. Example
+
+<pre>
+  <code>
+    class User &lt; ActiveRecord::Base
+      owns_events
+    end
+
+    class Pet &lt; ActiveRecord::Base
+      belongs_to :user
+
+      makes_events :owner => :user do
+        event :new_pet, :after_create
+        event :pet_died, :after_destroy
+        event :pet_changed_names, :after_update, :changed => :name
+        event :got_a_monkey, :after_save do |pet|
+          pet.type_changed? && pet.type == 'monkey'
+        end
+      end
+    end
+  </code>
+</pre>
+
+Here we have a trivial example where we have Users who have Pets.  We want to log every time a user saves a new pet, deletes a pet, changes a pet's name, or when the pet is a monkey.
+
+First we say that Pets make events using the _makes_events_ method.  We can pass a hash of options to that method which propagate down to the individual _event_ methods within the block.
+
+The individual _event_ calls are fairly straightforward. The first creates the :new_pet event type, which gets triggered on the _after_create_ callback.  Likewise, we make a :pet_died event type which gets triggered on the _after_destroy_ callback.
+
+The third _event_ is slightly more complicated in that it relies on the :changed option.  In this case, we want the event to be triggered on the _after_update_ callback, but only if the _name_ field has changed.  (This relies on Rails 2.1's Dirty fields functionality.)
+
+The last _event_ call is more complicated yet. Passing a block to _event_ allows you to control whether or not the event is triggered based on the return value of that block.  In this case, the event will only be triggered if the pet's type has been set to "monkey".  One important note is that the block you pass to it will actually be run in a _before_save_ callback.  This allows you to check whether a field has been changed and trigger the event based on that.
+

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the makes_events plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the makes_events plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MakesEvents'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/generators/makes_events/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    ./script/generate makes_events EventModel
+    
+    This will create:
+        what/will/it/create

data/generators/makes_events/makes_events_generator.rb

@@ -0,0 +1,15 @@
+class MakesEventsGenerator < Rails::Generator::NamedBase
+  def initialize(runtime_args, runtime_options={})
+    super
+  end
+  
+  def manifest
+    record do |m|
+      m.directory File.join('app/models')
+      m.directory File.join('db/migrate')
+      
+      m.migration_template 'migrate/create_events.rb', 'db/migrate'
+      m.file 'models/event.rb', 'app/models/event.rb'
+    end
+  end
+end

data/generators/makes_events/templates/migrate/create_events.rb

@@ -0,0 +1,17 @@
+class CreateEvents < ActiveRecord::Migration
+  def self.up
+    create_table :events do |t|
+      t.integer :owner_id
+      t.string :owner_type
+      t.integer :target_id
+      t.string :target_type
+      t.string :event_type
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :events
+  end
+end

data/generators/makes_events/templates/models/event.rb

@@ -0,0 +1,4 @@
+class Event < ActiveRecord::Base
+  belongs_to :owner, :polymorphic => true
+  belongs_to :target, :polymorphic => true
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'lib', 'makes_events.rb')

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/makes_events.rb

@@ -0,0 +1,85 @@
+module MakesEvents
+  module ClassMethods
+    def makes_events(options={})
+      extend MakesEvents::MakerMethods::ClassMethods
+      include MakesEvents::MakerMethods::InstanceMethods
+      
+      has_many :events, :as => :target
+      
+      @_makes_events_make_options = options
+      yield
+    end
+    
+    def owns_events
+      extend MakesEvents::OwnerMethods::ClassMethods
+      include MakesEvents::OwnerMethods::InstanceMethods
+      
+      has_many :events, :as => :owner
+    end
+  end
+  
+  module MakerMethods
+    module ClassMethods
+      def event(type, happens, options={}, &block)
+        set_conditional(type,&block) if block
+        
+        field = options.delete(:changed)
+        set_change_conditional(type,field) if field
+        
+        send(happens) do |object|
+          check = !@_makes_event_checks ||
+            !@_makes_event_checks.has_key?(type) || 
+            @_makes_event_checks.delete(type)
+          log_event(type, object, options) if check
+        end
+      end
+    
+      def log_event(type, object, options={})
+        options = @_makes_events_make_options.merge(options)
+        
+        Event.create :event_type => type.to_s,
+          :target => object,
+          :owner => options[:owner] ? object.send(options[:owner]) : object.owner
+      end
+      
+      private
+      
+      def set_change_conditional(type,field)
+        return set_conditional(type) { |o| o.changed? } if field == true
+        set_conditional(type) { |o| o.send("#{field}_changed?") }
+      end
+      
+      def set_conditional(type,&block)
+        send(:before_save) { |object|
+          @_makes_event_checks ||= {}
+          @_makes_event_checks[type] = !!block.call(object)
+          true
+        }
+      end
+    end
+    
+    module InstanceMethods
+      def log_event(type, options={})
+        self.class.log_event(type,self,options)
+      end
+    end
+  end
+  
+  module OwnerMethods
+    module ClassMethods
+      def recent_events(users,date=15.days.ago)
+        Event.find(:all, 
+          :conditions => ["owner_type = ? AND owner_id in (?) AND created_at >= ?",
+            self.to_s, users.map(&:id), date])
+      end
+    end
+    
+    module InstanceMethods
+      def recent_events(date=15.days.ago)
+        self.events.find(:all, :conditions => ["created_at >= ?", date])
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend MakesEvents::ClassMethods

data/makes_events.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |s|
+  s.name     = "makes_events"
+  s.version  = "0.6"
+  s.date     = "2008-09-29"
+  s.summary  = "Easy event logger plugin for Rails 2.1."
+  s.email    = "tbmcmullen@gmail.com"
+  s.homepage = "http://github.com/tyler/makes_events"
+  s.description = "Easy event logger plugin for Rails 2.1.  (Think:  Facebook's recent activity feed.)"
+  s.has_rdoc = false
+  s.authors  = ["Tyler McMullen"]
+  s.files    = ["generators",
+                "makes_events.gemspec",
+                "install.rb",
+                "uninstall.rb",
+                "init.rb",
+                "README.textile",
+                "Rakefile",
+                "MIT-LICENSE",
+                "generators/makes_events",
+                "lib/makes_events.rb",
+                "tasks/makes_events_tasks.rake",
+                "test/makes_events_test.rb",
+                "generators/makes_events/templates",
+                "generators/makes_events/USAGE",
+                "generators/makes_events/makes_events_generator.rb",
+                "generators/makes_events/templates/migrate",
+                "generators/makes_events/templates/models",
+                "generators/makes_events/templates/migrate/create_events.rb",
+                "generators/makes_events/templates/models/event.rb"]
+
+  s.add_dependency("activerecord", ["> 2.1.0"])
+end

data/tasks/makes_events_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :makes_events do
+#   # Task goes here
+# end

data/test/makes_events_test.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class MakesEventsTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: tyler-makes_events
+version: !ruby/object:Gem::Version 
+  version: "0.6"
+platform: ruby
+authors: 
+- Tyler McMullen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+description: "Easy event logger plugin for Rails 2.1.  (Think:  Facebook's recent activity feed.)"
+email: tbmcmullen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- generators
+- makes_events.gemspec
+- install.rb
+- uninstall.rb
+- init.rb
+- README.textile
+- Rakefile
+- MIT-LICENSE
+- generators/makes_events
+- lib/makes_events.rb
+- tasks/makes_events_tasks.rake
+- test/makes_events_test.rb
+- generators/makes_events/templates
+- generators/makes_events/USAGE
+- generators/makes_events/makes_events_generator.rb
+- generators/makes_events/templates/migrate
+- generators/makes_events/templates/models
+- generators/makes_events/templates/migrate/create_events.rb
+- generators/makes_events/templates/models/event.rb
+has_rdoc: false
+homepage: http://github.com/tyler/makes_events
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Easy event logger plugin for Rails 2.1.
+test_files: []
+