calorie 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/README.md

@@ -0,0 +1,69 @@
+# Calorie
+
+A calendar is a calendar is a calendar.
+
+Motivated by the frustration of solving the same problem in a dozen different ugly ways in a dozen different applications.
+
+## Requirements
+
+This uses the ruby core `Date` library.
+
+In other words, rails is *not* required.
+
+## Usage
+
+Create a hash that uses the day of the month as the key.
+The data can be anything, and only your code will be interacting with it.
+
+      data = {
+        1 => thing,
+        2 => different_thing,
+        3 => nil,
+        4 => medium_sized_thing,
+        5 => complicated_thing,
+        6 => nil,
+        # ... etc
+      }
+
+Create a presenter for a month by sending in `year`, `month`, and the data:
+
+      cal = Calorie.new(2010, 6, data)
+
+In your view, you can style it however you wish, e.g.:
+
+      cal.days_of_the_week do |label|
+        if day.weekend?
+          # label styled as a weekend
+        else
+          # label styled as a weekday
+        end
+      end
+
+      cal.each_week do |week|
+        week.each_day do |day|
+          unless day.blank?
+            # the day of the month is day.number
+            # do stuff with day.data
+            if day.today?
+              # omg, it's RIGHT NOW
+            end
+          end
+        end
+      end
+
+
+If you don't need to lay it out by week, you can also iterate straight through the days:
+
+      cal.each_day do |day|
+        # the day of the month is day.number
+        # do stuff with day.data
+        if day.today?
+          # omg, it's RIGHT NOW
+        end
+      end
+
+## TODO
+
+* configurable week start
+* i18n for days of the week
+* add labels for current, previous, and next month (with i18n support)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/calorie.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "calorie/version"
+
+Gem::Specification.new do |s|
+  s.name        = "calorie"
+  s.version     = Calorie::VERSION
+  s.authors     = ["Katrina Owen"]
+  s.email       = ["katrina.owen@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A calendar is a calendar is a calendar.}
+  s.description = %q{A simple, ruby calendar presenter.}
+
+  s.rubyforge_project = "calorie"
+
+  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_development_dependency "rspec"
+  s.add_development_dependency "timecop"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/calorie.rb

@@ -0,0 +1,15 @@
+require "calorie/version"
+
+require 'date'
+
+require 'calorie/weeks_in_month'
+require 'calorie/calendar'
+require 'calorie/week'
+require 'calorie/day'
+
+module Calorie
+
+  def self.new(year, month, data)
+    Calendar.new(year, month, data)
+  end
+end

data/lib/calorie/calendar.rb

@@ -0,0 +1,78 @@
+module Calorie
+
+  class Calendar
+    include WeeksInMonth
+
+    attr_reader :days, :weeks, :year, :month, :data
+    def initialize(year, month, data)
+      @data = data
+      @year = year
+      @month = month
+      initialize_days
+      initialize_weeks
+    end
+
+    def first_day
+      @first_day ||= Date.new(year, month, 1)
+      @first_day
+    end
+
+    def last_day
+      @last_day ||= first_day.next_month.prev_day
+      @last_day
+    end
+
+    def days_in_month
+      days.size
+    end
+
+    def first_day_falls_on
+      first_day.wday
+    end
+
+    def initialize_days
+      @days = []
+      (first_day.mday..last_day.mday).map do |i|
+        date = Date.new(year, month, i)
+        @days << Calorie::Day.new(date, data[i])
+      end
+    end
+
+    def initialize_weeks
+      @weeks = []
+      padded_days = days_for_slicing
+      number_of_weeks.times do
+        @weeks << Calorie::Week.new(padded_days.slice!(0..6))
+      end
+    end
+
+    def days_for_slicing
+      slices = days.clone
+
+      blank_days_at_start.times { slices.unshift(Calorie::Day.new) }
+      blank_days_at_end.times { slices.push(Calorie::Day.new) }
+
+      slices
+    end
+
+    def blank_days_at_start
+      first_day.wday
+    end
+
+    def blank_days_at_end
+      (blank_days_at_start + days_in_month) % 7
+    end
+
+    def days_in_month
+      last_day.mday
+    end
+
+    def each_day(&block)
+      days.each {|day| block.call(day) }
+    end
+
+    def days_of_the_week
+      %w(Su Mo Tu We Th Fr Sa)
+    end
+  end
+end

data/lib/calorie/day.rb

@@ -0,0 +1,46 @@
+module Calorie
+  class Day
+
+    def initialize(date = nil, data = nil)
+      if date
+        @date = date
+      else
+        @date = NullDate.new
+      end
+      @data = data
+    end
+
+    def weekend?
+      @date.sunday? || @date.saturday?
+    end
+
+    def number
+      @date.mday
+    end
+
+    def data
+      @data
+    end
+
+    def blank?
+      @date.is_a?(NullDate)
+    end
+
+    def today?
+      @date == Date.today
+    end
+  end
+
+  class NullDate
+    def sunday?
+      false
+    end
+
+    def saturday?
+      false
+    end
+
+    def mday
+    end
+  end
+end

data/lib/calorie/version.rb

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

data/lib/calorie/week.rb

@@ -0,0 +1,12 @@
+module Calorie
+  class Week
+
+    def initialize(days)
+      @days = days
+    end
+
+    def each_day(&block)
+      @days.each {|day| block.call(day) }
+    end
+  end
+end

data/lib/calorie/weeks_in_month.rb

@@ -0,0 +1,9 @@
+module Calorie
+  module WeeksInMonth
+
+    def number_of_weeks
+      ((days_in_month + first_day_falls_on) / 7.0).ceil
+    end
+
+  end
+end

data/spec/calendar_spec.rb

@@ -0,0 +1,42 @@
+require 'calorie'
+
+describe Calorie::Calendar do
+  subject { Calorie::Calendar.new(2010, 12, {25 => 'Christmas'}) }
+
+  it "creates all the days" do
+    numbers = []
+    subject.each_day do |day|
+      numbers << day.number
+    end
+
+    numbers.should eq((1..31).to_a)
+  end
+
+  it "hands out the data" do
+    subject.each_day do |day|
+      if day.number == 25
+        day.data.should eq('Christmas')
+      end
+    end
+  end
+
+  it "gets the first week right" do
+    numbers = []
+    subject.weeks.first.each_day do |day|
+      numbers << day.number
+    end
+    numbers.should eq([nil, nil, nil] + (1..4).to_a)
+  end
+
+  it "gets the last week right" do
+    numbers = []
+    subject.weeks.last.each_day do |day|
+      numbers << day.number
+    end
+    numbers.should eq((26..31).to_a + [nil])
+  end
+
+  it "has labels for the days of the week" do
+    subject.days_of_the_week.should eq(%w(Su Mo Tu We Th Fr Sa))
+  end
+end

data/spec/calorie_spec.rb

@@ -0,0 +1,13 @@
+require 'calorie'
+
+describe Calorie do
+  it "provides a simple presenter for a monthly calendar" do
+    cal = Calorie.new(2010, 12, {25 => 'Christmas'})
+
+    cal.each_day do |day|
+      if day.number == 25
+        day.data.should eq('Christmas')
+      end
+    end
+  end
+end

data/spec/day_spec.rb

@@ -0,0 +1,53 @@
+require 'calorie/day'
+require 'timecop'
+
+describe Calorie::Day do
+
+  context "during the weekend" do
+    subject { Calorie::Day.new(Date.new(2010, 6, 13), "hello, world") }
+
+    its(:number) { should eq(13) }
+    its(:data) { should eq("hello, world") }
+    its(:weekend?) { should be_true }
+    its(:blank?) { should be_false}
+
+    context "on that particular day" do
+      before :each do
+        Timecop.freeze(Time.new(2010, 6, 13, 11, 40, 17))
+      end
+
+      its(:today?) { should be_true }
+    end
+
+    context "on a different day" do
+      before :each do
+        Timecop.freeze(Time.new(2010, 6, 14, 20, 15, 47))
+      end
+
+      its(:today?) { should be_false }
+    end
+  end
+
+  context "midweek" do
+    subject { Calorie::Day.new(Date.new(2010, 6, 17), "so long, folks") }
+
+    its(:number) { should eq(17) }
+    its(:data) { should eq("so long, folks") }
+    its(:weekend?) { should be_false }
+    its(:blank?) { should be_false}
+  end
+
+  context "a null day" do
+    subject { Calorie::Day.new }
+    its(:blank?) { should be_true }
+    its(:number) { should be_nil }
+    its(:weekend?) { should be_false }
+    its(:data) { should be_nil }
+  end
+end
+
+describe Calorie::NullDate do
+  its(:mday) { should be_nil }
+  its(:sunday?) { should be_false }
+  its(:saturday?) { should be_false }
+end

data/spec/week_spec.rb

@@ -0,0 +1,24 @@
+require 'calorie/day'
+require 'calorie/week'
+
+describe Calorie::Week do
+
+  it "loops through the days" do
+    days = [
+      Calorie::Day.new,
+      Calorie::Day.new,
+      Calorie::Day.new(Date.new(2010, 6, 1), "the first"),
+      Calorie::Day.new(Date.new(2010, 6, 2), "the second"),
+      Calorie::Day.new(Date.new(2010, 6, 3), "the third"),
+      Calorie::Day.new(Date.new(2010, 6, 4), "the fourth"),
+      Calorie::Day.new(Date.new(2010, 6, 5), "the fifth"),
+    ]
+
+    numbers = []
+    Calorie::Week.new(days).each_day do |day|
+      numbers << day.number
+    end
+
+    numbers.should eq([nil, nil, 1, 2, 3, 4, 5])
+  end
+end

data/spec/weeks_in_month_spec.rb

@@ -0,0 +1,95 @@
+require 'calorie/weeks_in_month'
+
+describe Calorie::WeeksInMonth do
+  let(:cal) { stub.extend(Calorie::WeeksInMonth) }
+
+  context "with a 28 day month" do
+    before :each do
+      cal.stub(:days_in_month => 28)
+    end
+
+    it "has 4 weeks when first day is Sunday" do
+      cal.stub(:first_day_falls_on => 0)
+      cal.number_of_weeks.should eq(4)
+    end
+
+    it "has 5 weeks when first day is Monday" do
+      cal.stub(:first_day_falls_on => 1)
+      cal.number_of_weeks.should eq(5)
+    end
+
+    it "has 5 weeks when first day is Saturday" do
+      cal.stub(:first_day_falls_on => 6)
+      cal.number_of_weeks.should eq(5)
+    end
+  end
+
+  context "with a 29 day month" do
+    before :each do
+      cal.stub(:days_in_month => 29)
+    end
+
+    it "has 5 weeks when first day is Sunday" do
+      cal.stub(:first_day_falls_on => 0)
+      cal.number_of_weeks.should eq(5)
+    end
+
+    it "has 5 weeks when first day is Monday" do
+      cal.stub(:first_day_falls_on => 1)
+      cal.number_of_weeks.should eq(5)
+    end
+
+    it "has 5 weeks when first day is Saturday" do
+      cal.stub(:first_day_falls_on => 6)
+      cal.number_of_weeks.should eq(5)
+    end
+
+  end
+
+  context "with a 30 day month" do
+    before :each do
+      cal.stub(:days_in_month => 30)
+    end
+
+    it "has 5 weeks when first day is Sunday" do
+      cal.stub(:first_day_falls_on => 0)
+      cal.number_of_weeks.should eq(5)
+    end
+
+    it "has 5 weeks when first day is Friday" do
+      cal.stub(:first_day_falls_on => 5)
+      cal.number_of_weeks.should eq(5)
+    end
+
+    it "has 6 weeks when first day is Saturday" do
+      cal.stub(:first_day_falls_on => 6)
+      cal.number_of_weeks.should eq(6)
+    end
+  end
+
+  context "with a 31 day month" do
+    before :each do
+      cal.stub(:days_in_month => 31)
+    end
+
+    it "has 5 weeks when first day is Sunday" do
+      cal.stub(:first_day_falls_on => 0)
+      cal.number_of_weeks.should eq(5)
+    end
+
+    it "has 5 weeks when first day is Thursday" do
+      cal.stub(:first_day_falls_on => 4)
+      cal.number_of_weeks.should eq(5)
+    end
+
+    it "has 6 weeks when first day is Friday" do
+      cal.stub(:first_day_falls_on => 5)
+      cal.number_of_weeks.should eq(6)
+    end
+
+    it "has 6 weeks when first day is Saturday" do
+      cal.stub(:first_day_falls_on => 6)
+      cal.number_of_weeks.should eq(6)
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: calorie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Katrina Owen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-27 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153896240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153896240
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &2153895820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153895820
+description: A simple, ruby calendar presenter.
+email:
+- katrina.owen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- calorie.gemspec
+- lib/calorie.rb
+- lib/calorie/calendar.rb
+- lib/calorie/day.rb
+- lib/calorie/version.rb
+- lib/calorie/week.rb
+- lib/calorie/weeks_in_month.rb
+- spec/calendar_spec.rb
+- spec/calorie_spec.rb
+- spec/day_spec.rb
+- spec/week_spec.rb
+- spec/weeks_in_month_spec.rb
+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: '0'
+requirements: []
+rubyforge_project: calorie
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A calendar is a calendar is a calendar.
+test_files: []