reminder 0.0.1rc

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in reminder.gemspec
+gemspec

data/README

@@ -0,0 +1,66 @@
+Reminder
+========
+
+This is a simple gem that will throw a Growl notification every certain time. That way, you'll be reminded of something.
+
+For example, I normally make a lot of stuff before I commit my changes, which I know is really bad (and it's what pushed me to write this), so I just set a reminder to commit every 10 minutes.
+
+This is how it looks like
+
+![Please Commit](http://s3.amazonaws.com/hock-personal-bucket/commit_please.png "Please Commit")
+
+That way, the Growl notification will notice (bother) me and remind (make) me commit.
+
+
+Options
+=======
+
+**Reminder** has some cool options (thanks to [Choise](https://github.com/defunkt/choice)) so you can easily set up your notifications and start working.
+
+To use **Reminder**, just write
+
+    $ reminder -m 'Keep Growling Growling ...' -t 10
+
+and you'll get this every 10 _**minutes**_:
+
+![Keep Rolling](http://s3.amazonaws.com/hock-personal-bucket/keep_rolling.png "Keep Rolling")
+    
+
+To change the notification title, just add the ` -T ` option.
+
+
+All **Reminder**'s options are:
+
+    Usage: reminder [-mtT]
+
+    Notification Options:
+        -m, --message=MESSAGE            The notification message...
+        -T, --title=TITLE                The title of the notification...
+        -t, --time=TIME                  Number of minutes...
+
+    Other options: 
+        -v, --version                    Show version
+
+You can list all options at any time by running `reminder --help`
+
+TODO
+====
+
+* Find a better way to run the notification.
+* Clean up code. May be a little messy.
+* Add a `--for` option (remind me every 10 minutes for 3 hours)
+* Add documentation inside the source code.
+
+
+Issues
+======
+
+Please use the Github Issues Tracker above.
+
+
+Thank you for reading :-)
+-------------------------
+Released under the MIT License
+
+Nicolás Hock Isaza. nhocki@gmail.com. Zinergia
+   

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+require 'pamela'
+
+Bundler::GemHelper.install_tasks
+Pamela.load :spec, :console
+
+desc 'Default: run specs.'
+task :default => 'spec'

data/bin/reminder

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'reminder'
+require 'growl'
+require 'choice'
+
+Choice.options do
+  banner "Usage: #{File.basename(__FILE__)} [-mtT]"
+  header ''
+  header 'Notification Options:'
+
+  option :message do
+    d = "How's it going you awesome person?"
+    short '-m'
+    long '--message=MESSAGE'
+    desc "The notification message. The reminder! (default #{d})"
+    default d
+  end
+
+  option :title do
+    d = "Just remember..."
+    short '-T'
+    long '--title=TITLE'
+    desc "The title of the notification. (default #{d})"
+    default d
+  end
+
+  option :time do
+    d = 10
+    short '-t'
+    long '--time=TIME'
+    desc "Number of minutes between each notification (default #{d})"
+    cast Integer
+    default d
+  end
+  
+  separator ''
+  separator 'Other options: '
+
+  option :version do
+    short '-v'
+    long '--version'
+    desc 'Show version'
+    action do
+      puts "#{File.basename(__FILE__)} v#{Reminder::VERSION}"
+      exit
+    end
+  end  
+end
+
+options = Choice.choices
+
+Reminder::Notifier.new(options).run

data/lib/reminder.rb

@@ -0,0 +1,2 @@
+require 'reminder/notifier'
+require 'reminder/exceptions'

data/lib/reminder/exceptions.rb

@@ -0,0 +1,19 @@
+module Reminder
+  class Error < StandardError ; end
+
+
+  # This exception will be raised if Growl is not installed
+  # You'll need to install Growl to use this gem
+  class GrowlNotInstalled < Error
+    attr_writer :default_message
+    def initialize(message = nil)
+      @message = message
+      @default_message = "Growl is not installed. Download it at http://growl.info"
+    end
+    def to_s
+      @message || @default_message
+    end
+  end
+
+  
+end

data/lib/reminder/notifier.rb

@@ -0,0 +1,26 @@
+
+module Reminder
+  class Notifier
+    
+    def initialize options, output = STDOUT
+      @message   = options[:message]
+      @title     = options[:title]
+      @time      = options[:time]
+    end
+    
+    def run 
+      raise GrowlNotInstalled and return unless Growl.installed?
+      notification = Growl.new
+      notification.message = @message
+      notification.title = @title
+      notification.icon = nil
+      
+      while true
+        notification.run
+        sleep(@time * 60)
+      end
+            
+    end
+    
+  end
+end

data/lib/reminder/version.rb

@@ -0,0 +1,3 @@
+module Reminder
+  VERSION = "0.0.1rc"
+end

data/reminder.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "reminder/version"
+
+Gem::Specification.new do |s|
+  s.name        = "reminder"
+  s.version     = Reminder::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nicolás Hock Isaza"]
+  s.email       = ["nhocki@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Simple Growl reminders. Just work, set a timer, and get reminded!}
+  s.description = %q{This gem will allow you to create simple, repeating reminders with growl}
+
+  s.rubyforge_project = "reminder"
+
+  s.add_dependency('growl')
+  s.add_dependency('choice')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('pamela')
+
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/reminder/notifier_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module Reminder
+  describe Notifier do
+    let(:output) {double('output').as_null_object}
+    context "Growl is not installed" do
+      it "raises an exception" do
+        Growl.stub!(:installed?).and_return(false)
+        expect{
+          Notifier.new(default_options, output).run
+        }.to raise_error(
+          Reminder::GrowlNotInstalled, /Growl is not installed/
+        )
+      end
+    end
+  
+    context "Growl is happily installed" do
+      
+      it "should show notifications instantly" do
+        notifier = Notifier.new(default_options, output)
+        notifier.run
+      end
+    end
+  
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'reminder'
+require 'growl'
+
+def default_options
+  {
+    :message  => "How's it going you awesome person?",
+    :title    => "Just remember...",
+    :time     => 10
+  }
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: reminder
+version: !ruby/object:Gem::Version 
+  prerelease: 5
+  version: 0.0.1rc
+platform: ruby
+authors: 
+- "Nicol\xC3\xA1s Hock Isaza"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-11 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: growl
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: choice
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: pamela
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: This gem will allow you to create simple, repeating reminders with growl
+email: 
+- nhocki@gmail.com
+executables: 
+- reminder
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- assets/images/growl.png
+- bin/reminder
+- lib/reminder.rb
+- lib/reminder/exceptions.rb
+- lib/reminder/notifier.rb
+- lib/reminder/version.rb
+- reminder.gemspec
+- spec/reminder/notifier_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: reminder
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Simple Growl reminders. Just work, set a timer, and get reminded!
+test_files: 
+- spec/reminder/notifier_spec.rb
+- spec/spec_helper.rb