calorie 0.0.1 → 0.0.2

data/README.md

@@ -2,8 +2,6 @@
 
 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.
@@ -13,7 +11,7 @@ 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.
+The data can be anything; only your code will be interacting with it.
 
       data = {
         1 => thing,
@@ -25,21 +23,30 @@ The data can be anything, and only your code will be interacting with it.
         # ... etc
       }
 
+Obviously, you don't need to pass in any data -- if it's easy enough to just loop through and check what day it is and do whatever you need to do in your view, that's up to you.
+
 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.:
+In your view, you can style it however you wish.
 
-      cal.days_of_the_week do |label|
-        if day.weekend?
-          # label styled as a weekend
-        else
-          # label styled as a weekday
-        end
+      # previous month, e.g. December 2009
+      cal.previous
+
+      # current month, e.g. January 2010
+      cal.current
+
+      # next month, e.g. February 2010
+      cal.next
+
+      cal.days_of_the_week do |day|
+        # day.label
+        # day.weekend?
       end
 
       cal.each_week do |week|
+        # week.number
         week.each_day do |day|
           unless day.blank?
             # the day of the month is day.number
@@ -51,8 +58,10 @@ In your view, you can style it however you wish, e.g.:
         end
       end
 
+Note: Weeks are numbered per ISO-8601. This gets a bit weird if you've configured your week to start on Sunday, as the ISO-8601 specifies that the week starts on Monday.
+On the other hand, the definition for *week 1* is the week that has the year's first Thursday in it, so that can be defined unambiguously even if you start your week on a Sunday.
 
-If you don't need to lay it out by week, you can also iterate straight through the days:
+If you don't need to lay it out by week, you can also iterate straight through the days (though I'm not sure why you'd use Calorie for this):
 
       cal.each_day do |day|
         # the day of the month is day.number
@@ -62,8 +71,29 @@ If you don't need to lay it out by week, you can also iterate straight through t
         end
       end
 
-## TODO
+## Configuration
+
+By default the first day of the week is Sunday, however this can be changed to Monday like so:
+
+      Calorie.configuration do |config|
+        config.week_starts_on :monday
+      end
+
+
+You will need to add translations for your locale(s).
+The translations for the week begin with Sunday, regardless of how you configure your week.
+
+
+    # en.yml
+    ---
+    calorie:
+      days_of_the_week: ["Su", "Mo", "Tu", "We", "Th", "Fr", "Sa"]
+      months: ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
+
+
 
-* configurable week start
-* i18n for days of the week
-* add labels for current, previous, and next month (with i18n support)
+    # fr.yml
+    ---
+    calorie:
+      days_of_the_week: ["di", "lu", "ma", "me", "je", "ve", "sa"]
+      months: ["janv.", "fevr.", "mars", "avr.", "mai", "juin", "juil.", "aout", "sept.", "oct.", "nov.", "dec."]

data/calorie.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rspec"
   s.add_development_dependency "timecop"
-  # s.add_runtime_dependency "rest-client"
+  s.add_runtime_dependency "i18n"
 end

data/lib/calorie.rb

@@ -1,15 +1,49 @@
 require "calorie/version"
 
 require 'date'
+require 'i18n'
 
 require 'calorie/weeks_in_month'
+require 'calorie/day_of_the_week'
 require 'calorie/calendar'
 require 'calorie/week'
 require 'calorie/day'
 
 module Calorie
 
-  def self.new(year, month, data)
-    Calendar.new(year, month, data)
+  class Config
+
+    def initialize
+      week_starts_on :sunday
+    end
+
+    def week_starts_on(day = nil)
+      @week_starts_on = day if day
+      @week_starts_on
+    end
+
+    def week_starts_on?(day)
+      day == @week_starts_on
+    end
+
   end
+
+  class << self
+    def configuration
+      @config ||= Config.new
+
+      yield @config if block_given?
+
+      @config
+    end
+
+    def config=(configuration)
+      @config = configuration
+    end
+
+    def new(year, month, data = {})
+      Calendar.new(year, month, data)
+    end
+  end
+
 end

data/lib/calorie/calendar.rb

@@ -4,7 +4,7 @@ module Calorie
     include WeeksInMonth
 
     attr_reader :days, :weeks, :year, :month, :data
-    def initialize(year, month, data)
+    def initialize(year, month, data = {})
       @data = data
       @year = year
       @month = month
@@ -27,7 +27,11 @@ module Calorie
     end
 
     def first_day_falls_on
-      first_day.wday
+      if Calorie.configuration.week_starts_on?(:monday)
+        (first_day.wday - 1) % 7
+      else
+        first_day.wday
+      end
     end
 
     def initialize_days
@@ -49,18 +53,22 @@ module Calorie
     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) }
+      (1..blank_days_at_start).each do |i|
+        slices.unshift(Calorie::NullDay.new(first_day - i))
+      end
+      (1..blank_days_at_end).each do |i|
+        slices.push(Calorie::NullDay.new(last_day + i))
+      end
 
       slices
     end
 
     def blank_days_at_start
-      first_day.wday
+      first_day_falls_on
     end
 
     def blank_days_at_end
-      (blank_days_at_start + days_in_month) % 7
+      7 - ((blank_days_at_start + days_in_month) % 7)
     end
 
     def days_in_month
@@ -72,7 +80,33 @@ module Calorie
     end
 
     def days_of_the_week
-      %w(Su Mo Tu We Th Fr Sa)
+      unless @days_of_the_week
+        @days_of_the_week ||= (0..6).map do |i|
+          DayOfTheWeek.new(i)
+        end
+        if Calorie.configuration.week_starts_on? :monday
+          @days_of_the_week.push(@days_of_the_week.shift)
+        end
+      end
+      @days_of_the_week
+    end
+
+    def previous
+      date = first_day.prev_month
+      the_month = I18n.translate('calorie.months')[date.month-1]
+      "#{the_month} #{date.year}"
+    end
+
+    def current
+      date = first_day
+      the_month = I18n.translate('calorie.months')[date.month-1]
+      "#{the_month} #{date.year}"
+    end
+
+    def next
+      date = first_day.next_month
+      the_month = I18n.translate('calorie.months')[date.month-1]
+      "#{the_month} #{date.year}"
     end
   end
 end

data/lib/calorie/day.rb

@@ -1,12 +1,9 @@
 module Calorie
   class Day
 
+    attr_reader :date
     def initialize(date = nil, data = nil)
-      if date
-        @date = date
-      else
-        @date = NullDate.new
-      end
+      @date = date
       @data = data
     end
 
@@ -23,7 +20,7 @@ module Calorie
     end
 
     def blank?
-      @date.is_a?(NullDate)
+      false
     end
 
     def today?
@@ -31,7 +28,16 @@ module Calorie
     end
   end
 
-  class NullDate
+  class NullDay
+    attr_reader :date
+    def initialize(date = nil)
+      @date = date
+    end
+
+    def blank?
+      true
+    end
+
     def sunday?
       false
     end
@@ -42,5 +48,8 @@ module Calorie
 
     def mday
     end
+
+    def number
+    end
   end
 end

data/lib/calorie/day_of_the_week.rb

@@ -0,0 +1,21 @@
+module Calorie
+  class DayOfTheWeek
+    class << self
+      def day_names
+        I18n.translate('calorie.days_of_the_week')
+      end
+    end
+
+    def initialize(day_of_the_week)
+      @day_of_the_week = day_of_the_week
+    end
+
+    def label
+      DayOfTheWeek.day_names[@day_of_the_week]
+    end
+
+    def weekend?
+      [0, 6].include?(@day_of_the_week)
+    end
+  end
+end

data/lib/calorie/version.rb

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

data/lib/calorie/week.rb

@@ -1,12 +1,23 @@
 module Calorie
   class Week
 
+    attr_reader :days
     def initialize(days)
       @days = days
     end
 
     def each_day(&block)
-      @days.each {|day| block.call(day) }
+      days.each {|day| block.call(day) }
+    end
+
+    def number
+      (thursday.date.yday / 7.0).ceil
+    end
+
+    def thursday
+      days.each do |day|
+        return day if day.date.thursday?
+      end
     end
   end
 end

data/spec/calendar_spec.rb

@@ -1,7 +1,48 @@
 require 'calorie'
 
 describe Calorie::Calendar do
-  subject { Calorie::Calendar.new(2010, 12, {25 => 'Christmas'}) }
+  subject { Calorie::Calendar.new(2007, 12, {25 => 'Christmas'}) }
+
+  context "with default configuration" do
+    before(:each) { Calorie.config = nil }
+
+    context "in the first week" do
+      it "numbers the days correctly" do
+        numbers = []
+        subject.weeks.first.each_day do |day|
+          numbers << day.number
+        end
+        numbers.should eq([nil, nil, nil, nil, nil, nil, 1])
+      end
+
+      it "dates the days correctly" do
+        dates = []
+        subject.weeks.first.each_day do |day|
+          dates << day.date.to_s
+        end
+        dates.should eq(["2007-11-25", "2007-11-26", "2007-11-27", "2007-11-28", "2007-11-29", "2007-11-30", "2007-12-01"])
+      end
+    end
+
+    context "in the last week" do
+      it "numbers the days correctly" do
+        numbers = []
+        subject.weeks.last.each_day do |day|
+          numbers << day.number
+        end
+        numbers.should eq([30, 31, nil, nil, nil, nil, nil])
+      end
+
+      it "dates the days correctly" do
+        dates = []
+        subject.weeks.last.each_day do |day|
+          dates << day.date.to_s
+        end
+        dates.should eq(["2007-12-30", "2007-12-31", "2008-01-01", "2008-01-02", "2008-01-03", "2008-01-04", "2008-01-05"])
+      end
+    end
+
+  end
 
   it "creates all the days" do
     numbers = []
@@ -20,23 +61,102 @@ describe Calorie::Calendar do
     end
   end
 
-  it "gets the first week right" do
-    numbers = []
-    subject.weeks.first.each_day do |day|
-      numbers << day.number
+  context "when week starts on sunday" do
+    before(:each) { Calorie.config = nil }
+
+    describe "first day falls on" do
+      {
+        2003 => 2,
+        2004 => 4,
+        2005 => 5,
+        2006 => 6,
+        2007 => 0,
+        2008 => 2
+      }.each do |year, offset|
+        it "#{offset} in #{year}" do
+          cal = Calorie::Calendar.new(year, 4, {})
+          cal.first_day_falls_on.should eq(offset)
+        end
+      end
     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
+  context "when week starts on monday" do
+    before :each do
+      Calorie.configuration do |config|
+        config.week_starts_on :monday
+      end
+    end
+
+    describe "first day falls on" do
+      {
+        2003 => 3,
+        2004 => 5,
+        2005 => 6,
+        2006 => 0,
+        2007 => 1,
+        2008 => 3
+      }.each do |year, offset|
+        it "#{offset} in #{year}" do
+          cal = Calorie::Calendar.new(year, 5, {})
+          cal.first_day_falls_on.should eq(offset)
+        end
+      end
     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))
+  describe "translation" do
+    around :each do |example|
+      I18n.with_locale(:xx) do
+        example.run
+      end
+    end
+
+    before :each do
+      xx = {
+        :calorie => {
+          :days_of_the_week => ['dimanche', 'lundi', 'mardi', 'mercredi', 'jeudi', 'vendredi', 'samedi'],
+          :months => ['jan', 'fev', 'mar', 'avr', 'mai', 'jui', 'jui', 'aou', 'sep', 'oct', 'nov', 'dec']
+        }
+      }
+      I18n.backend.store_translations(:xx, xx)
+    end
+
+    describe "monthly labels" do
+      context "in january 2010" do
+        subject { Calorie::Calendar.new(2010, 1, {}) }
+
+        specify { subject.previous.should eq('dec 2009') }
+        specify { subject.current.should eq('jan 2010') }
+      end
+
+      context "in december" do
+        subject { Calorie::Calendar.new(2010, 12, {}) }
+
+        specify { subject.next.should eq('jan 2011') }
+      end
+    end
+
+
+    describe "weekdays" do
+      subject { Calorie::Calendar.new(2010, 4, {}) }
+
+      context "with default configuration" do
+        before(:each) { Calorie.config = nil }
+
+        specify { subject.days_of_the_week.map(&:label).should eq(%w(dimanche lundi mardi mercredi jeudi vendredi samedi)) }
+      end
+
+      context "with week starting on monday" do
+        before :each do
+          Calorie.configuration do |config|
+            config.week_starts_on :monday
+          end
+        end
+
+        specify { subject.days_of_the_week.map(&:label).should eq(%w(lundi mardi mercredi jeudi vendredi samedi dimanche)) }
+      end
+    end
   end
+
 end

data/spec/calorie_spec.rb

@@ -10,4 +10,40 @@ describe Calorie do
       end
     end
   end
+
+  describe "configuration" do
+    it "has a global config" do
+      Calorie.configuration.should eq(Calorie.configuration)
+    end
+
+    context "when unconfigured" do
+      before :each do
+        Calorie.config = nil
+      end
+
+      it "starts week on Sunday by default" do
+        Calorie.configuration.week_starts_on.should eq(:sunday)
+      end
+
+      it "knows when the week starts" do
+        Calorie.configuration.week_starts_on?(:sunday).should be_true
+      end
+    end
+
+    context "when overriding defaults" do
+      before :each do
+        Calorie.configuration do |config|
+          config.week_starts_on :monday
+        end
+      end
+
+      it "has the correct start of the week" do
+        Calorie.configuration.week_starts_on.should eq(:monday)
+      end
+
+      it "knows when the week starts" do
+        Calorie.configuration.week_starts_on?(:monday).should be_true
+      end
+    end
+  end
 end

data/spec/day_of_the_week_spec.rb

@@ -0,0 +1,27 @@
+require 'calorie'
+
+describe Calorie::DayOfTheWeek do
+  around :each do |example|
+    I18n.with_locale(:xx) do
+      example.run
+    end
+  end
+
+  before :each do
+    xx = { :calorie => { :days_of_the_week => ['dimanche', 'lundi', 'mardi', 'mercredi', 'jeudi', 'vendredi', 'samedi'], } }
+    I18n.backend.store_translations(:xx, xx)
+  end
+
+  it "has a label" do
+    Calorie::DayOfTheWeek.new(0).label.should eq('dimanche')
+  end
+
+  [0, 6].each do |i|
+    specify { Calorie::DayOfTheWeek.new(i).weekend?.should be_true }
+  end
+
+  (1..5).each do |i|
+    specify { Calorie::DayOfTheWeek.new(i).weekend?.should be_false }
+  end
+
+end

data/spec/day_spec.rb

@@ -16,6 +16,10 @@ describe Calorie::Day do
         Timecop.freeze(Time.new(2010, 6, 13, 11, 40, 17))
       end
 
+      after :each do
+        Timecop.return
+      end
+
       its(:today?) { should be_true }
     end
 
@@ -24,6 +28,10 @@ describe Calorie::Day do
         Timecop.freeze(Time.new(2010, 6, 14, 20, 15, 47))
       end
 
+      after :each do
+        Timecop.return
+      end
+
       its(:today?) { should be_false }
     end
   end
@@ -36,17 +44,12 @@ describe Calorie::Day do
     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
+describe Calorie::NullDay do
+  let(:jan1) { Date.new(2010, 1, 1) }
+  subject { Calorie::NullDay.new(jan1) }
+  its(:date) { should eq(jan1) }
   its(:mday) { should be_nil }
   its(:sunday?) { should be_false }
   its(:saturday?) { should be_false }

data/spec/week_of_the_year_spec.rb

@@ -0,0 +1,68 @@
+require 'calorie'
+
+describe "Week number" do
+
+  context "in the first week of january" do
+
+    {2005 => 53, 2006 => 52, 2007 => 1, 2008 => 1, 2009 => 1, 2010=> 53}.each do |year, week_number|
+      context "with week starting monday" do
+        before :each do
+          Calorie.configuration do |config|
+            config.week_starts_on :monday
+          end
+        end
+
+        specify "in #{year}" do
+          Calorie.new(year, 1).weeks.first.number.should eq(week_number)
+        end
+      end
+    end
+
+    {2005 => 53, 2006 => 1, 2007 => 1, 2008 => 1, 2009 => 1, 2010=> 53}.each do |year, week_number|
+      # this is a bit far-fetched, as the iso-8601 week always starts on a Monday.
+      # on the other hand, the numbering scheme is defined as week 1 being the week
+      # that has the year's first Thursday in it, so it kind of works.
+      context "with week starting sunday" do
+        before :each do
+          Calorie.configuration do |config|
+            config.week_starts_on :sunday
+          end
+        end
+
+        specify "in #{year}" do
+          Calorie.new(year, 1).weeks.first.number.should eq(week_number)
+        end
+      end
+    end
+  end
+
+  describe "in the last week of december" do
+    {2004 => 53, 2005 => 52, 2006 => 1, 2007 => 1, 2008 => 1, 2009 => 53, 2010 => 52}.each do |year, week_number|
+      context "with week starting sunday" do
+        before :each do
+          Calorie.configuration do |config|
+            config.week_starts_on :sunday
+          end
+        end
+
+        specify "in #{year}" do
+          Calorie.new(year, 12).weeks.last.number.should eq(week_number)
+        end
+      end
+    end
+
+    context "with week starting monday" do
+      {2004 => 53, 2005 => 52, 2006 => 52, 2007 => 1, 2008 => 1, 2009 => 53, 2010 => 52}.each do |year, week_number|
+        before :each do
+          Calorie.configuration do |config|
+            config.week_starts_on :monday
+          end
+        end
+
+        specify "in #{year}" do
+          Calorie.new(year, 12).weeks.last.number.should eq(week_number)
+        end
+      end
+    end
+  end
+end

data/spec/week_spec.rb

@@ -2,23 +2,31 @@ 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"),
+  let(:thursday) { Calorie::Day.new(Date.new(2010, 6, 3)) }
+  let(:days) {
+    [
+      Calorie::NullDay.new(Date.new(2010, 5, 29)),
+      Calorie::NullDay.new(Date.new(2010, 5, 31)),
+      Calorie::Day.new(Date.new(2010, 6, 1)),
+      Calorie::Day.new(Date.new(2010, 6, 2)),
+      thursday,
+      Calorie::Day.new(Date.new(2010, 6, 4)),
+      Calorie::Day.new(Date.new(2010, 6, 5)),
     ]
+  }
+
+  let(:week) { Calorie::Week.new(days) }
 
+  it "loops through the days" do
     numbers = []
-    Calorie::Week.new(days).each_day do |day|
+    week.each_day do |day|
       numbers << day.number
     end
 
     numbers.should eq([nil, nil, 1, 2, 3, 4, 5])
   end
+
+  it "can find its Thursday" do
+    week.thursday.should eq(thursday)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: calorie
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-27 00:00:00.000000000Z
+date: 2011-12-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153896240 !ruby/object:Gem::Requirement
+  requirement: &2161868520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153896240
+  version_requirements: *2161868520
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &2153895820 !ruby/object:Gem::Requirement
+  requirement: &2161868100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153895820
+  version_requirements: *2161868100
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &2161867680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161867680
 description: A simple, ruby calendar presenter.
 email:
 - katrina.owen@gmail.com
@@ -49,12 +60,15 @@ files:
 - lib/calorie.rb
 - lib/calorie/calendar.rb
 - lib/calorie/day.rb
+- lib/calorie/day_of_the_week.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_of_the_week_spec.rb
 - spec/day_spec.rb
+- spec/week_of_the_year_spec.rb
 - spec/week_spec.rb
 - spec/weeks_in_month_spec.rb
 homepage: ''