jalalidate 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2010 Aziz A. 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.rdoc

@@ -0,0 +1,31 @@
+= Jalali Date Library
+
+== History
+
+==== 0.2 - 25.FEB.2010
+* renamed the gem from JalaliDate to jalalidate
+* added spec and a full test suite
+* updated gemspec file for rubygems.org
+* updated some documentations
+
+==== 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
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2008-2010 Aziz A. Bargi. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,77 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+
+    gem.name = "jalalidate"
+    gem.version = "0.2.0"
+    gem.authors = ["Aziz A. Bargi"]
+    gem.email = "aziz.bargi@gmail.com"
+    gem.rubyforge_project = 'JalaliDate'  
+    gem.homepage = "http://github.com/aziz/jalalidate"
+    gem.summary = "A port of class Date in ruby that works based on Jalali Calendar (a.k.a Persian Calendar)"
+    gem.require_path = "lib"
+    gem.has_rdoc = true
+    gem.extra_rdoc_files = ["README.rdoc","LICENSE"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.rdoc_options << "--charset" << "utf-8"    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.options << "--charset" << "utf-8"
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jalalidate #{version}"
+  rdoc.rdoc_files.include(['README.rdoc','LICENSE'])
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,3 @@
+=TODO
+* jalali_strftime: Add support for localized time zone names(%z) and add week number of the year %W and %U
+* add rails active support date calculation for jalali

data/lib/jalalidate.rb

@@ -0,0 +1,315 @@
+# :title:Jalali Date #
+require 'jcode'
+require "date"
+
+class JalaliDate
+
+  #:stopdoc:
+  $KCODE = 'u'
+  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:
+
+  include Comparable
+
+  attr_accessor :year,:month,:day
+  attr_reader :g_year, :g_month, :g_day
+
+  # Can be initialized in two ways:
+  # - First by feeding 3 arguments for Jalali Date, year,month and day.
+  # - The Second way to initializes is to pass a normal Ruby Date object, it'll be converted to jalali automatically.
+  # 
+  # Example:
+  #   jdate = JalaliDate.new(Date.today)
+  #   other_jdate = JalaliDate.new(1388,9,17)
+  def initialize *args
+    if (args.size == 1) && (args.first.is_a? Date)
+      year,month,day = gregorian_to_jalali(args.first.year, args.first.month, args.first.day) 
+    else 
+      year,month,day = args
+    end
+    
+    raise ArgumentError, "invalid arguments or invalid Jalali date" unless self.class.valid?(year,month,day) 
+    @year = year
+    @month = month
+    @day = day
+    @g_year, @g_month, @g_day = jalali_to_gregorian(year,month,day)
+  end
+
+  # Class Methods
+  class << self
+    
+    # Return a JalaliDate object representing today's date in calendar
+    def today
+      JalaliDate.new(Date.today)
+    end
+
+    # Return a JalaliDate object representing yesterday's date in calendar
+    def yesterday
+      JalaliDate.new(Date.today - 1)
+    end
+
+    # Return a JalaliDate object representing tomorrow's date in calendar
+    def tomorrow  
+      JalaliDate.new(Date.today + 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 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 valid?(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
+  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
+
+  # Return internal object state as a programmer-readable string. 
+  def inspect
+    "#<#{self.class}:#{self.object_id}, :year => #{@year}, :month => #{@month}, :day => #{@day} >" 
+  end
+
+  # Adds n days to the current JalaliDate object
+  def +(days)
+    self.class.new( to_g + days )
+  end
+  
+  # Subtracts n days from the current JalaliDate object
+  def -(days)
+    self.class.new( to_g - days )
+  end
+  
+  # Return the next day for the current JalaliDate object
+  def next(n=1)
+    self + n 
+  end
+  alias :succ :next
+  
+  # Return the previous day for the current JalaliDate object
+  def previous(n=1) 
+    self - n 
+  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?(y, m, d)
+    self.class.new(y,m,d)
+  end
+  
+  # Move JalaliDate object backward by n months 
+  def <<(months)
+    self >> -months
+  end
+  
+  # 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.
+  #
+  # Example:
+  #   jdate = JalaliDate.new(Date.today)
+  #   jdate.step(Date.today+10, 2) do |jd|
+  #     puts jd.to_s
+  #   end
+  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.
+  #
+  # Example:
+  #   jdate = JalaliDate.new(Date.today)
+  #   days_string = ""
+  #   jdate.upto(jdate+5) do |jd|
+  #     days_string += jd.day.to_s
+  #   end
+  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. 
+  # See #upto for the example.
+  def downto(min, &block)
+    step(min, -1, &block)
+  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 meanings:
+  #
+  # [%a]  The abbreviated weekday name (۳ش)
+  # [%A]  The full weekday name (یکشنبه)
+  # [%b or %B]   The month name (اردیبهشت)
+  # [%d]   Day of the month (1..31)
+  # [%j]   Day of the year (1..366)
+  # [%m]   Month of the year (1..12)
+  # [%w]   Day of the week (Sunday is 0, 0..6)
+  # [%x]   Preferred representation for the date alone, no time in format YY/M/D
+  # [%y]   Year without a century (00..99)
+  # [%Y]   Year with century
+  # [%%]   Literal %'' character
+  # 
+  # Example:
+  #   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 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 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
+
+end

data/spec/jalalidate_spec.rb

@@ -0,0 +1,127 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe JalaliDate do
+  
+  it "should initialize with valid year,month,date values" do
+    jdate = JalaliDate.new(1388,11,22)
+    jdate.should be_instance_of(JalaliDate)
+  end
+
+  it "should raise error for invalid year,month,date combination on initialize" do
+    lambda { JalaliDate.new(1388,14,22) }.should raise_error(ArgumentError)  # invalid month
+    lambda { JalaliDate.new(1388,14,32) }.should raise_error(ArgumentError)  # invalid day
+    lambda { JalaliDate.new(1388,14,"22") }.should raise_error(ArgumentError)  # invalid type
+    lambda { JalaliDate.new(1388,14,22,11,0) }.should raise_error(ArgumentError)  # invalid arguments
+  end
+
+  it "should initialize with a ruby date object" do
+    jdate = JalaliDate.new(Date.today)
+    jdate.should be_instance_of(JalaliDate)
+  end
+
+  it "should populate attr_accessors for jalali year, month and date and attr_reader for gregorian year,month and date" do
+    jdate = JalaliDate.new(1388,11,22)
+    jdate.year.should eql(1388)
+    jdate.month.should eql(11)
+    jdate.day.should eql(22)
+    jdate.g_year.should eql(2010)
+    jdate.g_month.should eql(2)
+    jdate.g_day.should eql(11)
+  end
+
+  it "should return today, yesterday, and tomorrow date according to jalali calendar" do
+    Date.stub!(:today).and_return(Date.new(2010,1,1))
+    JalaliDate.today.should == JalaliDate.new(1388,10,11)
+    JalaliDate.yesterday.should == JalaliDate.new(1388,10,10)
+    JalaliDate.tomorrow.should == JalaliDate.new(1388,10,12)        
+  end
+
+  it "should distinguish invalid jalali dates" do
+    JalaliDate.valid?(1388,13,11).should be_false
+    JalaliDate.valid?(-1388,11,11).should be_false
+    JalaliDate.valid?(1388,1,45).should be_false
+    JalaliDate.valid?(1388,12,30).should be_false
+    JalaliDate.valid?(1387,12,30).should be_true
+  end
+
+  it "should distinguish leap years" do
+    JalaliDate.leap?(1387).should be_true
+    JalaliDate.leap?(1388).should be_false
+  end
+  
+  it "should convert to gregorian date correctly" do
+    jdate = JalaliDate.new(1388,10,11)
+    jdate.to_g.should == Date.new(2010,1,1)
+  end
+  
+  it "should convert to string, array and hash correctly" do
+    jdate = JalaliDate.new(1388,10,11)
+    jdate.to_s.should == "1388/10/11"
+    jdate.to_a.should == [1388,10,11]
+    jdate.to_hash.should == {:year => 1388, :month => 10, :day => 11}
+  end
+  
+  it "should be able to add and substract days from the currect jalai date object" do
+    jdate = JalaliDate.new(1388,10,11)
+    five_days_later = jdate + 5
+    twenty_days_ago = jdate - 20
+    five_days_later.should == JalaliDate.new(1388,10,16)
+    twenty_days_ago.should == JalaliDate.new(1388,9,21)
+  end
+  
+  it "should be able to compare two jalali dates" do
+    jdate = JalaliDate.new(1388,10,11)
+    next_month_jdate = JalaliDate.new(1388,11,11)
+    next_month_jdate.<=>(jdate).should == 1
+    jdate.<=>(next_month_jdate).should == -1
+    jdate.<=>(jdate).should == 0
+  end
+  
+  it "should now its next and previous dates" do
+    jdate = JalaliDate.new(1388,10,11)
+    jdate.next.should == JalaliDate.new(1388,10,12)
+    jdate.previous.should == JalaliDate.new(1388,10,10)
+  end
+  
+  it "should be able to move the month forward and backward" do
+    jdate = JalaliDate.new(1388,10,11)
+    five_month_later = jdate >> 5
+    five_month_ago = jdate << 5
+    five_month_later.should == JalaliDate.new(1389,3,11)
+    five_month_ago.should == JalaliDate.new(1388,5,11)
+  end
+  
+  it "should be able to cycle through dates in different ways, namely, step, upto and downto" do
+    jdate = JalaliDate.new(1388,10,10)
+    
+    days_string = ""
+    jdate.step( jdate + 10 , 2) do |jd|
+      days_string += jd.day.to_s
+    end
+    days_string.should == "101214161820"
+
+    days_string = ""
+    jdate.upto(jdate+5) do |jd|
+      days_string += jd.day.to_s
+    end
+    days_string.should == "101112131415"
+    
+    days_string = ""
+    jdate.downto(jdate-5) do |jd|
+      days_string += jd.day.to_s
+    end
+    days_string.should == "1098765"
+  end
+
+  it "should return a correct year day based on Jalali Calendar" do
+    JalaliDate.new(1388,1,1).yday.should == 1
+    JalaliDate.new(1388,12,29).yday.should == 365
+    JalaliDate.new(1387,12,30).yday.should == 366
+    JalaliDate.new(1388,9,17).yday.should == 263
+  end
+
+  it "should be able to print jalali date in different formats" do
+    JalaliDate.new(1388,1,7).format("%a %A %b %B %d %j %m %w %y %Y %% %x").should == "ج جمعه فروردین فروردین 7 7 1 5 88 1388 % 88/1/7"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jalalidate'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: jalalidate
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Aziz A. Bargi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-03 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: 
+email: aziz.bargi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- lib/jalalidate.rb
+- spec/jalalidate_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/aziz/jalalidate
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- --charset
+- utf-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: JalaliDate
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A port of class Date in ruby that works based on Jalali Calendar (a.k.a Persian Calendar)
+test_files: 
+- spec/jalalidate_spec.rb
+- spec/spec_helper.rb