updates for version 1

Author: devries

README.md

@@ -1,9 +1,7 @@
 # tzif
 
-<!--#
-[![Package Version](https://img.shields.io/hexpm/v/timezone)](https://hex.pm/packages/timezone)
-[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/timezone/)
--->
+[![Package Version](https://img.shields.io/hexpm/v/tzif)](https://hex.pm/packages/tzif)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/tzif/)
 
 Time zone support for Gleam time using the IANA Time Zone Database.
 This package loads the time zone database from the standard location
@@ -18,13 +16,18 @@ of day in the given time zone.
 >
 > --- Louis Pilfold
 
-To use, add the following entry in your `gleam.toml` file dependencies:
-
+Add to your project with the command:
 ```
-tzif = { git = "[email protected]:devries/timezone.git", ref = "main" }
+gleam add tzif@1
 ```
 
 # Using the Package
+There are three modules in the `tzif` package:
+- `tzif/database` has utilities for loading the IANA Time Zone database.
+- `tzif/tzcalendar` has utilities for converting a [gleam_time](https://hexdocs.pm/gleam_time/)
+  timestamp into date and time of day in a time zone.
+- `tzif/parser` has functions and records for parsing TZif formatted data.
+
 The most straightforward use would be to load the database from the default
 location on the operating system, and then obtain a timestamp using the
 [gleam_time](https://hexdocs.pm/gleam_time/) package, and convert that timestamp
@@ -43,27 +46,30 @@ pub fn main() {
     let now = timestamp.system_time()
 
     // Load the database from the operating system
-    let db = database.load_from_os()
-
-    case tzcalendar.get_time_and_zone(now, "America/New_York", db) {
-        Ok(time_and_zone) -> {
-            // Successfully converted time to the requested time zone
-            io.println(
-                int.to_string(time_and_zone.time_of_day.hours)
-                |> string.pad_start(2, "0")
-                <> ":"
-                <> int.to_string(time_and_zone.time_of_day.minutes)
-                |> string.pad_start(2, "0")
-                <> ":"
-                <> int.to_string(time_and_zone.time_of_day.seconds)
-                |> string.pad_start(2, "0")
-                <> " "
-                <> time_and_zone.designation
-            )
+    case database.load_from_os() {
+        Ok(db) -> {
+            case tzcalendar.to_time_and_zone(now, "America/New_York", db) {
+                Ok(time_and_zone) -> {
+                    // Successfully converted time to the requested time zone
+                    io.println(
+                        int.to_string(time_and_zone.time_of_day.hours)
+                        |> string.pad_start(2, "0")
+                        <> ":"
+                        <> int.to_string(time_and_zone.time_of_day.minutes)
+                        |> string.pad_start(2, "0")
+                        <> ":"
+                        <> int.to_string(time_and_zone.time_of_day.seconds)
+                        |> string.pad_start(2, "0")
+                        <> " "
+                        <> time_and_zone.designation
+                    )
+                }
+                Error(database.ZoneNotFound) -> io.println("Time zone not found")
+                Error(database.ProcessingError) ->
+                    io.println("Error processing time zone conversion")
+            }
         }
-        Error(database.ZoneNotFound) -> io.println("Time zone not found")
-        Error(database.ProcessingError) -> io.println("Error processing time zone conversion")
-    }
+        Error(Nil) -> io.println("No parsable TZif files found.")
 }
 ```
 If you are on windows and have installed the IANA Time Zone Database, or want

examples/simple/src/simple.gleam

@@ -13,7 +13,7 @@ pub fn main() {
     Error(Nil) ->
       io.println("No parsable TZif files found in default location.")
     Ok(db) -> {
-      case tzcalendar.get_time_and_zone(now, "America/New_York", db) {
+      case tzcalendar.to_time_and_zone(now, "America/New_York", db) {
         Ok(time_and_zone) -> {
           // Successfully converted time to the requested time zone
           io.println(

examples/time_now/src/time_now.gleam

@@ -21,7 +21,7 @@ fn print_all_times(now: timestamp.Timestamp) -> Result(Nil, Nil) {
 
   database.get_available_timezones(db)
   |> list.map(fn(zone_name) {
-    case tzcalendar.get_time_and_zone(now, zone_name, db) {
+    case tzcalendar.to_time_and_zone(now, zone_name, db) {
       Ok(tiz) ->
         io.println(
           string.pad_end(zone_name <> ":", 40, " ") <> format_time(tiz),

gleam.toml

@@ -1,5 +1,5 @@
 name = "tzif"
-version = "0.2.0"
+version = "1.0.0"
 
 # Fill out these fields if you intend to generate HTML documentation or publish
 # your project to the Hex package manager.

src/tzif/database.gleam

@@ -10,7 +10,7 @@ import gleam/string
 import gleam/time/duration.{type Duration}
 import gleam/time/timestamp
 import simplifile
-import tzif/tzparser
+import tzif/parser
 
 /// Time Zone Database record. This is typically created by
 /// loading from the operating system with the `load_from_os`
@@ -20,7 +20,7 @@ import tzif/tzparser
 pub opaque type TzDatabase {
   TzDatabase(
     zone_names: List(String),
-    zone_data: dict.Dict(String, tzparser.TzFile),
+    zone_data: dict.Dict(String, parser.TzFile),
   )
 }
 
@@ -82,7 +82,7 @@ pub fn new() -> TzDatabase {
 pub fn add_tzfile(
   db: TzDatabase,
   zone_name: String,
-  tzfile: tzparser.TzFile,
+  tzfile: parser.TzFile,
 ) -> TzDatabase {
   let namelist = case dict.has_key(db.zone_data, zone_name) {
     True -> db.zone_names
@@ -94,7 +94,7 @@ pub fn add_tzfile(
 fn process_tzfile(
   filename: String,
   components_to_drop: Int,
-) -> Result(#(String, tzparser.TzFile), Nil) {
+) -> Result(#(String, parser.TzFile), Nil) {
   let zone_name =
     filepath.split(filename)
     |> list.drop(components_to_drop)
@@ -103,9 +103,7 @@ fn process_tzfile(
   use tzdata <- result.try(
     simplifile.read_bits(filename) |> result.replace_error(Nil),
   )
-  use timeinfo <- result.try(
-    tzparser.parse(tzdata) |> result.replace_error(Nil),
-  )
+  use timeinfo <- result.try(parser.parse(tzdata) |> result.replace_error(Nil))
 
   Ok(#(zone_name, timeinfo))
 }
@@ -117,12 +115,10 @@ pub fn get_available_timezones(db: TzDatabase) -> List(String) {
 }
 
 /// Time zone parameters record.
-/// - `offset` is the offset from UTC.
+/// - `offset` is the offset from UTC using [gleam_time](https://hexdocs.pm/gleam_time/gleam/time/duration.html#Duration)
+///   `Duration`.
 /// - `is_dst` indicates if it is daylight savings time
 /// - `designation` is the time zone designation
-/// This is the same information provided by a `TtInfo` record, but
-/// modified to use the [gleam_time](https://hexdocs.pm/gleam_time/index.html)
-/// duration type and a boolean for the daylight saving time indication.
 pub type ZoneParameters {
   ZoneParameters(offset: Duration, is_dst: Bool, designation: String)
 }
@@ -223,7 +219,7 @@ type TtSlice {
 }
 
 // Turn time zone fields into a list of timezone information slices
-fn create_slices(fields: tzparser.TzFileFields) -> List(TtSlice) {
+fn create_slices(fields: parser.TzFileFields) -> List(TtSlice) {
   let infos =
     list.zip(fields.ttinfos, fields.designations)
     |> list.index_map(fn(tup, idx) { #(idx, tup) })
@@ -246,7 +242,7 @@ fn create_slices(fields: tzparser.TzFileFields) -> List(TtSlice) {
   |> result.values
 }
 
-fn default_slice(fields: tzparser.TzFileFields) -> Result(TtSlice, Nil) {
+fn default_slice(fields: parser.TzFileFields) -> Result(TtSlice, Nil) {
   use ttinfo <- result.try(list.first(fields.ttinfos))
   use designation <- result.try(list.first(fields.designations))
   let isdst = case ttinfo.isdst {

src/tzif/tzparser.gleam src/tzif/parser.gleamsrc/tzif/tzparser.gleam renamed to src/tzif/parser.gleam

@@ -50,7 +50,7 @@ pub type TimeAndZone {
 /// let ts = timestamp.from_unix_seconds(1_758_223_300)
 /// let assert Ok(db) = database.load_from_os()
 /// 
-/// get_time_and_zone(ts, "America/New_York", db)
+/// to_time_and_zone(ts, "America/New_York", db)
 /// // Ok(TimeInZone(
 /// //   Date(2025, September, 18),
 /// //   TimeOfDay(15, 21, 40, 0),
@@ -59,7 +59,7 @@ pub type TimeAndZone {
 /// //   True,
 /// // ))
 /// ```
-pub fn get_time_and_zone(
+pub fn to_time_and_zone(
   ts: Timestamp,
   zone_name: String,
   db: TzDatabase,
@@ -104,7 +104,7 @@ pub fn to_calendar(
   zone_name: String,
   db: TzDatabase,
 ) -> Result(#(calendar.Date, calendar.TimeOfDay), TzDatabaseError) {
-  use tiz <- result.map(get_time_and_zone(ts, zone_name, db))
+  use tiz <- result.map(to_time_and_zone(ts, zone_name, db))
 
   #(tiz.date, tiz.time_of_day)
 }

src/tzif/tzcalendar.gleam

@@ -3,7 +3,7 @@ import gleam/list
 import gleam/time/duration
 import gleam/time/timestamp
 import tzif/database
-import tzif/tzparser
+import tzif/parser
 
 const tzsample = "VFppZjIAAAAAAAAAAAAAAAAAAAAAAAAGAAAABgAAAAAAAADsAAAABgAAABSAAAAAnqYecJ+662CghgBwoZrNYKJl4nCjg+ngpGqucKU1p2CmU8rwpxWJYKgzrPCo/qXgqhOO8Kreh+Cr83DwrL5p4K3TUvCunkvgr7M08LB+LeCxnFFwsmdKYLN8M3C0RyxgtVwVcLYnDmC3O/dwuAbwYLkb2XC55tJguwT18LvGtGC85Nfwva/Q4L7EufC/j7LgwKSb8MFvlODChH3ww0924MRkX/DFL1jgxk18cMcPOuDILV5wyPhXYMoNQHDK2Dlgy4jwcNIj9HDSYPvg03Xk8NRA3eDVVcbw1iC/4Nc1qPDYAKHg2RWK8Nngg+Da/qdw28Bl4NzeiXDdqYJg3r5rcN+JZGDgnk1w4WlGYOJ+L3DjSShg5F4RcOVXLuDmRy3w5zcQ4OgnD/DpFvLg6gbx8Or21ODr5tPw7Na24O3GtfDuv9Ng76/ScPCftWDxj7Rw8n+XYPNvlnD0X3lg9U94cPY/W2D3L1pw+Ch34PkPPHD6CFng+vhY8PvoO+D82Drw/cgd4P64HPD/p//gAJf+8AGH4eACd+DwA3D+YARg/XAFUOBgBkDfcAcwwmAHjRlwCRCkYAmtlPAK8IZgC+CFcAzZouANwGdwDrmE4A+pg/AQmWbgEYll8BJ5SOATaUfwFFkq4BVJKfAWOQzgFykL8BgiKWAZCO3wGgILYBryCnAb4e1gHNHscB3Bz2Aesc5wH6GxYCB2APAhgZNgIlXi8CNqr+AkNcTwJUqR4CYVpvAnKnPgJ/7DcCkKVeAp3qVwKuo34Cu+h3As01RgLZ5pcC6zNmAvfktwMJMYYDFnZ/AycvpgM0dJ8DRS3GA1JyvwNjK+YDcHDfA4G9rgOObv8Dn7vOA6xtHwO9ue4Dyv7nA9u4DgPo/QcD+bYuBAb7JwQYR/YEJPlHBDZGFgRC92cEVEQ2BF86jwRy1f4EfTivBJDUHgSbNs8ErtI+BLnIlwTNZAYE18a3BOtiJgT1xNcFCWBGBRPC9wUnXmYFMcEXBUVchgVPvzcFY1qmBW5Q/wWB7G4FjE8fBZ/qjgWqTT8FveiuBchLXwXb5s4F5kl/Bfnk7gYE20cGGHa2BiLZZwY2dNYGQNeHBlRy9gZe1acGcnEWBnzTxwaQbzYGmtHnBq5tVga5Y68GzP8eBtdhzwbq/T4G9V/vBwj7XgcTXg8HJvl+BzFcLwdE954HT+33B2OJZgdt7BcHgYeGB4vqNwefhaYHqehXB72DxgfH5ncH24HmB+Xklwf5gAYAMBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIEBQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgEC//+6ngAA///HwAEE//+5sAAI//+5sAAI///HwAEM///HwAEQTE1UAEVEVABFU1QARVdUAEVQVAAAAAABAAEAAAABAAFUWmlmMgAAAAAAAAAAAAAAAAAAAAAAAAYAAAAGAAAAAAAAAOwAAAAGAAAAFP////9eA/CQ/////56mHnD/////n7rrYP////+ghgBw/////6GazWD/////omXicP////+jg+ng/////6RqrnD/////pTWnYP////+mU8rw/////6cViWD/////qDOs8P////+o/qXg/////6oTjvD/////qt6H4P////+r83Dw/////6y+aeD/////rdNS8P////+unkvg/////6+zNPD/////sH4t4P////+xnFFw/////7JnSmD/////s3wzcP////+0Ryxg/////7VcFXD/////ticOYP////+3O/dw/////7gG8GD/////uRvZcP////+55tJg/////7sE9fD/////u8a0YP////+85Nfw/////72v0OD/////vsS58P////+/j7Lg/////8Ckm/D/////wW+U4P/////ChH3w/////8NPduD/////xGRf8P/////FL1jg/////8ZNfHD/////xw864P/////ILV5w/////8j4V2D/////yg1AcP/////K2Dlg/////8uI8HD/////0iP0cP/////SYPvg/////9N15PD/////1EDd4P/////VVcbw/////9Ygv+D/////1zWo8P/////YAKHg/////9kVivD/////2eCD4P/////a/qdw/////9vAZeD/////3N6JcP/////dqYJg/////96+a3D/////34lkYP/////gnk1w/////+FpRmD/////4n4vcP/////jSShg/////+ReEXD/////5Vcu4P/////mRy3w/////+c3EOD/////6CcP8P/////pFvLg/////+oG8fD/////6vbU4P/////r5tPw/////+zWtuD/////7ca18P/////uv9Ng/////++v0nD/////8J+1YP/////xj7Rw//////J/l2D/////82+WcP/////0X3lg//////VPeHD/////9j9bYP/////3L1pw//////god+D/////+Q88cP/////6CFng//////r4WPD/////++g74P/////82Drw//////3IHeD//////rgc8P//////p//gAAAAAACX/vAAAAAAAYfh4AAAAAACd+DwAAAAAANw/mAAAAAABGD9cAAAAAAFUOBgAAAAAAZA33AAAAAABzDCYAAAAAAHjRlwAAAAAAkQpGAAAAAACa2U8AAAAAAK8IZgAAAAAAvghXAAAAAADNmi4AAAAAANwGdwAAAAAA65hOAAAAAAD6mD8AAAAAAQmWbgAAAAABGJZfAAAAAAEnlI4AAAAAATaUfwAAAAABRZKuAAAAAAFUkp8AAAAAAWOQzgAAAAABcpC/AAAAAAGCIpYAAAAAAZCO3wAAAAABoCC2AAAAAAGvIKcAAAAAAb4e1gAAAAABzR7HAAAAAAHcHPYAAAAAAesc5wAAAAAB+hsWAAAAAAIHYA8AAAAAAhgZNgAAAAACJV4vAAAAAAI2qv4AAAAAAkNcTwAAAAACVKkeAAAAAAJhWm8AAAAAAnKnPgAAAAACf+w3AAAAAAKQpV4AAAAAAp3qVwAAAAACrqN+AAAAAAK76HcAAAAAAs01RgAAAAAC2eaXAAAAAALrM2YAAAAAAvfktwAAAAADCTGGAAAAAAMWdn8AAAAAAycvpgAAAAADNHSfAAAAAANFLcYAAAAAA1JyvwAAAAADYyvmAAAAAANwcN8AAAAAA4G9rgAAAAADjm7/AAAAAAOfu84AAAAAA6xtHwAAAAADvbnuAAAAAAPK/ucAAAAAA9u4DgAAAAAD6P0HAAAAAAP5ti4AAAAABAb7JwAAAAAEGEf2AAAAAAQk+UcAAAAABDZGFgAAAAAEQvdnAAAAAARURDYAAAAABF86jwAAAAAEctX+AAAAAAR9OK8AAAAABJDUHgAAAAAEmzbPAAAAAASu0j4AAAAABLnIlwAAAAAEzWQGAAAAAATXxrcAAAAABOtiJgAAAAAE9cTXAAAAAAUJYEYAAAAABRPC9wAAAAAFJ15mAAAAAAUxwRcAAAAABUVchgAAAAAFT783AAAAAAVjWqYAAAAABW5Q/wAAAAAFgexuAAAAAAWMTx8AAAAABZ/qjgAAAAAFqk0/AAAAAAW96K4AAAAABchLXwAAAAAF2+bOAAAAAAXmSX8AAAAABfnk7gAAAAAGBNtHAAAAAAYYdrYAAAAABiLZZwAAAAAGNnTWAAAAAAZA14cAAAAABlRy9gAAAAAGXtWnAAAAAAZycRYAAAAABnzTxwAAAAAGkG82AAAAAAaa0ecAAAAABq5tVgAAAAAGuWOvAAAAAAbM/x4AAAAABtdhzwAAAAAG6v0+AAAAAAb1X+8AAAAABwj7XgAAAAAHE14PAAAAAAcm+X4AAAAABzFcLwAAAAAHRPeeAAAAAAdP7fcAAAAAB2OJZgAAAAAHbewXAAAAAAeBh4YAAAAAB4vqNwAAAAAHn4WmAAAAAAep6FcAAAAAB72DxgAAAAAHx+Z3AAAAAAfbgeYAAAAAB+XklwAAAAAH+YAGADAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECBAUCAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIBAv//up4AAP//x8ABBP//ubAACP//ubAACP//x8ABDP//x8ABEExNVABFRFQARVNUAEVXVABFUFQAAAAAAQABAAAAAQABCkVTVDVFRFQsTTMuMi4wLE0xMS4xLjAK"
 
@@ -13,13 +13,13 @@ const right_utc_sample = "VFppZjIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABsAAAABAAAAAQ
 
 fn get_database() -> database.TzDatabase {
   let assert Ok(tzdata) = bit_array.base64_decode(tzsample)
-  let assert Ok(tz_ny) = tzparser.parse(tzdata)
+  let assert Ok(tz_ny) = parser.parse(tzdata)
 
   let assert Ok(tzdata2) = bit_array.base64_decode(tzsample2)
-  let assert Ok(tz_utc) = tzparser.parse(tzdata2)
+  let assert Ok(tz_utc) = parser.parse(tzdata2)
 
   let assert Ok(tzdata3) = bit_array.base64_decode(right_utc_sample)
-  let assert Ok(tz_right_utc) = tzparser.parse(tzdata3)
+  let assert Ok(tz_right_utc) = parser.parse(tzdata3)
 
   database.new()
   |> database.add_tzfile("America/New_York", tz_ny)