hijri_date 1.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTc2YTA1NGVjZTAyOTFiZDZmOThiMjNkMDJhNDgyNTRhZGM0MTk4ZA==
+  data.tar.gz: !binary |-
+    NDkxZTMxZGI0MjYxMTZhMjgwZDdkNGNiOWFjNDQyMTE0ZGIzM2VmMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODZjODI5ZmYyMGM4NzVmMjE3MWYwNmViNTE5OGFjMzgwYjU3Y2EzZTBhYTlm
+    MmExYTc1MWU1NmFiZDQyOTU3MjgyZjI4NDgwN2VjZjIzOTYzYzc3ZGIxNTk3
+    MjJmNDNjZjUyZTRlYjA2YmMyYmNkNmM5MzM3OTY5YzJlN2YzNWY=
+  data.tar.gz: !binary |-
+    ZjkwYTM3NmNmZTVkZTcwNzllZWVkY2I5YjI2Y2I5ZDRmZGFmY2NmMDNhN2Rl
+    OGNmMmM3ZTk5YzBhMDUxYTk2ZWMwMzJhZDRkYjEzODllZDU4MmFlYzVkYmVm
+    YThhMmU0NmY4M2QxZGQ1NzQ1NzFkNDc2MDE4NjMzMmVmOTAxYjA=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hijri_date.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Murtaza Gulamali
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# HijriDate
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hijri_date'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hijri_date
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/hijri_date'
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => :test

data/hijri_date.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hijri_date/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hijri_date"
+  spec.version       = HijriDate::VERSION
+  spec.authors       = ["Murtaza Gulamali"]
+  spec.email         = ["mygulamali@gmail.com"]
+  spec.description   = %q{Class to store Hijri dates and convert them to/from Astronomical Julian Date.}
+  spec.summary       = %q{Hijri date object}
+  spec.homepage      = "https://github.com/mygulamali/hijri_date"
+  spec.license       = "MIT"
+
+  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/lib/hijri_date/constants.rb

@@ -0,0 +1,9 @@
+module HijriDate
+  # number of days in the year per month
+  DAYSINYEAR = [30, 59, 89, 118, 148, 177, 207, 236, 266, 295, 325, 355]
+  
+  # number of days in 30-years per year
+  DAYSIN30YEARS = [ 354,  708, 1063, 1417, 1771, 2126, 2480, 2834,  3189,  3543,
+                   3898, 4252, 4606, 4961, 5315, 5669, 6024, 6378,  6732,  7087,
+                   7441, 7796, 8150, 8504, 8859, 9213, 9567, 9922, 10276, 10631]
+end

data/lib/hijri_date/month_names.rb

@@ -0,0 +1,29 @@
+module HijriDate
+  MONTHNAMES = [nil,
+                'Moharram al-Haraam',
+                'Safar al-Muzaffar',
+                'Rabi al-Awwal',
+                'Rabi al-Aakhar',
+                'Jumada al-Ula',
+                'Jumada al-Ukhra',
+                'Rajab al-Asab',
+                'Shabaan al-Karim',
+                'Ramadaan al-Moazzam',
+                'Shawwal al-Mukarram',
+                'Zilqadah al-Haraam',
+                'Zilhaj al-Haraam']
+  
+  SHORTMONTHNAMES = [nil,
+                     'Moharram',
+                     'Safar',
+                     'Rabi I',
+                     'Rabi II',
+                     'Jumada I',
+                     'Jumada II',
+                     'Rajab',
+                     'Shabaan',
+                     'Ramadaan',
+                     'Shawwal',
+                     'Zilqadah',
+                     'Zilhaj']
+end

data/lib/hijri_date/version.rb

@@ -0,0 +1,3 @@
+module HijriDate
+  VERSION = "1.0.1"
+end

data/lib/hijri_date.rb

@@ -0,0 +1,116 @@
+require "hijri_date/version"
+require "hijri_date/month_names"
+require "hijri_date/constants"
+
+module HijriDate
+  class Date
+    # create setters and getters
+    attr_accessor :year, :month, :day
+
+    # constructor
+    def initialize(year = 1432, month = 4 , day = 20)
+      @year = year
+      @month = month
+      @day = day
+    end
+    
+    # convert to string object
+    def to_s(date = self)
+      return "#{date.day} #{HijriDate::MONTHNAMES[date.month]} #{date.year}H"
+    end
+    
+    # is this (or the specified) year a Kabisa year?
+    def is_kabisa?(year = self.year)
+      for i in [2, 5, 8, 10, 13, 16, 19, 21, 24, 27, 29]
+        if year % 30 == i
+          return true
+        end
+      end
+      return false
+    end
+    
+    # number of days in this (or the specified) month and year
+    def days_in_month(month = self.month, year = self.year)
+      if (month == 12 and is_kabisa?(year)) or (month % 2 == 1)
+        return 30
+      end
+      return 29         
+    end
+
+    # day of the year corresponding to this (or specified) Hijri date   
+    def day_of_year(date = self)
+      if date.month == 1
+        return date.day
+      end
+      return HijriDate::DAYSINYEAR[date.month - 2] + date.day
+    end
+    
+    # return Julian Day number associated with this (or specified) Hijri date
+    def jd(date = self)
+      y30 = (date.year / 30.0).floor
+      if (date.year % 30 == 0)
+        return 1948084 + y30*10631 + day_of_year(date)
+      else
+        return 1948084 + y30*10631 + HijriDate::DAYSIN30YEARS[date.year-y30*30-1] + day_of_year(date)
+      end
+    end
+
+    # comparison operator
+    def == (date)
+      if date.is_a?(HijriDate::Date)
+        if date.year == self.year and date.month == self.month and date.day == self.day
+          return true
+        end
+        return false
+      end
+      raise TypeError, 'expected HijriDate::Date'
+    end
+
+    # return a new HijriDate object that is n days after the current one.
+    def + (n)
+      case n
+      when Numeric; return HijriDate.jd(self.jd + n)
+      end
+      raise TypeError, 'expected numeric'
+    end
+
+    # return a new HijriDate object that is n days before the current one.
+    def - (n)
+      case n
+      when Numeric; return HijriDate.jd(self.jd - n)
+      end
+      raise TypeError, 'expected numeric'
+    end
+  end
+
+  # return new Hijri Date object associated with specified Julian Day number
+  def HijriDate.jd(jd = 1948084)
+    left = (jd - 1948084).to_i
+    y30 = (left / 10631.0).floor
+    left -= y30 * 10631
+    i = 0
+
+    while left > HijriDate::DAYSIN30YEARS[i]
+      i += 1
+    end
+    year = (y30 * 30.0 + i).to_i
+
+    if i>0
+      left -= HijriDate::DAYSIN30YEARS[i - 1]
+    end
+    i = 0
+
+    while left > HijriDate::DAYSINYEAR[i]
+      i += 1
+    end
+    month = (i + 1).to_i
+
+    if i>0
+      day = (left - HijriDate::DAYSINYEAR[i - 1]).to_i
+    else
+      day = left.to_i
+    end
+
+    return HijriDate::Date.new(year, month, day)
+  end
+end

data/test/hijri_date_test.rb

@@ -0,0 +1,73 @@
+require 'date'
+require 'hijri_date'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+class HijriDateTest < MiniTest::Unit::TestCase
+  def setup
+    @date = HijriDate::Date.new  # 20/04/1432H = 25/03/2011AD
+  end
+
+  def test_kabisa_year
+    refute @date.is_kabisa?
+    assert @date.is_kabisa? 1431
+  end
+
+  def test_days_in_month
+    assert_equal 29, @date.days_in_month
+    assert_equal 29, @date.days_in_month(12)
+    assert_equal 30, @date.days_in_month(12, 1431)
+  end
+
+  def test_day_of_year
+    assert_equal 109, @date.day_of_year
+    assert_equal  10, HijriDate::Date.new(1432, 1, 10).day_of_year
+    assert_equal 355, HijriDate::Date.new(1431, 12, 30).day_of_year
+    assert_equal 354, HijriDate::Date.new(1432, 12, 29).day_of_year
+  end
+
+  def test_conversion_to_jd
+    assert_equal 2455646, @date.jd
+  end
+
+  def test_comparison
+    assert @date == HijriDate::Date.new(@date.year, @date.month, @date.day)
+    refute @date == HijriDate::Date.new(@date.year + 1, @date.month, @date.day)
+    refute @date == HijriDate::Date.new(@date.year, @date.month + 1, @date.day)
+    refute @date == HijriDate::Date.new(@date.year, @date.month, @date.day + 1)
+
+    assert_raises TypeError do
+      @date == Date.today
+    end
+  end
+
+  def test_add
+    assert_equal 21, (@date + 1).day
+
+    date = HijriDate::Date.new(1432, 12, 29) + 1
+    assert_equal HijriDate::Date.new(1433, 1, 1), date
+  end
+
+  def test_subtract
+    assert_equal 19, (@date - 1).day
+
+    date = HijriDate::Date.new(1433, 1, 1) - 1
+    assert_equal HijriDate::Date.new(1432, 12, 29), date
+  end
+
+  def test_conversion_from_jd
+    assert_equal @date, HijriDate.jd(2455646)
+  end
+
+  def test_hijri_gregorian_conversion
+    date = Date.jd(@date.jd)
+    assert_equal 2011, date.year
+    assert_equal 3, date.month
+    assert_equal 25, date.day
+
+    date = HijriDate.jd(Date.new(2011, 3, 25).jd)
+    assert_equal 1432, date.year
+    assert_equal 4, date.month
+    assert_equal 20, date.day
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: hijri_date
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Murtaza Gulamali
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Class to store Hijri dates and convert them to/from Astronomical Julian
+  Date.
+email:
+- mygulamali@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hijri_date.gemspec
+- lib/hijri_date.rb
+- lib/hijri_date/constants.rb
+- lib/hijri_date/month_names.rb
+- lib/hijri_date/version.rb
+- test/hijri_date_test.rb
+homepage: https://github.com/mygulamali/hijri_date
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Hijri date object
+test_files:
+- test/hijri_date_test.rb