chore: renamed rrule_parser -> rrule_codec

Author: chrishop

.github/workflows/release.yaml

@@ -52,12 +52,12 @@ jobs:
         id: build-crate
         uses: philss/rustler-precompiled-action@v1.0.1
         with:
-          project-name: rrule_parser_rs
+          project-name: rrule_codec_rs
           project-version: ${{ env.PROJECT_VERSION }}
           target: ${{ matrix.job.target }}
           nif-version: ${{ matrix.nif }}
           use-cross: ${{ matrix.job.use-cross }}
-          project-dir: "native/rrule_parser_rs"
+          project-dir: "native/rrule_codec_rs"
 
       - name: Artifact upload
         uses: actions/upload-artifact@v4

.gitignore

@@ -20,13 +20,17 @@ erl_crash.dump
 *.ez
 
 # Ignore package tarball (built via "mix hex.build").
-RruleParser-*.tar
+rrule_codec-*.tar
 
 # Temporary files, for example, from tests.
 /tmp/
 
 /.elixir_ls
 
-checksum-Elixir.RruleParser.Rrule.Api.exs
+checksum-Elixir.RruleCodec.Rrule.Api.exs
+
+priv/native/*.so
+priv/native/*.dll
+priv/native/*.dylib
 
 .envrc

README.md

@@ -1,26 +1,26 @@
-# RruleParser
+# RruleCodec
 
 **Description**
 Rrule parsing and utils based on rust nif
 
 - https://docs.rs/rrule/latest/rrule/index.html
 - https://github.com/fmeringdal/rust-rrule
 
-Only does this for now: RruleParser.Rrule.next("DTSTART;TZID=Etc/UTC:20191220T020000\nRRULE:FREQ=MONTHLY;BYMONTHDAY=28,29,30,31;BYSETPOS=-1", 10)
+Only does this for now: RruleCodec.Rrule.next("DTSTART;TZID=Etc/UTC:20191220T020000\nRRULE:FREQ=MONTHLY;BYMONTHDAY=28,29,30,31;BYSETPOS=-1", 10)
 ## Installation
 
 If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `RruleParser` to your list of dependencies in `mix.exs`:
+by adding `rrule_codec` to your list of dependencies in `mix.exs`:
 
 ```elixir
 def deps do
   [
-    {:rrule_parser, "~> 0.1.0"}
+    {:rrule_codec, "~> 0.1.0"}
   ]
 end
 ```
 
 Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
 and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
-be found at <https://hexdocs.pm/RruleParser>.
+be found at <https://hexdocs.pm/rrule_codec>.
 

lib/rrule_parser/api.ex lib/rrule_codec/api.exlib/rrule_parser/api.ex renamed to lib/rrule_codec/api.ex

@@ -1,4 +1,4 @@
-defmodule RruleParser.Rrule.Api do
+defmodule RruleCodec.Rrule.Api do
   @moduledoc """
   Rrule parsing and utility functions using precompiled Rust NIF from https://github.com/fmeringdal/rust-rrule
 
@@ -13,7 +13,7 @@ defmodule RruleParser.Rrule.Api do
   ## Examples
 
       # Parse an RRULE string into a structured Elixir type
-      iex> rrule = RruleParser.Rrule.Api.string_to_rrule("FREQ=DAILY;INTERVAL=2;COUNT=10")
+      iex> rrule = RruleCodec.Rrule.Api.string_to_rrule("FREQ=DAILY;INTERVAL=2;COUNT=10")
       iex> rrule.freq
       :daily
       iex> rrule.interval
@@ -22,17 +22,17 @@ defmodule RruleParser.Rrule.Api do
       10
 
       # Convert an Elixir struct back to an RRULE string
-      iex> rrule = %RruleParser.Rrule{freq: :weekly, interval: 1, by_weekday: ["MO", "WE", "FR"]}
-      iex> RruleParser.Rrule.Api.rrule_to_string(rrule)
+      iex> rrule = %RruleCodec.Rrule{freq: :weekly, interval: 1, by_weekday: ["MO", "WE", "FR"]}
+      iex> RruleCodec.Rrule.Api.rrule_to_string(rrule)
       "FREQ=WEEKLY;BYDAY=MO,WE,FR"
 
       # Validate an RRULE against a start date
-      iex> rrule = %RruleParser.Rrule{freq: :monthly, interval: 1, by_month_day: [24]}
-      iex> RruleParser.Rrule.Api.validate_rrule(rrule, "2023-04-01T00:00:00Z")
+      iex> rrule = %RruleCodec.Rrule{freq: :monthly, interval: 1, by_month_day: [24]}
+      iex> RruleCodec.Rrule.Api.validate_rrule(rrule, "2023-04-01T00:00:00Z")
       :ok
 
-      iex> rrule = %RruleParser.Rrule{freq: :monthly, interval: 1, by_month_day: [32]}
-      iex> RruleParser.Rrule.Api.validate_rrule(rrule, "2023-02-01T00:00:00Z")
+      iex> rrule = %RruleCodec.Rrule{freq: :monthly, interval: 1, by_month_day: [32]}
+      iex> RruleCodec.Rrule.Api.validate_rrule(rrule, "2023-02-01T00:00:00Z")
       {:error, "Error validating rrule: February doesn't have 32 days"}
   """
 
@@ -50,15 +50,15 @@ defmodule RruleParser.Rrule.Api do
   )
 
   use RustlerPrecompiled,
-    otp_app: :rrule_parser,
-    crate: "rrule_parser_rs",
+    otp_app: :rrule_codec,
+    crate: "rrule_codec_rs",
     base_url: "#{github_url}/releases/download/v#{version}",
     force_build: System.get_env("RRULE_BUILD") in ["1", "true"],
     version: version,
     targets: targets
 
   @doc """
-  Parses an RFC 5545 RRULE string into a structured `RruleParser.Rrule` struct.
+  Parses an RFC 5545 RRULE string into a structured `RruleCodec.Rrule` struct.
 
   This function takes a string representation of a recurrence rule (RRULE) as defined in RFC 5545
   and converts it into a structured Elixir struct that can be used in your application.
@@ -69,31 +69,31 @@ defmodule RruleParser.Rrule.Api do
 
   ## Returns
 
-    * `{:ok, %RruleParser.Rrule{}}` - A structured representation of the RRULE if parsing succeeds
+    * `{:ok, %RruleCodec.Rrule{}}` - A structured representation of the RRULE if parsing succeeds
     * `{:error, reason}` - An error if the RRULE string is malformed or contains invalid values
 
   ## Examples
 
-      iex> RruleParser.Rrule.Api.string_to_rrule("FREQ=DAILY;INTERVAL=2;COUNT=10")
-      {:ok, %RruleParser.Rrule{freq: "Daily", interval: 2, count: 10}}
+      iex> RruleCodec.Rrule.Api.string_to_rrule("FREQ=DAILY;INTERVAL=2;COUNT=10")
+      {:ok, %RruleCodec.Rrule{freq: "Daily", interval: 2, count: 10}}
 
-      iex> RruleParser.Rrule.Api.string_to_rrule("FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR")
-      {:ok, %RruleParser.Rrule{freq: "Weekly", interval: 1, by_weekday: ["MO", "WE", "FR"]}}
+      iex> RruleCodec.Rrule.Api.string_to_rrule("FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR")
+      {:ok, %RruleCodec.Rrule{freq: "Weekly", interval: 1, by_weekday: ["MO", "WE", "FR"]}}
 
-      iex> RruleParser.Rrule.Api.string_to_rrule("INVALID")
+      iex> RruleCodec.Rrule.Api.string_to_rrule("INVALID")
       {:error, "Error parsing rrule: Invalid format"}
   """
   def string_to_rrule(_rrule_string), do: error()
 
   @doc """
-  Converts an `RruleParser.Rrule` struct back into an RFC 5545 RRULE string.
+  Converts an `RruleCodec.Rrule` struct back into an RFC 5545 RRULE string.
 
   This function takes an Elixir struct that represents a recurrence rule and
   converts it back into a string representation that follows the RFC 5545 RRULE format.
 
   ## Parameters
 
-    * `rrule_struct` - An `RruleParser.Rrule` struct containing the RRULE parameters
+    * `rrule_struct` - An `RruleCodec.Rrule` struct containing the RRULE parameters
 
   ## Returns
 
@@ -102,30 +102,30 @@ defmodule RruleParser.Rrule.Api do
 
   ## Examples
 
-      iex> rrule = %RruleParser.Rrule{freq: "Daily", interval: 2, count: 10}
-      iex> RruleParser.Rrule.Api.rrule_to_string(rrule)
+      iex> rrule = %RruleCodec.Rrule{freq: "Daily", interval: 2, count: 10}
+      iex> RruleCodec.Rrule.Api.rrule_to_string(rrule)
       {:ok, "FREQ=DAILY;INTERVAL=2;COUNT=10"}
 
-      iex> rrule = %RruleParser.Rrule{freq: "Weekly", interval: 1, by_weekday: ["MO", "WE", "FR"]}
-      iex> RruleParser.Rrule.Api.rrule_to_string(rrule)
+      iex> rrule = %RruleCodec.Rrule{freq: "Weekly", interval: 1, by_weekday: ["MO", "WE", "FR"]}
+      iex> RruleCodec.Rrule.Api.rrule_to_string(rrule)
       {:ok, "FREQ=WEEKLY;BYDAY=MO,WE,FR"}
 
-      iex> rrule = %RruleParser.Rrule{freq: "InvalidFreq", interval: 1}
-      iex> RruleParser.Rrule.Api.rrule_to_string(rrule)
+      iex> rrule = %RruleCodec.Rrule{freq: "InvalidFreq", interval: 1}
+      iex> RruleCodec.Rrule.Api.rrule_to_string(rrule)
       {:error, "Error converting properties to rrule: Invalid frequency: InvalidFreq"}
   """
   def rrule_to_string(_rrule_struct), do: error()
 
   @doc """
   Validates if a recurrence rule is properly formed with respect to a start date.
 
-  This function checks if the given `RruleParser.Rrule` struct represents a valid recurrence rule
+  This function checks if the given `RruleCodec.Rrule` struct represents a valid recurrence rule
   when combined with the provided start date. The validation includes checking if all
   rule components are consistent with each other and with the start date.
 
   ## Parameters
 
-    * `rrule_struct` - An `RruleParser.Rrule` struct containing the RRULE parameters
+    * `rrule_struct` - An `RruleCodec.Rrule` struct containing the RRULE parameters
     * `dt_start` - A string containing an RFC 3339 formatted date-time for the rule's start date
 
   ## Returns
@@ -135,16 +135,16 @@ defmodule RruleParser.Rrule.Api do
 
   ## Examples
 
-      iex> rrule = %RruleParser.Rrule{freq: "Monthly", interval: 1, by_month_day: [22]}
-      iex> RruleParser.Rrule.Api.validate_rrule(rrule, "2023-04-01T00:00:00Z")
+      iex> rrule = %RruleCodec.Rrule{freq: "Monthly", interval: 1, by_month_day: [22]}
+      iex> RruleCodec.Rrule.Api.validate_rrule(rrule, "2023-04-01T00:00:00Z")
       :ok
 
-      iex> rrule = %RruleParser.Rrule{freq: "Monthly", interval: 1, by_month_day: [-1]}
-      iex> RruleParser.Rrule.Api.validate_rrule(rrule, "2023-02-01T00:00:00Z")
+      iex> rrule = %RruleCodec.Rrule{freq: "Monthly", interval: 1, by_month_day: [-1]}
+      iex> RruleCodec.Rrule.Api.validate_rrule(rrule, "2023-02-01T00:00:00Z")
       {:error, "Error validating rrule: February doesn't have -1 days"}
 
-      iex> rrule = %RruleParser.Rrule{freq: "Monthly", interval: 1}
-      iex> RruleParser.Rrule.Api.validate_rrule(rrule, "invalid-date")
+      iex> rrule = %RruleCodec.Rrule{freq: "Monthly", interval: 1}
+      iex> RruleCodec.Rrule.Api.validate_rrule(rrule, "invalid-date")
       {:error, "Invalid datetime: invalid-date"}
   """
   def validate_rrule(_rrule_struct, _dt_start), do: error()