rbprayertime 0.1.0

data/lib/prayertime.rb

@@ -0,0 +1,315 @@
+#!/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
+# Thanks to:
+#	Ahmed Essam <suda.nix@hotmail.com>: cpp implementation (first one)
+# 	Ahmed Youssef <xmonader@gmail.com>: pyprayertime (python implementation, mine :D)
+#       Ahmed Atalla <a.atalla@linuxac.org>: support and azan!
+#       Amine Roukh  <amineroukh@gmail.com>: qibla & qibla distance cpp implementation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+require 'date'
+include Math
+
+def degrees(rad)
+  rad * (180 / PI)
+end
+
+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
+end
+
+class Season
+  Winter, Summer = 0, 1
+end
+
+class Calendar
+  UmmAlQuraUniv,
+  EgyptianGeneralAuthorityOfSurvey,
+  UnivOfIslamicSciencesKarachi,
+  IslamicSocietyOfNorthAmerica,
+  MuslimWorldLeague = (1..5).to_a
+end
+
+class Mazhab
+  Default, Hanafi = 0, 1
+end
+
+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
+      zone = "AM"
+    else
+      zone = "PM"
+    end
+  else
+    zone = "PM"
+  end
+  
+  if intvar > 12
+    time += (intvar%12).to_s            
+  elsif intvar % 12 == 12
+    time += var.to_s
+  else
+    time += var.to_s
+  end
+  
+  time += ":"
+  var -= intvar
+  var *= 60
+  minute = var.to_i
+  time += minute.to_s
+      
+  time += ":"
+      
+  var -= var.to_i
+  var *= 60
+  sec = var.to_i
+  time += sec.to_s
+  time += " "
+      
+  time += zone
+  
+end
+
+class Coordinate
+  
+  attr :longitude, true
+  attr :latitude, true
+  attr :zone, true
+
+  def initialize(longitude, latitude, zone)
+    @longitude = longitude
+    @latitude = latitude
+    @zone = zone
+  end
+  
+end
+
+class Prayertime
+  
+  def initialize(longitude, latitude, zone, 
+                 year, month, day,
+                 cal=Calendar::UmmAlQuraUniv, mazhab=Mazhab::Default,  season=Season::Winter)
+    
+    @coordinate = Coordinate.new(longitude, latitude, zone)
+    @date = Date.new(year, month, day)
+    @calendar = cal
+    @mazhab = mazhab
+    @season = season
+    @shrouk = nil
+    @fajr = nil
+    @zuhr = nil
+    @asr = nil
+    @maghrib = nil
+    @isha = nil
+    @dec = 0
+  end
+  
+  def shrouk_time
+    # Gets the time of fajr.
+    to_hrtime(@shrouk, true)
+  end
+            
+  def fajr_time
+    # Gets the time of fajr.
+    to_hrtime(@fajr, true)
+  end
+        
+  def zuhr_time
+    # Gets the time of zuhr.
+    to_hrtime(@zuhr, true)
+  end
+
+  def asr_time
+    # Gets the time of asr.
+    to_hrtime(@asr)
+  end
+  
+  def maghrib_time
+    # Gets the time of maghrib.
+    to_hrtime(@maghrib)
+  end
+  
+  def isha_time
+    # Gets the time of isha.
+    to_hrtime(@isha)
+  end
+   
+  def calculate
+    # Calculations of prayertimes.
+
+    year = @date.year
+    month = @date.month
+    day = @date.day
+    longitude = @coordinate.longitude
+    latitude = @coordinate.latitude
+    zone = @coordinate.zone
+    julian_day = (367*year)-(((year+((month+9)/12).to_i)*7)/4).to_i+(275*month/9).to_i+day-730531.5
+    sun_length = 280.461+0.9856474*julian_day
+    sun_length = remove_duplication(sun_length)
+    middle_sun = 357.528+0.9856003*julian_day
+    middle_sun = remove_duplication(middle_sun)
+        
+    lamda = sun_length+1.915*sin(radians(middle_sun))+0.02*sin(radians(2*middle_sun))
+    lamda = remove_duplication(lamda)
+        
+    obliquity = 23.439-0.0000004*julian_day
+    
+    alpha = degrees(atan(cos(radians(obliquity))*tan(radians(lamda))))
+        
+    if 90 < lamda and lamda < 180 
+      alpha += 180
+    elsif 100 < lamda and lamda < 360
+      alpha += 360
+    end
+     
+    st = 100.46+0.985647352*julian_day
+    
+    st = remove_duplication(st)
+    
+    @dec = degrees(asin(sin(radians(obliquity))*sin(radians(lamda))))
+    
+    noon = alpha-st
+    
+    noon += 360 if noon < 0
+      
+    unt_noon = noon-longitude
+    local_noon = (unt_noon/15)+zone
+    zuhr = local_noon      #Zuhr Time.
+    maghrib = local_noon+equation(-0.8333)/15 # Maghrib Time
+    shrouk = local_noon-equation(-0.8333)/15  # Shrouk Time
+
+    fajr_alt = 0
+    isha_alt = 0
+        
+    case  @calendar
+    when Calendar::UmmAlQuraUniv
+      fajr_alt = -19
+    when Calendar::EgyptianGeneralAuthorityOfSurvey
+      fajr_alt = -19.5
+      isha_alt = -17.5
+    when Calendar::MuslimWorldLeague
+      fajr_alt = -18
+      isha_alt = -17
+    when Calendar::IslamicSocietyOfNorthAmerica
+      fajr_alt = isha_alt = -15
+    when Calendar::UnivOfIslamicSciencesKarachi
+      fajr_alt = isha_alt = -18
+    end
+    
+    fajr = local_noon-equation(fajr_alt)/15  # Fajr Time
+    isha = local_noon+equation(isha_alt)/15  # Isha Time
+    
+    isha = (maghrib+1.5) if @calendar == Calendar::UmmAlQuraUniv
+    
+    asr_alt = 0
+        
+    if @mazhab == Mazhab::Hanafi
+      asr_alt = 90 - degrees(atan(2+tan(radians((latitude - @dec).abs))))
+    else
+      asr_alt = 90 - degrees(atan(1 + tan(radians((latitude - @dec).abs))))
+    end
+        
+    asr = local_noon+equation(asr_alt)/15   # Asr Time.
+        
+    #Add one hour to all times if the season is Summmer.
+    if @season == Season::Summer
+      fajr += 1
+      shrouk += 1
+      zuhr += 1
+      asr += 1
+      maghrib += 1
+      isha += 1
+    end
+    
+    @shrouk = shrouk
+    @fajr = fajr
+    @zuhr = zuhr
+    @asr = asr
+    @maghrib = maghrib
+    @isha = isha
+  end
+        
+  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
+
+  def qibla
+  
+    k_lat = radians(21.423333);
+    k_lon = radians(39.823333);
+    
+    longitude = radians(@coordinate.longitude)
+    latitude =  radians(@coordinate.latitude)
+    
+    numerator = sin(k_lon - longitude)
+    denominator = (cos(latitude) * tan(k_lat)) - (sin(latitude) * cos(k_lon - longitude))
+    q = atan2(numerator,denominator)
+    
+    q = degrees(q)
+    
+  end
+  
+  def qibla_distance
+    
+    k_lat = radians(21.423333);
+    k_lon = radians(39.823333);
+    
+    longitude = radians(@coordinate.longitude)
+    latitude =  radians(@coordinate.latitude)
+    
+    r = 6378.7 #kilometers
+    
+    acos(sin(k_lat) * sin(latitude) + cos(k_lat) * cos(latitude) * cos(longitude-k_lon)) * r
+    
+  end
+  
+  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}"
+    puts "Asr Time is 	#{asr_time}"
+    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()
+  pt.report()
+  puts pt.qibla.to_s + "° N"
+  puts pt.qibla_distance.to_s + " km"
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: rbprayertime
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Abdelrahmn Ghanem
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-06 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: A ruby port of pyprayertime (prayertime algorithm implementation in python).
+email: abom.jdev@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/prayertime.rb
+has_rdoc: true
+homepage: http://bitbucket.org/abom/rbprayertime
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rbprayertime
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A ruby port of pyprayertime.
+test_files: []
+