event_horizon 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jiri Zajpt
+
+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,17 @@
+= event_horizon
+
+Simple plugin for logging events in Rails applications.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jiri Zajpt. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "event_horizon"
+    gem.summary = %Q{Simple plugin for logging events in Rails applications.}
+    gem.description = %Q{Simple plugin for logging events in Rails applications using Mongoid ODM.}
+    gem.email = "jzajpt@blueberryapps.com"
+    gem.homepage = "http://github.com/jzajpt/event_horizon"
+    gem.authors = ["Jiri Zajpt"]
+    gem.add_development_dependency "rspec", "~> 2.0.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+Rspec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "./spec/**/*_spec.rb"
+end
+
+Rspec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = "./spec/**/*_spec.rb"
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "event_horizon #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/models/event.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+require 'event_horizon/orm_support'
+
+EventHorizon::OrmSupport.load_event_class
+

data/event_horizon.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{event_horizon}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jiri Zajpt"]
+  s.date = %q{2010-10-17}
+  s.description = %q{Simple plugin for logging events in Rails applications using Mongoid ODM.}
+  s.email = %q{jzajpt@blueberryapps.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "app/models/event.rb",
+     "event_horizon.gemspec",
+     "lib/event_horizon.rb",
+     "lib/event_horizon/events.rb",
+     "lib/event_horizon/helpers.rb",
+     "lib/event_horizon/helpers/event_horizon_helper.rb",
+     "lib/event_horizon/mongoid_support/document.rb",
+     "lib/event_horizon/mongoid_support/event.rb",
+     "lib/event_horizon/orm_support.rb",
+     "spec/event_horizon_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jzajpt/event_horizon}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple plugin for logging events in Rails applications.}
+  s.test_files = [
+    "spec/event_horizon_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.0.0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.0.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.0.0"])
+  end
+end
+

data/lib/event_horizon/events.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+require 'active_support/concern'
+
+module EventHorizon
+
+  module Events
+
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def on_event(*params)
+        if params.first.is_a?(Hash)
+          params = params.first
+          event, callback = params.keys.first, params.values.first
+        else
+          event, callback = params.first, params.last
+        end
+        @event_callbacks ||= {}
+        @event_callbacks[event] ||= []
+        @event_callbacks[event] << callback
+      end
+
+      def event_callbacks_for(event)
+        @event_callbacks[event]
+      end
+
+    end
+
+    module InstanceMethods
+
+      def fire(event, options = {})
+        self.call_event_callbacks_for(event)
+        self.create_event(event, options)
+      end
+
+      protected
+
+      def create_event(event, options = {})
+        params = options.except(:by, :user, :parent)
+        params.reverse_merge! :name => self.to_s
+
+        class_name = self._type || self.class.name
+        user       = options[:by] || options[:user]
+
+        Event.create(:event_type    => event.to_s,
+                     :user_id       => user && user.id,
+                     :document_id   => self.id,
+                     :document_type => class_name,
+                     :params        => params)
+      end
+
+      def call_event_callbacks_for(event)
+        if callbacks = self.class.event_callbacks_for(event)
+          callbacks.each { |method| self.send method }
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/event_horizon/helpers/event_horizon_helper.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+module EventHorizonHelper
+
+  def relativize_date(date)
+    ago = 7.days.ago.to_date
+    key = case date
+          when Date.today; :today
+          when Date.yesterday; :yesterday
+          when ago..Date.today; [:days, date.wday]
+          end
+    if key.is_a? Array
+      day = t("date.day_names")[key.last]
+      "#{day}, #{l date, :format => :short}"
+    elsif key
+      key && t("helpers.dashboards.relativize_date.#{key}")
+    else
+      l date, :format => :short
+    end
+  end
+
+  def event_description(event)
+    scope          = "#{event.document_type.tableize.singularize}.#{event.event_type}"
+    interpolations = event_interpolations(event)
+    t("helpers.dashboards.event_description.#{scope}", interpolations).html_safe
+  end
+
+  def event_interpolations(event)
+    interpolations = event.params.inject({}) { |h, (k, v)| h[k.to_sym] = v; h }
+    if interpolations[:name] && event.document.present?
+      method = :"link_to_#{event.document_type.downcase}"
+      interpolations[:name] = send(method, event.document) if respond_to?(method)
+    end
+    interpolations
+  rescue Mongoid::Errors::DocumentNotFound
+    interpolations
+  end
+
+end

data/lib/event_horizon/helpers.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'event_horizon/helpers/event_horizon_helper'
+
+if defined?(ActionController)
+  # In order to Rails recognize our helper (EventHorizonHelper), we
+  # have to use separate path for it and then tell Rails about it.
+  path = File.join(File.dirname(__FILE__), 'event_horizon/helpers')
+  $LOAD_PATH << path
+  ActionController::Base.helpers_path << path
+end

data/lib/event_horizon/mongoid_support/document.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'active_support/concern'
+
+module EventHorizon
+
+  module MongoidSupport
+
+    module Document
+
+      extend ActiveSupport::Concern
+
+      included do
+        references_many :events, :as => :document, :class_name => "::Event"
+      end
+
+    end
+
+  end
+
+end

data/lib/event_horizon/mongoid_support/event.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'active_support/concern'
+require 'mongoid'
+require 'mongoid/timestamps'
+
+
+class Event
+
+  include ::Mongoid::Document
+  include ::Mongoid::Timestamps
+
+
+  store_in :events
+
+  # Document keys
+
+  field :event_type
+  field :params,          :type => Hash
+  field :document_id#,     :type => ObjectID
+  field :document_type
+
+  index :created_at
+
+  # Associations
+
+  referenced_in :user
+
+
+  # Public methods
+
+  def document
+    self.document_type.constantize.find(self.document_id)
+  rescue ::Mongoid::Errors::DocumentNotFound
+    nil
+  end
+
+  def day
+    created_at.to_date
+  end
+
+  def same?(other)
+    return unless other
+    self.event_type == other.event_type &&
+      self.user_id == other.user_id &&
+      self.document_id == other.document_id
+  end
+
+end
+

data/lib/event_horizon/orm_support.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'active_support/concern'
+
+
+module EventHorizon
+
+  module OrmSupport
+
+    def self.load_event_class
+      require 'event_horizon/mongoid_support/event' if defined?(::Mongoid)
+    end
+
+    def self.document_class
+      if defined?(::Mongoid)
+        require 'event_horizon/mongoid_support/document'
+        EventHorizon::MongoidSupport::Document
+      end
+    end
+
+  end
+
+end

data/lib/event_horizon.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'active_support/concern'
+require 'event_horizon/events'
+require 'event_horizon/orm_support'
+require 'event_horizon/helpers'
+
+
+module EventHorizon
+
+  extend ActiveSupport::Concern
+
+  include Events
+  include EventHorizon::MongoidSupport::Document if defined?(::Mongoid)
+
+end

data/spec/event_horizon_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "EventHorizon" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'event_horizon'
+
+require 'rspec'
+require 'rspec/core'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: event_horizon
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jiri Zajpt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-17 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id001
+description: Simple plugin for logging events in Rails applications using Mongoid ODM.
+email: jzajpt@blueberryapps.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- app/models/event.rb
+- event_horizon.gemspec
+- lib/event_horizon.rb
+- lib/event_horizon/events.rb
+- lib/event_horizon/helpers.rb
+- lib/event_horizon/helpers/event_horizon_helper.rb
+- lib/event_horizon/mongoid_support/document.rb
+- lib/event_horizon/mongoid_support/event.rb
+- lib/event_horizon/orm_support.rb
+- spec/event_horizon_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jzajpt/event_horizon
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Simple plugin for logging events in Rails applications.
+test_files: 
+- spec/event_horizon_spec.rb
+- spec/spec_helper.rb