sixarm_ruby_week 1.1.4 → 1.1.6

data/README.md

@@ -0,0 +1,120 @@
+# SixArm.com » Ruby » <br> Week model based on Ruby Date
+
+* Docs: <http://sixarm.com/sixarm_ruby_week/doc>
+* Repo: <http://github.com/sixarm/sixarm_ruby_week>
+* Email: Joel Parker Henderson, <joel@sixarm.com>
+
+
+## Introduction
+
+This gem models a week, based on the built-in Ruby Date class.
+
+For docs go to <http://sixarm.com/sixarm_ruby_week/doc>
+
+Want to help? We're happy to get pull requests.
+
+
+## Quickstart
+
+Install:
+
+    gem install sixarm_ruby_week
+
+Bundler:
+
+    gem "sixarm_ruby_week", "=1.1.4"
+
+Require:
+
+    require "sixarm_ruby_week"
+
+
+## High Security (Optional)
+
+To enable high security	for all	our gems:
+
+    wget http://sixarm.com/sixarm.pem
+    gem cert --add sixarm.pem
+    gem sources --add http://sixarm.com
+
+To install with high security:
+
+    gem install sixarm_ruby_week --test --trust-policy HighSecurity
+
+
+## Examples
+
+Create:
+    
+    date = Date.parse('2012-01-02')
+    week = Week.new(date)
+    week.to_s => '2012-01-02'
+
+Parse:
+
+    week = Week.parse('2012-01-02')
+    week => 2012-01-02
+
+Enumerable:
+
+    week.previous => 2011-12-26
+    week.next => 2012-01-16
+
+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
+
+
+## Changes
+
+* 2012-03-16 1.1.6 Upgrade for Ruby 1.9.3, minitest/spec, and improved docs.
+* 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 
+
+
+## License
+
+You may choose any of these open source licenses:
+
+  * Apache License
+  * BSD License
+  * CreativeCommons License, Non-commercial Share Alike
+  * GNU General Public License Version 2 (GPL 2)
+  * GNU Lesser General Public License (LGPL)
+  * MIT License
+  * Perl Artistic License
+  * Ruby License
+
+The software is provided "as is", without warranty of any kind, 
+express or implied, including but not limited to the warranties of 
+merchantability, fitness for a particular purpose and noninfringement. 
+
+In no event shall the authors or copyright holders be liable for any 
+claim, damages or other liability, whether in an action of contract, 
+tort or otherwise, arising from, out of or in connection with the 
+software or the use or other dealings in the software.
+
+This license is for the included software that is created by SixArm;
+some of the included software may have its own licenses, copyrights, 
+authors, etc. and these do take precedence over the SixArm license.
+
+Copyright (c) 2013 Joel Parker Henderson

data/lib/sixarm_ruby_week.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 =begin rdoc
-Please see README.rdoc
+Please see README
 =end
 
 require 'date'

data/test/sixarm_ruby_week_test.rb

@@ -1,5 +1,4 @@
 # -*- coding: utf-8 -*-
-require 'test/unit'
 require 'minitest/autorun'
 require 'simplecov'
 SimpleCov.start
@@ -18,9 +17,9 @@ describe Week do
   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)
+      WEEK.date.cwyear.must_equal 2012
+      WEEK.date.cweek.must_equal 1
+      WEEK.date.cwday.must_equal 1
     end
 
   end
@@ -28,11 +27,11 @@ describe Week do
   describe "#date" do
 
     it "=> Date" do
-      assert_kind_of(Date, WEEK.date)
+      WEEK.date.must_be_kind_of Date
     end
 
     it "=> the date that initiazed the week" do 
-      assert_equal(DATE, WEEK.date)
+      WEEK.date.must_equal DATE
     end
 
   end
@@ -40,11 +39,11 @@ describe Week do
   describe "#to_s" do 
 
     it "=> String" do
-      assert_kind_of(String, WEEK.to_s)
+      WEEK.to_s.must_be_kind_of String
     end
 
     it "=> the week's date formatted as YYYY-MM-DD" do
-      assert_equal(TEXT, WEEK.to_s)
+      WEEK.to_s.must_equal TEXT
     end
 
   end
@@ -52,11 +51,11 @@ describe Week do
   describe ".now" do
 
     it "=> Week" do
-      assert_kind_of(Week, Week.now)
+      Week.now.must_be_kind_of Week
     end
 
     it "=> a week based on today's date" do
-      assert_equal(Date.today, Week.now.date)
+      Week.now.date.must_equal Date.today
     end
 
   end
@@ -64,12 +63,12 @@ describe Week do
   describe ".parse" do
 
     it "=> Week" do
-      assert_kind_of(Week, Week.parse(TEXT))
+      Week.parse(TEXT).must_be_kind_of Week
     end
 
     it "=> a week based on the date text" do
       s = '2012-01-02'
-      assert_equal(Date.parse(s), Week.parse(s).date)
+      Week.parse(s).date.must_equal Date.parse(s)
     end
 
   end
@@ -77,11 +76,11 @@ describe Week do
   describe "#hash" do
 
     it "=> Fixnum" do
-      assert_kind_of(Fixnum, WEEK.hash)
+      WEEK.hash.must_be_kind_of Fixnum
     end
 
     it "=> the week's date's hash" do
-      assert_equal(WEEK.date.hash, WEEK.hash)
+      WEEK.hash.must_equal WEEK.date.hash
     end
 
   end
@@ -113,15 +112,15 @@ describe Week do
   describe "<=>" do
 
     it "x<y => -1" do
-      assert_equal(-1, WEEK <=> WEEK_NEXT)
+      (WEEK <=> WEEK_NEXT).must_equal -1
     end
 
     it "x=y => 0" do
-      assert_equal( 0, WEEK <=> WEEK)
+      (WEEK <=> WEEK).must_equal 0
     end
 
     it "x>y => 1" do 
-      assert_equal( 1, WEEK <=> WEEK_PREV)
+      (WEEK <=> WEEK_PREV).must_equal 1
     end
 
   end
@@ -195,36 +194,34 @@ describe Week do
     describe "with Numeric type" do
 
       it "=> Week" do
-        assert_kind_of(Week, WEEK + 0)
+        (WEEK + 0).must_be_kind_of Week
       end
 
       it "+ 0 => this week" do
-        assert_equal(WEEK, WEEK + 0)
+        (WEEK + 0).must_equal WEEK
       end
 
       it "+ 1 => next week" do
-        assert_equal(WEEK_NEXT, WEEK + 1)
+        (WEEK + 1).must_equal WEEK_NEXT
       end
 
       it "+ (-1) => previous week" do
-        assert_equal(WEEK_PREV, WEEK + (-1))
+        (WEEK + (-1)).must_equal WEEK_PREV
       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)
+        w.wont_equal WEEK_PREV
+        w.wont_equal WEEK
+        w.wont_equal WEEK_NEXT
       end
 
     end
 
     describe "with bad type" do
 
-      it "raises TypeError" do
-        assert_raises TypeError do
-          WEEK + "foo"
-        end
+      it "TypeError" do
+        proc { WEEK + "foo" }.must_raise TypeError
       end
       
     end
@@ -236,26 +233,26 @@ describe Week do
     describe "with Numeric type" do
 
       it "=> Week" do
-        assert_kind_of(Week, WEEK - 0)
+        (WEEK - 0).must_be_kind_of Week
       end
 
       it "- 0 => this week" do
-        assert_equal(WEEK, WEEK - 0)
+        (WEEK - 0).must_equal WEEK
       end
 
       it "- 1 => previous week" do
-        assert_equal(WEEK_PREV, WEEK - 1)
+        (WEEK - 1).must_equal WEEK_PREV
       end
 
       it "- (-1) => next week" do
-        assert_equal(WEEK_NEXT, WEEK - (-1))
+        (WEEK - (-1)).must_equal WEEK_NEXT
       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)
+        w.wont_equal WEEK_PREV
+        w.wont_equal WEEK
+        w.wont_equal WEEK_NEXT
       end
 
     end
@@ -263,29 +260,27 @@ describe Week do
     describe "with Week type" do
       
       it "=> Integer" do
-        assert_kind_of(Integer, WEEK - WEEK)
+        (WEEK - WEEK).must_be_kind_of Integer
       end
 
       it "this week - previous week => 1" do
-        assert_equal(1, WEEK - WEEK_PREV)
+        (WEEK - WEEK_PREV).must_equal 1 
       end
 
       it "this week - this week => 0" do
-        assert_equal(0, WEEK - WEEK)
+        (WEEK - WEEK).must_equal 0
       end
 
       it "this week - next week => -1" do
-        assert_equal(-1, WEEK - WEEK_NEXT)
+        (WEEK - WEEK_NEXT).must_equal -1
       end
       
     end
 
     describe "with bad type" do
 
-      it "raises TypeError" do
-        assert_raises TypeError do
-          WEEK - "foo"
-        end
+      it "TypeError" do
+        proc { WEEK - "foo" }.must_raise TypeError 
       end
 
     end
@@ -295,11 +290,11 @@ describe Week do
   describe "#previous" do
 
     it "=> Week" do
-      assert_kind_of(Week, WEEK.previous)
+      WEEK.previous.must_be_kind_of Week
     end
 
     it "=> a week seven days earlier" do
-      assert_equal(Week.new(DATE-7), Week.new(DATE).previous)
+      Week.new(DATE).previous.must_equal Week.new(DATE-7)
     end
 
   end
@@ -307,11 +302,11 @@ describe Week do
   describe "#next" do
 
     it "=> Week" do
-      assert_kind_of(Week, WEEK.next)
+      (WEEK.next).must_be_kind_of Week
     end
 
     it "=> a week seven days later" do
-      assert_equal(Week.new(DATE+7), Week.new(DATE).next)
+      Week.new(DATE).next.must_equal Week.new(DATE+7)
     end
 
   end
@@ -319,11 +314,11 @@ describe Week do
   describe "#start_date" do
 
     it "=> Date" do
-      assert_kind_of(Date, WEEK.start_date)
+      WEEK.start_date.must_be_kind_of Date
     end
 
     it "=> the initialzation date" do
-      assert_equal(DATE, WEEK.start_date)
+      WEEK.start_date.must_equal DATE
     end
     
   end
@@ -331,11 +326,11 @@ describe Week do
   describe "#end_date" do
 
     it "=> Date" do
-      assert_kind_of(Date, WEEK.end_date)
+      WEEK.end_date.must_be_kind_of Date
     end
 
     it "=> six days after the initialization date" do
-      assert_equal(DATE + 6, WEEK.end_date)
+      WEEK.end_date.must_equal DATE + 6
     end
 
   end
@@ -343,15 +338,15 @@ describe Week do
   describe "#date_range" do
 
     it "=> Range" do
-      assert_kind_of(Range, WEEK.date_range)
+      WEEK.date_range.must_be_kind_of Range
     end
 
     it "=> Range first is the start date" do
-      assert_equal(WEEK.start_date, WEEK.date_range.first)
+      WEEK.date_range.first.must_equal WEEK.start_date
     end
 
     it "=> Range last is the end date" do
-      assert_equal(WEEK.end_date, WEEK.date_range.last)
+      WEEK.date_range.last.must_equal WEEK.end_date
     end
 
   end
@@ -359,23 +354,23 @@ describe Week do
   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)
+      WEEK.must_include DATE+0
+      WEEK.must_include DATE+1
+      WEEK.must_include DATE+2
+      WEEK.must_include DATE+3
+      WEEK.must_include DATE+4
+      WEEK.must_include DATE+5
+      WEEK.must_include DATE+6
     end
 
     it "any day before this week => false" do
-      refute_includes(WEEK, DATE-1)
-      refute_includes(WEEK, DATE-999)
+      WEEK.wont_include DATE-1
+      WEEK.wont_include DATE-999
     end
 
     it "any day after this week => false" do
-      refute_includes(WEEK, DATE+7)
-      refute_includes(WEEK, DATE+999)
+      WEEK.wont_include DATE+7
+      WEEK.wont_include DATE+999
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sixarm_ruby_week
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -35,7 +35,7 @@ cert_chain:
   L2RORkllUkVIekVSClpEUlFZTXFydTlURU1uYTZIRDl6cGNzdEY3dndUaEdv
   dmxPUSszWTZwbFE0bk16aXBYY1o5VEhxczY1UElMMHEKZWFid3BDYkFvcG89
   Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
-date: 2012-03-13 00:00:00.000000000 Z
+date: 2012-03-16 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: sixarm@sixarm.com
@@ -44,11 +44,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gemtest
-- CHANGELOG.txt
-- INSTALL.txt
-- LICENSE.txt
 - Rakefile
-- README.rdoc
+- README.md
 - VERSION
 - lib/sixarm_ruby_week.rb
 - test/sixarm_ruby_week_test.rb

data/CHANGELOG.txt

@@ -1,7 +0,0 @@
-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/INSTALL.txt

@@ -1,32 +0,0 @@
-
-= SixArm.com Ruby Gem Install
-
-
-First-time users: add our gem certificate and source.
-When you do this once, it works for all our gems.
-
-  sudo wget http://sixarm.com/sixarm.pem
-  sudo gem cert --add sixarm.pem   
-  sudo gem sources --add http://sixarm.com
-
-Install the gem with advanced options.
-
-  sudo gem install sixarm_ruby_week --test --trust-policy HighSecurity
-
-
-== Notes
-
-Do you have any questions, comments, suggestions, or feedback?
-Let us know, we're happy to help. Our email is sixarm@sixarm.com
-
-Do you want to create your own high security gems?
-Learn how at http://www.rubygems.org/read/chapter/21
-
-To see your current gem certificate list:
-
-  sudo gem cert --list
-
-Our cert looks like this:
-
-  /C=US/ST=California/L=San Francisco/O=SixArm/CN=sixarm.com
-

data/LICENSE.txt

@@ -1,25 +0,0 @@
-LICENSE
-
-You may choose any of these open source licenses:
-
-  - Apache License
-  - BSD License
-  - CreativeCommons License, Non-commercial Share Alike
-  - GNU General Public License Version 2 (GPL 2)
-  - GNU Lesser General Public License (LGPL)
-  - MIT License
-  - Perl Artistic License
-  - Ruby License
-
-The software is provided "as is", without warranty of any kind, 
-express or implied, including but not limited to the warranties of 
-merchantability, fitness for a particular purpose and noninfringement. 
-
-In no event shall the authors or copyright holders be liable for any 
-claim, damages or other liability, whether in an action of contract, 
-tort or otherwise, arising from, out of or in connection with the 
-software or the use or other dealings in the software.
-
-This license is for the included software that is created by SixArm;
-some of the included software may have its own licenses, copyrights, 
-authors, etc. and these do take precedence over the SixArm license.

data/README.rdoc

@@ -1,46 +0,0 @@
-= SixArm.com » Ruby » Week model based on Ruby Date
-
-Author:: Joel Parker Henderson, joel@joelparkerhenderson.com
-Copyright:: Copyright (c) 2006-2012 Joel Parker Henderson
-License:: See LICENSE.txt file
-
-This gem models a week, based on the built-in Ruby Date class.
-
-== Examples
-
-
-Initialize:
-    
-    date = Date.parse('2012-01-02')
-    week = Week.new(date)
-    week.to_s => '2012-01-02'
-
-Parse:
-
-    week = Week.parse('2012-01-02')
-    week => 2012-01-02
-
-Enumerable:
-
-    week.previous => 2011-12-26
-    week.next => 2012-01-16
-
-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