sixarm_ruby_week 1.1.0

data/CHANGELOG.txt

@@ -0,0 +1,4 @@
+CHANGELOG
+
+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

@@ -0,0 +1,32 @@
+
+= 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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,31 @@
+= 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
+
+  week = Week.parse('2012-01-02')
+  week.to_s => '2012-01-02'
+
+== Example Enumerable
+
+  week.previous.to_s => '2011-12-26'
+  week.next.to_s => '2012-01-16'
+
+== Example Math
+
+  (week - 3).to_s => '2011-12-12'
+  (week + 3).to_s => '2012-01-24'
+
+== Example Range Helpers
+
+  week.start_date.to_s => '2012-01-02'
+  week.end_date.to_s => '2012-01-09'
+  week.includes?(Date.parse('2012-01-05')) => true                                                                                                                                                                                                                                                                        
+
+
+

data/Rakefile

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/*.rb'
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/sixarm_ruby_week.rb

@@ -0,0 +1,213 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+Please see README.rdoc
+=end
+
+require 'date'
+
+
+class Week
+
+  attr :date
+
+  def initialize(date)
+    @date = date
+  end
+
+
+  # Return date.to_s
+
+  def to_s
+    @date.to_s
+  end
+
+
+  ### Instantiations
+
+
+  # Return the week that starts today
+
+  def self.now
+    Week.new(Date.today)
+  end
+
+
+  # Parse date text to a week. 
+  #
+  # @example
+  #   week = Week.parse('2012-01-02') 
+
+  def self.parse(date_text)
+    Week.new(Date.parse(date_text))
+  end
+
+
+  ### Comparable
+
+
+  # Return the hash for object comparison.
+  #
+  # This is simply the has of the date, which means
+  # that two week objects created with the same date
+  # will compare equally.
+
+  def hash
+    date.hash
+  end
+
+
+  # Return week1.date == week2.date
+
+  def ==(other)
+    self.date == other.date
+  end
+
+
+  # Return week1.date.eql? week2.date
+
+  def eql?(other)
+    self.date == other.date
+  end
+
+
+  # Return week1.date <=> week2.date
+
+  def <=>(other)
+   return self.date <=> other.date
+  end
+
+
+  # Return week1.date < week2.date
+
+  def <(other)
+    self.date < other.date
+  end
+
+
+  # Return week1.date <= week2.date
+
+  def <=(other)
+    self.date <= other.date
+  end
+
+
+  # Return week1.date > week2.date
+
+  def >(other)
+    self.date > other.date
+  end
+
+
+  # Return week1.date >= week2.date
+
+  def >=(other)
+    self.date >= other.date
+  end
+
+
+  ### Math
+
+
+  # Addition: week + other => week
+  #
+  # Return a date object pointing other weeks after self.
+  # The other should be a numeric value.
+  #
+  # @example
+  #     week = Week.parse('2012-01-02')
+  #     week + 3 => three weeks later
+
+  def +(other)
+    if other.is_a? Numeric
+      return Week.new(date + (other.to_i * 7))
+    else
+      raise TypeError
+    end
+  end
+
+
+  # Subtraction: week - other => week or integer
+  #
+  # If the other is a numeric value, return a week object pointing other weeks before self. 
+  #   
+  # If the other is a week object, then return the difference between the two weeks.
+  #
+  # @example
+  #     date = date.parse('2012-01-02')
+  #     week = Week.new(date)
+  #     week - 3 => three weeks earlier
+  #
+  # @example 
+  #     date = date.parse('2012-01-02')
+  #     start_week =  Week.new(date)
+  #     end_week =  Week.new(date + 21)
+  #     end_week - start_week => 3
+
+  def -(other)
+    if other.is_a? Numeric
+      return Week.new(date - (other * 7))
+    elsif other.is_a? Week
+      return ((self.date - other.date) / 7).round
+    else
+      raise TypeError
+    end
+  end
+
+  
+  ### Enumerable
+
+  # Return the previous week, i.e. seven day earlier.
+
+  def previous
+    return self - 1
+  end
+
+
+  # Return the next week, i.e. seven day later.
+
+  def next
+    return self + 1
+  end
+
+
+  ### Ranges
+
+ 
+  # Return the start date of this week.
+  # This is the same as week.date.
+  #
+  # @example
+  #   week = Week.parse('2012-01-02')
+  #   week.start_date.to_s => '2012-01-02'
+
+  def start_date
+    @date
+  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'
+
+  def end_date
+    @date + 6
+  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
+
+  def includes?(date)
+    (start_date..end_date).include?(date)
+  end
+
+
+end

data/test/sixarm_ruby_week_test.rb

@@ -0,0 +1,137 @@
+# -*- coding: utf-8 -*-
+require 'test/unit'
+require 'simplecov'
+SimpleCov.start
+require 'sixarm_ruby_week'
+
+class WeekTest < Test::Unit::TestCase
+
+  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)
+  end
+
+  def test_date
+    assert_equal(DATE, WEEK.date)
+  end
+
+  def test_to_s
+    assert_equal('2012-01-02', WEEK.to_s)
+  end
+
+  def test_now
+    assert_equal(Date.today, Week.now.date)
+  end
+
+  def test_parse
+    week = Week.parse('2012-01-02')
+    assert_equal(DATE, week.date)
+  end
+
+  def test_hash
+    assert_equal(DATE.hash, WEEK.hash)
+  end
+
+  def test_eq
+    assert(WEEK == Week.new(DATE))
+    assert(!(WEEK == Week.new(DATE+1)))
+  end
+
+  def test_eql
+    assert(WEEK.eql? Week.new(DATE))
+    assert(!(WEEK.eql? Week.new(DATE+1)))
+  end
+
+  def test_compare
+    assert_equal(-1, WEEK <=> WEEK_NEXT)
+    assert_equal( 0, WEEK <=> WEEK)
+    assert_equal( 1, WEEK <=> WEEK_PREV)
+  end
+
+  def test_lt
+    assert(!(WEEK < WEEK_PREV))
+    assert(!(WEEK < WEEK))
+    assert(WEEK < WEEK_NEXT)
+  end
+
+  def test_lte
+    assert(!(WEEK <= WEEK_PREV))
+    assert(WEEK <= WEEK)
+    assert(WEEK < WEEK_NEXT)
+  end
+
+  def test_gt
+    assert(WEEK > WEEK_PREV)
+    assert(!(WEEK > WEEK))
+    assert(!(WEEK > WEEK_NEXT))
+  end
+
+  def test_gte
+    assert(WEEK > WEEK_PREV)
+    assert(WEEK >= WEEK)
+    assert(!(WEEK > WEEK_NEXT))
+  end
+
+  def test_plus_with_numeric
+    assert_equal(WEEK_NEXT, WEEK + 1)
+    assert_not_equal(WEEK_NEXT, WEEK + 2)
+  end
+
+  def test_plus_with_bad_type
+    assert_raise TypeError do
+      WEEK + "foo"
+    end
+  end
+
+  def test_minus_with_numeric
+    assert_equal(WEEK_PREV, WEEK - 1)
+    assert_not_equal(WEEK_PREV, WEEK + 2)
+  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"
+    end
+  end
+
+  def test_previous
+    assert_equal(WEEK_PREV, WEEK.previous)
+  end
+
+  def test_next
+    assert_equal(WEEK_NEXT, WEEK.next)
+  end
+
+  def test_start_date
+    assert_equal(DATE, WEEK.start_date)
+  end
+
+  def test_end_date
+    assert_equal(DATE + 6, WEEK.end_date)
+  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))
+  end
+
+end

data.tar.gz.sig

@@ -0,0 +1 @@
+M��h�9�l�ź$�-�,�C�V�n�H��u%��܂0�˘��kD��ֺ�A�_�3́-׭�=>
�1����?�R:��:��oЎ����ɸ4�۽�h9ٚWP�ȍ��Z�M�T.E:2by:��

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: sixarm_ruby_week
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
+platform: ruby
+authors:
+- SixArm
+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
+dependencies: []
+description: 
+email: sixarm@sixarm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemtest
+- CHANGELOG.txt
+- INSTALL.txt
+- LICENSE.txt
+- Rakefile
+- README.rdoc
+- VERSION
+- lib/sixarm_ruby_week.rb
+- test/sixarm_ruby_week_test.rb
+homepage: http://sixarm.com/
+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: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: SixArm.com » Ruby » Week is seven days from Monday onward
+test_files:
+- test/sixarm_ruby_week_test.rb
+has_rdoc: true

metadata.gz.sig

@@ -0,0 +1 @@
+�O<��V��S�39����׍T��R\���J��(�m�Q��2%-���r����,����T�,rV<�\9`��()��\��-�(�O��r'�#Ik��B�b�H#ѵtE?���諍\!