rbprayertime 0.1.0 → 0.1.5

data/lib/prayertime.rb

@@ -1,9 +1,11 @@
 #!/usr/bin/env ruby
 # coding: utf-8
-# prayertimes implementation for ruby - just a port of pyprayertime
-# Author: Abdelrahman ghanem <abom.jdev@gmail.com>
 #
-# Algorithm is taken from http://qasweb.org
+# Prayertimes implementation for ruby - just a port of pyprayertime.
+#
+# Author: Abdelrahman ghanem <abom.jdev@gmail.com>.
+#
+# Algorithm is taken from http://qasweb.org.
 # Thanks to:
 #	Ahmed Essam <suda.nix@hotmail.com>: cpp implementation (first one)
 # 	Ahmed Youssef <xmonader@gmail.com>: pyprayertime (python implementation, mine :D)
@@ -26,28 +28,25 @@
 require 'date'
 include Math
 
+# Radians to Degrees
 def degrees(rad)
   rad * (180 / PI)
 end
-
+# Degrees to Radians
 def radians(deg)
   deg * (PI / 180)
 end
 
 def remove_duplication(var)
-  ##BETTER WAY?
-  if var > 360
-    var /= 360   
-    var -= var.to_i
-    var *= 360
-  end
-  var
+  var % 360
 end
 
+# A class represents seasons for day light saving time -dst-.
 class Season
   Winter, Summer = 0, 1
 end
 
+# A class represents calculation calendars.
 class Calendar
   UmmAlQuraUniv,
   EgyptianGeneralAuthorityOfSurvey,
@@ -56,17 +55,23 @@ class Calendar
   MuslimWorldLeague = (1..5).to_a
 end
 
+# A class represents mazhab -asr time difference only-.
 class Mazhab
   Default, Hanafi = 0, 1
 end
 
+# A String formatted time: %I:%M:%S %p.
 def to_hrtime(var, isAM = false)  
   # var: double -> human readable string of format "%I:%M:%S %p"
-  
   time = ''
   intvar = var.to_i #var is double.
   if isAM
-    if intvar % 12 and intvar % 12 < 12
+    # because 0, 1 arn't equal false, true in ruby
+    # in python 0 => False, 1 => True
+    # in ruby every thing except false and nil is true
+    a = true
+    a = false if intvar % 12 == 0
+    if a and intvar % 12 < 12
       zone = "AM"
     else
       zone = "PM"
@@ -78,9 +83,9 @@ def to_hrtime(var, isAM = false)
   if intvar > 12
     time += (intvar%12).to_s            
   elsif intvar % 12 == 12
-    time += var.to_s
+    time += intvar.to_s
   else
-    time += var.to_s
+    time += intvar.to_s
   end
   
   time += ":"
@@ -95,12 +100,23 @@ def to_hrtime(var, isAM = false)
   var *= 60
   sec = var.to_i
   time += sec.to_s
+  # fill => zero padded
+  fill = lambda {|t| t.split(':').map{|i| ('0'*(2-i.length)) + i}.join(':') }
+  time = fill[time]
   time += " "
-      
+  
+  # meridian indicator
   time += zone
   
 end
 
+# The same as to_hrtime() uses Time.
+def as_rbtime(var)
+  # needs testing
+  (Time.local('00:00:00 AM') + var*60*60).strftime("%I:%M:%S %p")
+end
+
+# A class represents coordinates (latitude, longitude) and zone.
 class Coordinate
   
   attr :longitude, true
@@ -115,11 +131,33 @@ class Coordinate
   
 end
 
+# Prayertime class, containing calculations, prayer times...etc.
 class Prayertime
   
+  # Initialize a new prayertime object.
+  #
+  # Usage example:
+  #
+  #   #cairo > lat,lon => 31.3101, 29.7768
+  #   pt=Prayertime.new(31.3101, 29.7768, 2, 2011, 2, 7, Calendar::EgyptianGeneralAuthorityOfSurvey, Mazhab::Default, Season::Winter)
+  #   pt.report()
+  #   puts pt.qibla.to_s + "° N"
+  #   puts pt.qibla_distance.to_s + " km"
+  # produces:
+  #   Fajr Time is    05:13:09 AM                                                                                   
+  #   Shrouk Time is  06:41:17 AM                                                                                   
+  #   Zuhr  Time is   12:08:50 PM                                                                                   
+  #   Asr Time is     03:13:56 PM                                                                                   
+  #   Maghrib Time is 05:36:24 PM                                                                                   
+  #   Ishaa Time is   06:55:13 PM                                                                                   
+  #   135.489731310865° N                                                                                           
+  #   1262.14097579674 km  
+
   def initialize(longitude, latitude, zone, 
                  year, month, day,
-                 cal=Calendar::UmmAlQuraUniv, mazhab=Mazhab::Default,  season=Season::Winter)
+                 cal=Calendar::UmmAlQuraUniv,
+                 mazhab=Mazhab::Default,
+                 season=Season::Winter)
     
     @coordinate = Coordinate.new(longitude, latitude, zone)
     @date = Date.new(year, month, day)
@@ -133,41 +171,42 @@ class Prayertime
     @maghrib = nil
     @isha = nil
     @dec = 0
+    
+    calculate()
   end
   
+  # Gets the time of shrouk.
   def shrouk_time
-    # Gets the time of fajr.
     to_hrtime(@shrouk, true)
   end
-            
+  
+  # Gets the time of fajr.
   def fajr_time
-    # Gets the time of fajr.
     to_hrtime(@fajr, true)
   end
         
+  # Gets the time of zuhr.
   def zuhr_time
-    # Gets the time of zuhr.
     to_hrtime(@zuhr, true)
   end
 
+  # Gets the time of asr.
   def asr_time
-    # Gets the time of asr.
     to_hrtime(@asr)
   end
   
+  # Gets the time of maghrib.
   def maghrib_time
-    # Gets the time of maghrib.
     to_hrtime(@maghrib)
   end
   
+  # Gets the time of isha.
   def isha_time
-    # Gets the time of isha.
     to_hrtime(@isha)
   end
-   
+ 
+  # Calculations of prayertimes.
   def calculate
-    # Calculations of prayertimes.
-
     year = @date.year
     month = @date.month
     day = @date.day
@@ -259,12 +298,14 @@ class Prayertime
     @maghrib = maghrib
     @isha = isha
   end
-        
+  
+  # The main equation used in calculations.
   def equation(alt)
     #return RadToDeg*acos((sin(alt*DegToRad)-sin(self.dec*DegToRad)*sin(self.coordinate.latitude*DegToRad))/(cos(self.dec*DegToRad)*cos(self.coordinate.latitude*DegToRad)))
     degrees( acos( (sin(radians(alt)) - sin(radians(@dec)) * sin(radians(@coordinate.latitude)))/(cos(radians(@dec))*cos(radians(@coordinate.latitude)))))
   end
-
+  
+  # Return qibla angle from north (in degrees).
   def qibla
   
     k_lat = radians(21.423333);
@@ -281,6 +322,7 @@ class Prayertime
     
   end
   
+  # The distance to kaaba in kilometers.
   def qibla_distance
     
     k_lat = radians(21.423333);
@@ -295,8 +337,8 @@ class Prayertime
     
   end
   
+  # A simple report of all prayertimes.
   def report
-    # Simple report of all prayertimes.
     puts "Fajr Time is  	#{fajr_time}"
     puts "Shrouk Time is 	#{shrouk_time}"
     puts "Zuhr  Time is	#{zuhr_time}"
@@ -304,11 +346,13 @@ class Prayertime
     puts "Maghrib Time is #{maghrib_time}"
     puts "Ishaa Time is 	#{isha_time}"
   end
+    
 end
 
 if $0 == __FILE__
-  pt=Prayertime.new(31.3101, 29.7768, 2, 2010, 12, 6, Calendar::EgyptianGeneralAuthorityOfSurvey, Mazhab::Default, Season::Winter)
-  pt.calculate()
+  #cairo > lat,lon => 31.3101, 29.7768
+  pt=Prayertime.new(31.3101, 29.7768, 2, 2011, 2, 7, Calendar::EgyptianGeneralAuthorityOfSurvey, Mazhab::Default, Season::Winter)
+  #pt.calculate()
   pt.report()
   puts pt.qibla.to_s + "° N"
   puts pt.qibla_distance.to_s + " km"

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: rbprayertime
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
-- Abdelrahmn Ghanem
+- Abdelrahman Ghanem
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-12-06 00:00:00 +02:00
+date: 2011-02-07 00:00:00 +02:00
 default_executable: 
 dependencies: []