sixarm_ruby_week 1.1.0 → 1.1.4

data/CHANGELOG.txt

@@ -1,4 +1,7 @@
 CHANGELOG
 
+2012-03-12 1.1.4 Improve tests from test/unit style toward minitest/spec style
+2012-03-11 1.1.2 Add #date_range method to return start_date..end_date
+2012-03-10 1.1.1 Rename #includes? to #include? because it matches Ruby's Array include? method 
 2012-02-24 1.1.0 Add methods .now, #includes?, #previous, #next, #start_date, #end_date, and improve examples
 2012-02-23 1.0.0 Updates for gem publishing 

data/README.rdoc

@@ -8,24 +8,39 @@ This gem models a week, based on the built-in Ruby Date class.
 
 == Examples
 
-  week = Week.parse('2012-01-02')
-  week.to_s => '2012-01-02'
 
-== Example Enumerable
+Initialize:
+    
+    date = Date.parse('2012-01-02')
+    week = Week.new(date)
+    week.to_s => '2012-01-02'
 
-  week.previous.to_s => '2011-12-26'
-  week.next.to_s => '2012-01-16'
+Parse:
 
-== Example Math
+    week = Week.parse('2012-01-02')
+    week => 2012-01-02
 
-  (week - 3).to_s => '2011-12-12'
-  (week + 3).to_s => '2012-01-24'
+Enumerable:
 
-== Example Range Helpers
+    week.previous => 2011-12-26
+    week.next => 2012-01-16
 
-  week.start_date.to_s => '2012-01-02'
-  week.end_date.to_s => '2012-01-09'
-  week.includes?(Date.parse('2012-01-05')) => true                                                                                                                                                                                                                                                                        
+Math:
 
+    week - 3 => 2011-12-12
+    week + 3 => 2012-01-24
 
+Start & End Dates:
 
+    week.start_date => 2012-01-02
+    week.end_date => 2012-01-08
+
+Range:
+
+    week.date_range => Range(2012-01-02..2012-01-08)
+
+Collection:
+
+    date = Date.parse('2012-01-02')
+    week.include?(date) => true
+    week.include?(date+7) => false

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.4

data/lib/sixarm_ruby_week.rb

@@ -185,27 +185,37 @@ class Week
   end
 
 
-
   # Return the end date of this week.
   # This is the same as week.date + 6 days
   #
   # @example
   #   week = Week.parse('2012-01-02')
-  #   week.end_date.to_s => '2012-01-09'
+  #   week.end_date.to_s => '2012-01-08'
 
   def end_date
     @date + 6
   end
 
 
+  # Return the range start_date..end_date
+  #
+  # @example
+  #   week = Week.parse('2012-01-02')
+  #   week.date_range => Range(2012-01-02..2012-01-08)
+  
+  def date_range
+    start_date..end_date
+  end
+
+
   # Return true iif the week includes the date, i.e. if the date is in start_date..end_date
   #
   # @example
   #   week = Week.parse('2012-01-02')
-  #   week.includes?(Date.parse('2012-01-05')) => true
-  #   week.includes?(Date.parse('2012-01-10')) => false
+  #   week.include?(Date.parse('2012-01-05')) => true
+  #   week.include?(Date.parse('2012-01-10')) => false
 
-  def includes?(date)
+  def include?(date)
     (start_date..end_date).include?(date)
   end
 

data/test/sixarm_ruby_week_test.rb

@@ -1,137 +1,383 @@
 # -*- coding: utf-8 -*-
 require 'test/unit'
+require 'minitest/autorun'
 require 'simplecov'
 SimpleCov.start
 require 'sixarm_ruby_week'
 
-class WeekTest < Test::Unit::TestCase
+describe Week do
 
-  DATE = Date.parse('2012-01-02')
-  WEEK = Week.new(DATE)
-  WEEK_PREV = Week.new(DATE-7)
-  WEEK_NEXT = Week.new(DATE+7)
-
-  def test_initialize
-    assert_equal(WEEK.date.cwyear, 2012)
-    assert_equal(WEEK.date.cweek, 1)
-    assert_equal(WEEK.date.cwday, 1)
+  before do
+    TEXT ||= '2012-01-02'
+    DATE ||= Date.parse(TEXT)
+    WEEK ||= Week.new(DATE)
+    WEEK_PREV ||= Week.new(DATE-7)
+    WEEK_NEXT ||= Week.new(DATE+7)
   end
 
-  def test_date
-    assert_equal(DATE, WEEK.date)
-  end
+  describe ".initialize" do
+
+    it "must initialize the year, week, and day" do
+      assert_equal(WEEK.date.cwyear, 2012)
+      assert_equal(WEEK.date.cweek, 1)
+      assert_equal(WEEK.date.cwday, 1)
+    end
 
-  def test_to_s
-    assert_equal('2012-01-02', WEEK.to_s)
   end
 
-  def test_now
-    assert_equal(Date.today, Week.now.date)
+  describe "#date" do
+
+    it "=> Date" do
+      assert_kind_of(Date, WEEK.date)
+    end
+
+    it "=> the date that initiazed the week" do 
+      assert_equal(DATE, WEEK.date)
+    end
+
   end
 
-  def test_parse
-    week = Week.parse('2012-01-02')
-    assert_equal(DATE, week.date)
+  describe "#to_s" do 
+
+    it "=> String" do
+      assert_kind_of(String, WEEK.to_s)
+    end
+
+    it "=> the week's date formatted as YYYY-MM-DD" do
+      assert_equal(TEXT, WEEK.to_s)
+    end
+
   end
 
-  def test_hash
-    assert_equal(DATE.hash, WEEK.hash)
+  describe ".now" do
+
+    it "=> Week" do
+      assert_kind_of(Week, Week.now)
+    end
+
+    it "=> a week based on today's date" do
+      assert_equal(Date.today, Week.now.date)
+    end
+
   end
 
-  def test_eq
-    assert(WEEK == Week.new(DATE))
-    assert(!(WEEK == Week.new(DATE+1)))
+  describe ".parse" do
+
+    it "=> Week" do
+      assert_kind_of(Week, Week.parse(TEXT))
+    end
+
+    it "=> a week based on the date text" do
+      s = '2012-01-02'
+      assert_equal(Date.parse(s), Week.parse(s).date)
+    end
+
   end
 
-  def test_eql
-    assert(WEEK.eql? Week.new(DATE))
-    assert(!(WEEK.eql? Week.new(DATE+1)))
+  describe "#hash" do
+
+    it "=> Fixnum" do
+      assert_kind_of(Fixnum, WEEK.hash)
+    end
+
+    it "=> the week's date's hash" do
+      assert_equal(WEEK.date.hash, WEEK.hash)
+    end
+
   end
 
-  def test_compare
-    assert_equal(-1, WEEK <=> WEEK_NEXT)
-    assert_equal( 0, WEEK <=> WEEK)
-    assert_equal( 1, WEEK <=> WEEK_PREV)
+  describe "#eql?" do
+    
+    it "weeks created from the same date => true" do
+      assert(WEEK.eql? Week.new(DATE))
+    end
+    
+    it "weeks created from different dates => false" do
+      refute(WEEK.eql? Week.new(DATE+1))
+    end
+
   end
 
-  def test_lt
-    assert(!(WEEK < WEEK_PREV))
-    assert(!(WEEK < WEEK))
-    assert(WEEK < WEEK_NEXT)
+  describe "==" do
+
+    it "weeks created from the same date => true" do
+      assert(WEEK == Week.new(DATE))
+    end
+
+    it "weeks created from different dates => false" do
+      refute(WEEK == Week.new(DATE+1))
+    end
+
   end
 
-  def test_lte
-    assert(!(WEEK <= WEEK_PREV))
-    assert(WEEK <= WEEK)
-    assert(WEEK < WEEK_NEXT)
+  describe "<=>" do
+
+    it "x<y => -1" do
+      assert_equal(-1, WEEK <=> WEEK_NEXT)
+    end
+
+    it "x=y => 0" do
+      assert_equal( 0, WEEK <=> WEEK)
+    end
+
+    it "x>y => 1" do 
+      assert_equal( 1, WEEK <=> WEEK_PREV)
+    end
+
   end
 
-  def test_gt
-    assert(WEEK > WEEK_PREV)
-    assert(!(WEEK > WEEK))
-    assert(!(WEEK > WEEK_NEXT))
+  describe "<" do
+
+    it "x<y => true" do
+      assert(WEEK < WEEK_NEXT)
+    end
+
+    it "x==y => false" do
+      refute(WEEK < WEEK)
+    end
+
+    it "x>y => false" do
+      refute(WEEK < WEEK_PREV)
+    end
+
   end
 
-  def test_gte
-    assert(WEEK > WEEK_PREV)
-    assert(WEEK >= WEEK)
-    assert(!(WEEK > WEEK_NEXT))
+  describe "<=" do
+
+    it "x<y => false" do
+      assert(WEEK < WEEK_NEXT)
+    end
+
+    it "x==y => true" do
+      assert(WEEK <= WEEK)
+    end
+
+    it "x>y => false" do
+      refute(WEEK <= WEEK_PREV)
+    end
+
   end
 
-  def test_plus_with_numeric
-    assert_equal(WEEK_NEXT, WEEK + 1)
-    assert_not_equal(WEEK_NEXT, WEEK + 2)
+  describe ">" do
+      
+    it "x<y => false" do
+      refute(WEEK > WEEK_NEXT)
+    end
+
+    it "x==y => false" do
+      refute(WEEK > WEEK)
+    end
+
+    it "x>y => true" do
+      assert(WEEK > WEEK_PREV)
+    end
+
   end
 
-  def test_plus_with_bad_type
-    assert_raise TypeError do
-      WEEK + "foo"
+  describe ">=" do
+
+    it "x<y => false" do
+      refute(WEEK >= WEEK_NEXT)
     end
+
+    it "x==y => true" do
+      assert(WEEK >= WEEK)
+    end
+
+    it "x>y => true" do
+      assert(WEEK >= WEEK_PREV)
+    end
+
   end
+  
+  describe "+" do
+
+    describe "with Numeric type" do
+
+      it "=> Week" do
+        assert_kind_of(Week, WEEK + 0)
+      end
+
+      it "+ 0 => this week" do
+        assert_equal(WEEK, WEEK + 0)
+      end
+
+      it "+ 1 => next week" do
+        assert_equal(WEEK_NEXT, WEEK + 1)
+      end
+
+      it "+ (-1) => previous week" do
+        assert_equal(WEEK_PREV, WEEK + (-1))
+      end
+
+      it "+ any other number => different week" do
+        w = WEEK + 2
+        refute_equal(WEEK_PREV, w)
+        refute_equal(WEEK, w)
+        refute_equal(WEEK_NEXT, w)
+      end
+
+    end
+
+    describe "with bad type" do
+
+      it "raises TypeError" do
+        assert_raises TypeError do
+          WEEK + "foo"
+        end
+      end
+      
+    end
 
-  def test_minus_with_numeric
-    assert_equal(WEEK_PREV, WEEK - 1)
-    assert_not_equal(WEEK_PREV, WEEK + 2)
   end
+  
+  describe "-" do
+
+    describe "with Numeric type" do
+
+      it "=> Week" do
+        assert_kind_of(Week, WEEK - 0)
+      end
+
+      it "- 0 => this week" do
+        assert_equal(WEEK, WEEK - 0)
+      end
+
+      it "- 1 => previous week" do
+        assert_equal(WEEK_PREV, WEEK - 1)
+      end
+
+      it "- (-1) => next week" do
+        assert_equal(WEEK_NEXT, WEEK - (-1))
+      end
+
+      it "- any other number => different week" do
+        w = WEEK - 2
+        refute_equal(WEEK_PREV, w)
+        refute_equal(WEEK, w)
+        refute_equal(WEEK_NEXT, w)
+      end
+
+    end
+
+    describe "with Week type" do
+      
+      it "=> Integer" do
+        assert_kind_of(Integer, WEEK - WEEK)
+      end
+
+      it "this week - previous week => 1" do
+        assert_equal(1, WEEK - WEEK_PREV)
+      end
+
+      it "this week - this week => 0" do
+        assert_equal(0, WEEK - WEEK)
+      end
+
+      it "this week - next week => -1" do
+        assert_equal(-1, WEEK - WEEK_NEXT)
+      end
+      
+    end
+
+    describe "with bad type" do
+
+      it "raises TypeError" do
+        assert_raises TypeError do
+          WEEK - "foo"
+        end
+      end
+
+    end
 
-  def test_minus_with_week
-    assert_equal(1, WEEK - WEEK_PREV)
-    assert_equal(0, WEEK - WEEK)
-    assert_equal(-1, WEEK - WEEK_NEXT)
   end
 
-  def test_minus_with_bad_type
-    assert_raise TypeError do
-      WEEK - "foo"
+  describe "#previous" do
+
+    it "=> Week" do
+      assert_kind_of(Week, WEEK.previous)
+    end
+
+    it "=> a week seven days earlier" do
+      assert_equal(Week.new(DATE-7), Week.new(DATE).previous)
     end
+
   end
 
-  def test_previous
-    assert_equal(WEEK_PREV, WEEK.previous)
+  describe "#next" do
+
+    it "=> Week" do
+      assert_kind_of(Week, WEEK.next)
+    end
+
+    it "=> a week seven days later" do
+      assert_equal(Week.new(DATE+7), Week.new(DATE).next)
+    end
+
   end
 
-  def test_next
-    assert_equal(WEEK_NEXT, WEEK.next)
+  describe "#start_date" do
+
+    it "=> Date" do
+      assert_kind_of(Date, WEEK.start_date)
+    end
+
+    it "=> the initialzation date" do
+      assert_equal(DATE, WEEK.start_date)
+    end
+    
   end
 
-  def test_start_date
-    assert_equal(DATE, WEEK.start_date)
+  describe "#end_date" do
+
+    it "=> Date" do
+      assert_kind_of(Date, WEEK.end_date)
+    end
+
+    it "=> six days after the initialization date" do
+      assert_equal(DATE + 6, WEEK.end_date)
+    end
+
   end
 
-  def test_end_date
-    assert_equal(DATE + 6, WEEK.end_date)
+  describe "#date_range" do
+
+    it "=> Range" do
+      assert_kind_of(Range, WEEK.date_range)
+    end
+
+    it "=> Range first is the start date" do
+      assert_equal(WEEK.start_date, WEEK.date_range.first)
+    end
+
+    it "=> Range last is the end date" do
+      assert_equal(WEEK.end_date, WEEK.date_range.last)
+    end
+
   end
 
-  def test_includes
-    assert(!(WEEK.includes? DATE-1))
-    assert(WEEK.includes? DATE+0)
-    assert(WEEK.includes? DATE+1)
-    assert(WEEK.includes? DATE+2)
-    assert(WEEK.includes? DATE+3)
-    assert(WEEK.includes? DATE+4)
-    assert(WEEK.includes? DATE+5)
-    assert(WEEK.includes? DATE+6)
-    assert(!(WEEK.includes? DATE+7))
+  describe "#include?" do
+
+    it "all days in this week => true" do
+      assert_includes(WEEK, DATE+0)
+      assert_includes(WEEK, DATE+1)
+      assert_includes(WEEK, DATE+2)
+      assert_includes(WEEK, DATE+3)
+      assert_includes(WEEK, DATE+4)
+      assert_includes(WEEK, DATE+5)
+      assert_includes(WEEK, DATE+6)
+    end
+
+    it "any day before this week => false" do
+      refute_includes(WEEK, DATE-1)
+      refute_includes(WEEK, DATE-999)
+    end
+
+    it "any day after this week => false" do
+      refute_includes(WEEK, DATE+7)
+      refute_includes(WEEK, DATE+999)
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sixarm_ruby_week
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,46 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain:
-- ! '-----BEGIN CERTIFICATE-----
-
-  MIIDBDCCAm2gAwIBAgIJAKPwEETU5bHoMA0GCSqGSIb3DQEBBQUAMGAxCzAJBgNV
-
-  BAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQHEw1TYW4gRnJhbmNp
-
-  c2NvMQ8wDQYDVQQKEwZTaXhBcm0xEzARBgNVBAMTCnNpeGFybS5jb20wHhcNMTAx
-
-  MjEzMjMyNzEzWhcNMTMwOTA4MjMyNzEzWjBgMQswCQYDVQQGEwJVUzETMBEGA1UE
-
-  CBMKQ2FsaWZvcm5pYTEWMBQGA1UEBxMNU2FuIEZyYW5jaXNjbzEPMA0GA1UEChMG
-
-  U2l4QXJtMRMwEQYDVQQDEwpzaXhhcm0uY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GN
-
-  ADCBiQKBgQC94mD9JDwBsunsOI0VR3CXXbOWg9cWaWciwFyJNFiM7A9I8KPLfXUw
-
-  QC4czUe5ZuG4WHvinrWhkrCK+1dWBqoEClxdF/FoKO5a+tonGCjjmfy81JmFjjyx
-
-  eTsjsHyvw+Qik9kpf9aj6+pnkNrVswgNHVea2o9yabbEiS6VSeJWoQIDAQABo4HF
-
-  MIHCMB0GA1UdDgQWBBQzPJtqmSgc53eDN7aSzDQwr9TALDCBkgYDVR0jBIGKMIGH
-
-  gBQzPJtqmSgc53eDN7aSzDQwr9TALKFkpGIwYDELMAkGA1UEBhMCVVMxEzARBgNV
-
-  BAgTCkNhbGlmb3JuaWExFjAUBgNVBAcTDVNhbiBGcmFuY2lzY28xDzANBgNVBAoT
-
-  BlNpeEFybTETMBEGA1UEAxMKc2l4YXJtLmNvbYIJAKPwEETU5bHoMAwGA1UdEwQF
-
-  MAMBAf8wDQYJKoZIhvcNAQEFBQADgYEAooEexP/oPam1TP71SyuhxMb+uTrZbSQe
-
-  jVB+ExRwWadGwaNPUA56d39qwavwP+iu+3JpeonNMVvbWXF5naCX/dNFIeREHzER
-
-  ZDRQYMqru9TEMna6HD9zpcstF7vwThGovlOQ+3Y6plQ4nMzipXcZ9THqs65PIL0q
-
-  eabwpCbAopo=
-
-  -----END CERTIFICATE-----
-
-'
-date: 2012-02-25 00:00:00.000000000 Z
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURCRENDQW0yZ0F3SUJB
+  Z0lKQUtQd0VFVFU1YkhvTUEwR0NTcUdTSWIzRFFFQkJRVUFNR0F4Q3pBSkJn
+  TlYKQkFZVEFsVlRNUk13RVFZRFZRUUlFd3BEWVd4cFptOXlibWxoTVJZd0ZB
+  WURWUVFIRXcxVFlXNGdSbkpoYm1OcApjMk52TVE4d0RRWURWUVFLRXdaVGFY
+  aEJjbTB4RXpBUkJnTlZCQU1UQ25OcGVHRnliUzVqYjIwd0hoY05NVEF4Ck1q
+  RXpNak15TnpFeldoY05NVE13T1RBNE1qTXlOekV6V2pCZ01Rc3dDUVlEVlFR
+  R0V3SlZVekVUTUJFR0ExVUUKQ0JNS1EyRnNhV1p2Y201cFlURVdNQlFHQTFV
+  RUJ4TU5VMkZ1SUVaeVlXNWphWE5qYnpFUE1BMEdBMVVFQ2hNRwpVMmw0UVhK
+  dE1STXdFUVlEVlFRREV3cHphWGhoY20wdVkyOXRNSUdmTUEwR0NTcUdTSWIz
+  RFFFQkFRVUFBNEdOCkFEQ0JpUUtCZ1FDOTRtRDlKRHdCc3Vuc09JMFZSM0NY
+  WGJPV2c5Y1dhV2Npd0Z5Sk5GaU03QTlJOEtQTGZYVXcKUUM0Y3pVZTVadUc0
+  V0h2aW5yV2hrckNLKzFkV0Jxb0VDbHhkRi9Gb0tPNWErdG9uR0Nqam1meTgx
+  Sm1Gamp5eAplVHNqc0h5dncrUWlrOWtwZjlhajYrcG5rTnJWc3dnTkhWZWEy
+  bzl5YWJiRWlTNlZTZUpXb1FJREFRQUJvNEhGCk1JSENNQjBHQTFVZERnUVdC
+  QlF6UEp0cW1TZ2M1M2VETjdhU3pEUXdyOVRBTERDQmtnWURWUjBqQklHS01J
+  R0gKZ0JRelBKdHFtU2djNTNlRE43YVN6RFF3cjlUQUxLRmtwR0l3WURFTE1B
+  a0dBMVVFQmhNQ1ZWTXhFekFSQmdOVgpCQWdUQ2tOaGJHbG1iM0p1YVdFeEZq
+  QVVCZ05WQkFjVERWTmhiaUJHY21GdVkybHpZMjh4RHpBTkJnTlZCQW9UCkJs
+  TnBlRUZ5YlRFVE1CRUdBMVVFQXhNS2MybDRZWEp0TG1OdmJZSUpBS1B3RUVU
+  VTViSG9NQXdHQTFVZEV3UUYKTUFNQkFmOHdEUVlKS29aSWh2Y05BUUVGQlFB
+  RGdZRUFvb0VleFAvb1BhbTFUUDcxU3l1aHhNYit1VHJaYlNRZQpqVkIrRXhS
+  d1dhZEd3YU5QVUE1NmQzOXF3YXZ3UCtpdSszSnBlb25OTVZ2YldYRjVuYUNY
+  L2RORkllUkVIekVSClpEUlFZTXFydTlURU1uYTZIRDl6cGNzdEY3dndUaEdv
+  dmxPUSszWTZwbFE0bk16aXBYY1o5VEhxczY1UElMMHEKZWFid3BDYkFvcG89
+  Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
+date: 2012-03-13 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: sixarm@sixarm.com
@@ -88,7 +75,7 @@ rubyforge_project:
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: SixArm.com » Ruby » Week is seven days from Monday onward
+summary: SixArm.com » Ruby » Week model based on Ruby Date
 test_files:
 - test/sixarm_ruby_week_test.rb
 has_rdoc: true

metadata.gz.sig

@@ -1 +1 @@
-�O<��V��S�39����׍T��R\���J��(�m�Q��2%-���r����,����T�,rV<�\9`��()��\��-�(�O��r'�#Ik��B�b�H#ѵtE?���諍\!
+~;�g�f��.�-J*��"5��Y)���1?Ϗ�5��H�K2B]Rӹ�XB�Z��04$��p��ѕ^�`Lj�is�Y�q~��0�[�J�`A/�hk��ce�cS�:%��(z��z����