parsi-date 0.2 → 0.2.1

data/README.rdoc

@@ -2,5 +2,34 @@
 
 This is an implementation of {Solar Hijri Calendar}[http://en.wikipedia.org/wiki/Solar_Hijri_calendar]
 (some times referred to as Jalali or Persian Calendar) which is Iran's official calendar.
-Main aim of this gem is to create a Solar Hijri date library as close as possible to built-in date library.
+Main aim of this gem is to create a Solar Hijri date library as close as possible to the built-in date library.
 Conversion algorithm originally adopted from {here}[http://www.fourmilab.ch/documents/calendar/].
+
+== Usage
+
+You can use +Parsi::Date+ and +Parsi::DateTime+ objects as +Date+ and +DateTime+ objects
+For example:
+
+```
+a = Parsi::Date.today                     # => #<Parsi::Date: 1391-08-09 (4912461/2,0/1)>
+b = a >> 12                               # => #<Parsi::Date: 1392-08-09 (4913193/2,0/1)>
+a.upto(b).select{ |d| d.sunday? }.count   # => 52
+
+Parsi::Date.leap? 1391                    # => true
+
+c = Parsi::Date.parse "1391/10/12"        # => #<Parsi::Date: 1391-10-12 (4912587/2,0)>
+c.strftime "%A %d %B %Y"                  # => "سه‌شنده 12 دی 1391"
+c.strftime "%^EA %d %^EB %Y"              # => "Seshambe 12 Day 1391"
+```
+
+For converting a +Date+ or +DateTime+ object just call +to_parsi+ (aliased to +jalali+ and +to_jalali+) on it.
+To convert back use +to_gregorian+.
+
+```
+d = Date.civil(2012, 10, 30).to_parsi     # => #<Parsi::Date: 1391-08-09 (4912461/2,0/1)>
+d.to_gregorian                            # => #<Date: 2012-10-30 ((2456231j,0s,0n),+0s,2299161j)>
+```
+
+
+
+Copyright (c) 2012 Hassan Zamani, released under the MIT license.

data/lib/parsi-date.rb

@@ -93,19 +93,31 @@ module Parsi
     # month's numerical representation indexed into this array
     # gives the name of that month (hence the first element is nil).
     MONTHNAMES = [nil] + %w(فروردین اردیبهشت خرداد تیر مرداد شهریور مهر آبان آذر دی بهمن اسفند)
+    # Full month names, in English. Months count from 1 to 12;
+    EN_MONTHNAMES = [nil] + %w(farvardin ordibehesht khordad tir mordad sharivar mehr aban azar day bahman esfand)
 
     # Full names of days of the week, in Farsi. Days of the week
-    # count from 0 to 6 (except in the commercial week); a day's numerical
-    # representation indexed into this array gives the name of that day.
+    # count from 0 to 6; a day's numerical representation indexed into this array gives
+    # the name of that day.
     DAYNAMES = %w(یک‌شنده دوشنده سه‌شنده چهارشنده چنج‌شنده جمعه شنده)
 
+    # Full names of days of the week, in English. Days of the week
+    # count from 0 to 6; a day's numerical representation indexed into this array gives
+    # the name of that day.
+    EN_DAYNAMES = %w(yekshambe doshambe seshambe chaharshambe panjshanbe jomee shanbe)
+
     # Abbreviated month names, in English.
-    ABBR_MONTHNAMES = [nil] + %w(Far Ord Kho Tir Mor Sha Meh Abn Azr Dey Bah Esf)
+    #
+    # We don't have Farsi abbreviated month names, as they are not useful
+    ABBR_MONTHNAMES = [nil] + %w(far ord kho tir mor sha meh abn azr dey bah esf)
 
     # Abbreviated day names, in Farsi.
     ABBR_DAYNAMES = %w(۱ش ۲ش ۳ش ۴ش ۵ش ج ش)
 
-    [MONTHNAMES, ABBR_MONTHNAMES, DAYNAMES, ABBR_DAYNAMES].each do |xs|
+    # Abbreviated day names, in English.
+    ABBR_EN_DAYNAMES = %w(ye do se ch pj jo sh)
+
+    [MONTHNAMES, EN_MONTHNAMES, ABBR_MONTHNAMES, DAYNAMES, EN_DAYNAMES, ABBR_DAYNAMES, ABBR_EN_DAYNAMES].each do |xs|
       xs.each{|x| x.freeze unless x.nil?}.freeze
     end
 
@@ -457,6 +469,10 @@ module Parsi
       define_method(n.downcase + '?'){ wday == i }
     end
 
+    EN_DAYNAMES.each_with_index do |n, i|
+      define_method(n.downcase + '?'){ wday == i }
+    end
+
     # Return a new Date object that is +n+ days later than the current one.
     #
     # +n+ may be a negative value, in which case the new Date is earlier
@@ -590,6 +606,27 @@ module Parsi
       DateTime.new! jd_to_ajd(jd, 0, 0), 0
     end
 
+    def to_parsi
+      self
+    end
+    alias :jalali     :to_parsi
+    alias :to_jalali  :to_parsi
+    alias :to_persian :to_parsi
+
+    # Formats time according to the directives in the given format string.
+    # The directives begins with a percent (%) character. Any text not listed as a
+    # directive will be passed through to the output string.
+    #
+    # The directive consists of a percent (%) character, zero or more flags,
+    # optional minimum field width, optional modifier and a conversion specifier as
+    # follows.
+    #
+    #   %<flags><width><modifier><conversion>
+    #
+    # +flags+ and +conversion+ are as in +Time+ exept that the +E+ flag is not egnored
+    # any more, it forse useing English names
+    #
+    #
     def strftime format='%Y/%m/%d'
       format.
         gsub('%%', 'PERCENT_SUBSTITUTION_MARKER').
@@ -598,24 +635,34 @@ module Parsi
         gsub('%x', '%D').
         gsub('%D', '%y/%m/%d').
         gsub('%F', '%Y-%m-%d').
-        gsub('%v', '%e-%b-%Y').
+        gsub('%v', '%e-%B-%Y').
         gsub('%Y', year.to_s).
         gsub('%C', (year / 100).to_s).
         gsub('%y', (year % 100).to_s).
         gsub('%m',  '%02d' % month).
-        gsub('%_m', '% 2d' % month).
+        gsub('%_m', '%2d' % month).
         gsub('%-m', month.to_s).
         gsub('%^B', '%B').
         gsub('%B', MONTHNAMES[month]).
+        gsub('%E^B', '%^EB').
+        gsub('%^EB', EN_MONTHNAMES[month].capitalize).
+        gsub('%EB', EN_MONTHNAMES[month]).
         gsub('%h', '%b').
+        gsub('%^h', '%^b').
         gsub('%b', ABBR_MONTHNAMES[month]).
         gsub('%^b', ABBR_MONTHNAMES[month].capitalize).
         gsub('%d', '%02d' % day).
-        gsub('%e', '% 2d' % day).
+        gsub('%e', '%2d' % day).
         gsub('%-d', day.to_s).
         gsub('%j', '%03d' % yday.to_s).
         gsub('%A', DAYNAMES[wday]).
         gsub('%a', ABBR_DAYNAMES[wday]).
+        gsub('%EA', EN_DAYNAMES[wday]).
+        gsub('%Ea', ABBR_EN_DAYNAMES[wday]).
+        gsub('%E^A', '%^EA').
+        gsub('%^EA', EN_DAYNAMES[wday].capitalize).
+        gsub('%E^a', '%^Ea').
+        gsub('%^Ea', ABBR_EN_DAYNAMES[wday].capitalize).
         gsub('%w', wday.to_s).
         gsub('%n', "\n").
         gsub('%t', "\t").
@@ -693,3 +740,5 @@ class Date
   alias :to_jalali  :to_parsi
   alias :to_persian :to_parsi
 end
+
+require 'parsi-datetime'

data/lib/parsi-datetime.rb

@@ -200,3 +200,13 @@ class DateTime
   alias :to_jalali  :to_parsi
   alias :to_persian :to_parsi
 end
+
+class Time
+  # Returns a Parsi::DateTime object representing same date in Jalali calendar
+  def to_parsi
+    to_datetime.to_parsi
+  end
+  alias :jalali     :to_parsi
+  alias :to_jalali  :to_parsi
+  alias :to_persian :to_parsi
+end

data/lib/version.rb

@@ -1,5 +1,5 @@
 module Parsi
   class Date
-    VERSION = "0.2"
+    VERSION = "0.2.1"
   end
 end

data/spec/parsi-date/constants_spec.rb

@@ -3,23 +3,40 @@ require File.expand_path('../../spec_helper', __FILE__)
 
 describe "Date constants" do
   it "defines MONTHNAMES" do
-    Parsi::Date::MONTHNAMES.should == [nil] + %w(فروردین اردیبهشت خرداد تیر مرداد شهریور مهر آبان آذر دی بهمن اسفند)
+    Parsi::Date::MONTHNAMES.should == [nil] +
+      %w(فروردین اردیبهشت خرداد تیر مرداد شهریور مهر آبان آذر دی بهمن اسفند)
+  end
+
+  it "defines EN_MONTHNAMES" do
+    Parsi::Date::EN_MONTHNAMES.should == [nil] +
+      %w(farvardin ordibehesht khordad tir mordad sharivar mehr aban azar day bahman esfand)
   end
 
   it "defines ABBR_MONTHNAMES" do
-    Parsi::Date::ABBR_MONTHNAMES.should == [nil] + %w(Far Ord Kho Tir Mor Sha Meh Abn Azr Dey Bah Esf)
+    Parsi::Date::ABBR_MONTHNAMES.should == [nil] +
+      %w(far ord kho tir mor sha meh abn azr dey bah esf)
   end
 
   it "defines DAYNAMES" do
-    Parsi::Date::DAYNAMES.should == %w(یک‌شنده دوشنده سه‌شنده چهارشنده چنج‌شنده جمعه شنده )
+    Parsi::Date::DAYNAMES.should == %w(یک‌شنده دوشنده سه‌شنده چهارشنده چنج‌شنده جمعه شنده)
+  end
+
+  it "defines EN_DAYNAMES" do
+    Parsi::Date::EN_DAYNAMES.should == %w(yekshambe doshambe seshambe chaharshambe panjshanbe jomee shanbe)
   end
 
   it "defines ABBR_DAYNAMES" do
     Parsi::Date::ABBR_DAYNAMES.should == %w(۱ش ۲ش ۳ش ۴ش ۵ش ج ش)
   end
 
-  it "freezes MONTHNAMES, DAYNAMES, ABBR_MONTHNAMES, ABBR_DAYSNAMES" do
-    [Parsi::Date::MONTHNAMES, Parsi::Date::DAYNAMES, Parsi::Date::ABBR_MONTHNAMES, Parsi::Date::ABBR_DAYNAMES].each do |ary|
+  it "defines ABBR_EN_DAYNAMES" do
+    Parsi::Date::ABBR_EN_DAYNAMES.should == %w(ye do se ch pj jo sh)
+  end
+
+  it "freezes MONTHNAMES, DAYNAMES, EN_DAYNAMES, ABBR_MONTHNAMES, ABBR_DAYSNAMES" do
+    [Parsi::Date::MONTHNAMES, Parsi::Date::EN_MONTHNAMES, Parsi::Date::ABBR_MONTHNAMES,
+     Parsi::Date::DAYNAMES, Parsi::Date::EN_DAYNAMES,
+     Parsi::Date::ABBR_DAYNAMES, Parsi::Date::ABBR_EN_DAYNAMES].each do |ary|
       ary.should be_frozen
     end
   end

data/spec/parsi-date/strftime_spec.rb

@@ -17,11 +17,15 @@ describe "Parsi::Date#strftime" do
 
   it "should be able to print the full month name" do
     Parsi::Date.civil(1390, 4, 6).strftime("%B").should == "تیر"
+    Parsi::Date.civil(1390, 4, 6).strftime("%EB").should == "tir"
+    Parsi::Date.civil(1390, 4, 6).strftime("%^EB").should == "Tir"
   end
 
   it "should be able to print the short month name" do
-    Parsi::Date.civil(1390, 4, 6).strftime("%b").should == "Tir"
-    Parsi::Date.civil(1390, 4, 6).strftime("%h").should == "Tir"
+    Parsi::Date.civil(1390, 4, 6).strftime("%b").should == "tir"
+    Parsi::Date.civil(1390, 4, 6).strftime("%h").should == "tir"
+    Parsi::Date.civil(1390, 4, 6).strftime("%^b").should == "Tir"
+    Parsi::Date.civil(1390, 4, 6).strftime("%^h").should == "Tir"
     Parsi::Date.civil(1390, 4, 6).strftime("%b").should == Parsi::Date.civil(1390, 4, 6).strftime("%h")
   end
 
@@ -30,15 +34,23 @@ describe "Parsi::Date#strftime" do
   end
 
   it "should be able to print the month day with leading zeroes" do
-    Parsi::Date.civil(1390, 4, 6).strftime("%d").should == "06"
+    Parsi::Date.civil(1390, 4,  6).strftime("%d").should == "06"
+    Parsi::Date.civil(1390, 4, 16).strftime("%d").should == "16"
   end
 
-  it "should be able to print the month day with leading spaces" do
-    Parsi::Date.civil(1390, 4, 6).strftime("%e").should == " 6"
+  it "should be able to print the month day with leading spaces and without em" do
+    Parsi::Date.civil(1390, 4,  6).strftime("%-d").should == "6"
+    Parsi::Date.civil(1390, 4,  6).strftime("%e").should == " 6"
+    Parsi::Date.civil(1390, 4, 16).strftime("%e").should == "16"
   end
 
-  it "should be able to print the month with leading zeroes" do
-    Parsi::Date.civil(1390, 4, 6).strftime("%m").should == "04"
+  it "should be able to print the month with leading zeroes, spaces and none" do
+    Parsi::Date.civil(1390,  4, 6).strftime("%m").should == "04"
+    Parsi::Date.civil(1390, 11, 6).strftime("%m").should == "11"
+    Parsi::Date.civil(1390,  4, 6).strftime("%_m").should == " 4"
+    Parsi::Date.civil(1390, 11, 6).strftime("%_m").should == "11"
+    Parsi::Date.civil(1390,  4, 6).strftime("%-m").should == "4"
+    Parsi::Date.civil(1390, 11, 6).strftime("%-m").should == "11"
   end
 
   it "should be able to add a newline" do
@@ -86,8 +98,8 @@ describe "Parsi::Date#strftime" do
   end
 
   it "should be able to show the commercial week" do
-    Parsi::Date.civil(1390, 4, 9).strftime("%v").should == " 9-Tir-1390"
-    Parsi::Date.civil(1390, 4, 9).strftime("%v").should == Parsi::Date.civil(1390, 4, 9).strftime('%e-%b-%Y')
+    Parsi::Date.civil(1390, 4, 9).strftime("%v").should == " 9-تیر-1390"
+    Parsi::Date.civil(1390, 4, 9).strftime("%v").should == Parsi::Date.civil(1390, 4, 9).strftime('%e-%B-%Y')
   end
 
   it "should be able to show YY/MM/DD" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parsi-date
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors: