nepdate-patro 1.0.0.rc.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b459e6f82b11e2c351e3d920a7ecc85ab0322905d925a6b32686428361a06d9
+  data.tar.gz: 125260e1c923b5bf0623891a2b537e2a40dcbea999aef226c636df1404a95ac7
+SHA512:
+  metadata.gz: 9027e6bfb745b932cc8ab8b509ec4eaf2614713e06efbb829e8eafd036082642156d49da01ef6fc2e8f6b3950c0ee4a1a5af61cd75dab29f07e9cd3a005beae1
+  data.tar.gz: bc4bc4238031b957f64614bf69a891667aae84d549aa053c2f3c940614c6d130f63d1b053720e0c92c10f243f9466d108f24545f687fcab34fd71a2cecb4b72d

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+See the repository's [CHANGELOG.md](https://github.com/sanamhub/nepdate-ruby/blob/main/CHANGELOG.md).
+
+## [Unreleased]
+
+### Added
+
+- The `nepdate-patro` gem, version 1.0.0-rc.1, with tithi, public holidays and events.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 NepDate contributors
+
+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/NOTICE

@@ -0,0 +1,31 @@
+NepDate for Ruby
+
+This repository ports NepDate, the C# library by Raju Prasai and contributors
+(https://github.com/RajuPrasai/NepDate), to Ruby. The calendar and patro data, the golden test
+vectors and the behaviour this port follows all come from that library.
+
+The calendar data in shared/data (data/calendar/, data/patro/) was extracted from
+NepDate (https://github.com/RajuPrasai/NepDate, commit c6fff4f2f60ac01e31c086568320649627422ba1)
+and is used under the MIT License:
+
+MIT License
+
+Copyright (c) 2023 NepDate and contributors
+
+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,18 @@
+# nepdate-patro
+
+The patro (पात्रो, the Nepali almanac) for Ruby: tithi, public holidays and events for Bikram Sambat
+dates. It depends on `nepdate`; the core gem has no almanac data.
+
+```ruby
+require "nepdate"
+require "nepdate/patro"
+
+day = NepDate::Patro.info(NepDate::Date.from_bs(2081, 2, 15))
+puts day.tithi.english  # Panchami
+puts day.public_holiday? # true
+puts day.events_en       # Republic Day
+```
+
+The data covers BS 2077-01-01 to 2084-08-20 and is informational, not an official calendar. It is
+compiled into constant tables, so nothing is read at run time. The full API is in the repository's
+[docs/API.md](https://github.com/sanamhub/nepdate-ruby/blob/main/docs/API.md).

data/lib/nepdate/patro/calendar_info.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module NepDate
+  module Patro
+    # Everything the patro knows about one BS date. A date without data has a +nil+ tithi, a
+    # false holiday flag and an empty event list; +info+ never fails.
+    class CalendarInfo
+      attr_reader :tithi, :events
+
+      def initialize(tithi: nil, public_holiday: false, events: [])
+        @tithi = tithi
+        @public_holiday = public_holiday ? true : false
+        @events = events.freeze
+        freeze
+      end
+
+      def public_holiday?
+        @public_holiday
+      end
+      alias_method :is_public_holiday, :public_holiday?
+      alias_method :holiday?, :public_holiday?
+
+      def tithi_np
+        tithi&.nepali || ""
+      end
+
+      def tithi_en
+        tithi&.english || ""
+      end
+
+      def events_np
+        events.map(&:nepali)
+      end
+
+      def events_en
+        events.map(&:english)
+      end
+
+      def to_h
+        {
+          tithi: tithi&.to_h,
+          public_holiday: public_holiday?,
+          events: events.map(&:to_h)
+        }
+      end
+
+      def ==(other)
+        other.is_a?(CalendarInfo) &&
+          tithi == other.tithi &&
+          public_holiday? == other.public_holiday? &&
+          events == other.events
+      end
+      alias_method :eql?, :==
+
+      def hash
+        [CalendarInfo, tithi, public_holiday?, events].hash
+      end
+
+      def inspect
+        "#<NepDate::Patro::CalendarInfo tithi=#{tithi&.english.inspect} holiday=#{public_holiday?} " \
+          "events=#{events_en.inspect}>"
+      end
+    end
+  end
+end

data/lib/nepdate/patro/named.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module NepDate
+  module Patro
+    # A tithi or event name in both languages. +name+ selects one; +nepali+ and +english+ are
+    # always available.
+    class Named
+      attr_reader :nepali, :english
+
+      def initialize(nepali, english)
+        @nepali = String(nepali).freeze
+        @english = String(english).freeze
+        freeze
+      end
+
+      def name(lang: :en)
+        (Lang.coerce(lang) == :ne) ? nepali : english
+      end
+
+      def to_h
+        {np: nepali, en: english}
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && nepali == other.nepali && english == other.english
+      end
+      alias_method :eql?, :==
+
+      def hash
+        [self.class, nepali, english].hash
+      end
+
+      def to_s
+        english
+      end
+
+      def inspect
+        "#<#{self.class} #{english.inspect} / #{nepali.inspect}>"
+      end
+    end
+
+    # A lunar day name.
+    class Tithi < Named
+    end
+
+    # One almanac event, in file order when several share a day.
+    class Event < Named
+    end
+  end
+end