bahai_date 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d42db0fd17b26fc7407fea6e278734d8159a2a2
+  data.tar.gz: 819bc3a41f306df700094d1859cf2b5acfd1c5f9
+SHA512:
+  metadata.gz: e375bc85d651c6aab277dd6faa2bd44f6b244ce6bddc641c79545170f1a665a926a904ed9b9601fcfa06a1ab85eae555407a9ce158dfbaf96f336170edf95472
+  data.tar.gz: e4399e7b2f57506dccbf46a68ede1bfd5b2f2e987b264287dbca219074fdd76c1b102b199fc7ae9cadd6c675e173fdbf8aaeea1bd3f726a0532434b26d249fff

data/LICENSE.md

@@ -0,0 +1,25 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>
+

data/README.md

@@ -0,0 +1,124 @@
+Baha'i Date Ruby Gem
+====================
+A Ruby gem for conversion between the Gregorian calendar and the Baha'i (or Badi) calendar.
+
+
+The Baha'i calendar
+-------------------
+In the Baha'i (or Badi) calendar there are 19 months each having 19 days, with 4 or 5 days left aside as intercalery days. Each weekday, day of the month and month of the year have a name, named after the attributes of God (such as Glory, Beauty, etc). The names have been transliterated into English from the original Arabic, and a translation is also provided.
+
+Each year also has a name, as part of a 19 year cycle called a Vahid (meaning "unity"). Every 19 Vahids (i.e. 361 years) constitute a Kull-i-Shay (meaning "all things"). 
+
+The calendar begins on the vernal equinox, normally on the 20th or 21st of March. The first year is 1844.
+
+More information about this calendar is on the [Wikipedia entry](http://en.wikipedia.org/wiki/Bah%C3%A1'%C3%AD_calendar).
+
+
+Functionality
+-------------
+A BahaiDate instance can be created either from a Gregorian date or supplying the year, month and day in the Baha'i calendar.
+
+The instance then exposes:
+- **weekday**
+ - **number**: e.g. 6
+ - **title**: e.g. Istijlal
+ - **translation**: e.g. Majesty
+ - **html**: e.g. Istijlál
+ - **english_equivalent**: e.g. Thursday
+- **day**
+ - **number**: e.g. 1
+ - **title**: e.g. Baha
+ - **translation**: e.g. Splendour
+ - **html**: e.g. Bahá
+- **month**
+ - **number**: e.g. 1
+ - **title**: e.g. Baha
+ - **translation**: e.g. Splendour
+ - **html**: e.g. Bahá
+- **year**
+ - **bahai_era**: e.g. 172
+ - **number**: e.g. 1
+ - **title**: e.g. Alif
+ - **translation**: e.g. A
+ - **html**: e.g. Alif
+ - **vahid**: e.g. 10
+ - **kull_i_shay**: e.g. 1
+- **gregorian_date**: e.g. 2015-3-21 (using the ruby Date class)
+- **occasions**: array of Occasion objects:
+ - **type**: e.g. holy
+ - **work_suspended?**: e.g. true
+ - **title**: e.g. Naw-Ruz (New Year)
+ - **short_title**: e.g. Naw-Ruz
+ - **title_html**: e.g. Naw-Rúz (New Year)
+ - **short_title_html**: e.g. Naw-Rúz
+
+A calendar can also be obtained using the YearCalendar class and providing a year. It is then populated with details about that year, each month and each day in it.
+
+
+Installation
+------------
+Add this line to your application's Gemfile:
+
+`gem 'bahai_date'`
+
+And then execute:
+
+`$ bundle install`
+
+Or, install it yourself:
+`$ gem install bahai_date`
+
+
+Example Usage
+-------------
+Creating an instance:
+```ruby
+require "bahai_date"
+
+today = BahaiDate.new(date: Date.today)
+
+#or
+
+nawruz = BahaiDate.new(year: 171, month: 1, day: 1)
+```
+
+Attributes:
+```ruby
+puts "to_s: " + today.to_s
+puts "long_format: " + today.long_format
+puts "gregorian_date: " + today.gregorian_date.to_s
+```
+Outputs:
+```
+to_s: 171.11.8
+long_format: Jalal 8 Mashiyyat 171 B.E.
+gregorian_date: 2014-10-04
+```
+
+Calendar:
+```ruby
+calendar = YearCalendar.new(171)
+puts "Year: " + calendar.bahai_era.to_s
+puts "Month 1:" + calendar.months[1].title
+puts "  Day 1 in Month 1:" + calendar.months[1].days[1].title
+puts "         (weekday):" + calendar.months[1].days[1].weekday.title
+puts "       (occasions):" + calendar.months[1].days[1].occasions[0].title
+puts "                   " + calendar.months[1].days[1].occasions[1].title
+```
+Outputs:
+```
+Year: 171
+Month 1:Baha
+  Day 1 in Month 1:Baha
+         (weekday):Istiqlal
+       (occasions):Naw-Ruz (New Year)
+                   Nineteen Day Feast of the month of Baha (Splendour)
+```
+
+
+License
+-------
+This is free and unencumbered software released into the public domain.
+
+For more information, please refer to <http://unlicense.org/>
+

data/lib/bahai_date/bahai_date.rb

@@ -0,0 +1,118 @@
+require 'date'
+require_relative 'year'
+require_relative 'month'
+require_relative 'day'
+require_relative 'weekday'
+require_relative 'year_data'
+require_relative 'occasion_factory'
+
+module BahaiDate
+
+  class BahaiDate
+
+    AYYAM_I_HA = -1
+
+    attr_reader :weekday, :day, :month, :year, :gregorian_date, :occasions
+
+    def initialize(params)
+      if params[:date]
+        @gregorian_date = params[:date]
+        year, month, day = from_gregorian
+        @year = Year.new(year)
+        @month = Month.new(month)
+        @day = Day.new(day)
+      elsif params[:year] and params[:month] and params[:day]
+        @year = Year.new(params[:year])
+        @month = Month.new(params[:month])
+        @day = Day.new(params[:day])
+        validate_ayyam_i_ha
+        @gregorian_date = to_gregorian
+      else
+        raise ArgumentError, "Invalid arguments. Use a hash with :date or with :year, :month, and :day."
+      end
+      @weekday = Weekday.new(weekday_from_gregorian)
+      @occasions = OccasionFactory.new(@year.bahai_era, @month.number, @day.number).occasions
+    end
+
+    def to_s
+      "#{@year.bahai_era}.#{@month.number}.#{@day.number}"
+    end
+
+    def long_format
+      "#{@weekday} #{@day.number} #{@month} #{@year.bahai_era} B.E."
+    end
+
+    def next_day!
+      initialize(date: @gregorian_date + 1)
+    end
+
+  private
+
+    def validate_ayyam_i_ha
+      if @month.number == AYYAM_I_HA && @day.number > ayyam_i_ha_days
+        raise ArgumentError, "'#{@day.number}' is not a valid day for Ayyam-i-Ha in the year #{@year.bahai_era}"
+      end
+    end
+
+    def ayyam_i_ha_days(year = @year.bahai_era)
+        YearData.is_leap?(year) ? 5 : 4
+    end
+
+    def to_gregorian
+      year_gregorian = @year.bahai_era + 1844 - 1
+      nawruz = YearData.nawruz_for(year_gregorian)
+      nawruz + days_from_nawruz
+    end
+
+    def from_gregorian
+      nawruz = YearData.nawruz_for(@gregorian_date.year)
+
+      year = @gregorian_date.year - 1844
+      if @gregorian_date >= nawruz then
+        year += 1
+        days = (@gregorian_date - nawruz).to_i
+      else
+        days = (@gregorian_date - YearData.nawruz_for(@gregorian_date.year - 1)).to_i
+      end
+ 
+      # determine day and month, taking into account ayyam-i-ha
+      if days >= 342
+        if days < (342 + ayyam_i_ha_days(year))
+          month = AYYAM_I_HA
+          day = days - 342
+        else
+          month = 19
+          day = days - (342 + ayyam_i_ha_days(year))
+        end
+      else
+        month, day = (days).divmod(19)
+        month += 1
+      end
+      day += 1
+      [year, month, day]
+    end
+
+    def weekday_from_gregorian
+      # saturday (6 in ruby) is the first day of the week
+      @gregorian_date.wday == 6 ? 1 : @gregorian_date.wday + 2
+    end
+
+    def days_from_nawruz
+      days = @day.number - 1
+
+      full_months = @month.number - 1
+      if @month.number == AYYAM_I_HA
+        full_months = 18
+      end
+      days += full_months * 19
+    
+      if @month.number == 19
+        days += ayyam_i_ha_days
+      end
+
+      days
+    end
+
+  end
+
+end

data/lib/bahai_date/day.rb

@@ -0,0 +1,54 @@
+module BahaiDate
+
+  class Day 
+    TITLES = %w[Baha Jalal Jamal Azamat Nur Rahmat Kalimat Kamal Asma Izzat Mashiyyat Ilm Qudrat Qawl Masail Sharaf Sultan Mulk Ala]
+    TITLES_HTML = %w[Bahá Jalál Jamál ‘Aẓamat Núr Raḥmat Kalimát Kamál Asmá’ ‘Izzat Ma<u>sh</u>íyyat ‘Ilm Qudrat Qawl Masá’il <u>Sh</u>araf Sulṭán Mulk ‘Alá’]
+    TITLES_EN = %w[Splendour Glory Beauty Grandeur Light Mercy Words Perfection Names Might Will Knowledge Power Speech Questions Honour Sovereignty Dominion Loftiness]
+
+    attr_reader :number, :weekday, :occasions
+
+    def initialize(number_arg)
+      validate number_arg
+      @number = number_arg.to_i
+    end
+
+    def to_s
+      title
+    end
+
+    def title
+      TITLES[title_index]
+    end
+
+    def translation
+      TITLES_EN[title_index]
+    end
+
+    def html
+      TITLES_HTML[title_index]
+    end
+
+    def set_weekday(weekday)
+      @weekday = weekday
+    end
+
+    def set_occasions(occasions)
+      @occasions = occasions
+    end
+
+  private
+
+    def title_index
+      @number - 1
+    end
+
+    def validate(number_arg)
+      number = number_arg.to_i
+      if (number < 1 || number > 19)
+        raise ArgumentError, "'#{number}' is not a valid day. Please use 1 to 19."
+      end
+     end
+
+  end
+
+end

data/lib/bahai_date/month.rb

@@ -0,0 +1,57 @@
+module BahaiDate
+
+  class Month 
+    TITLES = %w[Baha Jalal Jamal Azamat Nur Rahmat Kalimat Kamal Asma Izzat Mashiyyat Ilm Qudrat Qawl Masail Sharaf Sultan Mulk Ala Ayyam-i-Ha]
+    TITLES_HTML = %w[Bahá Jalál Jamál ‘Aẓamat Núr Raḥmat Kalimát Kamál Asmá’ ‘Izzat Ma<u>sh</u>íyyat ‘Ilm Qudrat Qawl Masá’il <u>Sh</u>araf Sulṭán Mulk ‘Alá’ Ayyám-i-Há]
+    TITLES_EN = %w[Splendour Glory Beauty Grandeur Light Mercy Words Perfection Names Might Will Knowledge Power Speech Questions Honour Sovereignty Dominion Loftiness Ayyam-i-Ha]
+
+    attr_reader :number, :days
+
+    def initialize(number_arg)
+      validate number_arg
+      @number = number_arg.to_i
+      @days = {}
+    end
+
+    def to_s
+      title
+    end
+
+    def title
+      TITLES[title_index]
+    end
+
+    def translation
+      TITLES_EN[title_index]
+    end
+
+    def html
+      TITLES_HTML[title_index]
+    end
+
+    def set_day(day_number)
+      unless @days[day_number]
+        @days[day_number] = Day.new(day_number)
+      end
+    end
+
+  private
+
+    def title_index
+      if @number == -1
+        19 #20th element of the array
+      else
+        @number - 1
+      end
+    end
+
+    def validate(number_arg)
+      number = number_arg.to_i
+      if (number < -1 || number == 0 || number > 19 )
+        raise ArgumentError, "'#{number}' is not a valid month. Please use 1 to 19 or -1 for Ayyam-i-Ha."
+      end
+     end
+
+  end
+
+end

data/lib/bahai_date/occasion.rb

@@ -0,0 +1,24 @@
+module BahaiDate
+
+  class Occasion
+
+    attr_reader :type, 
+                :work_suspended,
+                :title,
+                :short_title,
+                :title_html,
+                :short_title_html
+    alias_method :work_suspended?, :work_suspended
+
+    def initialize(opts = {})
+      @type = opts[:type]
+      @work_suspended = opts[:work_suspended]
+      @title = opts[:title]
+      @short_title = opts[:short_title]
+      @title_html = opts[:title_html]
+      @short_title_html = opts[:short_title_html]
+    end
+
+  end
+
+end