prayer_times 0.1.0

data/lib/prayer_times/constants.rb

@@ -0,0 +1,51 @@
+module PrayerTimes
+  # General constants. Don't try to change their values.
+  # 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 
+    @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'
+      }
+
+    #  The option time_format takes the following values:
+    #  '24h':    24-hour format,
+    #  '12h':    12-hour format,
+    #  '12hNS':  12-hour format with no suffix,
+    #  'Float':  floating point number
+    @time_format =    '24h'
+    
+    # Determines the accepted time format values 
+    @accepted_time_formats = ['12h','24h','12hNS','Float']
+
+    # Times suffixes names to be displayed
+    @time_suffixes=  {:am => 'AM', :pm => 'PM'}
+
+    # What to display when the time is invalid
+    @invalid_time=   '-----'
+
+    # 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
+    end
+  end
+end

data/lib/prayer_times/math_helpers.rb

@@ -0,0 +1,55 @@
+module PrayerTimes
+  # Math helpers module
+  module MathHelpers
+    # Calculates radians from degrees
+    # @param [Float] x
+    # @return [Float]
+    def radians(x) ; x * Math::PI/180 ; end
+
+    # Calculates degrees from radians
+    # @param [Float] x
+    # @return [Float]
+    def degrees(x) ; x * 180/Math::PI ; end
+
+    # Calculates sin in radians
+    # @param [Float] x
+    # @return [Float]
+    def rsin(x); Math.sin(radians x) ; end
+
+    # Calculates cos in radians
+    # @param [Float] x
+    # @return [Float]
+    def rcos(x); Math.cos(radians x) ; end
+
+    # Calculates tan in radians
+    # @param [Float] x
+    # @return [Float]
+    def rtan(x); Math.tan(radians x) ; end
+
+    # Calculates arcsin in degrees
+    # @param [Float] x
+    # @return [Float]
+    def darcsin(x); degrees Math.asin(x) ; end
+
+    # Calculates arccos in degrees
+    # @param [Float] x
+    # @return [Float]
+    def darccos(x); degrees Math.acos(x) ; end
+
+    # Calculates arctan in degrees
+    # @param [Float] x
+    # @return [Float]
+    def darctan(x); degrees Math.atan(x) ; end
+
+    # Calculates arccot in degrees
+    # @param [Float] x
+    # @return [Float]
+    def darccot(x); degrees Math.atan(1.0/x) ; end
+
+    # Calculates arctan2 in degrees
+    # @param [Float] x
+    # @param [Float] y
+    # @return [Float]
+    def darctan2(y, x); degrees Math.atan2(y, x) ; end
+  end
+end

data/lib/prayer_times/setters.rb

@@ -0,0 +1,71 @@
+module PrayerTimes
+  # 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
+    end
+    
+    # Sets time format
+    # @param [String] format
+    #   '24h':    24-hour format,
+    #   '12h':    12-hour format,
+    #   '12hNS':  12-hour format with no suffix,
+    #   'Float':  floating point number
+    def time_format=(format)
+      @time_format = if Constants.accepted_time_formats.include?(format)
+        format
+      else 
+        const_class.time_format
+      end
+    end
+
+    # Sets the invalid time replacement string
+    # @param [String] str
+    def invalid_time=(str)
+      @invalid_time = str || const_class.invalid_time
+    end
+
+    # Sets times suffixes
+    # @param [Hash] suffixes
+    def time_suffixes=(suffixes)
+      s = suffixes.reject{|k,v| !(const_class.time_suffixes.key?(k) and v.is_a?(String))} rescue {}
+      @time_suffixes = const_class.time_suffixes.merge(s)
+    end
+
+    # Sets times names
+    # @param [Hash] names
+    def times_names=(names)
+      s = names.reject{|k,v| !(const_class.times_names.key?(k) and v.is_a?(String))} rescue {}
+      @times_names = const_class.times_names.merge(s)
+    end
+
+    # Sets times offsets
+    # @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) 
+    end
+
+    # Sets calculation method and the corresponding settings
+    # @param [String] calc_method the method name
+    def calculation_method=(calc_method)
+      @calculation_method = if PrayerTimes.calculation_methods.key?(calc_method)
+        const_class.calculation_methods[calc_method]
+      else
+        PrayerTimes.calculation_method
+      end
+    end 
+    
+    def const_class #:nodoc:
+      raise "Please override this method"
+    end
+  end
+end

data/lib/prayer_times/version.rb

@@ -0,0 +1,4 @@
+module PrayerTimes
+  # Determines the version of this gem
+  VERSION = "0.1.0"
+end

data/lib/prayer_times.rb

@@ -0,0 +1,41 @@
+require 'date'
+require 'forwardable'
+require_relative "prayer_times/version"
+require_relative "prayer_times/constants"
+require_relative "prayer_times/math_helpers"
+require_relative "prayer_times/calculation_method"
+require_relative "prayer_times/calculation_methods"
+require_relative "prayer_times/setters"
+require_relative "prayer_times/calculator"
+require_relative "prayer_times/calculation"
+
+module PrayerTimes #:nodoc:
+  class << self
+    include Setters
+
+    attr_reader :iterations_count, :times_names, :calculation_methods,
+     :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)
+    end
+
+    def const_class
+      Constants
+    end
+
+    def set_attributes
+      attrs =  [:iterations_count, :times_names, :time_format,
+        :time_suffixes,:times_offsets, :invalid_time]
+      attrs.each {|attr| self.send "#{attr}=", nil}
+
+      @calculation_methods = CalculationMethods.new
+
+      @calculation_method = @calculation_methods['MWL']
+    end
+  end
+
+  set_attributes
+
+end

data/prayer_times.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prayer_times/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "prayer_times"
+  spec.version       = PrayerTimes::VERSION
+  spec.authors       = ["Khaled alHabache"]
+  spec.email         = ["khellls@gmail.com"]
+  spec.description   = %q{Calculates Muslim prayers times in given settings}
+  spec.summary       = %q{Muslim prayers times calculator}
+  spec.homepage      = "https://github.com/Startappz/prayer_times/"
+  spec.license       = "GNU LGPL v3.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/lib/prayer_times/calculation_method_test.rb

@@ -0,0 +1,57 @@
+require_relative '../../test_helper'
+
+describe PrayerTimes::CalculationMethod do
+  
+  let(:name){"Medina"}
+  let(:description){"Medina testing methods"}
+  
+  describe "Object" do
+    subject{PrayerTimes::CalculationMethod.new(name, description,{})}
+    it {subject.must_respond_to :description}
+    it {subject.must_respond_to :description=}
+    it {subject.must_respond_to :settings}
+    it {subject.must_respond_to :settings=}
+    it {subject.must_respond_to :offsets}
+    it {subject.must_respond_to :offsets=}
+  end
+  
+  describe "#initialize" do
+    context "when name and description are provided" do
+      subject{PrayerTimes::CalculationMethod.new(name, description)}
+      it {subject.name.must_equal(name)}
+      it {subject.description.must_equal(description)}
+    end
+    
+    context "when settings are not provided" do
+      subject{PrayerTimes::CalculationMethod.new(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
+      }}
+      subject{PrayerTimes::CalculationMethod.new(name, description,opts)}
+      it {subject.settings.must_equal(PrayerTimes::CalculationMethod.default_settings.merge opts)}
+    end   
+    
+    context "when offsets are not provided" do
+      subject{PrayerTimes::CalculationMethod.new(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
+      }}
+      subject{PrayerTimes::CalculationMethod.new(name, description,{},opts)}
+      it {subject.offsets.must_equal(PrayerTimes::Constants.times_offsets.merge opts)}
+    end     
+       
+  end
+
+end

data/test/lib/prayer_times/calculation_methods_test.rb

@@ -0,0 +1,39 @@
+require_relative '../../test_helper'
+
+describe PrayerTimes::CalculationMethods do
+  describe "#initialize" do
+    subject{PrayerTimes::CalculationMethods.new}
+    it {subject.must_respond_to :add}
+    it {subject.keys.must_equal subject.class.default_methods.keys}
+    it {subject.must_respond_to :[]}
+    it {subject.must_respond_to :each}
+    it {subject.must_respond_to :keys}
+    it {subject.must_respond_to :key?}
+    it {subject.must_respond_to :delete}
+  end
+  
+
+  
+  describe  "#add" do
+    before do
+      @subject = PrayerTimes::CalculationMethods.new
+      @settings = {fajr: 16.5, asr: 'Hanafi', isha: '80 min'}
+      @offsets = {dhuhr: 2, asr: -1, isha: 3}
+
+      @new = @subject.add("Test", "Testing method", @settings, @offsets)
+    end
+    it {@new.must_be_instance_of PrayerTimes::CalculationMethod}
+    it {@subject["Test"].must_be_same_as @new}
+    it {@subject["Test"].settings[:fajr].must_equal 16.5}
+    it {@subject["Test"].settings[:asr].must_equal 'Hanafi'}
+    it {@subject["Test"].settings[:isha].must_equal '80 min'}
+    it {@subject["Test"].offsets[:dhuhr].must_equal 2}
+    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}
+  end
+end

data/test/lib/prayer_times/calculation_test.rb

@@ -0,0 +1,123 @@
+require_relative '../../test_helper'
+
+# Those results are tested against numbers from the js code
+# http://praytimes.org/code/v2/js/PrayTimes.js
+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}
+      end
+    end
+    
+    context 'when method is Makkah' do
+      let(:method_name){'Makkah'}
+      
+       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}
+        end
+      end
+      
+      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}
+        end
+      end
+      
+    
+      
+      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}
+        end
+      end
+      
+      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}
+        end
+      end
+    end
+   
+  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}
+      end
+    end
+    
+    
+  end
+end

data/test/lib/prayer_times/calculator_test.rb

@@ -0,0 +1,16 @@
+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}
+      
+end

data/test/lib/prayer_times/math_helpers_test.rb

@@ -0,0 +1,46 @@
+require_relative '../../test_helper'
+
+describe PrayerTimes::MathHelpers do
+
+  subject{ Object.new.extend PrayerTimes::MathHelpers}
+
+  describe "#radians" do
+    it {subject.must_respond_to(:radians)}
+  end
+
+  describe "#degrees" do
+    it {subject.must_respond_to(:degrees)}
+  end
+
+  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
+end

data/test/lib/prayer_times/prayer_times_test.rb

@@ -0,0 +1,23 @@
+require_relative '../../test_helper'
+
+describe PrayerTimes do
+
+  describe "Class" do
+    subject{PrayerTimes}
+    it{subject.must_respond_to :calculation_method}
+    it{subject.must_respond_to :calculation_methods}
+    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_be_kind_of PrayerTimes::Setters}
+  end
+  
+  describe ".new" do
+    subject{PrayerTimes.new}
+    it{subject.must_be_kind_of PrayerTimes::Calculator}
+  end
+
+end

data/test/lib/prayer_times/setters_test.rb

@@ -0,0 +1,105 @@
+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
+      ["",1,6].each do |num|
+        let(:iterations_count){8}
+        let(:result){subject.iterations_count = iterations_count; subject.iterations_count}
+        it{result.must_equal PrayerTimes.iterations_count}
+      end
+    end
+
+    context "when in range" do
+      let(:iterations_count){3}
+      let(:result){subject.iterations_count = iterations_count; subject.iterations_count}
+      it{result.must_equal iterations_count}
+    end
+  end
+
+  describe "#time_format=" do
+    context "when wrong value" do
+      let(:time_format){"kh"}
+      let(:result){subject.time_format = time_format; subject.time_format}
+      it{result.must_equal PrayerTimes.time_format}
+    end
+
+    context "when right value" do
+      let(:time_format){'12h'}
+      let(:result){subject.time_format = time_format; subject.time_format}
+      it{result.must_equal time_format}
+    end
+  end
+  
+  describe "#invalid_time=" do
+    context "when nil" do
+      let(:invalid_time){nil}
+      let(:result){subject.invalid_time = invalid_time; subject.invalid_time}
+      it{result.must_equal PrayerTimes.invalid_time}
+    end
+
+    context "when other value" do
+      let(:invalid_time){'*****'}
+      let(:result){subject.invalid_time = invalid_time; subject.invalid_time}
+      it{result.must_equal invalid_time}
+    end
+  end
+  
+  describe "#time_suffixes=" do
+    context "when wrong value" do
+      let(:time_suffixes){{:amz => "صباحا", :pm => "مساءا"}}
+      let(:result){subject.time_suffixes = time_suffixes; subject.time_suffixes}
+      it{result.must_equal PrayerTimes.time_suffixes.merge({:pm => "مساءا"})}
+    end
+
+    context "when right value" do
+      let(:time_suffixes){{:am => "صباحا", :pm => "مساءا"}}
+      let(:result){subject.time_suffixes = time_suffixes; subject.time_suffixes}
+      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"}}
+      let(:result){subject.times_names = times_names; subject.times_names}
+      it{result.must_equal PrayerTimes.times_names.merge({:isha => "Ishaa"})}
+    end
+
+    context "when right value" do
+      let(:times_names){{:asr => "Aser", :isha => "Ishaa"}}
+      let(:result){subject.times_names = times_names; subject.times_names}
+      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}}
+      let(:result){subject.times_offsets = times_offsets; subject.times_offsets}
+      it{result.must_equal PrayerTimes.times_offsets.merge({:isha => 3.6})}
+    end
+
+    context "when right value" do
+      let(:times_offsets){{:asr => 1, :dhuhr => 1.2, :isha => 3.6}}
+      let(:result){subject.times_offsets = times_offsets; subject.times_offsets}
+      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'}
+      let(:result){subject.calculation_method = calculation_method; subject.calculation_method}
+      it{result.must_equal PrayerTimes.calculation_method}
+    end
+
+    context "when right value" do
+      let(:calculation_method){'Makkah'}
+      let(:result){subject.calculation_method = calculation_method; subject.calculation_method}
+      it{result.must_equal PrayerTimes.calculation_methods['Makkah']}
+    end
+  end
+end

data/test/lib/prayer_times/version_test.rb

@@ -0,0 +1,9 @@
+require_relative '../../test_helper'
+
+describe PrayerTimes do
+
+  it "must be defined" do
+    PrayerTimes::VERSION.wont_be_nil
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/prayer_times.rb', __FILE__)
+
+class MiniTest::Spec
+  class << self
+    alias :context :describe
+  end
+end