netphase-acts_as_eventable 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [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

@@ -0,0 +1,184 @@
+= ActsAsEventable
+
+This "acts_as" module makes it extremely simple to add events to a model that will
+be stored in a table for later querying or reporting on. The events have an event 
+type, which also corresponds to how the event is triggered. 
+
+An example of acts_as_eventable's use would be if you needed to track every time a
+particular object was viewed on your site. You could setup and event type of 'view',
+then simply call my_object.view from the the controller's show method (assuming a 
+restful design is in play, of course). This would trigger an entry in the event table,
+noting the object that was viewed.  
+
+The events can be anything you want, and you can call the methods from anywhere. It 
+works whether the object is a first-class Active Record object, or an associated 
+object (via has_xxx or belongs_to).
+
+This is the initial commit, and I have not written any tests or comments in the code
+as of yet. Soon come, mon!  
+
+== Install
+
+Acts As Eventable is hosted on github. It may be installed as a gem or a plugin. To 
+install as a gem, do the following:
+
+  sudo gem install netphase-acts_as_eventable
+  
+To install as a plugin, do this:
+
+  script/plugin install git://github.com/netphase/acts_as_eventable.git
+  
+You may also get the latest from github.com by cloning from git://github.com/netphase/acts_as_eventable.git
+
+== Setup
+
+This code does not require changing any current database tables.  It only requires 
+adding one migration for two new tables which contain the event types and track the
+events.
+
+If you are using acts_as_eventable as a plugin, you can run this to create the migration:
+
+  script/generate acts_as_eventable_migration
+  
+If you are using the gem, create a migration with the following:
+  
+  def self.up
+     create_table :event_types do |t|
+       t.string :name
+     end
+
+     create_table :events do |t|
+       t.integer :eventable_id, :default => 0, :null => false
+       t.string :eventable_type, :limit => 25, :default => "", :null => false
+       t.integer :event_type_id
+
+       t.timestamps
+     end
+     add_index :events, [:eventable_id, :eventable_type]  
+     add_index :events, :event_type_id
+   end
+
+   def self.down
+     drop_table :events
+     drop_table :event_types
+   end
+
+IMPORTANT! Acts as Eventable relies on acts_as_enumerated to cache the event types.
+You need to install the enumerations_mixin plugin.
+
+To get it, do this:
+
+  script/plugin install http://svn.protocool.com/public/plugins/enumerations_mixin 
+
+== Using acts_as_eventable
+
+First off, after you run the migration above, you need to populate your event_types
+table with whatever kind of events you are going to track. Let's look at the example
+of a coupon website.
+
+For our coupon site, we want to know every time someone views, prints or clips a coupon.
+In that case, I would put the following items in a database population migration or 
+fixture:
+
+EventType.enumeration_model_updates_permitted = true
+EventType.create :name => "print"
+EventType.create :name => "clip"
+EventType.create :name => "view"
+
+Please note that the enumeration_model_updates_permitted = true line is required 
+whenever you are updating the event_types table, because acts_as_eventable uses
+acts_as_enumerated for the EventType model (please make sure you have the 
+enumerations_mixin plugin to support this as I have not yet added it).
+
+Now with your event types setup, you are ready to log events on your objects. Let's
+suppose we have a Coupon object that is living in a lovely RESTfully architected 
+application. 
+
+First, in the Coupon model, you add this:
+
+class Coupon < ActiveRecord::Base  
+  acts_as_eventable
+end  
+  
+In the CouponController's show method, you can do this:
+
+def show
+  @coupon = Coupon.find(params[:id])
+  @coupon.view
+end
+
+Now, whenever someone views that individual coupon, an entry will be logged in the
+events table that looks like this:
+
++----+--------------+----------------+---------------+---------------------+---------------------+
+| id | eventable_id | eventable_type | event_type_id | created_at          | updated_at          |
++----+--------------+----------------+---------------+---------------------+---------------------+
+|  1 |            6 | Coupon         |             3 | 2009-06-15 17:37:47 | 2009-06-15 17:37:47 | 
++----+--------------+----------------+---------------+---------------------+---------------------+
+
+Pretty cool! Notice, we did not add any other methods to Coupon object. The code automatically
+gives the coupon object the methods that correspond to the names of the event types! 
+
+Now, you can actually call the event type items anything you want. Because these items are added
+as methods to whatever object you are making eventable, you may have to come up with some 
+interesting names to prevent name collisions. But, they are purely arbitrary. Just know that the 
+event type name is the same as the method name you will call on your eventable object. One more
+thing: make sure the name can be a valid :symbol. It is important for the rails internals in this 
+case.
+
+So, does it work with associated objects, you ask? As a matter of fact, it does! Let's say you 
+had a ClippedCoupon model, and it was defined as such:
+
+class ClippedCoupon < ActiveRecord::Base
+  belongs_to :coupon
+  belongs_to :user   # just makes our example make more sense - need to know who clipped it!
+end
+
+Notice, I did not make this object acts_as_eventable. Just an ordinary association, because we are
+tracking Coupons, not necessarily ClippedCoupons.
+
+Now, if I want to know if the coupon gets clipped, I would put this in my create method in the 
+ClippedCouponController (again, assuming your app is RESTful):
+
+def create
+  @clipped_coupon = ClippedCoupon.create(:coupon_id => params[:coupon_id], :user_id => current_user.id)
+  @clipped_coupon.coupon.clip
+end
+
+Bam! You have just made the following entry into the events table:
++----+--------------+----------------+---------------+---------------------+---------------------+
+| id | eventable_id | eventable_type | event_type_id | created_at          | updated_at          |
++----+--------------+----------------+---------------+---------------------+---------------------+
+|  2 |            7 | Coupon         |             2 | 2009-06-15 18:01:40 | 2009-06-15 18:01:40 | 
++----+--------------+----------------+---------------+---------------------+---------------------+
+
+And voila! You now have the basis for reporting events on your objects. I will leave that part up to 
+your imagination for now. 
+
+There are a couple of other minor methods in the code, and I am sure I will add a bunch more. I will 
+update this README once I have tests and more methods for you to play with.
+
+For now, enjoy!
+
+= Credits
+acts_as_eventable was created by Netphase, LLC.
+
+Netphase is Chris Beck and Scott Nedderman. 
+
+We'd love to here how you like acts_as_eventable.  If you use it in one of your projects, please 
+drop us a line. 
+
+For more information or updates on this plugin, visit http://github.com/netphase/acts_as_eventable/tree/master
+
+Also, check out our other projects at http://netphase.com. We are available for consulting work. Contact us
+for your next project.
+
+Copyright (c) 2009 Chris Beck, released under the MIT license 
+
+
+
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_eventable plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the acts_as_eventable plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsEventable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "netphase-acts_as_eventable"
+    gemspec.summary = "This acts_as module makes it extremely simple to add events to a model that will be stored in a table for later querying or reporting on."
+    gemspec.email = "chris@netphase.com"
+    gemspec.homepage = "http://github.com/netphase/acts_as_eventable"
+    gemspec.description = "This acts_as module makes it extremely simple to add events to a model that will be stored in a table for later querying or reporting on. The events have an event type, which also corresponds to how the event is triggered. View the README for examples and usage instructions."
+    gemspec.authors = ["Chris Beck"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/generators/acts_as_eventable_migration/acts_as_eventable_migration_generator.rb

@@ -0,0 +1,11 @@
+class ActsAsEventableMigrationGenerator < Rails::Generator::Base 
+  def manifest 
+    record do |m| 
+      m.migration_template 'migration.rb', 'db/migrate'
+    end 
+  end
+  
+  def file_name
+    "acts_as_eventable_migration"
+  end
+end

data/generators/acts_as_eventable_migration/templates/migration.rb

@@ -0,0 +1,22 @@
+class ActsAsEventableMigration < ActiveRecord::Migration
+  def self.up
+    create_table :event_types do |t|
+      t.string :name
+    end
+
+    create_table :events do |t|
+      t.integer :eventable_id, :default => 0, :null => false
+      t.string :eventable_type, :limit => 25, :default => "", :null => false
+      t.integer :event_type_id
+
+      t.timestamps
+    end
+    add_index :events, [:eventable_id, :eventable_type]  
+    add_index :events, :event_type_id
+  end
+
+  def self.down
+    drop_table :events
+    drop_table :event_types
+  end
+end

data/init.rb

@@ -0,0 +1,4 @@
+# Include hook code here
+require 'acts_as_eventable'
+ActiveRecord::Base.send(:include, Netphase::Acts::Eventable::ActiveRecordExtensions)
+# ActionView::Base.send(:include, Netphase::Acts::Eventable::ActionViewExtensions)

data/install.rb

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

data/lib/acts_as_eventable.rb

@@ -0,0 +1,86 @@
+module Netphase
+  module Acts
+    module Eventable
+    
+      module ActiveRecordExtensions
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+      
+        module ClassMethods
+          def acts_as_eventable
+            has_many :events, :as => :eventable, :dependent => :destroy
+            extend SingletonMethods
+            include InstanceMethods
+          
+            # any class methods here -  like validations and callbacks
+          end
+        end
+      
+        module SingletonMethods
+          # Helper method to lookup for events for a given object.
+          # This method is equivalent to obj.issues.
+          def find_events_for(obj)
+            eventable = ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
+         
+            Event.find(:all,
+              :conditions => ["eventable_id = ? and eventable_type = ?", obj.id, eventable],
+              :order => "created_at DESC"
+            )
+          end
+        
+        end
+      
+        module InstanceMethods
+          # Helper method to sort events by date
+          def events_by_most_recent
+            Event.find(:all,
+              :conditions => ["eventable_id = ? and eventable_type = ?", id, self.type.name],
+              :order => "created_at DESC"
+            )
+          end
+        
+          def events_by_event_type(symbol)
+            event_type = EventType[symbol]
+            Event.find(:all,
+              :conditions => ["eventable_id = ? and eventable_type = ? and event_type_id = ?", id, self.type.name, event_type.id],
+              :order => "created_at DESC"
+            )
+          end
+        
+          def call(symbol, *args)
+            event_type = EventType[symbol]
+            Event.create(:eventable_id => id, :eventable_type => self.type.name, :event_type_id => event_type.id) unless event_type.blank?
+          end
+        
+          def method_missing(symbol, *args)
+            begin
+              super(symbol, *args)
+            rescue NoMethodError
+              call(symbol, *args)
+            end
+          end
+          
+          def respond_to?(method_id, include_private = false)
+            if EventType.to_a.include? method_id.to_s 
+              return true 
+            else         
+              super
+            end
+          end        
+        
+        end
+      
+      end
+    
+      module ActionControllerExtensions
+        # not sure i will need this yet - placeholder so i don't forget
+      end
+    
+      module ActionViewExtensions
+        # not sure i will need this yet - placeholder so i don't forget
+      end
+      
+    end    
+  end
+end

data/lib/event.rb

@@ -0,0 +1,24 @@
+class Event < ActiveRecord::Base
+  belongs_to :eventable, :polymorphic => true
+  has_enumerated :event_type
+  
+  def self.find_events_for_eventable(eventable_str, eventable_id)
+    find(:all,
+      :conditions => ["eventable_type = ? and eventable_id = ?", eventable_str, eventable_id],
+      :order => "updated_at DESC"
+    )
+  end
+  
+  def self.find_events_for_eventable_by_event_type(eventable_str, event_type_id)
+    find(:all,
+      :conditions => ["eventable_type = ? and event_type_id = ?", eventable_str, event_type_id],
+      :order => "created_at ASC"
+    )
+  end
+
+  def self.find_eventable(eventable_str, eventable_id)
+    eventable_str.constantize.find(eventable_id)
+  end
+  
+  
+end

data/lib/event_type.rb

@@ -0,0 +1,8 @@
+class EventType < ActiveRecord::Base
+  has_many :events  
+  acts_as_enumerated
+  
+  def self.to_a
+    a = EventType.all.collect {|et| et.name } || []
+  end
+end

data/netphase-acts_as_eventable.gemspec

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_eventable}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Beck"]
+  s.date = %q{2009-06-18}
+  s.description = %q{This acts_as module makes it extremely simple to add events to a model that will be stored in a table for later querying or reporting on. The events have an event type, which also corresponds to how the event is triggered. View the README for examples and usage instructions.}
+  s.email = %q{chris@netphase.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "generators/acts_as_eventable_migration/acts_as_eventable_migration_generator.rb",
+     "generators/acts_as_eventable_migration/templates/migration.rb",
+     "init.rb",
+     "install.rb",
+     "lib/acts_as_eventable.rb",
+     "lib/event.rb",
+     "lib/event_type.rb",
+     "netphase-acts_as_eventable.gemspec",
+     "pkg/netphase-acts_as_eventable-0.0.0.gem",
+     "pkg/netphase-acts_as_eventable-0.2.0.gem",
+     "tasks/acts_as_eventable_tasks.rake",
+     "test/acts_as_eventable_test.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/netphase/acts_as_eventable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{This acts_as module makes it extremely simple to add events to a model that will be stored in a table for later querying or reporting on.}
+  s.test_files = [
+    "test/acts_as_eventable_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/acts_as_eventable_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class ActsAsEventableTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

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

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: netphase-acts_as_eventable
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Chris Beck
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-18 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: This acts_as module makes it extremely simple to add events to a model that will be stored in a table for later querying or reporting on. The events have an event type, which also corresponds to how the event is triggered. View the README for examples and usage instructions.
+email: chris@netphase.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- generators/acts_as_eventable_migration/acts_as_eventable_migration_generator.rb
+- generators/acts_as_eventable_migration/templates/migration.rb
+- init.rb
+- install.rb
+- lib/acts_as_eventable.rb
+- lib/event.rb
+- lib/event_type.rb
+- netphase-acts_as_eventable.gemspec
+- pkg/netphase-acts_as_eventable-0.0.0.gem
+- pkg/netphase-acts_as_eventable-0.2.0.gem
+- tasks/acts_as_eventable_tasks.rake
+- test/acts_as_eventable_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/netphase/acts_as_eventable
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: This acts_as module makes it extremely simple to add events to a model that will be stored in a table for later querying or reporting on.
+test_files: 
+- test/acts_as_eventable_test.rb
+- test/test_helper.rb