rbprayertime 0.1.5 → 0.1.9.1

data/ChangeLog

@@ -0,0 +1,17 @@
+[*] 2010-12-6
+  - Initial relese :)
+
+[*] 2011-2-6
+  - two bug fixes (into to_hrtime method)
+  - just use % in remove_duplication()
+  - add as_rbtime method to get string formatted time with ruby time
+  - add more comments
+
+[*] 2013-7-29
+  - remove season and add dst instead
+  - a simple cli (prayertimes executable)
+  - will be rewritten
+  - latitude is written first
+
+[*] 2013-7-30
+  - fix doc and version

data/bin/prayertimes

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+require 'prayertime'
+# cairo > lat, lon => 29.7768, 31.3101 
+clat, clon = 29.7768, 31.3101 #30.1, 31.41667 ??
+
+require 'optparse'
+require 'optparse/date'
+require 'ostruct'
+
+opts = OpenStruct.new
+
+opts_parser = OptionParser.new do |optp|
+  optp.banner = "Usage: #{__FILE__} [options]..."
+  optp.version = Prayertime::VERSION
+
+  optp.separator ""
+  optp.separator "location coordinates options: "
+
+  # FIXME: use coordinates instead (after being fixed in lib)
+  optp.on("--lat Latitude", Float, "latitude, default 31.3101") do |lat|
+    opts.lat = lat
+  end
+
+  optp.on("--lon Longitude", Float, "longitude, default 29.7768") do |lon|
+    opts.lon = lon
+  end
+
+  optp.on("-z", "--zone Zone", Float, "time zone, default: 2") do |zone|
+    opts.zone = zone
+  end
+
+  optp.separator ""
+  optp.separator "date: "
+
+  optp.on("-d", "--date [Date], date", Date, "chosen date, yyyy/mm/dd, default: today") do |date|
+    opts.date = date
+  end
+
+
+  optp.separator ""
+  optp.separator "calculation options: "
+
+  optp.on("-c", "--calendar N", Integer, "calculation method", 
+          "0: Umm Al Qura Univ",
+          "1: Egyptian General Authority Of Survey",
+          "2: Univ Of Islamic Sciences Karachi",
+          "3: Islamic Society Of North America",
+          "4: Muslim World League") do |cal|
+    opts.calendar = cal
+  end
+
+  optp.separator ""
+
+  optp.on("-m", "--mazhab N", Integer, "chosen mazhab", "0: Default", "1: Hanafi") do |mazhab|
+    opts.mazhab = mazhab
+  end
+
+  optp.separator ""
+
+  #it should be dst
+  optp.on("-s", "--dst Hours", Float, "daylight saving time, default: 0", ) do |dst|
+    opts.dst = dst# || 0
+  end
+
+  optp.separator ""
+  optp.separator "common options:"
+
+  optp.on("-h", "--help", "show this message") do |season|
+    puts optp
+    exit
+  end
+
+  optp.on("-v", "--version", "prayertimes version") do |season|
+    puts "prayertimes library for ruby, version: #{Prayertime::VERSION}"
+    exit
+  end
+end
+
+opts_parser.accept(Float)
+opts_parser.parse!(ARGV)
+
+# why?!!
+opts.lat = opts.lat || clat
+opts.lon = opts.lon || clon
+opts.zone = opts.zone || 2
+opts.calendar = opts.calendar || Calendar::EgyptianGeneralAuthorityOfSurvey
+opts.mazhab = opts.mazhab || Mazhab::Default
+opts.dst = opts.dst || 0
+opts.date = opts.date || Date.today
+
+year, month, day = opts.date.year, opts.date.month, opts.date.day
+ 
+pt = Prayertime.new(opts.lat, opts.lon, opts.zone, year, month, day, opts.calendar, opts.mazhab, opts.dst)
+
+puts "Location: [#{opts.lat}, #{opts.lon}]"
+puts "Date: #{opts.date.strftime("%Y/%m/%d")}"
+
+#pt.calculate()
+pt.report()
+puts "Qibla: " + pt.qibla.to_s + "° N"
+puts "Distance to kaaba: " + pt.qibla_distance.to_s + " km"

data/lib/prayertime.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # coding: utf-8
-#
+# TODO: rewrite with more explanations (also port PrayTimes.js)
 # Prayertimes implementation for ruby - just a port of pyprayertime.
 #
 # Author: Abdelrahman ghanem <abom.jdev@gmail.com>.
@@ -41,10 +41,10 @@ def remove_duplication(var)
   var % 360
 end
 
-# A class represents seasons for day light saving time -dst-.
-class Season
-  Winter, Summer = 0, 1
-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
@@ -52,7 +52,7 @@ class Calendar
   EgyptianGeneralAuthorityOfSurvey,
   UnivOfIslamicSciencesKarachi,
   IslamicSocietyOfNorthAmerica,
-  MuslimWorldLeague = (1..5).to_a
+  MuslimWorldLeague = (0...5).to_a
 end
 
 # A class represents mazhab -asr time difference only-.
@@ -61,7 +61,7 @@ class Mazhab
 end
 
 # A String formatted time: %I:%M:%S %p.
-def to_hrtime(var, isAM = false)  
+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.
@@ -123,9 +123,9 @@ class Coordinate
   attr :latitude, true
   attr :zone, true
 
-  def initialize(longitude, latitude, zone)
-    @longitude = longitude
+  def initialize(latitude, longitude, zone)
     @latitude = latitude
+    @longitude = longitude
     @zone = zone
   end
   
@@ -133,13 +133,14 @@ end
 
 # Prayertime class, containing calculations, prayer times...etc.
 class Prayertime
-  
+  VERSION = '0.1.9.1'
   # 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)
+  #   # cairo => lat,lon => 29.7768, 31.3101
+  #   # dst => one hour
+  #   pt=Prayertime.new(29.7768, 31.3101, 2, 2011, 2, 7, Calendar::EgyptianGeneralAuthorityOfSurvey, Mazhab::Default, 1)
   #   pt.report()
   #   puts pt.qibla.to_s + "° N"
   #   puts pt.qibla_distance.to_s + " km"
@@ -153,17 +154,26 @@ class Prayertime
   #   135.489731310865° N                                                                                           
   #   1262.14097579674 km  
 
-  def initialize(longitude, latitude, zone, 
+  # TODO: use attributes directly
+  # remove ostruct when parsing options
+  # attr_accessor :coordinate
+  # attr_accessor :date
+  # attr_accessor :calendar
+  # attr_accessor :mazhab
+  # attr_accessor :dst
+
+  def initialize(latitude, longitude, zone, 
                  year, month, day,
                  cal=Calendar::UmmAlQuraUniv,
                  mazhab=Mazhab::Default,
-                 season=Season::Winter)
+                 dst=nil)
     
-    @coordinate = Coordinate.new(longitude, latitude, zone)
+    @coordinate = Coordinate.new(latitude, longitude, zone)
     @date = Date.new(year, month, day)
     @calendar = cal
     @mazhab = mazhab
-    @season = season
+    #@season = season
+    @dst = dst
     @shrouk = nil
     @fajr = nil
     @zuhr = nil
@@ -210,8 +220,8 @@ class Prayertime
     year = @date.year
     month = @date.month
     day = @date.day
-    longitude = @coordinate.longitude
     latitude = @coordinate.latitude
+    longitude = @coordinate.longitude
     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
@@ -282,13 +292,15 @@ class Prayertime
     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
+    # FIXME: DST: daylight saving time not usually equals one hour in all countries/cities,
+    #also not all of them apply dst.
+    unless @dst
+      fajr += @dst
+      shrouk += @dst
+      zuhr += @dst
+      asr += @dst
+      maghrib += @dst
+      isha += @dst
     end
     
     @shrouk = shrouk
@@ -308,11 +320,11 @@ class Prayertime
   # Return qibla angle from north (in degrees).
   def qibla
   
-    k_lat = radians(21.423333);
-    k_lon = radians(39.823333);
-    
-    longitude = radians(@coordinate.longitude)
+    k_lat = radians(21.423333)
+    k_lon = radians(39.823333)
+
     latitude =  radians(@coordinate.latitude)
+    longitude = radians(@coordinate.longitude)
     
     numerator = sin(k_lon - longitude)
     denominator = (cos(latitude) * tan(k_lat)) - (sin(latitude) * cos(k_lon - longitude))
@@ -325,11 +337,11 @@ class Prayertime
   # The distance to kaaba in kilometers.
   def qibla_distance
     
-    k_lat = radians(21.423333);
-    k_lon = radians(39.823333);
-    
-    longitude = radians(@coordinate.longitude)
+    k_lat = radians(21.423333)
+    k_lon = radians(39.823333)
+
     latitude =  radians(@coordinate.latitude)
+    longitude = radians(@coordinate.longitude)
     
     r = 6378.7 #kilometers
     
@@ -347,13 +359,4 @@ class Prayertime
     puts "Ishaa Time is 	#{isha_time}"
   end
     
-end
-
-if $0 == __FILE__
-  #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"
 end

metadata

@@ -1,67 +1,48 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rbprayertime
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 5
-  version: 0.1.5
+version: !ruby/object:Gem::Version
+  version: 0.1.9.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Abdelrahman Ghanem
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-07 00:00:00 +02:00
-default_executable: 
+date: 2013-07-30 00:00:00.000000000 Z
 dependencies: []
-
 description: A ruby port of pyprayertime (prayertime algorithm implementation in python).
 email: abom.jdev@gmail.com
-executables: []
-
+executables:
+- prayertimes
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/prayertime.rb
-has_rdoc: true
+- bin/prayertimes
+- ChangeLog
 homepage: http://bitbucket.org/abom/rbprayertime
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: rbprayertime
-rubygems_version: 1.3.7
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A ruby port of pyprayertime.
 test_files: []
-