month 0.1.0

data/lib/month.rb

@@ -0,0 +1,93 @@
+# Month represents a specific month in time. With the exception of
+# Month.month_names (which returns a zero-based array), every usage of the
+# month value assumes that 1 equals January and 12 equals December.
+class Month
+	Version = '0.1.0'
+	
+	# Returns an array of the full names of months (in English). Note that
+	# "January" is the 0th element, and "December" is the 11th element.
+	def Month.month_names
+		[ "January", "February", "March", "April", "May", "June", "July",
+			"August", "September", "October", "November", "December" ]
+	end
+
+	include Comparable
+
+	attr_reader :month, :year
+
+	# A new month can be set to a specific +month+ and +year+, or you can call 
+	# Month.new with no arguments to receive the current month.
+	def initialize( year = nil, month = nil )
+		require 'date'
+		if month.nil? || year.nil?
+			date = Date.today
+			month = date.mon unless month
+			year = date.year unless year
+		end
+		fail "invalid month" if month < 1 || month > 12
+		@month = month
+		@year = year
+	end
+
+	# Returns a new Month that is +amountToAdd+ months later.
+	def +( amountToAdd )
+		( fullYears, remainingMonths ) = amountToAdd.divmod( 12 )
+		resultYear = @year + fullYears
+		resultMonth = @month + remainingMonths
+		if resultMonth > 12
+			resultMonth -= 12
+			resultYear += 1
+		end
+		Month.new( resultYear, resultMonth )
+	end
+	
+	# Returns a new Month that is +amountToSubtract+ months earlier.
+	def -(amountToSubtract)
+		self + (-amountToSubtract)
+	end
+	
+	# Compare this Month to another Month.
+	def <=>(anOther)
+		if @year == anOther.year
+			@month <=> anOther.month
+		else
+			@year <=> anOther.year
+		end
+	end
+
+	# Returns the last Date of the month.
+	def end_date
+		self.next.start_date - 1
+	end
+
+	# Is this Month equal to +anOther+? +anOther+ must be another Month of the
+	# same value.
+	def eql?(anOther)
+		self == anOther
+	end
+	
+	# Calculate a hash value for this Month.
+	def hash
+		"#{@year}#{@month}".to_i
+	end
+
+	# Returns the next Month.
+	def next
+		self + 1
+	end
+	
+	# Returns the previous Month.
+	def prev
+		self - 1
+	end
+	
+	# Returns the first Date of the month.
+	def start_date
+		Date.new( @year, @month, 1 )
+	end
+	
+	# Returns a string of the format "January 2001".
+	def to_s
+		Month.month_names[@month-1][0..2] + " " + @year.to_s
+	end
+end

data/lib/month.rb~

@@ -0,0 +1,91 @@
+# Represents a specific month in time. With the exception of
+# Month.month_names (which returns a zero-based array), every usage of the
+# month value assumes that 1 equals January and 12 equals December.
+class Month
+	# Returns an array of the full names of months (in English). Note that
+	# "January" is the 0th element, and "December" is the 11th element.
+	def Month.month_names
+		[ "January", "February", "March", "April", "May", "June", "July",
+			"August", "September", "October", "November", "December" ]
+	end
+
+	include Comparable
+
+	attr_reader :month, :year
+
+	# A new month can be set to a specific +month+ and +year+, or you can call 
+	# Month.new with no arguments to receive the current month.
+	def initialize( year = nil, month = nil )
+		require 'date'
+		if month.nil? || year.nil?
+			date = Date.today
+			month = date.mon unless month
+			year = date.year unless year
+		end
+		fail "invalid month" if month < 1 || month > 12
+		@month = month
+		@year = year
+	end
+
+	# Returns a new Month that is +amountToAdd+ months later.
+	def +( amountToAdd )
+		( fullYears, remainingMonths ) = amountToAdd.divmod( 12 )
+		resultYear = @year + fullYears
+		resultMonth = @month + remainingMonths
+		if resultMonth > 12
+			resultMonth -= 12
+			resultYear += 1
+		end
+		Month.new( resultYear, resultMonth )
+	end
+	
+	# Returns a new Month that is +amountToSubtract+ months earlier.
+	def -(amountToSubtract)
+		self + (-amountToSubtract)
+	end
+	
+	# Compare this Month to another Month.
+	def <=>(anOther)
+		if @year == anOther.year
+			@month <=> anOther.month
+		else
+			@year <=> anOther.year
+		end
+	end
+
+	# Returns the last Date of the month.
+	def end_date
+		self.next.start_date - 1
+	end
+
+	# Is this Month equal to +anOther+? +anOther+ must be another Month of the
+	# same value.
+	def eql?(anOther)
+		self == anOther
+	end
+	
+	# Calculate a hash value for this Month.
+	def hash
+		"#{@year}#{@month}".to_i
+	end
+
+	# Returns the next Month.
+	def next
+		self + 1
+	end
+	
+	# Returns the previous Month.
+	def prev
+		self - 1
+	end
+	
+	# Returns the first Date of the month.
+	def start_date
+		Date.new( @year, @month, 1 )
+	end
+	
+	# Returns a string of the format "January 2001".
+	def to_s
+		Month.month_names[@month-1][0..2] + " " + @year.to_s
+	end
+end

metadata

@@ -0,0 +1,40 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.6
+specification_version: 1
+name: month
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2005-06-07
+summary: Month is a utility class for representing months in Ruby.
+require_paths: 
+  - lib
+email: sera@fhwang.net
+homepage: http://month.rubyforge.org/
+rubyforge_project: 
+description: "Ruby Month is a utility class for representing months in Ruby. It handles
+  addition, previous and next months, end and start dates, month names (in
+  English), and a few other handy things."
+autorequire: month
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+  - Francis Hwang
+files: 
+  - lib/month.rb
+  - lib/month.rb~
+test_files: []
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies: []