olauzon-weekender 0.0.0

data/README.rdoc

@@ -0,0 +1,37 @@
+= weekender
+
+A simple Ruby library for creating calendars based on weeks rather than months.
+
+
+== Installation
+
+    $ sudo gem sources -a http://gems.github.com
+    $ sudo gem install olauzon-weekender
+
+
+== Usage
+
+    >> weekender = Weekender.new( :year       => Date.today.year,
+                                   :month      => Date.today.month,
+                                   :day        => Date.today.day,
+                                   :before     => 3,   # number of weeks to display before
+                                   :after      => 4)   # number of weeks to display after
+    => Returns a Weekender instance
+
+    >> weekender.add_event(Date.today,
+                           :html_class => 'special_event',
+                           :content    => '<p>special event 1</p>')
+    => Returns weekender with an event (you can add as many events as necessary)
+
+    >> weekender.display
+    => Outputs HTML calendar
+
+
+== Inspiration
+
+* nakajima's Calendar Maker http://github.com/nakajima/calendar-maker
+
+
+== Copyright
+
+Copyright (c) 2009 Olivier Lauzon. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "weekender"
+    gem.summary = %Q{A simple Ruby library for creating calendars based on weeks rather than months.}
+    gem.email = "olauzon@gmail.com"
+    gem.homepage = "http://github.com/olauzon/weekender"
+    gem.authors = ["Olivier Lauzon"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "weekender #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/lib/core_ext/date.rb

@@ -0,0 +1,15 @@
+class Date
+
+  def day_name
+    strftime('%A')
+  end
+
+  def month_name
+    strftime('%B')
+  end
+
+  def day_of_month
+    strftime('%d').to_i
+  end
+
+end

data/lib/core_ext/string.rb

@@ -0,0 +1,15 @@
+class String
+
+  # Aligns each line n spaces.
+  #
+  # CREDIT: Gavin Sinclair
+  #
+  def tab(n)
+    gsub(/^ */, ' ' * n)
+  end
+
+  def add(string)
+    self << "\n#{string}"
+  end
+
+end

data/lib/weekender.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.expand_path(File.dirname(__FILE__)))
+
+require 'date'
+
+require 'core_ext/date'
+require 'core_ext/string'
+
+require 'weekender/view_helpers'
+require 'weekender/weekender'

data/lib/weekender/view_helpers.rb

@@ -0,0 +1,76 @@
+module WeekenderHelpers
+
+  attr_reader :date_format,
+              :name_format
+
+  def display(options={})
+    @date_format  = options[:date_format] || '%Y-%m-%d'
+    @name_format  = options[:name_format] || :long
+    output = '<table class="weekender">'
+    output.add header_row
+    output.add week_rows(:reverse => (options[:reverse] || false))
+    output.add '</table>'
+  end
+
+private
+
+  def header_row
+    output = '<tr class="weekender_header">'.tab(2)
+    Weekender::DAY_NAMES.each do |day_name|
+      output.add ['<th>', abbreviate(day_name), '</th>'].join.tab(4)
+    end
+    output.add '</tr>'.tab(2)
+  end
+
+  def week_rows(options={})
+    output = ''
+    if options[:reverse] && options[:reverse] == true
+      weeks.downto(1) do |week|
+        if week == weeks
+          output = '<tr>'.tab(2)
+        else
+          output.add '<tr>'.tab(2)
+        end
+        1.upto(7) do |day|
+          output.add day_cell(week, day)
+        end
+        output.add '</tr>'.tab(2)
+      end
+    else
+      1.upto(weeks) do |week|
+        if week == 1
+          output = '<tr>'.tab(2)
+        else
+          output.add '<tr>'.tab(2)
+        end
+        1.upto(7) do |day|
+          output.add day_cell(week, day)
+        end
+        output.add '</tr>'.tab(2)
+      end
+    end
+    output
+  end
+
+  def day_cell(week, day)
+    date = date_on(week, day)
+    output = '<td>'
+    output << '<a href="#" class="weekender_date">'
+    output << date.strftime(date_format)
+    output << '</a>'
+    output << content_on(date.to_s)
+    output << '</td>'
+    output.tab(4)
+  end
+
+  def abbreviate(day_name)
+    if name_format == :medium
+      day_name[0..2]
+    elsif name_format == :short
+      day_name[0..0]
+    else
+      day_name
+    end
+  end
+
+end

data/lib/weekender/weekender.rb

@@ -0,0 +1,154 @@
+class Weekender
+
+  include WeekenderHelpers
+
+  DAY_NAMES = [ 'Monday',
+                'Tuesday',
+                'Wednesday',
+                'Thursday',
+                'Friday',
+                'Saturday',
+                'Sunday' ]
+
+  attr_accessor :year,
+                :month,
+                :day,
+                :year_end,
+                :month_end,
+                :day_end,
+                :before,
+                :after,
+                :events
+
+  def initialize(options={})
+    @year       = options[:year]      || Date.today.year
+    @month      = options[:month]     || Date.today.month
+    @day        = options[:day]       || Date.today.day
+    @year_end   = options[:year_end]  || year
+    @month_end  = options[:month_end] || month
+    @day_end    = options[:day_end]   || day
+    @before     = options[:before]    || 0
+    @after      = options[:after]     || 0
+    @events     = options[:events]    || []
+  end
+
+  def weeks
+    before + span + after
+  end
+
+  def span
+    ((spans_to - spans_from).to_i + 1) / 7
+  end
+
+  def spans_from
+    Date.commercial(date.cwyear, date.cweek, 1)
+  end
+
+  def starts_on
+    Date.commercial(start_week.cwyear, start_week.cweek, 1)
+  end
+
+  def ends_on
+    Date.commercial(end_week.cwyear, end_week.cweek, 7)
+  end
+
+  def spans_to
+    Date.commercial(end_date.cwyear, end_date.cweek, 7)
+  end
+
+  def date_on(week, day)
+    Date.commercial(week_date(week).cwyear, week_date(week).cweek, day)
+  end
+
+  def add_event(date, options={})
+    @events << [date, options]
+  end
+
+  def event_on?(date)
+    if events.empty?
+      false
+    else
+      events_dates.include?(date)
+    end
+  end
+
+  def events_dates
+    events.map { |event| event[0] }
+  end
+
+  def events_on(date)
+    if event_on?(date)
+      events.select { |event| event[0] == date }
+    else
+      []
+    end
+  end
+
+  def content_on(date)
+    content = ''
+    events_on(date).each do |event|
+      content << event[1][:content]
+    end
+    content
+  end
+
+  def html_classes_on(date)
+    classes = ''
+    events_on(date).each do |event|
+      classes << ' ' unless classes == ''
+      classes << event[1][:html_class]
+    end
+    classes
+  end
+
+  def previous
+    Weekender.new(
+      :year   => previous_date.year,
+      :month  => previous_date.month,
+      :day    => previous_date.day,
+      :before => before,
+      :after  => after
+    )
+  end
+
+  def next
+    Weekender.new(
+      :year   => next_date.year,
+      :month  => next_date.month,
+      :day    => next_date.day,
+      :before => before,
+      :after  => after
+    )
+  end
+
+# private
+
+  def date
+    Date.new(year, month, day)
+  end
+
+  def end_date
+    Date.new(year_end, month_end, day_end)
+  end
+
+  def start_week
+    date - (before * 7)
+  end
+
+  def end_week
+    end_date + (after * 7)
+  end
+
+  def week_date(week)
+    start_week + ((week - 1) * 7)
+  end
+
+  def previous_date
+    starts_on - 1 - (after * 7)
+  end
+
+  def next_date
+    ends_on + 1 + (before * 7)
+  end
+
+end

data/spec/fixtures/weekender.html

@@ -0,0 +1,38 @@
+<table class="weekender">
+  <tr class="weekender_header">
+    <th>Monday</th>
+    <th>Tuesday</th>
+    <th>Wednesday</th>
+    <th>Thursday</th>
+    <th>Friday</th>
+    <th>Saturday</th>
+    <th>Sunday</th>
+  </tr>
+  <tr>
+    <td><a href="#" class="weekender_date">2009-04-20</a></td>
+    <td><a href="#" class="weekender_date">2009-04-21</a></td>
+    <td><a href="#" class="weekender_date">2009-04-22</a></td>
+    <td><a href="#" class="weekender_date">2009-04-23</a></td>
+    <td><a href="#" class="weekender_date">2009-04-24</a></td>
+    <td><a href="#" class="weekender_date">2009-04-25</a></td>
+    <td><a href="#" class="weekender_date">2009-04-26</a></td>
+  </tr>
+  <tr>
+    <td><a href="#" class="weekender_date">2009-04-27</a></td>
+    <td><a href="#" class="weekender_date">2009-04-28</a></td>
+    <td><a href="#" class="weekender_date">2009-04-29</a></td>
+    <td><a href="#" class="weekender_date">2009-04-30</a></td>
+    <td><a href="#" class="weekender_date">2009-05-01</a><p>This is an event</p></td>
+    <td><a href="#" class="weekender_date">2009-05-02</a><p>This is another event</p></td>
+    <td><a href="#" class="weekender_date">2009-05-03</a></td>
+  </tr>
+  <tr>
+    <td><a href="#" class="weekender_date">2009-05-04</a></td>
+    <td><a href="#" class="weekender_date">2009-05-05</a></td>
+    <td><a href="#" class="weekender_date">2009-05-06</a></td>
+    <td><a href="#" class="weekender_date">2009-05-07</a></td>
+    <td><a href="#" class="weekender_date">2009-05-08</a></td>
+    <td><a href="#" class="weekender_date">2009-05-09</a></td>
+    <td><a href="#" class="weekender_date">2009-05-10</a></td>
+  </tr>
+</table>

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'weekender'
+
+Spec::Runner.configure do |config|
+
+end

data/spec/weekender_spec.rb

@@ -0,0 +1,281 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Weekender do
+
+  describe "defaults" do
+
+    before(:each) do
+      @weekender = Weekender.new
+    end
+
+    it "should be this year" do
+      @weekender.year.should eql(Date.today.year)
+    end
+
+    it "should be this month" do
+      @weekender.month.should eql(Date.today.month)
+    end
+
+    it "should be today" do
+      @weekender.day.should eql(Date.today.day)
+    end
+
+    it "should have 0 weeks before" do
+      @weekender.before.should eql(0)
+    end
+
+    it "should have 0 weeks after" do
+      @weekender.after.should eql(0)
+    end
+
+    it "should have 1 week" do
+      @weekender.weeks.should eql(1)
+    end
+
+    it "should start on a Monday" do
+      @weekender.starts_on.day_name.should eql("Monday")
+    end
+
+    it "should end on a Sunday" do
+      @weekender.ends_on.day_name.should eql("Sunday")
+    end
+
+    it "should have a date by week number and day number" do
+      @weekender.date_on(1, 1).should eql(@weekender.starts_on)
+    end
+
+    it "should have a date on end week and end day" do
+      @weekender.date_on(1, 7).should eql(@weekender.ends_on)
+    end
+
+    it "should start and end on the same date" do
+      @weekender.date.strftime('%Y-%m-%d').
+        should eql(@weekender.end_date.strftime('%Y-%m-%d'))
+    end
+
+    it "should start and end on the same week" do
+      @weekender.start_week.should eql(@weekender.end_week)
+    end
+
+  end
+
+  describe "with start date" do
+
+    before(:each) do
+      @weekender = Weekender.new( :year   => 1999,
+                                  :month  => 12,
+                                  :day    => 31,
+                                  :before => 3,
+                                  :after  => 4)
+    end
+
+    it "should be in 1999" do
+      @weekender.year.should eql(1999)
+    end
+
+    it "should start on a Monday" do
+      @weekender.starts_on.day_name.should eql("Monday")
+    end
+
+    it "should start in December" do
+      @weekender.starts_on.month_name.should eql('December')
+    end
+
+    it "should start on the 6th" do
+      @weekender.starts_on.day_of_month.should eql(6)
+    end
+
+    it "should start in 1999" do
+      @weekender.starts_on.year.should eql(1999)
+    end
+
+    it "should start on Monday, December 6th, 1999" do
+      @weekender.starts_on.should eql(Date.new(1999, 12, 6))
+    end
+
+    it "should end on a Sunday" do
+      @weekender.ends_on.day_name.should eql("Sunday")
+    end
+
+    it "should end in January" do
+      @weekender.ends_on.month_name.should eql("January")
+    end
+
+    it "should end on the 29th" do
+      @weekender.ends_on.day_of_month.should eql(30)
+    end
+
+    it "should end in 2000" do
+      @weekender.ends_on.year.should eql(2000)
+    end
+
+  end
+
+  describe "with start and end date" do
+
+    before(:each) do
+      @weekender = Weekender.new( :year       => 2009,
+                                  :month      => 5,
+                                  :day        => 1,
+                                  :year_end   => 2009,
+                                  :month_end  => 5,
+                                  :day_end    => 15,
+                                  :before     => 0,
+                                  :after      => 0)
+    end
+
+    it "should start on Monday, April 27th, 2009" do
+      @weekender.starts_on.should eql(Date.new(2009, 4, 27))
+    end
+
+    it "should end on a Sunday, May 17th, 2009" do
+      @weekender.ends_on.should eql(Date.new(2009, 5, 17))
+    end
+
+    it "should have 3 weeks" do
+      @weekender.weeks.should eql(3)
+    end
+
+  end
+
+  describe 'events' do
+
+    it 'should be an array of events' do
+      Weekender.new.events.should be_a_kind_of(Array)
+    end
+
+    it 'should be initialized as empty by default' do
+      Weekender.new.events.should be_empty
+    end
+
+    describe 'adding' do
+
+      before(:each) do
+        @weekender = Weekender.new
+      end
+
+      it "should not be an eventful day by default" do
+        @weekender.event_on?(Date.today).should be_false
+      end
+
+      it 'should add events to the specified day' do
+        @weekender.add_event(Date.today - 1)
+        @weekender.event_on?(Date.today - 1).should be_true
+      end
+
+    end
+
+    describe 'adding with content' do
+
+      before(:each) do
+        @weekender = Weekender.new
+
+        @weekender.add_event(Date.today - 1,
+                             :html_class => 'first',
+                             :content    => '<p>special content 1</p>')
+
+        @weekender.add_event(Date.today - 1,
+                             :html_class => 'second',
+                             :content    => '<p>special content 2</p>')
+
+        @weekender.add_event(Date.today - 2,
+                             :html_class => 'third',
+                             :content    => 'special content 3')
+      end
+
+      it "should have two events yesterday" do
+        @weekender.events_on(Date.today - 1).length.should eql(2)
+      end
+
+      it "should store the content" do
+        @weekender.content_on(Date.today - 1).
+          should eql('<p>special content 1</p><p>special content 2</p>')
+      end
+
+      it "should store the HTML class" do
+        @weekender.html_classes_on(Date.today - 1).
+          should eql('first second')
+      end
+
+    end
+
+  end
+
+  describe "day names" do
+
+    it "should be Monday through Sunday" do
+      Weekender::DAY_NAMES.should eql(
+        [ 'Monday',
+          'Tuesday',
+          'Wednesday',
+          'Thursday',
+          'Friday',
+          'Saturday',
+          'Sunday' ]
+      )
+    end
+
+  end
+
+  describe "previous and next" do
+
+    describe "defaults" do
+
+      it "should have previous" do
+        Weekender.new.previous.should be
+      end
+
+      it "should have next" do
+        Weekender.new.next.should be
+      end
+
+    end
+
+    describe "with weekender" do
+
+      before(:each) do
+        @weekender = Weekender.new(:year    => 2009,
+                                   :month   => 5,
+                                   :day     => 1,
+                                   :before  => 1,
+                                   :after   => 1)
+      end
+
+      it "should return the previous weekender" do
+        @weekender.previous.month.should eql(4)
+      end
+
+      it "should return the next weekender" do
+        @weekender.next.month.should eql(5)
+      end
+
+    end
+
+  end
+
+  describe 'generate HTML' do
+
+    describe 'for default' do
+
+      before(:each) do
+        @weekender = Weekender.new(:year    => 2009,
+                                   :month   => 5,
+                                   :day     => 1,
+                                   :before  => 1,
+                                   :after   => 1)
+        @weekender.add_event("2009-05-01",
+                            :content => "<p>This is an event</p>")
+        @weekender.add_event("2009-05-02",
+                            :content => "<p>This is another event</p>")
+        @default_table = File.read('spec/fixtures/weekender.html').chomp
+      end
+
+      it 'should display an HTML calendar' do
+        @weekender.display.should == @default_table
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: olauzon-weekender
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Olivier Lauzon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-19 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: olauzon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/core_ext/date.rb
+- lib/core_ext/string.rb
+- lib/weekender.rb
+- lib/weekender/view_helpers.rb
+- lib/weekender/weekender.rb
+- spec/fixtures/weekender.html
+- spec/spec_helper.rb
+- spec/weekender_spec.rb
+has_rdoc: false
+homepage: http://github.com/olauzon/weekender
+licenses: 
+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.3.5
+signing_key: 
+specification_version: 3
+summary: A simple Ruby library for creating calendars based on weeks rather than months.
+test_files: 
+- spec/spec_helper.rb
+- spec/weekender_spec.rb