0.3.0 (#9)

* * Added `toml.decodeFromFile`, `toml.encodeToFile`.

* Renamed  `toml.tomlToJSON` and `toml.tomlToYAML` to `toml.toJSON` and `toml.toYAML`

* Add tests for the property accessors of `toml.Date`, `toml.Time`, `toml.DateTime`, and `toml.TimeOffset`, and for `toml.toJSON` and `toml.toYAML`

Author: LebJe

.busted

@@ -7,6 +7,7 @@ repos:
           - id: "prettier"
             name: "Format YAML & Markdown"
             tags: ["md"]
+            exclude: "tests/test-data"
     - repo: "https://github.com/doublify/pre-commit-clang-format.git"
       rev: "62302476d0da01515660132d76902359bed0f782"
       hooks:

.pre-commit-config.yaml

@@ -5,6 +5,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.0](https://github.com/LebJe/toml.lua/releases/tag/0.2.0) - 2023-02-19
+
+### Added
+
+-   `toml.decodeFromFile(filePath: string)`:
+    -   Decodes a TOML document at `filePath`. Throws the same errors as `toml.decode`.
+-   `toml.encodeToFile(data: table, fileOrOptions: string|table)`:
+    -   Encodes `data` to the file specified in `fileOrOptions`. the file will be created if it doesn't exist.
+        -   When `fileOrOptions` is a string, it simply is the file path.
+        -   When `fileOrOptions` is a table, it should have`file`, and optionally, `overwrite` as keys. `file` is the file path, and `overwrite` should be `true` when `file` should be `overwritten` with `data`, and `false` when `data` should be appended to `file`.
+-   Added tests that cover:
+    -   The property accessors of `toml.Date`, `toml.Time`, `toml.DateTime`, and `toml.TimeOffset`.
+    -   `toml.toJSON` and `toml.toYAML`.
+
+### Changed
+
+-   `toml.tomlToJSON` and `toml.tomlToYAML` have been renamed to `toml.toJSON` and `toml.toYAML`.
+    -   They have been renamed because they now have two functions: converting a TOML string to JSON/YAML (as before), or converting a table into JSON/YAML.
+    -   The first parameter can be a string containing TOML (as before), or a table.
+
 ## [0.2.0](https://github.com/LebJe/toml.lua/releases/tag/0.2.0) - 2023-02-12
 
 ### Added

CHANGELOG.md

@@ -6,7 +6,7 @@
 [![Build and Test on Linux](https://github.com/LebJe/toml.lua/actions/workflows/buildAndTest-Linux.yml/badge.svg)](https://github.com/LebJe/toml.lua/actions/workflows/buildAndTest-Linux.yml)
 [![Build and Test on Windows](https://github.com/LebJe/toml.lua/actions/workflows/buildAndTest-Windows.yml/badge.svg)](https://github.com/LebJe/toml.lua/actions/workflows/buildAndTest-Windows.yml)
 
-toml.lua is a [Lua](https://www.lua.org) wrapper around [toml++](https://github.com/marzer/tomlplusplus/), allowing you to parse and serialize [TOML](https://toml.io) files in Lua.
+toml.lua is a [Lua](https://www.lua.org) wrapper around [toml++](https://github.com/marzer/tomlplusplus/), allowing you to parse and serialize [TOML](https://toml.io) in Lua.
 
 ## Table of Contents
 
@@ -33,18 +33,18 @@ toml.lua is a [Lua](https://www.lua.org) wrapper around [toml++](https://github.
                 -   [temporalTypesAsUserData](#temporaltypesasuserdata)
         -   [Encoding](#encoding)
         -   [Error Handling](#error-handling)
+        -   [Inline Tables](#inline-tables)
         -   [TOML Conversion](#toml-conversion)
             -   [JSON](#json)
             -   [YAML](#yaml)
-        -   [Inline Tables](#inline-tables)
         -   [Output Formatting](#output-formatting)
-            -   [Formatting TOML, JSON, YAML](#formatting-toml-json-yaml)
+            -   [Formatting TOML, JSON, or YAML](#formatting-toml-json-or-yaml)
         -   [Date and Time](#date-and-time)
     -   [Dependencies](#dependencies)
     -   [Licenses](#licenses)
     -   [Contributing](#contributing)
 
-<!-- Added by: lebje, at: Sun Feb 12 09:15:16 EST 2023 -->
+<!-- Added by: lebje, at: Sun Feb 19 22:27:48 EST 2023 -->
 
 <!--te-->
 
@@ -167,8 +167,12 @@ i = 1979-05-27T07:32:00-07:00
 local toml = require("toml")
 local inspect = require("inspect")
 
+-- Decode from string
 local succeeded, table = pcall(toml.decode, tomlStr)
 
+-- Decode from file
+succeeded, table = pcall(toml.decodeFromFile, "configuration.toml")
+
 if succeeded then
 -- Use `table`.
 	print(inspect(table))
@@ -290,9 +294,22 @@ local table = {
 	inlineTable = inlineTable
 }
 
-local tomlDocument = toml.encode(table)
+-- Encode to string
+local succeeded, documentOrErrorMessage = pcall(toml.encode, table)
 
-print(tomlDocument)
+-- Encode to file, this will **append** to the file.
+succeeded, documentOrErrorMessage = pcall(toml.encodeToFile, table, "configuration.toml")
+
+-- Encode to file, this will **overwrite** the file.
+succeeded, documentOrErrorMessage = pcall(toml.encodeToFile, table, { file = "configuration.toml", overwrite = true })
+
+if succeeded then
+	-- Successfully encoded to string / wrote to file
+	print(tomlDocumentOrErrorMessage)
+else
+-- Error occurred
+	print(tomlDocumentOrErrorMessage)
+end
 
 --[[
 inlineTable = { a = 1275892, b = "Hello, World!", c = true, d = 124.2548 }
@@ -349,6 +366,10 @@ else
 end
 ```
 
+### Inline Tables
+
+Use `setmetatable(myTable, { inline = true })` to create an [inline table](https://toml.io/en/v1.0.0#inline-table).
+
 ### TOML Conversion
 
 ```lua
@@ -371,21 +392,23 @@ i = 1979-05-27T07:32:00-07:00
 #### JSON
 
 ```lua
-local json = toml.tomlToJSON(tomlStr)
+-- Convert from a string
+local json = toml.toJSON(tomlStr)
+
+-- or from a table
+json = toml.toJSON(toml.decode(tomlStr))
+
 print(json)
 ```
 
 #### YAML
 
 ```lua
-local yaml = toml.tomlToYAML(tomlStr)
+local yaml = toml.toYAML(tomlStr)
+yaml = toml.toYAML(toml.decode(tomlStr))
 print(yaml)
 ```
 
-### Inline Tables
-
-Use `setmetatable(myTable, { inline = true })` to create an [inline table](https://toml.io/en/v1.0.0#inline-table).
-
 ### Output Formatting
 
 <!---
@@ -422,9 +445,9 @@ int3 = 0x169F
 ```
 -->
 
-#### Formatting TOML, JSON, YAML
+#### Formatting TOML, JSON, or YAML
 
-`toml.encode`, `toml.tomlToJSON`, and `toml.tomlToYAML` all take an optional second parameter: a table containing keys that disable or enable different formatting options.
+`toml.encode`, `toml.encodeToFile`, `toml.toJSON`, and `toml.toYAML` all take an optional second parameter: a table containing keys that disable or enable different formatting options.
 Passing an empty table removes all options, while not providing a table will use the default options.
 
 ```lua

README.md

@@ -45,7 +45,7 @@ print("\n\nEncoding:\n")
 print(toml.encode(data, { indentation = true }))
 
 print("\n\nTOML to JSON:\n")
-print(toml.tomlToJSON(tomlStr, { indentation = true }))
+print(toml.toJSON(tomlStr, { indentation = true }))
 
 print("\n\nTOML to YAML:\n")
-print(toml.tomlToYAML(tomlStr, { indentation = true }))
+print(toml.toYAML(tomlStr, { indentation = true }))

examples/example.lua

@@ -1,4 +1,3 @@
-#include "magic_enum.hpp"
 #include "toml.hpp"
 #include <DataTypes/TOMLInt/TOMLInt.hpp>
 #include <bitset>

src/DataTypes/TOMLInt/TOMLInt.cpp

@@ -2,7 +2,7 @@
 #define OPTIONS_H
 
 struct Options {
-	bool formattedIntAsUserData = false;
+	bool formattedIntsAsUserData = false;
 	bool temporalTypesAsUserData = true;
 };
 #endif /* OPTIONS_H */

src/Options.hpp

@@ -1,6 +1,5 @@
 #include "decoding.hpp"
 #include <DataTypes/TOMLInt/TOMLInt.hpp>
-#include <magic_enum.hpp>
 #include <sol/sol.hpp>
 #include <toml.hpp>
 
@@ -20,13 +19,13 @@ void insertNodeInTable(
 		case toml::node_type::integer: {
 			auto v = *node->as_integer();
 			try {
-				if (options.formattedIntAsUserData && v.flags() != toml::value_flags::none) {
+				if (options.formattedIntsAsUserData && v.flags() != toml::value_flags::none) {
 					luaTable[std::get<std::string>(keyOrIndex)] = TOMLInt(v, v.flags());
 				} else {
 					luaTable[std::get<std::string>(keyOrIndex)] = v.get();
 				}
 			} catch (std::bad_variant_access) {
-				if (options.formattedIntAsUserData && v.flags() != toml::value_flags::none) {
+				if (options.formattedIntsAsUserData && v.flags() != toml::value_flags::none) {
 					luaTable[std::get<size_t>(keyOrIndex)] = TOMLInt(v, v.flags());
 				} else {
 					luaTable[std::get<size_t>(keyOrIndex)] = v.get();

src/decoding/decoding.cpp

@@ -5,7 +5,6 @@
 #include <Options.hpp>
 #include <cstddef>
 #include <sol/sol.hpp>
-#include <string>
 #include <toml.hpp>
 
 /// Convert `luaTable` into a `toml::table`.

src/decoding/decoding.hpp

@@ -3,8 +3,6 @@
 #include <DataTypes/DateAndTime/dateAndTime.hpp>
 #include <DataTypes/TOMLInt/TOMLInt.hpp>
 #include <cassert>
-#include <iostream>
-#include <magic_enum.hpp>
 #include <sol/sol.hpp>
 #include <string>
 #include <utilities/utilities.hpp>