cal 0.5.1 → 0.6.1

data/README.md

@@ -24,6 +24,28 @@ Cal is a simple calendar structure. It **does not** render a calendar. It **does
 
 See the Rails app [https://github.com/austinthecoder/cal-app](https://github.com/austinthecoder/cal-app) for an example.
 
+### API
+
+``` ruby
+calendar = Cal::MonthlyCalendar.new 2012, 11, :start_week_on => :monday
+
+calendar.month # a Cal::Month
+
+calendar.first_day # a Cal::Day representing the first day on the calendar, might be in the previous month
+
+calendar.last_day # a Cal::Day representing the last day on the calendar, might be in the next month
+
+calendar.days # a Range of Cal::Day's from the first day to the last
+
+calendar.weeks # an Array of Cal::Day Arrays
+
+calendar.previous # the calendar for the previous month
+
+calendar.next # the calendar for the next month
+
+calendar.day_names # an Array of the day names, e.g. ['Sunday', 'Monday', ...], depends on the `:start_week_on` option
+```
+
 ### Rails example
 
 ``` ruby
@@ -37,7 +59,7 @@ calendar = Cal::MonthlyCalendar.from_param params[:month], :start_week_on => :mo
 %h3
   = link_to 'Previous month', calendar_path(calendar.previous)
   |
-  = "#{calendar.month} #{calendar.year}"
+  = "#{calendar.month.to_s "%B"} #{calendar.year}"
   |
   = link_to 'Next month', calendar_path(calendar.next)
 
@@ -60,4 +82,4 @@ calendar = Cal::MonthlyCalendar.from_param params[:month], :start_week_on => :mo
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/lib/cal.rb

@@ -6,5 +6,12 @@ module Cal
   autoload :MonthlyCalendar, 'cal/monthly_calendar'
   autoload :Day, 'cal/day'
   autoload :Month, 'cal/month'
+  autoload :DayName, 'cal/day_name'
+
+  class << self
+    def new_monthly_calendar(*args)
+      MonthlyCalendar.new *args
+    end
+  end
 
 end

data/lib/cal/day_name.rb

@@ -0,0 +1,73 @@
+module Cal
+  class DayName
+
+    class << self
+      def all(options = {})
+        if options[:start_on]
+          sunday_to_saturday.rotate(send(options[:start_on].to_s.downcase.to_sym).position - 1)
+        else
+          sunday_to_saturday
+        end
+      end
+
+      def sunday
+        @sunday ||= new :sunday, 'Sunday', 1
+      end
+
+      def monday
+        @monday ||= new :monday, 'Monday', 2
+      end
+
+      def tuesday
+        @tuesday ||= new :tuesday, 'Tuesday', 3
+      end
+
+      def wednesday
+        @wednesday ||= new :wednesday, 'Wednesday', 4
+      end
+
+      def thursday
+        @thursday ||= new :thursday, 'Thursday', 5
+      end
+
+      def friday
+        @friday ||= new :friday, 'Friday', 6
+      end
+
+      def saturday
+        @saturday ||= new :saturday, 'Saturday', 7
+      end
+
+    private
+
+      def sunday_to_saturday
+        @sunday_to_saturday ||= [sunday, monday, tuesday, wednesday, thursday, friday, saturday]
+      end
+    end
+
+    private_class_method :new
+
+    def initialize(symbol, string, position)
+      @to_sym = symbol
+      @to_s = string
+      @position = position
+    end
+
+    attr_reader :to_sym, :to_s, :position
+
+    def succ
+      self.class.all.detect do |day_name|
+        day_name.position == (position < 7 ? position + 1 : 1)
+      end
+    end
+
+    alias_method :next, :succ
+
+    def previous
+      self.class.all.detect do |day_name|
+        day_name.position == (position > 1 ? position - 1 : 7)
+      end
+    end
+
+  end
+end

data/lib/cal/monthly_calendar.rb

@@ -6,16 +6,6 @@ module Cal
 
     include Comparable
 
-    DAY_NAMES = {
-      :sunday => 0,
-      :monday => 1,
-      :tuesday => 2,
-      :wednesday => 3,
-      :thursday => 4,
-      :friday => 5,
-      :saturday => 6
-    }
-
     class << self
       def from_month(month, options = {})
         month = month.to_month
@@ -79,7 +69,7 @@ module Cal
     end
 
     def day_names
-      %w[Sunday Monday Tuesday Wednesday Thursday Friday Saturday].rotate DAY_NAMES[start_week_on]
+      @day_names ||= DayName.all :start_on => start_week_on
     end
 
     def to_param

data/lib/cal/version.rb

@@ -1,5 +1,5 @@
 module Cal
 
-  VERSION = "0.5.1"
+  VERSION = "0.6.1"
 
 end

data/spec/cal/day_name_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe Cal::DayName do
+
+  describe "class method" do
+    subject { described_class }
+
+    describe "all" do
+      it "returns all the days, starting with sunday" do
+        subject.all.should == [
+          subject.sunday,
+          subject.monday,
+          subject.tuesday,
+          subject.wednesday,
+          subject.thursday,
+          subject.friday,
+          subject.saturday
+        ]
+      end
+
+      it "when given a day name symbol as the :start_on option, it starts the week on that day" do
+        subject.all(:start_on => :tuesday).should == [
+          subject.tuesday,
+          subject.wednesday,
+          subject.thursday,
+          subject.friday,
+          subject.saturday,
+          subject.sunday,
+          subject.monday
+        ]
+      end
+
+      it "accepts the :start_on option in various formats" do
+        [:tuesday, 'Tuesday', 'tuesday'].each do |start_on|
+          subject.all(:start_on => start_on).should == [
+            subject.tuesday,
+            subject.wednesday,
+            subject.thursday,
+            subject.friday,
+            subject.saturday,
+            subject.sunday,
+            subject.monday
+          ]
+        end
+      end
+
+      it "without the :start_on option, it returns the same object" do
+        subject.all.equal?(subject.all).should be_true
+      end
+    end
+
+    it "doesn't allow direct initialization" do
+      expect { subject.new }.to raise_error NoMethodError
+    end
+  end
+
+  describe "instance method" do
+    [
+      [:sunday, 'Sunday', 1],
+      [:monday, 'Monday', 2],
+      [:tuesday, 'Tuesday', 3],
+      [:wednesday, 'Wednesday', 4],
+      [:thursday, 'Thursday', 5],
+      [:friday, 'Friday', 6],
+      [:saturday, 'Saturday', 7]
+    ].each do |day, string, position|
+      context "when the day is #{day}" do
+        subject { described_class.send day }
+
+        it "is the same instance as another #{day}" do
+          subject.equal?(described_class.send(day)).should be_true
+        end
+
+        describe "to_sym" do
+          it "is #{day.inspect}" do
+            subject.to_sym.should == day
+          end
+        end
+
+        describe "to_s" do
+          it "is #{string.inspect}" do
+            subject.to_s.should == string
+          end
+        end
+
+        describe "position" do
+          it "is #{position.inspect}" do
+            subject.position.should == position
+          end
+        end
+      end
+    end
+
+    describe "succ" do
+      [
+        [:sunday, :monday],
+        [:monday, :tuesday],
+        [:tuesday, :wednesday],
+        [:wednesday, :thursday],
+        [:thursday, :friday],
+        [:friday, :saturday],
+        [:saturday, :sunday]
+      ].each do |day, next_day|
+        it "is #{next_day} when the say is #{day}" do
+          described_class.send(day).succ.should == described_class.send(next_day)
+        end
+      end
+    end
+
+    describe "next" do
+      it "is an alias of #succ" do
+        day_name = described_class.friday
+        day_name.next.should == day_name.succ
+      end
+    end
+
+    describe "previous" do
+      [
+        [:sunday, :saturday],
+        [:monday, :sunday],
+        [:tuesday, :monday],
+        [:wednesday, :tuesday],
+        [:thursday, :wednesday],
+        [:friday, :thursday],
+        [:saturday, :friday]
+      ].each do |day, previous_day|
+        it "is #{previous_day} when the say is #{day}" do
+          described_class.send(day).previous.should == described_class.send(previous_day)
+        end
+      end
+    end
+  end
+
+end

data/spec/cal/monthly_calendar_spec.rb

@@ -172,20 +172,28 @@ describe Cal::MonthlyCalendar do
 
     describe "day_names" do
       it "defaults to sunday through saturday" do
-        subject.day_names.should == %w[Sunday Monday Tuesday Wednesday Thursday Friday Saturday]
+        subject.day_names.should == [
+          Cal::DayName.sunday,
+          Cal::DayName.monday,
+          Cal::DayName.tuesday,
+          Cal::DayName.wednesday,
+          Cal::DayName.thursday,
+          Cal::DayName.friday,
+          Cal::DayName.saturday
+        ]
       end
 
       [
-        %w[Monday Tuesday Wednesday Thursday Friday Saturday Sunday],
-        %w[Tuesday Wednesday Thursday Friday Saturday Sunday Monday],
-        %w[Wednesday Thursday Friday Saturday Sunday Monday Tuesday],
-        %w[Thursday Friday Saturday Sunday Monday Tuesday Wednesday],
-        %w[Friday Saturday Sunday Monday Tuesday Wednesday Thursday],
-        %w[Saturday Sunday Monday Tuesday Wednesday Thursday Friday]
+        [:monday, :tuesday, :wednesday, :thursday, :friday, :saturday, :sunday],
+        [:tuesday, :wednesday, :thursday, :friday, :saturday, :sunday, :monday],
+        [:wednesday, :thursday, :friday, :saturday, :sunday, :monday, :tuesday],
+        [:thursday, :friday, :saturday, :sunday, :monday, :tuesday, :wednesday],
+        [:friday, :saturday, :sunday, :monday, :tuesday, :wednesday, :thursday],
+        [:saturday, :sunday, :monday, :tuesday, :wednesday, :thursday, :friday]
       ].each do |day_names|
         it "is #{day_names[0]} through #{day_names[6]} when the weekday is set to start on #{day_names[0]}" do
-          @options[:start_week_on] = day_names[0].downcase.to_sym
-          subject.day_names.should == day_names
+          @options[:start_week_on] = day_names[0]
+          subject.day_names.should == day_names.map { |dn| Cal::DayName.send dn }
         end
       end
     end

data/spec/cal_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Cal do
+  subject { described_class }
+
+  describe "new_monthly_calendar" do
+    it "creates a new monthly calendar with the given args" do
+      @args = [1, 2, 3]
+      monthly_calendar = Object.new
+      Cal::MonthlyCalendar.stub :new do |*args|
+        monthly_calendar if args == @args
+      end
+      subject.new_monthly_calendar(*@args).should == monthly_calendar
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cal
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-13 00:00:00.000000000 Z
+date: 2012-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -59,12 +59,15 @@ files:
 - cal.gemspec
 - lib/cal.rb
 - lib/cal/day.rb
+- lib/cal/day_name.rb
 - lib/cal/month.rb
 - lib/cal/monthly_calendar.rb
 - lib/cal/version.rb
+- spec/cal/day_name_spec.rb
 - spec/cal/day_spec.rb
 - spec/cal/month_spec.rb
 - spec/cal/monthly_calendar_spec.rb
+- spec/cal_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/austinthecoder/cal
 licenses: []
@@ -91,7 +94,9 @@ signing_key:
 specification_version: 3
 summary: A low level calendar engine.
 test_files:
+- spec/cal/day_name_spec.rb
 - spec/cal/day_spec.rb
 - spec/cal/month_spec.rb
 - spec/cal/monthly_calendar_spec.rb
+- spec/cal_spec.rb
 - spec/spec_helper.rb