nepdate-patro 1.0.0.rc.1

data/lib/nepdate/patro/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NepDate
+  module Patro
+    VERSION = "1.0.0.rc.1"
+  end
+end

data/lib/nepdate/patro.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "nepdate"
+require_relative "patro/version"
+require_relative "patro/table"
+require_relative "patro/named"
+require_relative "patro/calendar_info"
+
+module NepDate
+  # The patro (पात्रो, the Nepali almanac): tithi, public holidays and events per BS day. It is
+  # a separate gem that depends on +nepdate+; the core gem has no almanac data.
+  module Patro
+    # Builds one immutable CalendarInfo per coverage day, sharing the tithi and event objects. A
+    # lookup is then an array read, as in the Python port, instead of a binary search and three
+    # allocations per call.
+    def self.build_day_info(serial, holiday, event_days)
+      tithi = if serial.between?(Table::TITHI_FIRST_SERIAL, Table::TITHI_LAST_SERIAL)
+        TITHI_OBJECTS[Table::TITHI_INDEX[serial - Table::TITHI_FIRST_SERIAL]]
+      end
+      public_holiday = holiday.key?(serial)
+      events = EMPTY_EVENTS
+      position = event_days[serial]
+      if position
+        first = Table::EVENT_START[position]
+        last = Table::EVENT_START[position + 1]
+        events = Array.new(last - first) { |offset| EVENT_OBJECTS[Table::EVENTS_FLAT[first + offset]] }
+      end
+
+      if tithi.nil? && !public_holiday && events.empty?
+        EMPTY_INFO
+      else
+        CalendarInfo.new(tithi: tithi, public_holiday: public_holiday, events: events)
+      end
+    end
+    private_class_method :build_day_info
+
+    TITHI_OBJECTS = Table::NAMES.map { |nepali, english| Tithi.new(nepali, english) }.freeze
+    EVENT_OBJECTS = Table::NAMES.map { |nepali, english| Event.new(nepali, english) }.freeze
+    EMPTY_EVENTS = [].freeze
+    EMPTY_INFO = CalendarInfo.new
+    DAY_INFO = begin
+      holiday = {}
+      Table::HOLIDAY_SERIALS.each { |serial| holiday[serial] = true }
+      event_days = {}
+      Table::EVENT_DAY_SERIALS.each_with_index { |serial, index| event_days[serial] = index }
+      info = Array.new(CalendarTable::TOTAL_DAYS, EMPTY_INFO)
+      (Table::FIRST_SERIAL..Table::LAST_SERIAL).each do |serial|
+        info[serial] = build_day_info(serial, holiday, event_days)
+      end
+      info.freeze
+    end
+    COVERAGE = NepDate::DateRange.new(
+      NepDate::Date.from_serial(Table::FIRST_SERIAL),
+      NepDate::Date.from_serial(Table::LAST_SERIAL)
+    )
+
+    class << self
+      # Everything the patro knows about +date+, never nil for the date itself. A day without
+      # data returns a nil tithi, a false holiday flag and no events.
+      def info(date)
+        raise TypeError, "expected a NepDate::Date, got #{date.class}" unless date.is_a?(NepDate::Date)
+
+        DAY_INFO[date.serial]
+      end
+      alias_method :of, :info
+
+      # The smallest BS range containing every day with tithi, holiday or event data.
+      def coverage
+        COVERAGE
+      end
+
+      # Every gazetted public holiday, ascending.
+      def public_holidays
+        Table::HOLIDAY_SERIALS.map { |serial| NepDate::Date.from_serial(serial) }
+      end
+    end
+  end
+end
+
+module NepDate
+  class Date
+    # One lookup returning the tithi, holiday flag and events of this date. It comes from the
+    # patro gem, so the core has no reference to it (D-13).
+    def calendar_info
+      Patro.info(self)
+    end
+  end
+end

data/sig/nepdate-patro.rbs

@@ -0,0 +1,58 @@
+module NepDate
+  module Patro
+    VERSION: String
+
+    module Lookup
+      def self.index_of: (Array[Integer], Integer) -> Integer?
+      def self.include?: (Array[Integer], Integer) -> bool
+    end
+
+    class Named
+      attr_reader nepali: String
+      attr_reader english: String
+
+      def initialize: (String, String) -> void
+      def name: (?lang: Symbol | String) -> String
+      def to_h: () -> Hash[Symbol, String]
+      def ==: (untyped) -> bool
+      def eql?: (untyped) -> bool
+      def hash: () -> Integer
+      def to_s: () -> String
+      def inspect: () -> String
+    end
+
+    class Tithi < Named
+    end
+
+    class Event < Named
+    end
+
+    class CalendarInfo
+      attr_reader tithi: Tithi?
+      attr_reader events: Array[Event]
+
+      def initialize: (?tithi: Tithi?, ?public_holiday: bool, ?events: Array[Event]) -> void
+      def public_holiday?: () -> bool
+      def is_public_holiday: () -> bool
+      def holiday?: () -> bool
+      def tithi_np: () -> String
+      def tithi_en: () -> String
+      def events_np: () -> Array[String]
+      def events_en: () -> Array[String]
+      def to_h: () -> Hash[Symbol, untyped]
+      def ==: (untyped) -> bool
+      def eql?: (untyped) -> bool
+      def hash: () -> Integer
+      def inspect: () -> String
+    end
+
+    def self.info: (NepDate::Date) -> CalendarInfo
+    def self.of: (NepDate::Date) -> CalendarInfo
+    def self.coverage: () -> NepDate::DateRange
+    def self.public_holidays: () -> Array[NepDate::Date]
+  end
+
+  class Date
+    def calendar_info: () -> NepDate::Patro::CalendarInfo
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: nepdate-patro
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc.1
+platform: ruby
+authors:
+- Sanam Pakuwal
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nepdate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc.1
+description: |
+  The patro (पात्रो, the Nepali almanac) as a separate gem for NepDate for Ruby. It answers the
+  tithi, the gazetted holiday flag and the ordered event list for every covered BS date, with
+  the data compiled into the gem. It depends on nepdate and the core has no almanac data.
+email:
+- 31341013+sanamhub@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- NOTICE
+- README.md
+- lib/nepdate/patro.rb
+- lib/nepdate/patro/calendar_info.rb
+- lib/nepdate/patro/named.rb
+- lib/nepdate/patro/table.rb
+- lib/nepdate/patro/version.rb
+- sig/nepdate-patro.rbs
+homepage: https://nepdate.com
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/sanamhub/nepdate-ruby/issues
+  changelog_uri: https://github.com/sanamhub/nepdate-ruby/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/sanamhub/nepdate-ruby/blob/main/docs/API.md
+  homepage_uri: https://nepdate.com
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/sanamhub/nepdate-ruby
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: 'The Nepali patro for Ruby: tithi, public holidays and events for Bikram
+  Sambat dates'
+test_files: []