nanakshahi 0.1.9 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf652ae1baa2a9e260f827e3a2b7942fc7c95bb264e000b5b59a3c1e01b10f45
-  data.tar.gz: 78d318348c2b62d737acc7eb84ba794236dc578d3449efafe13a3fe8257071c2
+  metadata.gz: a0463259484c7c4dc42a9cca224c2aa0f92c973bf15cface244fbd8737d56428
+  data.tar.gz: 156097925d4f56d5eaf3e3cc7e51fc57f5f14168b8eca053b0aac4418fdf3d48
 SHA512:
-  metadata.gz: '084132ba26de3b00969415f8c9d41a78176f7f2749aba37e5a9edd03043b9b11bb4feadcc74a78edff5e0565ce553f462fc07b62f99fc7aa2a8b91b6f5b91345'
-  data.tar.gz: 210eef669c266262af2b6d7594cd5573f9366546c94b760898bcc4b40fd9e60da5e9fcb5bbe8ba370cb9cee1c642491be658c936bd6e3dd87034361afa77a13d
+  metadata.gz: 7615dbb96309c2aa058fdf5659c32d288951014662c286acdd51d5eb1f01833d13a16dae366d9d4fcf837bc6bbea5383d2adc3fce39f4121e5e7530066ebdd7f
+  data.tar.gz: 81b05d9eabfcedaff95c2677f5aa545ed2c25ccb8643cc3e0fd4f129ae2a4903a9630542b5204ca234414a944b231242794e937f6ce2daafcb905b4e66b675be

data/CHANGELOG.md

@@ -1,4 +1,20 @@
 # coding: UTF-8
+=== 0.3 / 2021-09-20
+
+Features:
+
+- Now supports Shahmukhi Script of Panjabi language via `to_shahmukhi` method
+
+Bug fixes:
+- Fixed a bug which returned incorrect `to_gregorian method`
+
+=== 0.2.0 / 2021-09-12
+
+Bug fixes:
+
+- Updated rake 13.0.6 (was 13.0.1)
+- Updated minitest 5.14.4 (was 5.14.0)
+- Updated i18n 1.8.10 (was 1.8.2)
 
 === 0.1.9 / 2020-04-15
 

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    nanakshahi (0.1.9)
+    nanakshahi (0.2.0)
       i18n (~> 1.8, >= 1.8.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    concurrent-ruby (1.1.6)
-    i18n (1.8.2)
+    concurrent-ruby (1.1.9)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.0)
-    rake (13.0.1)
+    minitest (5.14.4)
+    rake (13.0.6)
 
 PLATFORMS
   ruby
@@ -23,4 +23,4 @@ DEPENDENCIES
   rake (~> 13.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/README.md

@@ -1,8 +1,9 @@
-# ਨਾਨਕਸ਼ਾਹੀ (Nanakshahi)
+ਨਾਨਕਸ਼ਾਹੀ (Nanakshahi)[![Gem Version](https://badge.fury.io/rb/nanakshahi.svg)](https://badge.fury.io/rb/nanakshahi)  ![Build Status](https://github.com/akaltakht/nanakshahi/actions/workflows/gempush.yml/badge.svg)
+========
 
 ਨਾਨਕਸ਼ਾਹੀ ਇੱਕ ਰੂਬੀ ਪਰੋਗਰਾਮਿੰਗ ਭਾਸ਼ਾ ਚ ਲਿਖਿਆ ਗਿਆ gem ਹੈ ਜੋ ਕਿ [ਪਾਲ ਸਿੰਘ ਪੁਰੇਵਾਲ](http://purewal.biz/) ਦੁਆਰਾ ਲਿਖੇ ਗਏ [ਮੂਲ ਨਾਨਕਸ਼ਾਹੀ ਕਲੰਡਰ](http://www.purewal.biz/Gurbani_and_Nanakshahi_Calendar.pdf) ਤੇ ਅਧਾਰਿਤ ਹੈ।
 
-ਇਹ ਆਮ/ਗਰਿਗੋਰੀਅਨ ਕਲੰਡਰ ਦੀਆਂ ਤਰੀਕਾਂ ਤੋਂ ਨਾਨਕਸ਼ਾਹੀ ਤੇ ਵਾਪਸ ਬਦਲਣ ਦੇ ਤਰੀਕੇ ਮੁਹੱੲੀਆ ਕਰਵਾਉਂਦਾ ਹੈ। ਤੁਸੀਂ ਇਸ ਨੂੰ ਕਿਸੇ ਵੀ ਰੂਬੀ ਪਰੋਗਰਾਮ ਵਿੱਚ ਨਾਨਕਸ਼ਾਹੀ ਤਰੀਕਾਂ ਵਰਤਣ ਲੲੀ ਵਰਤ ਸਕਦੇ ਹੋ।
+ਇਹ ਆਮ/ਗਰਿਗੋਰੀਅਨ ਕਲੰਡਰ ਦੀਆਂ ਤਰੀਕਾਂ ਤੋਂ ਨਾਨਕਸ਼ਾਹੀ ਤੇ ਵਾਪਸ ਬਦਲਣ ਦੇ ਤਰੀਕੇ ਮੁਹੱਈਆ ਕਰਵਾਉਂਦਾ ਹੈ। ਤੁਸੀਂ ਇਸ ਨੂੰ ਕਿਸੇ ਵੀ ਰੂਬੀ ਪਰੋਗਰਾਮ ਵਿੱਚ ਨਾਨਕਸ਼ਾਹੀ ਤਰੀਕਾਂ ਵਰਤਣ ਲਈ ਵਰਤ ਸਕਦੇ ਹੋ।
 
 Nanakshahi is a ruby gem for Nanakshahi Calendar based on the [original work](http://www.purewal.biz/Gurbani_and_Nanakshahi_Calendar.pdf) by [Pal Singh Purewal](http://purewal.biz/).
 
@@ -36,21 +37,19 @@ require 'nanakshahi'
 
 ```ruby
 date = Nanakshahi.new # Creates an object with 1 Chet, Nanakshahi
-date = Nanakshahi.new(550)
-date = Nanakshahi.new(550, 10)
-date = Nanakshahi.new(550, 10, 5)
+date = Nanakshahi.new(553)
+date = Nanakshahi.new(553, 7)
+date = Nanakshahi.new(550, 7, 6)
+date = Nanakshahi.today
 ```
 
 ### Using common calendar/gregorian date
 
 ```ruby
-date = Nanakshahi.from_gregorian(2019,1,8)
-```
-
-### Nanakshahi date today
-
-```ruby
-date = Nanakshahi.today
+date = Nanakshahi.from_gregorian(2021,9,21)
+=> #<Nanakshahi:0x00007fbec18410e8 @day=7, @month=7, @year=553>
+ndate = date.to_gregorian
+=> #<Date: 2021-09-21 ((2459479j,0s,0n),+0s,2299161j)>
 ```
 
 ### Is it a gurpurab?
@@ -76,6 +75,8 @@ p date.to_nanakshahi
 
 ### Printing Nanakshahi date
 
+#### Roman
+
 `to_s` method prints Nanakshahi date either Nanakshahi or Dhundkaal suffix (pre-Guru Nanak). To take care of 0 year correction, like gregorian, it is assumed that 1 Dhundkaal precedes 1 Nanakshahi when printed with suffix.
 
 ```ruby
@@ -83,7 +84,7 @@ date = Nanakshahi.new(1400-2-18)
 puts date
 ```
 
-### To Gurmukhi
+#### Gurmukhi
 
 `to_gurmukhi` prints the date in Gurmukhi characters, complete with Gurmukhi numerals.
 
@@ -92,11 +93,31 @@ date = Nanakshahi.new(1400-2-18)
 puts date.to_gurmukhi
 ```
 
+#### Shahmukhi
+
+`to_shahmukhi` prints the date in Shahmukhi characters, complete with Shahmukhi numerals.
+
+```ruby
+date = Nanakshahi.today
+puts date.to_shahmukhi
+```
+
+### Recommendations
+The following was not part of the seminal work by Pal Singh Purewal, but constituted part of recommendations in our paper [Building an Open-Source Nanakshahi Calendar: Identity and a Spiritual and Computational Journey(Singh et al., 2020)](https://sikhresearchjournal.org/building-an-open-source-nanakshahi-calendar-identity-and-a-spiritual-and-computational-journey-by-arvinder-singh-amandeep-singh-amarpreet-singh-harvinder-singh-parm-singh/)
+
+### Dhundkaal - The era of the fog
+
+```ruby
+date = Nanakshahi.from_gregorian(1468,1,1)
+date.to_s
+=> "19 Poh, 2 Dhundkaal"
+```
+
 For a complete list of all the methods, check out [the documentation](https://www.rubydoc.info/gems/nanakshahi).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/punjab/nanakshahi.
+Bug reports and pull requests are welcome on GitHub at https://github.com/akaltakht/nanakshahi.
 
 ## License
 

data/config/locales/pa_PK.yml

@@ -0,0 +1,34 @@
+pa_PK:
+  nanakshahi_months:
+    -
+    - چیت
+    - وساکھ
+    - جیٹھ
+    - ہاڑھ
+    - ساؤݨ
+    - بھادوں
+    - اسو
+    - کتک
+    - مگھر
+    - پوہ
+    - ماگھ
+    - پھگݨ
+  digits:
+    - ۰
+    - ۱
+    - ۲
+    - ۳
+    - ۴
+    - ۵
+    - ۶
+    - ۷
+    - ۸
+    - ۹
+  day_names:
+    - سوم وار
+    - منگل
+    - بدھ
+    - جمعرات
+    - شکروار
+    - سن
+    - اتوار

data/lib/nanakshahi/version.rb

@@ -1,3 +1,3 @@
 class Nanakshahi
-  VERSION = "0.1.9"
+  VERSION = "0.3.1"
 end

data/lib/nanakshahi.rb

@@ -15,7 +15,7 @@ require "nanakshahi/gurpurab"
 # @attr_reader [Integer] day Day part of Nanakshahi date object
 class Nanakshahi
   I18n.load_path << Dir[File.expand_path("config/locales") + "/*.yml"]
-  I18n.available_locales = [:en, :pa]
+  I18n.available_locales = [:en, :pa, :pa_PK]
   include Comparable
   extend Utils
   extend Grid
@@ -42,15 +42,7 @@ class Nanakshahi
   #
   # @return [Date] Converts nanakshahi into corresponding gregorian# as Date object
   def to_gregorian
-    last_nmonth_of_gyear = 10 # ਪੋਹ
-    last_nday_of_gyear = 18 # ੧੮
-
-    if month <= last_nmonth_of_gyear && day <= last_nday_of_gyear
-      gyear = year + 1468
-    else
-      gyear = year + 1469
-    end
-
+    gyear = year + 1468
     nanakshahi_months = self.class.date_grid(gyear)
     nanakshahi_months[month - 1][day - 1]
   end
@@ -71,6 +63,14 @@ class Nanakshahi
     "#{panjabi_numerals(day)} #{I18n.t(:nanakshahi_months, locale: :pa)[month]}, #{panjabi_numerals(year_zero_correction(year))} #{era}"
   end
 
+  # Shahmukhi String representation of Nanakshahi object
+  #
+  # @return [String] Shahmukhi String representation of Nanakshahi
+  def to_shahmukhi
+    era = year < 1 ? :دھندکال  : :نانکشاھی 
+    "#{shahmukhi_numerals(day)} #{I18n.t(:nanakshahi_months, locale: :pa_PK)[month]} #{shahmukhi_numerals(year_zero_correction(year))} #{era} "
+  end
+
   # Checks Nanakshahi leap year
   #
   # @return [Boolean] True if Nanakshahi year's Phagun has 31 days
@@ -157,4 +157,13 @@ class Nanakshahi
   def panjabi_numerals(number)
     number.to_s.chars.map { |digit| I18n.t(:digits, locale: :pa)[digit.to_i] }.join
   end
+
+  # Converts english numerals to Shahmukhi
+  #
+  # @param [Integer] number A numeric usually date
+  # @return [String] Shahmukhi representation of date
+  # @private
+  def shahmukhi_numerals(number)
+    number.to_s.chars.map { |digit| I18n.t(:digits, locale: :pa_PK)[digit.to_i] }.join
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanakshahi
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.3.1
 platform: ruby
 authors:
 - Arvinder Singh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,7 @@ files:
 - bin/setup
 - config/locales/en.yml
 - config/locales/pa.yml
+- config/locales/pa_PK.yml
 - lib/nanakshahi.rb
 - lib/nanakshahi/date.rb
 - lib/nanakshahi/grid.rb
@@ -120,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Nanakshahi calendar by Pal Singh Purewal