JalaliDate 0.1.0

data/CHANGELOG

@@ -0,0 +1,8 @@
+=== History
+
+==== 0.02 - 08.AUG.2008
+* added jalali to geregorian date convertor. 
+* added JalaliDate class and ported Date class method to JalaliDate
+
+==== 0.01 - 07.AUG.2008
+* planning the project

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+== License
+Copyright (c) 2008 Aziz Ashofte Bargi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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.

data/README

@@ -0,0 +1 @@
+=== README

data/TODO

@@ -0,0 +1 @@
+here is the social todo

data/lib/jalali_date.rb

@@ -0,0 +1,273 @@
+# :title:JalaliDate
+#
+class JalaliDate
+	#:stopdoc:
+	$KCODE = 'u'
+	require 'jcode'
+	include Comparable
+	
+	GDaysInMonth = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+	JDaysInMonth = [31, 31, 31, 31, 31, 31, 30, 30, 30, 30, 30, 29]
+	PERSIAN_MONTH_NAMES = [nil, "فروردین","اردیبهشت","خرداد","تیر","مرداد","شهریور","مهر","آبان","آذر","دی","بهمن","اسفند"]
+	PERSIAN_WEEKDAY_NAMES = ["یک‌شنبه","دوشنبه","سه‌شنبه","چهارشنبه","پنج‌شنبه","جمعه","شنبه"]
+	PERSIAN_ABBR_WEEKDAY_NAMES = ["۱ش","۲ش","۳ش","۴ش","۵ش","ج","ش"]
+	PERSIAN_MERIDIAN_INDICATOR = ["قبل از ظهر","بعد از ظهر"]
+	PERSIAN_ABBR_MERIDIAN_INDICATOR = ["ق.ظ","ب.ظ"]
+	#:startdoc:
+	
+	attr_accessor :year,:month,:day
+	attr_reader :g_year, :g_month, :g_day
+	
+	
+	def initialize(year,month,day)
+		raise ArgumentError, "invalid arguments or invalid Jalali date" unless self.class.valid_date?(year,month,day) 
+		@year = year
+		@month = month
+		@day = day
+		@g_year, @g_month, @g_day = self.class.jalali_to_gregorian(year,month,day)
+	end
+	
+	# Return a new JalaliDate object but accept a Ruby Date object as the parameter, 
+	# rather than 3 values for jalali year, jalali month and jalali date (which is what JalaliDate#new does). 
+	def self.build(date)
+		g_to_j(date)
+	end
+	
+	# Return a JalaliDate object representing today's date in calendar
+	def self.today(date = Time.now)
+		g_to_j(date)
+	end
+	
+	# Return a JalaliDate object representing yesterday's date in calendar
+	def self.yesterday
+		tod = Time.now
+		today(Date.new(tod.year,tod.month,tod.day) - 1)
+	end
+	
+	# Return a JalaliDate object representing tomorrow's date in calendar
+	def self.tomorrow	
+		tod = Time.now
+		today(Date.new(tod.year,tod.month,tod.day) + 1)
+	end
+	
+	# Accpets a four digit number as the jalaliyear and returns true if that particular year 
+	# is a leap year in jalali calendar otherwise it returns false.
+	def self.leap?(y) 
+		[6,22,17,13,9,5,1,30].include?(y%33) ? true : false 
+	end
+	
+	# Accpets three numbers for year (4 digit), month and day in jalali calendar and checks if it's a 
+	# valid date according to jalali calendar or not.
+	def self.valid_date?(y,m,d)
+		(y.class == Fixnum && y > 0 && 
+		 m.class == Fixnum && (1..12).include?(m) && 
+		 d.class == Fixnum && (((1..JDaysInMonth[m-1]).include?(d)) || (d == 30 && m == 12 && leap?(y)   )) 
+		) ? true : false
+	end
+	
+	# Converts a JalaiDate object to Ruby Date object
+	def to_gregorian; Date.new(@g_year,@g_month,@g_day); end;
+	alias :to_g :to_gregorian
+	
+	# Returns a string represtation of the JalaliDate object in format like this: y/m/d
+	def to_s() [@year,@month,@day].join("/") end
+	
+	# Returns a hash in a format like this: {:year => @year, :month => @month, :day => @day}
+	def to_hash() {:year => @year, :month => @month, :day => @day} end
+	
+	# Returns an array in a format like this: [y,m,d]
+	def to_a() [@year,@month,@day] end
+
+	# Adds n days to the current JalaliDate object
+	def +(days) self.class.g_to_j( to_g + days ) end
+	
+	# Subtracts n days from the current JalaliDate object
+	def -(days) self.class.g_to_j( to_g - days ) end
+	
+	# Compares two JalaliDate objects. acts like Date#<=>
+	def <=>(other) to_g <=> other.to_g	end
+
+	# Move JalaliDate object forward by n months
+	def >>(months)
+	  y, m = (@year * 12 + (@month - 1) + months).divmod(12)
+    m,   = (m + 1)                    .divmod(1)
+    d = @day
+    d -= 1 until self.class.valid_date?(y, m, d)
+    self.class.new(y,m,d)
+	end
+	
+	# Move JalaliDate object backward by n months 
+	def <<(months) self >> -months end
+	
+	# Return the next day for the current JalaliDate object
+	def next(n=1) self + n end
+	
+	# Return the previous day for the current JalaliDate object
+	def previous(n=-1) self - n end
+	alias :succ :next
+
+  # Step the current date forward step days at a time (or backward, if step is negative) until we reach 
+  # limit (inclusive), yielding the resultant date at each step. 
+	def step(limit, step=1) 
+    da = self
+    op = %w(- <= >=)[step <=> 0]
+    while da.__send__(op, limit)
+      yield da
+      da += step
+    end
+    self
+  end
+  
+  # Step forward one day at a time until we reach max (inclusive), yielding each date as we go. 
+  def upto(max, &block) step(max, +1, &block) end
+  
+  # Step backward one day at a time until we reach min (inclusive), yielding each date as we go. 
+  def downto(min, &block) step(min, -1, &block) end
+  
+  # Return internal object state as a programmer-readable string. 
+	def inspect() "#<%#{self.class}: :year => #{@year} , :month => #{@month} , :day => #{@day} >" end
+	
+	# Is this a leap year? 
+	def leap?() self.class.leap?(@year) end
+	
+	# Get the week day of this date. Sunday is day-of-week 0; Saturday is day-of-week 6. 
+	def wday() to_g.wday end
+	
+	# Get the day-of-the-year of this date.
+	# Farvardin 1 is day-of-the-year 1
+	def yday() 
+		m = (@month-2 < 0) ? 0 : @month-2
+		(@month==1) ? @day : @day + JDaysInMonth[0..m].inject(0) {|sum, n| sum + n } 
+	end	
+  
+	# Formats time according to the directives in the given format string. Any text not listed as a directive will be 
+	# passed through to the output string.
+	#
+	# Format meaning:
+	#
+  #<tt>%a - The abbreviated weekday name (۳ش)</tt>
+  #<tt>%A - The full weekday name (یکشنبه)</tt>
+  #<tt>%b or %B - The month name (اردیبهشت)</tt>
+  #<tt>%d - Day of the month (1..31)</tt>
+  #<tt>%j - Day of the year (1..366)</tt>
+  #<tt>%m - Month of the year (1..12)</tt>
+  #<tt>%w - Day of the week (Sunday is 0, 0..6)</tt>
+  #<tt>%x - Preferred representation for the date alone, no time in format YY/M/D</tt>
+  #<tt>%y - Year without a century (00..99)</tt>
+  #<tt>%Y - Year with century</tt>
+  #<tt>%% - Literal %'' character</tt>
+
+  # d = JalaliDate.today
+  # d.strftime("Printed on %Y/%m/%d")   #=> "Printed on 87/5/26
+	def strftime(format_str = '%Y/%m/%d')
+    clean_fmt = format_str.gsub(/%{2}/, "SUBSTITUTION_MARKER").
+      gsub(/%a/, PERSIAN_ABBR_WEEKDAY_NAMES[wday]).
+      gsub(/%A/, PERSIAN_WEEKDAY_NAMES[wday]).
+      gsub(/%b/, PERSIAN_MONTH_NAMES[@month]).
+      gsub(/%B/, PERSIAN_MONTH_NAMES[@month]).
+      gsub(/%d/, @day.to_s).
+      gsub(/%m/, @month.to_s).
+      gsub(/%Y/, @year.to_s).
+      gsub(/%y/, @year.to_s.slice(2,2)).
+			gsub(/%j/, yday.to_s).
+      gsub(/%w/, wday.to_s).
+      gsub(/%x/, [@year.to_s.slice(2,2),@month,@day].join("/")).
+      gsub(/#{"SUBSTITUTION_MARKER"}/, '%')
+	end		
+	alias :format :strftime			  	
+	
+	private #-------------------------------------------------------------------------
+	def self.gregorian_to_jalali(year, month, day)
+		gy = year - 1600
+	  gm = month - 1
+	  gd = day - 1
+		g_day_no = 365*gy + (gy+3)/4 - (gy+99)/100 + (gy+399)/400
+		gm.times { |i| g_day_no += GDaysInMonth[i] }
+		g_day_no += 1 if gm > 1 && ((gy%4 == 0 && gy%100 != 0) || (gy%400 == 0))
+		g_day_no += gd
+	
+		j_day_no = g_day_no-79
+		j_np = j_day_no/12053
+		j_day_no %= 12053
+		jy = 979 + 33 * j_np + 4*(j_day_no/1461)
+		j_day_no %= 1461
+	
+		if (j_day_no >= 366)
+		   jy += (j_day_no - 1)/365
+		   j_day_no = (j_day_no - 1) % 365
+		end
+	
+		11.times do |i|
+			if j_day_no >= JDaysInMonth[i]
+				j_day_no -= JDaysInMonth[i]
+				$j = i + 1
+			else
+				$j = i
+				break
+			end
+		end
+		jm = $j + 1
+		jd = j_day_no + 1
+	
+		[jy, jm, jd]
+	end
+	
+	def self.jalali_to_gregorian(year,month,day)
+		jy = year - 979
+		jm = month - 1
+		jd = day - 1
+		j_day_no = 365*jy + (jy/33)*8 + (jy % 33 + 3)/4
+		jm.times { |i| j_day_no += JDaysInMonth[i] }
+		j_day_no += jd
+		
+		g_day_no = j_day_no + 79
+		gy = 1600 + 400*(g_day_no/146097)
+		g_day_no %= 146097
+		
+		leap = true
+		if g_day_no >= 36525 
+			g_day_no -= 1
+			gy += 100 * (g_day_no/36524)
+			g_day_no %= 36524 	
+			(g_day_no >= 365) ? g_day_no += 1 : leap = false
+		end
+		
+		gy += 4 * (g_day_no/1461)
+		g_day_no %= 1461
+		
+		if g_day_no >= 366
+			leap = false
+			g_day_no -= 1
+			gy += g_day_no/365
+			g_day_no %= 365 					
+		end	
+
+		11.times do |i|
+			leap_day = (i==1 && leap) ?  1 : 0
+			if g_day_no >= (GDaysInMonth[i] + leap_day )
+				g_day_no -= (GDaysInMonth[i] + leap_day )
+				$g = i + 1
+			else
+				$g = i
+				break
+			end
+		end
+		gm = $g + 1 
+		gd = g_day_no + 1
+		
+		[gy,gm,gd]
+	end
+
+	# Accept a Date or Time object and return a JalaliDate object
+	def self.g_to_j(date)
+		y,m,d = gregorian_to_jalali(date.year, date.month, date.day)
+		JalaliDate.new(y,m,d)
+	end
+
+	# Accept a JalaliDate and return a Ruby Date object
+	def self.j_to_g(date)
+		y,m,d = jalali_to_gregorian(date.year, date.month, date.day)
+		Date.new(y,m,d)
+	end
+	
+end

data/test/test.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require 'jalali_date'
+
+class TC_JalaliDate < Test::Unit::TestCase
+
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: JalaliDate
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aziz Ashofte Bargi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-25 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: aziz.bargi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGELOG
+- TODO
+- MIT-LICENSE
+files: 
+- lib/jalali_date.rb
+- test/test.rb
+- README
+- CHANGELOG
+- TODO
+- MIT-LICENSE
+has_rdoc: true
+homepage: http://jalalidate.rubyforge.org
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: JalaliDate
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A port of class Date in ruby that works based on Jalali Calendar (a.k.a Persian Calendar)
+test_files: 
+- test/test.rb