alarm_it 0.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.tmproj
+.DS_Store
+Gemfile.lock
+.bundle
+spec/database.yml

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--backtrace

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Michael Bleigh and Intridea Inc.
+
+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,33 @@
+= AlarmIt
+
+This plugin is a work in progress.
+it allows the attachment of alarms to any kind of models.
+
+=== Rails 3.0
+
+To use it, add it to your Gemfile:
+  
+  gem 'alarm_it'
+
+==== Post Installation
+
+1. rails generate alarm_it:migration
+2. rake db:migrate
+
+== Testing
+
+Acts As Alarmable On uses RSpec for its test coverage. Inside the plugin
+directory, you can run the specs for RoR 3.0.0 with:
+
+  rake spec
+
+
+== Usage
+
+    class User < ActiveRecord::Base
+      acts_as_alarmer
+    end
+    
+    class AModel < ActiveRecord::Base
+      acts_as_alarmable
+    end

data/Rakefile

@@ -0,0 +1,18 @@
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Default: run specs'
+  task :default => :spec  
+  RSpec::Core::RakeTask.new do |t|
+    t.pattern = "spec/**/*_spec.rb"
+  end
+  
+  RSpec::Core::RakeTask.new('rcov') do |t|
+    t.pattern = "spec/**/*_spec.rb"
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec']
+  end
+
+rescue LoadError
+  puts "Rspec not available. Install it with: gem install rspec"  
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/alarm_it.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name = "alarm_it"
+  s.version = '0.0.0'
+  # s.platform = Gem::Platform::RUBY
+  
+  s.authors = ["Yannis Jaquet"]
+  s.date = %q{2011-05-24}
+  s.description = %q{Associate alarms to any model}
+  s.summary = %q{Associate alarms to any model}
+  s.email = %q{suvar3_7@mac.com}
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rails", "~> 3.1.0.rc1"
+  s.add_dependency "mysql2", "~> 0.3.2"
+  s.add_dependency "will_paginate", "~>3.0.pre2"
+  
+  s.add_development_dependency "rspec", "~> 2.6.0"
+  s.add_development_dependency 'shoulda-matchers'
+  s.add_development_dependency 'factory_girl'
+end
+

data/generators/alarm_it_migration/alarm_it_migration_generator.rb

@@ -0,0 +1,7 @@
+class AlarmItMigrationGenerator < Rails::Generator::Base 
+  def manifest 
+    record do |m| 
+      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => "alarm_it_migration"
+    end
+  end
+end

data/generators/alarm_it_migration/templates/migration.rb

@@ -0,0 +1,21 @@
+class AlarmItMigration < ActiveRecord::Migration
+  def self.up
+    create_table :alarms do |t|
+      t.string :name
+      t.text :description
+      t.reference :alarmable, :polymorphic => true
+      t.datetime :set_at
+      t.datetime :repeat_at
+      t.datetime :inactivated_at
+      t.reference :alarmer, :polymorphic => true
+
+      t.timestamps
+    end
+    add_index :alarms, [:alarmable_type, :alarmable_id]
+    add_index :alarms, [:alarmer_type, :alarmer_id]
+  end
+
+  def self.down
+    drop_table :alarms
+  end
+end

data/lib/alarm_it.rb

@@ -0,0 +1,20 @@
+require "active_record"
+require "action_view"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "alarm_it/alarmable"
+require "alarm_it/alarmer"
+require "alarm_it/alarm"
+require "alarm_it/alarms_helper"
+
+$LOAD_PATH.shift
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send :include, AlarmIt::Alarmer
+  ActiveRecord::Base.send :include, AlarmIt::Alarmable
+end
+
+if defined?(ActionView::Base)
+  ActionView::Base.send :include, AlarmIt::AlarmsHelper
+end

data/lib/alarm_it/alarm.rb

@@ -0,0 +1,62 @@
+module AlarmIt
+  class Alarm < ::ActiveRecord::Base
+  
+    attr_accessible :name, :set_at, :repeat_at, :alarmable, :alarmable_type, :alarmable_id, :alarmer, :alarmer_type, :alarmer_id, :inactivated_at
+    
+    belongs_to :alarmable, :polymorphic => true
+    belongs_to :alarmer, :polymorphic => true
+  
+    validates_presence_of :name, :alarmable_type, :alarmable_id, :alarmer_type, :alarmer_id, :set_at
+  
+    validates_each :repeat_at do |alarmable, attr, value|
+      if !alarmable.set_at.blank? and !alarmable.repeat_at.blank? and alarmable.repeat_at < alarmable.set_at
+        alarmable.errors[:repeat_at] < ": anterior to set time!"
+      end
+    end
+  
+    before_validation :set_set_at
+  
+    default_scope order("alarms.set_at ASC")
+    scope :inactivated, order("set_at DESC, repeat_at DESC").where("inactivated_at IS NOT NULL")
+    scope :pending, order("set_at DESC, repeat_at DESC").where("inactivated_at IS NULL")
+    scope :ringing, order("set_at DESC, repeat_at DESC").where("inactivated_at IS NULL AND (set_at < UTC_TIMESTAMP() OR (repeat_at IS NOT NULL AND repeat_at < UTC_TIMESTAMP()))")
+  
+    def symbols
+      "⚠" if ringing?
+    end
+    
+    
+    def inactivate!
+      update_attributes(:inactivated_at => Time.current)
+    end
+  
+    def is_pending?
+      inactivated_at.blank? and (set_at > Time.current or (repeat_at.present? and repeat_at > Time.current))
+    end
+    
+    def is_inactivated?
+      inactivated_at.present? and inactivated_at < Time.current
+    end
+  
+    def is_ringing?
+      inactivated_at.blank? and (set_at < Time.current or (repeat_at.present? and repeat_at < Time.current))
+    end
+  
+    def inactivated_at_bool=(inactivated_at_bool)
+      if inactivated_at_bool.nil?
+        self.inactivated_at = ''
+      elsif self.inactivated_at.blank?
+        self.inactivated_at = Time.current
+      end
+    end  
+  
+    private
+  
+    def set_set_at
+      if self.set_at.blank? and !self.repeat_at.blank?
+        self.set_at = self.repeat_at
+        self.repeat_at = nil
+      end    
+    end
+  end
+end

data/lib/alarm_it/alarmable.rb

@@ -0,0 +1,13 @@
+module AlarmIt
+  module Alarmable
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def acts_as_alarmable
+        has_many :alarms, :as => :alarmable, :dependent => :destroy, :include => :alarmer, :class_name => "AlarmIt::Alarm"
+      end
+    end
+  end
+end

data/lib/alarm_it/alarmer.rb

@@ -0,0 +1,21 @@
+module AlarmIt
+  module Alarmer
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def acts_as_alarmer
+        has_many :alarms, :as => :alarmer, :dependent => :destroy, :include => :alarmable, :class_name => "AlarmIt::Alarm"
+
+        include AlarmIt::Alarmer::InstanceMethods
+      end
+    end
+    
+    module InstanceMethods
+      def set_alarm(name, alarmable, datetime)
+        alarms.create!(:name => name, :alarmable => alarmable, :set_at => datetime)
+      end
+    end
+  end
+end

data/lib/alarm_it/alarms_helper.rb

@@ -0,0 +1,17 @@
+module AlarmIt
+  module AlarmsHelper
+    # See the README for an example using tag_cloud.
+    # def tag_cloud(tags, classes)
+    #   tags = tags.all if tags.respond_to?(:all)
+    # 
+    #   return [] if tags.empty?
+    # 
+    #   max_count = tags.sort_by(&:count).last.count.to_f
+    # 
+    #   tags.each do |tag|
+    #     index = ((tag.count / max_count) * (classes.size - 1)).round
+    #     yield tag, classes[index]
+    #   end
+    # end
+  end
+end

data/lib/alarm_it/version.rb

@@ -0,0 +1,3 @@
+module AlarmIt
+  VERSION = "0.0.0"
+end

data/lib/generators/alarm_it/migration/migration_generator.rb

@@ -0,0 +1,32 @@
+require 'rails/generators/migration'
+
+module AlarmIt
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration for Alarm"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def url(/assets/
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/alarm_it_migration'
+      end
+    end
+  end
+end
+

data/lib/generators/alarm_it/migration/templates/active_record/migration.rb

@@ -0,0 +1,21 @@
+class AlarmItMigration < ActiveRecord::Migration
+  def self.up
+    create_table :alarms do |t|
+      t.string :name
+      t.text :description
+      t.reference :alarmable, :polymorphic => true
+      t.datetime :set_at
+      t.datetime :repeat_at
+      t.datetime :inactivated_at
+      t.reference :alarmer, :polymorphic => true
+
+      t.timestamps
+    end
+    add_index :alarms, [:alarmable_type, :alarmable_id]
+    add_index :alarms, [:alarmer_type, :alarmer_id]
+  end
+
+  def self.down
+    drop_table :alarms
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'alarm_it'

data/spec/alarm_it/alarm_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+describe AlarmIt::Alarm do
+  before(:each) do
+    clean_database!
+    @alarmer = Alarmer.create(:name => 'pablo')
+    @alarmable = Alarmable.create(:name => 'thiz_obzect')
+  end
+
+  it { should belong_to(:alarmable) }
+  it { should belong_to(:alarmer) }
+  it { should validate_presence_of :alarmable_type }
+  it { should validate_presence_of :alarmable_id }
+  it { should validate_presence_of :set_at }
+  it { should validate_presence_of :alarmer_id }
+  it { should validate_presence_of :alarmer_type }
+
+  describe "an alarm" do
+    let(:alarm){AlarmIt::Alarm.create(:name => 'alarm', :alarmer => @alarmer, :alarmable => @alarmable, :set_at => 2.days.from_now)}
+    specify {alarm.alarmer.should eql(@alarmer)}
+    specify {alarm.alarmable.should eql(@alarmable)}
+    specify {alarm.should(be_valid, alarm.errors.full_messages.to_sentence)}
+    specify {alarm.should be_an_instance_of(AlarmIt::Alarm)}
+    specify {alarm.should respond_to(:alarmer)}
+    specify {alarm.should respond_to(:alarmable)}
+    it "should be among the pending alarms" do
+      AlarmIt::Alarm.pending.include?(alarm)
+    end
+    it "should be pending" do
+      alarm.is_pending?.should be_true
+    end
+    
+    it "should not be inactivated" do
+      alarm.is_inactivated?.should_not be_true
+    end
+    
+    it "should not be ringing" do
+      alarm.is_ringing?.should_not be_true
+    end
+    
+    describe "when it's inactivated" do
+      before :each do
+        alarm.inactivate!
+      end
+      
+      it "should be among the inactivated alarms" do
+        AlarmIt::Alarm.inactivated.include?(alarm)
+      end
+            
+      it "should be inactivated" do
+        alarm.is_inactivated?.should be_true
+      end
+    
+      it "should not be pending" do
+        alarm.is_pending?.should_not be_true
+      end
+    
+      it "should not be ringing" do
+        alarm.is_ringing?.should_not be_true
+      end
+    end
+    
+    describe "with set_at time in the past" do
+      before :each do
+        alarm.update_attributes(:set_at => 2.hours.ago)
+      end
+      
+      it "should be among the ringing alarms" do
+        AlarmIt::Alarm.ringing.include?(alarm)
+      end
+      
+      it "should be ringing" do
+        alarm.is_ringing?.should be_true
+      end
+    end
+  end
+end

data/spec/alarm_it/alarmable_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+describe Alarmable do
+  before(:each) do
+    clean_database!
+  end
+
+  it { should have_many(:alarms) }
+end