matthewtodd-events 0.1.0

data/README.rdoc

@@ -0,0 +1,19 @@
+Lists upcoming birthdays and anniversaries from your OSX Address Book.
+
+I like this better than iCal's "Birthdays" calendar because it goes anywhere I can send STDOUT, and because it figures out how old people are, or what anniversary they've got coming up. (Ah, and iCal doesn't do anniversaries.)
+
+So, there you have it.
+
+== Usage
+
+  $ events
+  Dino turns 52 TODAY. (Thursday, January 15)
+  Fred & Wilma Flintstone's 53rd anniversary is in 5 days. (Tuesday, January 20)
+
+== Install
+
+  gem install matthewtodd-events --source http://gems.github.com
+
+== Tips
+
+* I like to keep this running in a GeekTool window. If you like, you can bottom-justify this text by piping it through http://gist.github.com/43363.

data/bin/events

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'events'
+
+Events::CLI.new(STDOUT, ARGV).run

data/features/events.feature

@@ -0,0 +1,26 @@
+Feature: Display Upcoming Birthdays
+  In order to remember to greet my friends and family on their birthdays
+  I want to see whose birthdays are coming up soon
+  
+  Scenario: One birthday in the coming week
+    Given these people in my address book
+      | first_name | last_name | birthday   |
+      | Matthew    | Todd      | 1978-04-03 |
+    When I ask for upcoming events on 2009-03-31
+    Then I should see these results
+      """
+      Matthew Todd turns 31 in 3 days. (Friday, April 3)
+      
+      """
+
+  Scenario: One anniversary in the coming week
+    Given these people in my address book
+      | first_name | last_name | related_names                  | other_dates                       |
+      | Matthew    | Todd      | { 'spouse' => 'Valerie Todd' } | { 'anniversary' => '2006-11-04' } |
+      | Valerie    | Todd      | { 'spouse' => 'Matthew Todd' } | { 'anniversary' => '2006-11-04' } |
+    When I ask for upcoming events on 2009-11-01
+    Then I should see these results
+      """
+      Matthew & Valerie Todd's 3rd anniversary is in 3 days. (Wednesday, November 4)
+
+      """

data/features/steps/events.rb

@@ -0,0 +1,20 @@
+require 'test/unit/assertions'
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', 'lib')
+require 'events'
+
+World do |world|
+  world.extend(Test::Unit::Assertions)
+  world
+end
+
+Given /^these people in my address book$/ do |table|
+  Events.address_book = Events::AddressBook::Fake.new(table.hashes)
+end
+
+When /^I ask for upcoming events on (\d\d\d\d-\d\d-\d\d)$/ do |date|
+  Events::CLI.new(StringIO.new(@output = '', 'w'), [date]).run
+end
+
+Then /^I should see these results$/ do |results|
+  assert_equal results, @output
+end

data/lib/events.rb

@@ -0,0 +1,16 @@
+require 'date'
+
+require 'events/recurring_date'
+require 'events/person'
+require 'events/address_book'
+require 'events/cli'
+
+module Events
+  def self.address_book
+    @@address_book ||= AddressBook::Real.new
+  end
+
+  def self.address_book=(address_book)
+    @@address_book = address_book
+  end
+end

data/lib/events/address_book.rb

@@ -0,0 +1,14 @@
+module Events
+  module AddressBook
+    class Base
+      def upcoming(date)
+        events = []
+        @people.each { |person| events.concat(person.upcoming(date)) }
+        events.sort_by { |event| event.first }.map { |event| event.last }.uniq
+      end
+    end
+  end
+end
+
+require 'events/address_book/fake'
+require 'events/address_book/real'

data/lib/events/address_book/fake.rb

@@ -0,0 +1,21 @@
+module Events
+  module AddressBook
+    class Fake < Base
+      def initialize(people_attributes = {})
+        @people = people_attributes.map { |attributes| Events::Person.new(preprocess(attributes)) }
+      end
+
+      private
+
+      def preprocess(attributes)
+        hashify(attributes, 'related_names')
+        hashify(attributes, 'other_dates')
+        attributes
+      end
+
+      def hashify(hash, key)
+        hash[key] = hash.key?(key) ? eval(hash[key]) : {}
+      end
+    end
+  end
+end

data/lib/events/address_book/real.rb

@@ -0,0 +1,42 @@
+# FIXME multiple libruby.dylib found: '/opt/local/lib/libruby.dylib' and '/usr/lib/libruby.1.dylib'
+require 'osx/cocoa'
+OSX.require_framework 'AddressBook'
+
+module Events
+  module AddressBook
+    class Real < Base
+      def initialize
+        @people = OSX::ABAddressBook.sharedAddressBook.people.to_ruby.map do |card|
+          Events::Person.new(attributes(card))
+        end
+      end
+
+      private
+
+      def attributes(card)
+        attributes = {}
+        attributes['first_name']    = rubify(card.valueForProperty(OSX::KABFirstNameProperty))
+        attributes['last_name']     = rubify(card.valueForProperty(OSX::KABLastNameProperty))
+        attributes['nickname']      = rubify(card.valueForProperty(OSX::KABNicknameProperty))
+        attributes['birthday']      = rubify(card.valueForProperty(OSX::KABBirthdayProperty))
+        attributes['related_names'] = hashify(card.valueForProperty(OSX::KABRelatedNamesProperty))
+        attributes['other_dates']   = hashify(card.valueForProperty(OSX::KABOtherDatesProperty))
+        attributes
+      end
+
+      def hashify(cocoa_value)
+        result = {}
+        if cocoa_value
+          (0...cocoa_value.count).each do |index|
+            result[rubify(cocoa_value.labelAtIndex(index)).downcase.gsub(/[^a-z]/,'')] = rubify(cocoa_value.valueAtIndex(index))
+          end
+        end
+        result
+      end
+
+      def rubify(cocoa_value)
+        cocoa_value ? cocoa_value.to_ruby : nil
+      end
+    end
+  end
+end

data/lib/events/cli.rb

@@ -0,0 +1,12 @@
+module Events
+  class CLI
+    def initialize(output, argv)
+      @output = output
+      @date   = argv.empty? ? Date.today : Date.parse(argv.shift)
+    end
+
+    def run
+      @output.puts Events.address_book.upcoming(@date)
+    end
+  end
+end

data/lib/events/person.rb

@@ -0,0 +1,102 @@
+module Events
+  class Person
+    def initialize(attributes)
+      @first_name    = attributes['first_name']
+      @last_name     = attributes['last_name']
+      @nickname      = attributes['nickname']
+      @birthday      = recurring_date(attributes['birthday'])
+      @related_names = attributes['related_names']
+      @other_dates   = recurring_date(attributes['other_dates'])
+    end
+
+    def upcoming(date, within_days=7)
+      upcoming = []
+
+      if @birthday
+        next_birthday = @birthday.next_occurrence(date)
+        if next_birthday.days_until < within_days
+          upcoming << [next_birthday, format(":name_or_nickname turns :age :in_days. (:date)", next_birthday)]
+        end
+      end
+
+      if @other_dates['anniversary']
+        next_anniversary = @other_dates['anniversary'].next_occurrence(date)
+        if next_anniversary.days_until < within_days
+          upcoming << [next_anniversary, format(":name_with_spouse's :ordinal_age anniversary is :in_days. (:date)", next_anniversary)]
+        end
+      end
+
+      upcoming
+    end
+
+    private
+
+    def format(string, recurring_date)
+      string.sub! /:name_or_nickname/, name_or_nickname
+      string.sub! /:name_with_spouse/, name_with_spouse
+      string.sub! /:age/, recurring_date.years_since.to_s
+      string.sub! /:ordinal_age/, ordinalize(recurring_date.years_since)
+      string.sub! /:in_days/, in_days(recurring_date)
+      string.sub! /:date/, recurring_date.strftime('%A, %B %e')
+      string.strip!
+      string.gsub!(/\s+/, ' ')
+      string
+    end
+
+    def name
+      "#{@first_name} #{@last_name}"
+    end
+
+    def name_or_nickname
+      @nickname || name
+    end
+
+    def name_with_spouse
+      if spouse_name = @related_names['spouse']
+        if spouse_name =~ / #{@last_name}$/
+          [@first_name, spouse_name.sub(/ #{@last_name}$/, '')].sort.join(' & ').concat(' ').concat(@last_name)
+        else
+          [name, spouse_name].sort.join(' & ')
+        end
+      else
+        name
+      end
+    end
+
+    def ordinalize(number)
+      if (11..13).include?(number.to_i % 100)
+        "#{number}th"
+      else
+        case number.to_i % 10
+          when 1; "#{number}st"
+          when 2; "#{number}nd"
+          when 3; "#{number}rd"
+          else    "#{number}th"
+        end
+      end
+    end
+
+    def in_days(recurring_date)
+      case in_days = recurring_date.days_until
+        when 0; "TODAY"
+        when 1; "tomorrow"
+        else    "in #{in_days} days"
+      end
+    end
+
+    def recurring_date(date)
+      case date
+      when Date, Time, DateTime
+        RecurringDate.new(date)
+      when String
+        RecurringDate.parse(date)
+      when Hash
+        date.inject({}) { |result, pair| result[pair.first] = recurring_date(pair.last); result }
+      when NilClass
+        nil
+      else
+        raise "Unhandled recurring date conversion: #{date.inspect}"
+      end
+    end
+  end
+end

data/lib/events/recurring_date.rb

@@ -0,0 +1,46 @@
+module Events
+  class RecurringDate
+    def self.parse(original)
+      original ? new(Date.parse(original)) : nil
+    end
+
+    def initialize(original)
+      @original = original
+    end
+
+    def next_occurrence(from = Date.today)
+      Occurrence.new(@original, from)
+    end
+
+    private
+
+    class Occurrence
+      include Comparable
+
+      attr_reader :date
+
+      def initialize(original, from)
+        @date     = Date.new(from.year, original.month, original.day)
+        @date     = Date.new(from.year + 1, original.month, original.day) if @date < from
+        @from     = from
+        @original = original
+      end
+
+      def method_missing(symbol, *args, &block)
+        @date.send(symbol, *args, &block)
+      end
+
+      def days_until
+        @date - @from
+      end
+
+      def years_since
+        @date.year - @original.year
+      end
+
+      def <=>(other)
+        self.date <=> other.date
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: matthewtodd-events
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matthew Todd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-17 00:00:00 -08:00
+default_executable: events
+dependencies: []
+
+description: 
+email: matthew.todd@gmail.com
+executables: 
+- events
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- bin/events
+files: 
+- README.rdoc
+- bin/events
+- features/events.feature
+- features/steps/events.rb
+- lib/events/address_book/fake.rb
+- lib/events/address_book/real.rb
+- lib/events/address_book.rb
+- lib/events/cli.rb
+- lib/events/person.rb
+- lib/events/recurring_date.rb
+- lib/events.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --title
+- events-0.1.0
+- --inline-source
+- --line-numbers
+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: 
+- RubyCocoa
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Lists upcoming birthdays and anniversaries from your OSX Address Book.
+test_files: []
+