prayer_times 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc0996688ff5201c4e183a45361a1a4f5beb66d1
-  data.tar.gz: 086cf6bc3b0c3ca73152ae665c67d0a2545eb45e
+  metadata.gz: 9e89b6c2230b659b3b2fd707ba5a3c194d65033b
+  data.tar.gz: faa3a09be325715ae026b46db68843e541621e28
 SHA512:
-  metadata.gz: 6bbf9b0ab8fa8ce1e41a0b9bbef676b9165bf51c341de57882acee751c68f1675093609336086215b3da02f24ca5b7131f26f9467611ad6dfc491d7f6035f59d
-  data.tar.gz: d2815e18826c25882274f407532b2aa0e2e684b59898f37b2484d6c944466ab1bb8216410c26ee4a1c4896e7cf2738af558d1d067321af41f0e7bad2a518a38a
+  metadata.gz: 8e9e13fe01d692a5cd75b7ee19f3a88073828a2a434c3968bb3db95412dac5b043e8f972cee7090440ce93f5dd2c4e981f8050b766376ff654bb615d2e978c6d
+  data.tar.gz: c8a69236937c91491578b4f27d54e7807c106c6ac1603dfa7512a959407e09d5100a0ec9f029a4082ebe1e162494757f22580624f3173273f133bb59db7c22ce

data/README.md

@@ -1,4 +1,5 @@
-# PrayerTimes
+PrayerTimes [![Build Status](https://travis-ci.org/Startappz/prayer_times.png?branch=master)](https://travis-ci.org/Startappz/prayer_times) [![Dependency Status](https://gemnasium.com/Startappz/prayer_times.png)](https://gemnasium.com/Startappz/prayer_times) [![Coverage Status](https://coveralls.io/repos/Startappz/prayer_times/badge.png)](https://coveralls.io/r/Startappz/prayer_times)
+===
 
 Flexible and configurable calculation for Muslim prayers times.
 
@@ -22,9 +23,9 @@ Or install it yourself as:
 
 ```ruby
 require 'prayer_times'
-pt = PrayerTimes.new("Makkah")
-times = pt.get_times(Date.today(), [31,36], 3)
-puts times.inspect
+pt = PrayerTimes.new("Makkah") # there are several calculation methods, check adding more methods
+times = pt.get_times(Date.today, [31,36], 3)
+p times
 ```
 
 ### Global configuration

data/lib/prayer_times/calculation.rb

@@ -5,8 +5,13 @@ module PrayerTimes
     extend Forwardable
     include MathHelpers
 
+    SunPosition = Struct.new(:declination, :equation)
+
+    MINUTE = 60
+    DEGREES_PER_HOUR = 15.0
+
     def_delegators :@calculator, :time_suffixes, :time_format, :invalid_time, :iterations_count, :times_offsets
-    
+
     # Gets the prayers times
     # @param [PrayTime] calculator parent class
     # @param [Date] date the desired date
@@ -19,45 +24,45 @@ module PrayerTimes
       self.lng = coords[1]
       self.elv = coords.size > 2 ? coords[2] : 0
       self.time_zone = time_zone
-      date = Date.new(date[0], date[1], date[2]) unless date.is_a? Date
-      self.jdate = date.ajd.to_f - lng / (15 * 24.0)
-    end 
+      self.jdate = julian_date(date) - lng / (360.0)
+      self.times = {
+        imsak: 5, fajr: 5, sunrise: 6, dhuhr: 12, asr: 13,
+        sunset: 18, maghrib: 18, isha: 18
+      }
+    end
 
     # Compute prayer times
     # @return [Hash] times
     def compute
-      times = {
-        imsak: 5, fajr: 5, sunrise: 6, dhuhr: 12,
-        asr: 13, sunset: 18, maghrib: 18, isha: 18
-      }
       # main iterations
-      iterations_count.times{times = compute_prayer_times(times)}
-      times = adjust_times(times)
+      iterations_count.times{compute_prayer_times}
 
-      # add midnight time
-      if method_settings[:midnight] == 'Jafari'
-        times[:midnight] = times[:sunset] + time_diff(times[:sunset], times[:fajr]) / 2
-      else
-        times[:midnight] = times[:sunset] + time_diff(times[:sunset], times[:sunrise]) / 2
-      end
+      adjust_times
+
+      tune_times
+
+      modify_formats
 
-      times = tune_times(times)
-      modify_formats(times)
-      set_names(times)
-    end 
+      set_names
+    end
 
-    private 
+    private
 
-    attr_accessor :calculator, :time_zone, :lat, :lng, :elv, :jdate
+    attr_accessor :calculator, :time_zone, :lat, :lng, :elv, :jdate, :times
 
+    # get julian date of date object or array
+    def julian_date(date)
+      date_obj = date.is_a?(Date) ? date : Date.new(date[0], date[1], date[2])
+      date_obj.ajd.to_f
+    end
 
     # convert float time to the given format (see time_formats)
     def get_formatted_time(time)
       return invalid_time if time.nan?
       return time if time_format == 'Float'
-      time = fix_hour(time + 0.5 / 60)  # add 0.5 minutes to round
+      time = fix_hour(time + 0.5 / self.class::MINUTE)  # add 0.5 minutes to round
       hours = time.floor
-      minutes = ((time - hours) * 60).floor
+      minutes = ((time - hours) * self.class::MINUTE).floor
       suffix = time_format == '12h' ? time_suffixes[hours < 12 ? :am : :pm ] : ''
       formatted_time =  (time_format == "24h") ?  ("%02d:%02d" % [hours, minutes]) : "%d:%02d" % [((hours + 11) % 12)+1, minutes]
       formatted_time + suffix
@@ -65,15 +70,15 @@ module PrayerTimes
 
     # compute mid-day time
     def mid_day(time)
-      eqt = sun_position(jdate + time)[1]
-        fix_hour(12 - eqt)
+      eqt = sun_position(jdate + time).equation
+      fix_hour(12 - eqt)
     end
-      
-    # compute the time at which sun reaches a specific angle below horizon 
+
+    # compute the time at which sun reaches a specific angle below horizon
     def sun_angle_time(angle, time, direction = nil)
-      decl = sun_position(jdate + time)[0]
+      decl = sun_position(jdate + time).declination
       noon = mid_day(time)
-      t = 1/15.0 * darccos((-rsin(angle)- rsin(decl)* rsin(lat))/
+      t = 1.0 / self.class::DEGREES_PER_HOUR * darccos((-rsin(angle)- rsin(decl)* rsin(lat))/
           (rcos(decl) * rcos(lat)))
       return noon + (direction == 'ccw' ? -t : t)
     rescue
@@ -81,16 +86,16 @@ module PrayerTimes
     end
 
     # compute asr time
-    def asr_time(factor, time) 
-      decl = sun_position(jdate + time)[0]
+    def asr_time(factor, time)
+      decl = sun_position(jdate + time).declination
       angle = -darccot(factor + rtan(lat - decl).abs)
-        sun_angle_time(angle, time)
+      sun_angle_time(angle, time)
     end
 
     # compute declination angle of sun and equation of time
     # Ref: http://aa.usno.navy.mil/faq/docs/SunApprox.php
-    def sun_position(jd)
-      d = jd - 2451545.0
+    def sun_position(julian_date)
+      d = julian_date - 2451545.0
       g = fix_angle(357.529 + 0.98560028 * d)
       q = fix_angle(280.459 + 0.98564736 * d)
       l = fix_angle(q + 1.915* rsin(g) + 0.020* rsin(2*g))
@@ -98,51 +103,71 @@ module PrayerTimes
       #r = 1.00014 - 0.01671 * cos(g) - 0.00014 * cos(2*g)
       e = 23.439 - 0.00000036 * d
 
-      ra = darctan2(rcos(e)* rsin(l), rcos(l))/ 15.0
-      eqt = q / 15.0 - fix_hour(ra)
-      decl = darcsin(rsin(e)* rsin(l))
+      ra = darctan2(rcos(e)* rsin(l), rcos(l))/ self.class::DEGREES_PER_HOUR
+      equation = q / self.class::DEGREES_PER_HOUR - fix_hour(ra) # equation of time
+      declination = darcsin(rsin(e)* rsin(l)) # declination of the Sun
 
-      [decl, eqt]
+      SunPosition.new(declination,equation)
     end
 
 
     # compute prayer times at given julian date
-    def compute_prayer_times(times)
-        day_portion(times)
-        {
-          imsak:   sun_angle_time(method_settings[:imsak].to_f, times[:imsak], 'ccw'),
-          fajr:    sun_angle_time(method_settings[:fajr].to_f, times[:fajr], 'ccw'),
-          sunrise: sun_angle_time(rise_set_angle(elv), times[:sunrise], 'ccw'),
-          dhuhr:   mid_day(times[:dhuhr]),
-          asr:     asr_time(asr_factor(method_settings[:asr]), times[:asr]),
-          sunset:  sun_angle_time(rise_set_angle(elv), times[:sunset]),
-          maghrib: sun_angle_time(method_settings[:maghrib].to_f, times[:maghrib]),
-          isha:    sun_angle_time(method_settings[:isha].to_f, times[:isha]) 
-      }
+    def compute_prayer_times
+      day_portion
+
+      initial_computation
+    end
+
+    # make the primary calculations
+    def initial_computation
+      times.merge!(
+        imsak:   sun_angle_time(method_settings[:imsak].to_f, times[:imsak], 'ccw'),
+        fajr:    sun_angle_time(method_settings[:fajr].to_f, times[:fajr], 'ccw'),
+        sunrise: sun_angle_time(rise_set_angle(elv), times[:sunrise], 'ccw'),
+        dhuhr:   mid_day(times[:dhuhr]),
+        asr:     asr_time(asr_factor(method_settings[:asr]), times[:asr]),
+        sunset:  sun_angle_time(rise_set_angle(elv), times[:sunset]),
+        maghrib: sun_angle_time(method_settings[:maghrib].to_f, times[:maghrib]),
+        isha:    sun_angle_time(method_settings[:isha].to_f, times[:isha])
+      )
     end
 
     # adjust times in a prayer time array
-    def adjust_times(times)
-      tz_adjust = time_zone - lng / 15.0
-      times.keys.each{|k| times[k] += tz_adjust}
+    def adjust_times
+
+      adjust_time_zones
+
       if !method_settings[:high_lats].nil?
-        times = adjust_high_lats(times)
+        adjust_high_lats
       end
 
       if minute?(method_settings[:imsak])
-        times[:imsak] = times[:fajr] - method_settings[:imsak].to_f / 60.0
+        times[:imsak] = times[:fajr] - method_settings[:imsak].to_f / self.class::MINUTE
       end
+
       # need to ask about 'min' settings
       if minute?(method_settings[:maghrib])
-        times[:maghrib] = times[:sunset] + method_settings[:maghrib].to_f / 60.0
+        times[:maghrib] = times[:sunset] + method_settings[:maghrib].to_f / self.class::MINUTE
       end
+
       if minute?(method_settings[:isha])
-        times[:isha] = times[:maghrib] + method_settings[:isha].to_f / 60.0
+        times[:isha] = times[:maghrib] + method_settings[:isha].to_f / self.class::MINUTE
       end
 
-      times[:dhuhr] += method_settings[:dhuhr].to_f / 60.0
+      times[:dhuhr] += method_settings[:dhuhr].to_f / self.class::MINUTE
 
-      return times
+      # add midnight time
+      if method_settings[:midnight] == 'Jafari'
+        times[:midnight] = times[:sunset] + time_diff(times[:sunset], times[:fajr]) / 2
+      else
+        times[:midnight] = times[:sunset] + time_diff(times[:sunset], times[:sunrise]) / 2
+      end
+    end
+
+    # adjust time zones
+    def adjust_time_zones
+      tz_adjust = time_zone - lng / self.class::DEGREES_PER_HOUR
+      times.keys.each{|k| times[k] += tz_adjust}
     end
 
     # get asr shadow factor
@@ -157,29 +182,28 @@ module PrayerTimes
     end
 
     # apply offsets to the times
-    def tune_times(times)
-      times.each{|k,_| times[k] += (method_offsets[k] + times_offsets[k]) / 60.0}
+    def tune_times
+      times.each{|k,_| times[k] += (method_offsets[k] + times_offsets[k]).to_f / self.class::MINUTE}
     end
 
     # convert times to given time format
-    def modify_formats(times)
+    def modify_formats
       times.each{|k,_| times[k] = get_formatted_time(times[k])}
     end
-    
-    def set_names(times)
+
+    def set_names
       res = {}
       calculator.times_names.each{|k,v| res[v] = times[k]}
       res
     end
 
     # adjust times for locations in higher latitudes
-    def adjust_high_lats(times)
+    def adjust_high_lats
       night_time = time_diff(times[:sunset], times[:sunrise]) # sunset to sunrise
       times[:imsak] = adjust_hl_time(times[:imsak], times[:sunrise], method_settings[:imsak].to_f, night_time, 'ccw')
       times[:fajr]  = adjust_hl_time(times[:fajr], times[:sunrise], method_settings[:fajr].to_f, night_time, 'ccw')
       times[:isha]  = adjust_hl_time(times[:isha], times[:sunset], method_settings[:isha].to_f, night_time)
       times[:maghrib] = adjust_hl_time(times[:maghrib], times[:sunset], method_settings[:maghrib].to_f, night_time)
-        times
     end
 
     # adjust a time for higher latitudes
@@ -195,27 +219,25 @@ module PrayerTimes
     # the night portion used for adjusting times in higher latitudes
     def night_portion(angle, night)
       hl_method = method_settings[:high_lats]
-      portion = 1/2.0  # midnight
-      portion = 1/60.0 * angle if hl_method == 'AngleBased'
-      portion = 1/7.0 if hl_method == 'OneSeventh'
-        portion * night
-      end
+      portion = 1.0 / 2  # midnight
+      portion = 1.0 / self.class::MINUTE * angle if hl_method == 'AngleBased'
+      portion = 1.0 / 7 if hl_method == 'OneSeventh'
+      portion * night
+    end
 
     # convert hours to day portions
-    def day_portion(times)
+    def day_portion
       times.each{|k,v| times[k] = times[k] / 24.0}
     end
-    
+
     # compute the difference between two times
     def time_diff(time1, time2); fix_hour(time2 - time1); end
 
-
     # detect if input contains 'min'
     def minute?(arg); arg.to_s.include? "min"; end
 
     def fix_hour(hour); fix(hour, 24.0) ; end
 
-
     def fix_angle(angle); fix(angle, 360.0) ; end
 
     def fix(a, mode)
@@ -223,15 +245,15 @@ module PrayerTimes
       a = a - mode * (a / mode).floor
       a < 0 ? a + mode : a
     end
-    
+
     def method_settings
       @m_settings ||= calculator.calculation_method.settings
     end
-    
+
     def method_offsets
       @m_offsets ||= calculator.calculation_method.offsets
     end
 
   end
 
-end
+end

data/lib/prayer_times/calculation_method.rb

@@ -4,7 +4,7 @@ module PrayerTimes
   class CalculationMethod
     attr_reader :name, :description, :settings, :offsets
     attr_writer :description
-    
+
     # Default settings
     def self.default_settings
       {
@@ -16,28 +16,28 @@ module PrayerTimes
         high_lats:  'NightMiddle'
       }
     end
-    
+
     # Initializer
     # @param [String] name
-    # @param [String] description  
-    # @param [Hash] settings 
+    # @param [String] description
+    # @param [Hash] settings
     # @option settings [String] :imsak
     # @option settings [String] :fajr
     # @option settings [String] :sunrise
     # @option settings [String] :dhuhr
     # @option settings [String] :asr Asr Juristic Methods:
-    #   'Standard':  Shafi`i, Maliki, Ja`fari and Hanbali, 
+    #   'Standard':  Shafi`i, Maliki, Ja`fari and Hanbali,
     #   'Hanafi':    Hanafi
     # @option settings [String] :sunset
     # @option settings [String] :maghrib
     # @option settings [String] :isha
     # @option settings [String] :midnight Midnight Mode:
-    #   'Standard':     Mid Sunset to Sunrise, 
-    #   'Jafari':       Mid Sunset to Fajr   
+    #   'Standard':     Mid Sunset to Sunrise,
+    #   'Jafari':       Mid Sunset to Fajr
     # @option settings [String] :high_lights Adjust Methods for Higher Latitudes:
-    #   'NightMiddle': middle of night, 
-    #   'AngleBased':  angle/60th of night, 
-    #   'OneSeventh':   1/7th of night, 
+    #   'NightMiddle': middle of night,
+    #   'AngleBased':  angle/60th of night,
+    #   'OneSeventh':   1/7th of night,
     #   'None'
     # @param [Hash] offsets
     # @option offsets [String] :imsak
@@ -55,32 +55,33 @@ module PrayerTimes
       self.settings = settings
       self.offsets = offsets
     end
-  
+
     # Sets times settings
     # @param [Hash] settings
-    # Check the initializer         
+    # Check the initializer
     def settings=(settings)
       s = settings.reject{|k,v| !(Constants.times_names.key?(k))} rescue {}
-      @settings = self.class.default_settings.merge(s) 
+      @settings = self.class.default_settings.merge(s)
     end
-    
+
     # Sets times offsets
     # @param [Hash] offsets
-    # Check the initializer         
+    # Check the initializer
     def offsets=(offsets)
       s = offsets.reject{|k,v| !(Constants.times_offsets.key?(k) and v.is_a?(Numeric))} rescue {}
-      @offsets = Constants.times_offsets.merge(s) 
+      s[:sunset] = s[:maghrib] if s[:maghrib]
+      @offsets = Constants.times_offsets.merge(s)
     end
-    
-      
+
+
     # @return readable representation of this object
     def to_s
       name
     end
-    
+
     private
-    
+
     attr_writer :name
-    
+
   end
-end
+end

data/lib/prayer_times/calculation_methods.rb

@@ -4,7 +4,7 @@ module PrayerTimes
   class CalculationMethods
     extend Forwardable
     def_delegators :@hash, :[], :length, :each, :key?, :keys, :delete, :to_s
-    
+
     # default methods defined in this gem
     # Methods MWL, ISNA, Egypt, Makkah, Karachi, Tehran and Jafari are accurate
     # Other methods need validation. Your help is appreciated.
@@ -14,7 +14,7 @@ module PrayerTimes
           desc: 'Muslim World League',
           settings: {fajr: 18, isha: 17}
         },
-        'ISNA' => { 
+        'ISNA' => {
           desc: 'Islamic Society of North America (ISNA)',
           settings: {fajr: 15, isha: 15}
         },
@@ -23,24 +23,24 @@ module PrayerTimes
           settings: {fajr: 19.5, isha: 17.5}
         },
         'Makkah' => {
-            desc: 'Umm Al-Qura University, Makkah',
-            settings: {fajr: 18.5, isha: '90 min'}  # fajr was 19 degrees before 1430 hijri
+          desc: 'Umm Al-Qura University, Makkah',
+          settings: {fajr: 18.5, isha: '90 min'}  # fajr was 19 degrees before 1430 hijri
         },
         'Karachi' => {
           desc: 'University of Islamic Sciences, Karachi',
-          settings: {fajr: 18, isha: 18}
+          settings: {fajr: 18, asr: 'Hanafi', isha: 18}
         },
         'Tehran' => {
           desc: 'Institute of Geophysics, University of Tehran',
           settings: {fajr: 17.7, maghrib: 4.5, isha: 14, midnight: 'Jafari'}  # isha is not explicitly specified in this method
         },
-       'Jafari' => {
+        'Jafari' => {
           desc: 'Shia Ithna-Ashari, Leva Institute, Qum',
           settings: {fajr: 16, maghrib: 4, isha: 14, midnight: 'Jafari'}
         },
-       'UOIF' =>{
+        'UOIF' =>{
           desc: "UNION DES ORGANISATIONS ISLAMIQUES DE FRANCE",
-          settings: {fajr: 19, maghrib: '0 min', isha: 17} 
+          settings: {fajr: 19, maghrib: '0 min', isha: 17}
         },
         'Algeria' =>{
           desc: "Algeria",
@@ -63,11 +63,11 @@ module PrayerTimes
         },
         'Jordan' =>{
           desc: "General Iftaa' Department, The Hashemite Kingdom of Jordan",
-          settings: {fajr: 18, maghrib: '0 min', isha: 18} 
+          settings: {fajr: 18, maghrib: '0 min', isha: 18}
         },
         'Kuwait' =>{
           desc: "Kuwait",
-          settings: {fajr: 18, maghrib: '0 min', isha: 17.5} 
+          settings: {fajr: 18, maghrib: '0 min', isha: 17.5}
         },
         'Libya' =>{
           desc: "Libya",
@@ -110,14 +110,14 @@ module PrayerTimes
         }
       }
     end
-    
+
     # Initializer
     # it populates a hash with predefined set of methods
     def initialize
       self.hash = {}
       populate
     end
-    
+
     # @param [String] name
     # @param [String] description
     # @param [Hash] settings
@@ -126,20 +126,20 @@ module PrayerTimes
     def add(name, description, settings={}, offsets={})
       hash[name] = CalculationMethod.new(name, description, settings, offsets)
     end
-   
+
     # Names of the available methods
     # @return [Array] list of names
     def names
       keys
     end
-    
+
     private
-    
+
     attr_accessor :hash
-    
+
     def populate
       self.class.default_methods.each {|k,v| add(k, v[:desc], v[:settings], v[:offsets])}
-    end 
-    
+    end
+
   end
-end
+end

data/lib/prayer_times/calculator.rb

@@ -3,9 +3,9 @@ module PrayerTimes
   # This is main interface class
   class Calculator
     include Setters
-    
+
     attr_reader :calculation_method, :time_format, :times_names, :time_suffixes, :invalid_time, :iterations_count, :times_offsets
-    
+
     # Initializer
     # @param [String] calc_method the calculation method to use
     # @param [Hash] opts formatting options
@@ -32,7 +32,7 @@ module PrayerTimes
       self.iterations_count = opts[:iterations_count]
     end
 
-   
+
 
     # Gets the prayers times
     # @param [Date] date the date
@@ -42,17 +42,17 @@ module PrayerTimes
     # @return [Hash] times
     def get_times(date, coords, time_zone, dst = nil)
       Calculation.new(self,
-      date,
-      coords,
+                      date,
+                      coords,
       time_zone + (dst.nil? ? 0 : 1)).
-      compute
+        compute
     end
-    
+
     private
-    
+
     def const_class
       PrayerTimes
     end
 
   end
-end
+end

data/lib/prayer_times/constants.rb

@@ -1,28 +1,28 @@
 # encoding: UTF-8
 module PrayerTimes
   # General constants. Don't try to change their values.
-  # You have flexible general and instance configurations.  
+  # You have flexible general and instance configurations.
   module Constants
     # Used internally in the algorithm. Don't change unless you know
     # What you are doing
     # 0 < iterations_count < 6
     @iterations_count = 1
-    
-    # Determines the accepted values for iterations count 
+
+    # Determines the accepted values for iterations count
     @accepted_iterations_count_range = 1..5
 
     # Times names to be displayed
     @times_names = {
-        imsak:    'Imsak',
-        fajr:     'Fajr',
-        sunrise:  'Sunrise',
-        dhuhr:    'Dhuhr',
-        asr:      'Asr',
-        sunset:   'Sunset',
-        maghrib:  'Maghrib',
-        isha:     'Isha',
-        midnight: 'Midnight'
-      }
+      imsak:    'Imsak',
+      fajr:     'Fajr',
+      sunrise:  'Sunrise',
+      dhuhr:    'Dhuhr',
+      asr:      'Asr',
+      sunset:   'Sunset',
+      maghrib:  'Maghrib',
+      isha:     'Isha',
+      midnight: 'Midnight'
+    }
 
     #  The option time_format takes the following values:
     #  '24h':    24-hour format,
@@ -30,8 +30,8 @@ module PrayerTimes
     #  '12hNS':  12-hour format with no suffix,
     #  'Float':  floating point number
     @time_format =    '24h'
-    
-    # Determines the accepted time format values 
+
+    # Determines the accepted time format values
     @accepted_time_formats = ['12h','24h','12hNS','Float']
 
     # Times suffixes names to be displayed
@@ -42,11 +42,11 @@ module PrayerTimes
 
     # Time offsets
     @times_offsets = @times_names.keys.inject({}){ |h,k| h.merge!(k => 0)}
-    
+
     class << self
-       attr_reader :iterations_count, :times_names,
-      :time_format, :time_suffixes,:times_offsets,:invalid_time, 
-      :accepted_iterations_count_range, :accepted_time_formats
+      attr_reader :iterations_count, :times_names,
+        :time_format, :time_suffixes,:times_offsets,:invalid_time,
+        :accepted_iterations_count_range, :accepted_time_formats
     end
   end
-end
+end

data/lib/prayer_times/math_helpers.rb

@@ -53,4 +53,4 @@ module PrayerTimes
     # @return [Float]
     def darctan2(y, x); degrees Math.atan2(y, x) ; end
   end
-end
+end

data/lib/prayer_times/setters.rb

@@ -1,19 +1,19 @@
 # encoding: UTF-8
 module PrayerTimes
-  # General setters 
+  # General setters
   module Setters
-   
+
     # Sets iterations c
     # @param [Integer] num
     #   0 < num < 6
     def iterations_count=(num)
       @iterations_count = if (Constants.accepted_iterations_count_range).include?(num)
         num
-       else
-         const_class.iterations_count
-       end
+      else
+        const_class.iterations_count
+      end
     end
-    
+
     # Sets time format
     # @param [String] format
     #   '24h':    24-hour format,
@@ -23,7 +23,7 @@ module PrayerTimes
     def time_format=(format)
       @time_format = if Constants.accepted_time_formats.include?(format)
         format
-      else 
+      else
         const_class.time_format
       end
     end
@@ -52,7 +52,7 @@ module PrayerTimes
     # @param [Hash] offsets
     def times_offsets=(offsets)
       s = offsets.reject{|k,v| !(const_class.times_offsets.key?(k) and v.is_a?(Numeric))} rescue {}
-      @times_offsets = const_class.times_offsets.merge(s) 
+      @times_offsets = const_class.times_offsets.merge(s)
     end
 
     # Sets calculation method and the corresponding settings
@@ -63,10 +63,11 @@ module PrayerTimes
       else
         PrayerTimes.calculation_method
       end
-    end 
-    
+    end
+
     def const_class #:nodoc:
-      raise "Please override this method"
+      raise NotImplementedError,
+        "You must implement #const_class to define which class to get the default attributes from"
     end
   end
-end
+end

data/lib/prayer_times/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 module PrayerTimes
   # Determines the version of this gem
-  VERSION = "0.1.1"
-end
+  VERSION = "0.1.2"
+end

data/lib/prayer_times.rb

@@ -15,8 +15,8 @@ module PrayerTimes #:nodoc:
     include Setters
 
     attr_reader :iterations_count, :times_names, :calculation_methods,
-     :calculation_method,:time_format, :time_suffixes,:times_offsets,
-     :invalid_time
+      :calculation_method,:time_format, :time_suffixes,:times_offsets,
+      :invalid_time
     # @see Calculator initializer
     def new(calc_method=@calucation_method,opts={})
       PrayerTimes::Calculator.new(calc_method, opts)
@@ -28,7 +28,7 @@ module PrayerTimes #:nodoc:
 
     def set_attributes
       attrs =  [:iterations_count, :times_names, :time_format,
-        :time_suffixes,:times_offsets, :invalid_time]
+                :time_suffixes,:times_offsets, :invalid_time]
       attrs.each {|attr| self.send "#{attr}=", nil}
 
       @calculation_methods = CalculationMethods.new

data/prayer_times.gemspec

@@ -21,5 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "coveralls"
 
 end

data/test/lib/prayer_times/calculation_method_test.rb

@@ -2,10 +2,10 @@
 require_relative '../../test_helper'
 
 describe PrayerTimes::CalculationMethod do
-  
+
   let(:method_name){"Medina"}
   let(:description){"Medina testing methods"}
-  
+
   describe "Object" do
     subject{PrayerTimes::CalculationMethod.new(method_name, description,{})}
     it {subject.must_respond_to :description}
@@ -15,44 +15,44 @@ describe PrayerTimes::CalculationMethod do
     it {subject.must_respond_to :offsets}
     it {subject.must_respond_to :offsets=}
   end
-  
+
   describe "#initialize" do
     context "when method_name and description are provided" do
       subject{PrayerTimes::CalculationMethod.new(method_name, description)}
       it {subject.name.must_equal(method_name)}
       it {subject.description.must_equal(description)}
     end
-    
+
     context "when settings are not provided" do
       subject{PrayerTimes::CalculationMethod.new(method_name, description, {})}
       it {subject.settings.must_equal(PrayerTimes::CalculationMethod.default_settings)}
     end
-       
+
     context "when settings are provided" do
       let(:opts){{
-         fajr:       18,
-         asr:        'Hanafi',
-         isha:       18
+                   fajr:       18,
+                   asr:        'Hanafi',
+                   isha:       18
       }}
       subject{PrayerTimes::CalculationMethod.new(method_name, description,opts)}
       it {subject.settings.must_equal(PrayerTimes::CalculationMethod.default_settings.merge opts)}
-    end   
-    
+    end
+
     context "when offsets are not provided" do
       subject{PrayerTimes::CalculationMethod.new(method_name, description, {}, {})}
       it {subject.offsets.must_equal(PrayerTimes::Constants.times_offsets)}
     end
-       
+
     context "when offsets are provided" do
       let(:opts){{
-         fajr:       3,
-         asr:        -1,
-         isha:       6
+                   fajr:       3,
+                   asr:        -1,
+                   isha:       6
       }}
       subject{PrayerTimes::CalculationMethod.new(method_name, description,{},opts)}
       it {subject.offsets.must_equal(PrayerTimes::Constants.times_offsets.merge opts)}
-    end     
-       
+    end
+
   end
 
 end

data/test/lib/prayer_times/calculation_methods_test.rb

@@ -12,9 +12,9 @@ describe PrayerTimes::CalculationMethods do
     it {subject.must_respond_to :key?}
     it {subject.must_respond_to :delete}
   end
-  
 
-  
+
+
   describe  "#add" do
     before do
       @subject = PrayerTimes::CalculationMethods.new
@@ -32,7 +32,7 @@ describe PrayerTimes::CalculationMethods do
     it {@subject["Test"].offsets[:asr].must_equal -1}
     it {@subject["Test"].offsets[:isha].must_equal 3}
   end
-  
+
   describe "#names" do
     subject{PrayerTimes::CalculationMethods.new}
     it{subject.names.must_equal subject.keys}

data/test/lib/prayer_times/calculation_test.rb

@@ -7,118 +7,153 @@ describe PrayerTimes::Calculation do
   describe '#compute' do
     context 'when method is MWL' do
       context 'when date is 2011/2/9, location is Waterloo/Canada and timezone -5' do
-         let(:pt){PrayerTimes.new}
-         subject{pt.get_times([2011,2,9], [43, -80], -5)}
-         let(:expected){{
-           'Imsak' =>  '05:40',
-           'Fajr' => '05:50',
-           'Sunrise' => '07:26',
-           'Dhuhr' => '12:34',
-           'Asr' => '15:18' ,
-           'Sunset' => '17:43' ,
-           'Maghrib' => '17:43' ,
-           'Isha' => '19:14' ,
-           'Midnight' => '00:35' }}
-         it{subject.must_equal expected}
+        let(:pt){PrayerTimes.new}
+        subject{pt.get_times([2011,2,9], [43, -80], -5)}
+        let(:expected){{
+                         'Imsak' =>  '05:40',
+                         'Fajr' => '05:50',
+                         'Sunrise' => '07:26',
+                         'Dhuhr' => '12:34',
+                         'Asr' => '15:18' ,
+                         'Sunset' => '17:43' ,
+                         'Maghrib' => '17:43' ,
+                         'Isha' => '19:14' ,
+        'Midnight' => '00:35' }}
+        it{subject.must_equal expected}
       end
     end
-    
+
     context 'when method is Makkah' do
       let(:method_name){'Makkah'}
-      
-       context 'time format is 24h and other settings are default' do 
+
+      context 'time format is 24h and other settings are default' do
         context 'when date is 2013/12/16, location is Amman/Jordan and timezone 3' do
-           let(:pt){PrayerTimes.new method_name}
-           subject{pt.get_times([2013,12,16], [31,36], 3)}
-           let(:expected){{
-             'Imsak' =>  '05:48',
-             'Fajr' => '05:58',
-             'Sunrise' => '07:27',
-             'Dhuhr' => '12:32',
-             'Asr' => '15:18' ,
-             'Sunset' => '17:36' ,
-             'Maghrib' => '17:36' ,
-             'Isha' => '19:06' ,
-             'Midnight' => '00:32' }}
-           it{subject.must_equal expected}
+          let(:pt){PrayerTimes.new method_name}
+          subject{pt.get_times([2013,12,16], [31,36], 3)}
+          let(:expected){{
+                           'Imsak' =>  '05:48',
+                           'Fajr' => '05:58',
+                           'Sunrise' => '07:27',
+                           'Dhuhr' => '12:32',
+                           'Asr' => '15:18' ,
+                           'Sunset' => '17:36' ,
+                           'Maghrib' => '17:36' ,
+                           'Isha' => '19:06' ,
+          'Midnight' => '00:32' }}
+          it{subject.must_equal expected}
         end
       end
-      
-      context 'time format is 24h, offsets are custom and other settings are default' do 
+
+      context 'time format is 24h, offsets are custom and other settings are default' do
         context 'when date is 2013/12/16, location is Amman/Jordan and timezone 3' do
-           let(:pt){PrayerTimes.new method_name, times_offsets: {fajr: 4, dhuhr: 2, midnight: 1}}
-           subject{pt.get_times([2013,12,16], [31,36], 3)}
-           let(:expected){{
-             'Imsak' =>  '05:48',
-             'Fajr' => '06:02',
-             'Sunrise' => '07:27',
-             'Dhuhr' => '12:34',
-             'Asr' => '15:18' ,
-             'Sunset' => '17:36' ,
-             'Maghrib' => '17:36' ,
-             'Isha' => '19:06' ,
-             'Midnight' => '00:33' }}
-           it{subject.must_equal expected}
+          let(:pt){PrayerTimes.new method_name, times_offsets: {fajr: 4, dhuhr: 2, midnight: 1}}
+          subject{pt.get_times([2013,12,16], [31,36], 3)}
+          let(:expected){{
+                           'Imsak' =>  '05:48',
+                           'Fajr' => '06:02',
+                           'Sunrise' => '07:27',
+                           'Dhuhr' => '12:34',
+                           'Asr' => '15:18' ,
+                           'Sunset' => '17:36' ,
+                           'Maghrib' => '17:36' ,
+                           'Isha' => '19:06' ,
+          'Midnight' => '00:33' }}
+          it{subject.must_equal expected}
         end
       end
-      
-    
-      
-      context 'time format is 24h, times names are custom and settings are default' do 
+
+
+
+      context 'time format is 24h, times names are custom and settings are default' do
         context 'when date is 2013/12/16, location is Amman/Jordan and timezone 3' do
-           let(:pt){PrayerTimes.new method_name, times_names: {asr: "Aser", isha: "Ishaa"}}
-           subject{pt.get_times([2013,12,16], [31,36], 3)}
-           let(:expected){{
-             'Imsak' =>  '05:48',
-             'Fajr' => '05:58',
-             'Sunrise' => '07:27',
-             'Dhuhr' => '12:32',
-             'Aser' => '15:18' ,
-             'Sunset' => '17:36' ,
-             'Maghrib' => '17:36' ,
-             'Ishaa' => '19:06' ,
-             'Midnight' => '00:32' }}
-           it{subject.must_equal expected}
+          let(:pt){PrayerTimes.new method_name, times_names: {asr: "Aser", isha: "Ishaa"}}
+          subject{pt.get_times([2013,12,16], [31,36], 3)}
+          let(:expected){{
+                           'Imsak' =>  '05:48',
+                           'Fajr' => '05:58',
+                           'Sunrise' => '07:27',
+                           'Dhuhr' => '12:32',
+                           'Aser' => '15:18' ,
+                           'Sunset' => '17:36' ,
+                           'Maghrib' => '17:36' ,
+                           'Ishaa' => '19:06' ,
+          'Midnight' => '00:32' }}
+          it{subject.must_equal expected}
         end
       end
-      
-      context 'time format is 12h, suffixes are custom and other settings are default' do 
+
+      context 'time format is 12h, suffixes are custom and other settings are default' do
         context 'when date is 2013/12/16, location is Amman/Jordan and timezone 3' do
-           let(:pt){PrayerTimes.new method_name, time_format: '12h', time_suffixes: {:am => ' صباحا', :pm => ' مساءا'}}
-           subject{pt.get_times([2013,12,16], [31,36], 3)}
-           let(:expected){{
-             'Imsak' => '5:48 صباحا',
-             'Fajr' => '5:58 صباحا',
-             'Sunrise' => '7:27 صباحا',
-             'Dhuhr' => '12:32 مساءا',
-             'Asr' => '3:18 مساءا' ,
-             'Sunset' => '5:36 مساءا' ,
-             'Maghrib' => '5:36 مساءا' ,
-             'Isha' => '7:06 مساءا' ,
-             'Midnight' => '12:32 صباحا' }}
-           it{subject.must_equal expected}
+          let(:pt){PrayerTimes.new method_name, time_format: '12h', time_suffixes: {:am => ' صباحا', :pm => ' مساءا'}}
+          subject{pt.get_times([2013,12,16], [31,36], 3)}
+          let(:expected){{
+                           'Imsak' => '5:48 صباحا',
+                           'Fajr' => '5:58 صباحا',
+                           'Sunrise' => '7:27 صباحا',
+                           'Dhuhr' => '12:32 مساءا',
+                           'Asr' => '3:18 مساءا' ,
+                           'Sunset' => '5:36 مساءا' ,
+                           'Maghrib' => '5:36 مساءا' ,
+                           'Isha' => '7:06 مساءا' ,
+          'Midnight' => '12:32 صباحا' }}
+          it{subject.must_equal expected}
         end
       end
     end
-   
-  context 'when method is Turkey' do
+
+    context 'when method is Turkey' do
       context 'when date is 2013/12/17, location is Fatih/Istanbul/Turkey and timezone +2' do
-         let(:pt){PrayerTimes.new "Turkey", time_format: '12h'}
-         subject{pt.get_times([2013,12,17], [41.02,28.94], 2)}
-         let(:expected){{
-           'Imsak' =>  '5:34AM',
-           'Fajr' => '5:42AM',
-           'Sunrise' => '7:16AM',
-           'Dhuhr' => '12:06PM',
-           'Asr' => '2:24PM' ,
-           'Sunset' => '4:37PM' ,
-           'Maghrib' => '4:46PM' ,
-           'Isha' => '6:13PM' ,
-           'Midnight' => '12:00AM' }}
-         it{subject.must_equal expected}
+        let(:pt){PrayerTimes.new "Turkey", time_format: '12h'}
+        subject{pt.get_times([2013,12,17], [41.02,28.94], 2)}
+        let(:expected){{
+                         'Imsak' =>  '5:34AM',
+                         'Fajr' => '5:42AM',
+                         'Sunrise' => '7:16AM',
+                         'Dhuhr' => '12:06PM',
+                         'Asr' => '2:24PM' ,
+                         'Sunset' => '4:37PM' ,
+                         'Maghrib' => '4:46PM' ,
+                         'Isha' => '6:13PM' ,
+        'Midnight' => '12:00AM' }}
+        it{subject.must_equal expected}
       end
     end
-    
-    
+
+    context 'when method is Karachi' do
+      context 'when date is 2013/12/17, location is Islamabad, timezone +5 and format is 12h' do
+        let(:pt){PrayerTimes.new "Karachi", time_format: '12h'}
+        subject{pt.get_times([2014,1,23], [33.73,73.06], 5)}
+        let(:expected){{
+                         'Imsak' =>  '5:33AM',
+                         'Fajr' => '5:43AM',
+                         'Sunrise' => '7:10AM',
+                         'Dhuhr' => '12:20PM',
+                         'Asr' => '3:52PM' ,
+                         'Sunset' => '5:30PM' ,
+                         'Maghrib' => '5:30PM' ,
+                         'Isha' => '6:56PM' ,
+        'Midnight' => '12:20AM' }}
+        it{subject.must_equal expected}
+      end
+    end
+
+    context 'when method is Kula Malaysia' do
+      context 'when date is 2013/12/17, location is Kula Lumpur, timezone +8 and format is 12h' do
+        let(:pt){PrayerTimes.new "Malaysia", time_format: '12h'}
+        subject{pt.get_times([2014,1,23], [3.15,101.69], 8)}
+        let(:expected){{
+                         'Imsak' =>  '5:54AM',
+                         'Fajr' => '6:07AM',
+                         'Sunrise' => '7:28AM',
+                         'Dhuhr' => '1:26PM',
+                         'Asr' => '4:50PM' ,
+                         'Sunset' => '7:25PM' ,
+                         'Maghrib' => '7:25PM' ,
+                         'Isha' => '8:36PM' ,
+        'Midnight' => '1:25AM' }}
+        it{subject.must_equal expected}
+      end
+    end
+
   end
 end

data/test/lib/prayer_times/calculator_test.rb

@@ -3,15 +3,15 @@ require_relative '../../test_helper'
 
 describe PrayerTimes::Calculator do
 
-      subject{PrayerTimes::Calculator.new "MWL",{}}
-      it{subject.must_respond_to :calculation_method}
-      it{subject.must_respond_to :time_format}
-      it{subject.must_respond_to :times_names}
-      it{subject.must_respond_to :time_suffixes}
-      it{subject.must_respond_to :invalid_time}
-      it{subject.must_respond_to :iterations_count}
-      it{subject.must_respond_to :times_offsets}
-      it{subject.must_respond_to :get_times}
-      it{subject.must_be_kind_of PrayerTimes::Setters}
-      
+  subject{PrayerTimes::Calculator.new "MWL",{}}
+  it{subject.must_respond_to :calculation_method}
+  it{subject.must_respond_to :time_format}
+  it{subject.must_respond_to :times_names}
+  it{subject.must_respond_to :time_suffixes}
+  it{subject.must_respond_to :invalid_time}
+  it{subject.must_respond_to :iterations_count}
+  it{subject.must_respond_to :times_offsets}
+  it{subject.must_respond_to :get_times}
+  it{subject.must_be_kind_of PrayerTimes::Setters}
+
 end

data/test/lib/prayer_times/math_helpers_test.rb

@@ -16,31 +16,31 @@ describe PrayerTimes::MathHelpers do
   describe "#rsin" do
     it {subject.must_respond_to(:rsin)}
   end
-  
+
   describe "#rcos" do
     it {subject.must_respond_to(:rcos)}
   end
-  
+
   describe "#rtan" do
     it {subject.must_respond_to(:rtan)}
   end
-  
+
   describe "#darcsin" do
     it {subject.must_respond_to(:darcsin)}
   end
-  
+
   describe "#darccos" do
     it {subject.must_respond_to(:darccos)}
   end
-  
+
   describe "#darctan" do
     it {subject.must_respond_to(:darctan)}
   end
-  
+
   describe "#darccot" do
     it {subject.must_respond_to(:darccot)}
   end
-  
+
   describe "#darctan2" do
     it {subject.must_respond_to(:darctan2)}
   end

data/test/lib/prayer_times/prayer_times_test.rb

@@ -15,10 +15,10 @@ describe PrayerTimes do
     it{subject.must_respond_to :times_offsets}
     it{subject.must_be_kind_of PrayerTimes::Setters}
   end
-  
+
   describe ".new" do
     subject{PrayerTimes.new}
     it{subject.must_be_kind_of PrayerTimes::Calculator}
   end
 
-end
+end

data/test/lib/prayer_times/setters_test.rb

@@ -2,7 +2,7 @@
 require_relative '../../test_helper'
 
 describe PrayerTimes::Setters do
-  
+
   subject{PrayerTimes::Calculator.new "MWL",{}}
   describe "#iteration_count=" do
     context "when number not number or out of range" do
@@ -33,7 +33,7 @@ describe PrayerTimes::Setters do
       it{result.must_equal time_format}
     end
   end
-  
+
   describe "#invalid_time=" do
     context "when nil" do
       let(:invalid_time){nil}
@@ -47,7 +47,7 @@ describe PrayerTimes::Setters do
       it{result.must_equal invalid_time}
     end
   end
-  
+
   describe "#time_suffixes=" do
     context "when wrong value" do
       let(:time_suffixes){{:amz => "صباحا", :pm => "مساءا"}}
@@ -61,7 +61,7 @@ describe PrayerTimes::Setters do
       it{result.must_equal PrayerTimes.time_suffixes.merge(time_suffixes)}
     end
   end
-  
+
   describe "#times_names=" do
     context "when wrong value" do
       let(:times_names){{:aser => "Aser", :koko => "Dano", :isha => "Ishaa"}}
@@ -75,7 +75,7 @@ describe PrayerTimes::Setters do
       it{result.must_equal PrayerTimes.times_names.merge(times_names)}
     end
   end
-  
+
   describe "#times_offsets=" do
     context "when wrong value" do
       let(:times_offsets){{:aser => 10, :dhuhr => "Dano", :isha => 3.6}}
@@ -89,7 +89,7 @@ describe PrayerTimes::Setters do
       it{result.must_equal PrayerTimes.times_offsets.merge(times_offsets)}
     end
   end
-  
+
   describe "#calculation_method=" do
     context "when wrong value" do
       let(:calculation_method){'K@mp'}
@@ -103,4 +103,4 @@ describe PrayerTimes::Setters do
       it{result.must_equal PrayerTimes.calculation_methods['Makkah']}
     end
   end
-end
+end

data/test/lib/prayer_times/version_test.rb

@@ -7,4 +7,4 @@ describe PrayerTimes do
     PrayerTimes::VERSION.wont_be_nil
   end
 
-end
+end

data/test/test_helper.rb

@@ -1,9 +1,11 @@
 # encoding: UTF-8
 require 'minitest/autorun'
 require 'minitest/pride'
+require 'coveralls'
+Coveralls.wear!
 require File.expand_path('../../lib/prayer_times.rb', __FILE__)
 class MiniTest::Spec
   class << self
     alias :context :describe
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prayer_times
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Khaled alHabache
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-19 00:00:00.000000000 Z
+date: 2014-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Calculates Muslim prayers times in given settings
 email:
 - khellls@gmail.com