hijri_date 1.1.0 → 1.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MzM5YzdhMWJjNjlmZTM2N2Q2NTIzOGUxMjhkNWQxMjIyY2IzZGI2MA==
-  data.tar.gz: !binary |-
-    MDA2NWI5MmU3ODMxNjQ4YWFmYTY3ZGU1N2IxNTEwMTRhYmIxMjllMA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    N2FhNTQwMDdkZGU3MGU0MWFiMjkyMDcwZmYwZmUxNmZmZmFjNmEwMDZmYWI3
-    YTQxYzMwYWEyOWE2YzNlM2VkMDZhYjU0MjlhZDg2YTE2NGE2NTlhYWQzYWQ4
-    NDQ5NTNhOTNhYzBmMThlNzEzNzY4YzkzNWVkMTBhMGM4NDJlOWY=
-  data.tar.gz: !binary |-
-    NjJjMDUyMzk4YTIxZTdmNDY1MjE5NjZkMzY0Yjc1Nzk0YmRmN2Q1YWE1NTQ5
-    NDlmYmEzOGNmMDgwMzM4YzM0NDNiYjdhN2MxMjg4YzFlZDU5NWZkYTk2Yjc2
-    NWNjODZlMGFiNDJlYzNiMTVjNTY0NTNiZGQ3Y2IzMjk0ODllMjU=
+SHA1:
+  metadata.gz: baac7a18ca7221ae583e13eb36201724c65c2be7
+  data.tar.gz: b9d39db18168dea4e2663b14ae2e1e45f3f31c1a
+SHA512:
+  metadata.gz: 949186c69da3ec5e7402be1f75b0a1681967633830c4afb2ce02fb11b64890400f23cf55cb3fbb94ad4173e0e0441c2fb8f0febb4480fa321cd917a8a166dd6e
+  data.tar.gz: a7633b925b136465906ff0182284d88122e21cf6c9a589beee9c52ce3f42703d5d266423deb0c17c855fb95edb16e2b3b011b413ad883c2f674e214b381b9709

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: .rubocop_todo.yml
+
+Style/Documentation:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,21 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-09-28 23:38:18 +0100 using RuboCop version 0.34.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+Metrics/AbcSize:
+  Max: 30
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 12
+
+# Offense count: 2
+Style/OpMethod:
+  Exclude:
+    - 'lib/hijri_date.rb'

data/Rakefile

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

data/hijri_date.gemspec

@@ -4,20 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'hijri_date/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "hijri_date"
+  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.authors       = ['Murtaza Gulamali']
+  spec.email         = ['mygulamali@gmail.com']
+  spec.description   = 'Manage Islamic Hijri dates.'
+  spec.summary       = 'Hijri date object'
+  spec.homepage      = 'https://github.com/mygulamali/hijri_date'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
 end

data/lib/hijri_date/constants.rb

@@ -1,9 +1,13 @@
 module HijriDate
   # number of days in the year per month
-  DAYSINYEAR = [30, 59, 89, 118, 148, 177, 207, 236, 266, 295, 325, 355]
-  
+  DAYS_IN_YEAR = [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]
+  DAYS_IN_30_YEARS = [
+    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
+  ]
+
+  KABISA_YEAR_REMAINDERS = [2, 5, 8, 10, 13, 16, 19, 21, 24, 27, 29]
 end

data/lib/hijri_date/month_names.rb

@@ -1,51 +1,59 @@
 # encoding: utf-8
 
 module HijriDate
-  MONTHNAMES_AR = [
-    nil,
-    'محرم الحرام',
-    'صفر المظفر',
-    'ربيع الاول',
-    'ربيع الآخر',
-    'جمادى الاولى',
-    'جمادى الاُخرى',
-    'رجب الاصب',
-    'شعبان الكريم',
-    'رمضان المعظم',
-    'شوال المكرم',
-    'ذي القعدة الحرام',
-    'ذي الحجة الحرام'
-  ]
+  MONTH_NAMES = {
+    ar: [
+      nil,
+      'محرم الحرام',
+      'صفر المظفر',
+      'ربيع الاول',
+      'ربيع الآخر',
+      'جمادى الاولى',
+      'جمادى الاُخرى',
+      'رجب الاصب',
+      'شعبان الكريم',
+      'رمضان المعظم',
+      'شوال المكرم',
+      'ذي القعدة الحرام',
+      'ذي الحجة الحرام'
+    ],
+    en: [
+      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'
+    ]
+  }
 
-  MONTHNAMES_EN = [
-    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'
-  ]
-  
-  SHORT_MONTHNAMES_EN = [
-    nil,
-    'Moharram',
-    'Safar',
-    'Rabi I',
-    'Rabi II',
-    'Jumada I',
-    'Jumada II',
-    'Rajab',
-    'Shabaan',
-    'Ramadaan',
-    'Shawwal',
-    'Zilqadah',
-    'Zilhaj'
-  ]
+  MONTHNAMES_AR = MONTH_NAMES[:ar]
+  MONTHNAMES_EN = MONTH_NAMES[:en]
+
+  SHORT_MONTH_NAMES = {
+    en: [
+      nil,
+      'Moharram',
+      'Safar',
+      'Rabi I',
+      'Rabi II',
+      'Jumada I',
+      'Jumada II',
+      'Rajab',
+      'Shabaan',
+      'Ramadaan',
+      'Shawwal',
+      'Zilqadah',
+      'Zilhaj'
+    ]
+  }
+
+  SHORT_MONTHNAMES_EN = SHORT_MONTH_NAMES[:en]
 end

data/lib/hijri_date/version.rb

@@ -1,3 +1,3 @@
 module HijriDate
-  VERSION = "1.1.0"
+  VERSION = '1.2.0'
 end

data/lib/hijri_date.rb

@@ -1,6 +1,6 @@
-require "hijri_date/version"
-require "hijri_date/month_names"
-require "hijri_date/constants"
+require 'hijri_date/constants'
+require 'hijri_date/month_names'
+require 'hijri_date/version'
 
 module HijriDate
   class Date
@@ -8,114 +8,94 @@ module HijriDate
     attr_accessor :year, :month, :day
 
     # constructor
-    def initialize(year = 1432, month = 4 , day = 20)
+    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_EN[date.month]} #{date.year}H"
+      "#{date.day} #{MONTH_NAMES[:en][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
+    def kabisa?(year = self.year)
+      KABISA_YEAR_REMAINDERS.any? { |remainder| year % 30 == remainder }
     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         
+      (month == 12 && kabisa?(year) || month.odd?) ? 30 : 29
     end
 
-    # day of the year corresponding to this (or specified) Hijri date   
+    # 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
+      date.month == 1 ? date.day : (DAYS_IN_YEAR[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)
+      day_number = 1948084 + y30 * 10631 + day_of_year(date)
+
+      if date.year % 30 == 0
+        day_number
       else
-        return 1948084 + y30*10631 + HijriDate::DAYSIN30YEARS[date.year-y30*30-1] + day_of_year(date)
+        day_number + DAYS_IN_30_YEARS[date.year - y30 * 30 - 1]
       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
+    def ==(other)
+      if other.is_a?(Date)
+        return other.year == year && other.month == month && other.day == day
       end
-      raise TypeError, 'expected HijriDate::Date'
+      fail TypeError, 'expected HijriDate::Date'
     end
 
     # return a new HijriDate object that is n days after the current one.
-    def + (n)
+    def +(n)
       case n
-      when Numeric; return HijriDate.jd(self.jd + n)
+      when Numeric
+        return HijriDate.jd(jd + n)
       end
-      raise TypeError, 'expected numeric'
+      fail TypeError, 'expected numeric'
     end
 
     # return a new HijriDate object that is n days before the current one.
-    def - (n)
+    def -(n)
       case n
-      when Numeric; return HijriDate.jd(self.jd - n)
+      when Numeric
+        return HijriDate.jd(jd - n)
       end
-      raise TypeError, 'expected numeric'
+      fail TypeError, 'expected numeric'
     end
 
     # return the day of the week (0-6, Sunday is zero)
     def wday
-      Object::Date.jd(self.jd).wday
-    end 
+      Object::Date.jd(jd).wday
+    end
   end
 
   # return new Hijri Date object associated with specified Julian Day number
-  def HijriDate.jd(jd = 1948084)
+  def self.jd(jd = 1948084)
     left = (jd - 1948084).to_i
     y30 = (left / 10631.0).floor
     left -= y30 * 10631
+
     i = 0
+    i += 1 while left > DAYS_IN_30_YEARS[i]
 
-    while left > HijriDate::DAYSIN30YEARS[i]
-      i += 1
-    end
-    year = (y30 * 30.0 + i).to_i
+    year = (y30 * 30 + i).to_i
+    left -= DAYS_IN_30_YEARS[i - 1] if i > 0
 
-    if i>0
-      left -= HijriDate::DAYSIN30YEARS[i - 1]
-    end
     i = 0
+    i += 1 while left > DAYS_IN_YEAR[i]
 
-    while left > HijriDate::DAYSINYEAR[i]
-      i += 1
-    end
     month = (i + 1).to_i
+    day = i > 0 ? (left - DAYS_IN_YEAR[i - 1]) : left
 
-    if i>0
-      day = (left - HijriDate::DAYSINYEAR[i - 1]).to_i
-    else
-      day = left.to_i
-    end
-
-    return HijriDate::Date.new(year, month, day)
+    Date.new(year, month, day)
   end
 end

data/test/hijri_date_test.rb

@@ -3,14 +3,14 @@ require 'hijri_date'
 require 'minitest/autorun'
 require 'minitest/pride'
 
-class HijriDateTest < MiniTest::Unit::TestCase
+class HijriDateTest < MiniTest::Test
   def setup
-    @date = HijriDate::Date.new  # 20/04/1432H = 25/03/2011AD
+    @date = HijriDate::Date.new # 20/04/1432H = 25/03/2011AD
   end
 
   def test_kabisa_year
-    refute @date.is_kabisa?
-    assert @date.is_kabisa? 1431
+    refute @date.kabisa?
+    assert @date.kabisa? 1431
   end
 
   def test_days_in_month
@@ -21,7 +21,7 @@ class HijriDateTest < MiniTest::Unit::TestCase
 
   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 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
@@ -72,6 +72,6 @@ class HijriDateTest < MiniTest::Unit::TestCase
   end
 
   def test_day_of_week
-    assert_equal 5, @date.wday  # Friday
+    assert_equal 5, @date.wday # Friday
   end
 end

metadata

@@ -1,52 +1,81 @@
 --- !ruby/object:Gem::Specification
 name: hijri_date
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Murtaza Gulamali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2015-09-29 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: minitest
+  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'
 - !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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.
+description: Manage Islamic Hijri dates.
 email:
 - mygulamali@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -67,17 +96,17 @@ 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
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Hijri date object