newfunction: sqlpage.version

Author: lovasoa

CHANGELOG.md

@@ -12,6 +12,7 @@
       You can write your code in .sql files in /path/to/your/website/directory.
       ```
  - New `sqlpage.current_working_directory` function to get the [current working directory](https://en.wikipedia.org/wiki/Working_directory) of the SQLPage process.
+  - New `sqlpage.version` function to get the version of SQLPage.
 
 ## 0.10.3 (2023-09-14)
 

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "sqlpage"
-version = "0.10.4"
+version = "0.11.0"
 edition = "2021"
 description = "A SQL-only web application framework. Takes .sql files and formats the query result using pre-made configurable professional-looking components."
 keywords = ["web", "sql", "framework"]

Cargo.toml

@@ -2,7 +2,7 @@
 select 'http_header' as component, 'public, max-age=600, stale-while-revalidate=3600, stale-if-error=86400' as "Cache-Control";
 select 'dynamic' as component, properties FROM example WHERE component = 'shell' LIMIT 1;
 
-select 'text' as component, 'SQLPage documentation' as title;
+select 'text' as component, format('SQLPage v%s documentation', sqlpage.version()) as title;
 select '
 If you are completely new to SQLPage, you should start by reading the [get started tutorial](get%20started.sql),
 which will guide you through the process of creating your first SQLPage application.
@@ -53,7 +53,8 @@ select 'text' as component,
 select description as contents from component where name = $component;
 
 select 'text' as component;
-select 'Introduced in SQLPage v' || introduced_in_version || '.' as contents, 1 as size
+select format('Introduced in SQLPage v%s.', introduced_in_version) as contents,
+        1 as size
 from component where name = $component;
 
 select 'title' as component, 3 as level, 'Top-level parameters' as contents where $component IS NOT NULL;

examples/official-site/documentation.sql

@@ -270,4 +270,16 @@ VALUES (
         'name',
         'The name of the environment variable to read. Must be a literal string.',
         'TEXT'
-    );
+    );
+
+INSERT INTO sqlpage_functions (
+        "name",
+        "introduced_in_version",
+        "icon",
+        "description_md"
+    )
+VALUES (
+        'version',
+        '0.11.0',
+        'git-commit',
+        'Returns the current version of SQLPage as a string.');

examples/official-site/sqlpage/migrations/08_functions.sql

@@ -9,7 +9,9 @@ select 'shell' as component,
 --  and filling them with contents from the results of your SQL queries
 select 'hero' as component, -- We select a component. The documentation for each component can be found on https://sql.ophir.dev/documentation.sql
     'It works !' as title, -- 'title' is top-level parameter of the 'hero' component
-    'If you can see this, then SQLPage is running correctly on your server. Congratulations! ' as description;
+    'If you can see this, then SQLPage v' ||
+    sqlpage.version() ||
+    ' is running correctly on your server. Congratulations! ' as description;
 -- Properties can be textual, numeric, or booleans
 
 -- Let's start with the text component

index.sql

@@ -182,8 +182,7 @@ fn bind_parameters<'a>(
 ) -> anyhow::Result<Query<'a, sqlx::Any, AnyArguments<'a>>> {
     let mut arguments = AnyArguments::default();
     for param in &stmt.parameters {
-        let argument = extract_req_param(param, request)
-            .with_context(|| format!("Unable to extract {param:?} from the HTTP request"))?;
+        let argument = extract_req_param(param, request)?;
         log::debug!("Binding value {:?} in statement {}", &argument, stmt);
         match argument {
             None => arguments.add(None::<String>),

src/webserver/database/mod.rs

@@ -28,6 +28,7 @@ pub(super) enum StmtParam {
     RandomString(usize),
     CurrentWorkingDir,
     EnvironmentVariable(String),
+    SqlPageVersion,
 }
 
 pub(super) fn func_call_to_param(func_name: &str, arguments: &mut [FunctionArg]) -> StmtParam {
@@ -46,6 +47,7 @@ pub(super) fn func_call_to_param(func_name: &str, arguments: &mut [FunctionArg])
         "current_working_directory" => StmtParam::CurrentWorkingDir,
         "environment_variable" => extract_single_quoted_string("environment_variable", arguments)
             .map_or_else(StmtParam::Error, StmtParam::EnvironmentVariable),
+        "version" => StmtParam::SqlPageVersion,
         unknown_name => StmtParam::Error(format!(
             "Unknown function {unknown_name}({})",
             FormatArguments(arguments)
@@ -82,6 +84,7 @@ pub(super) fn extract_req_param<'a>(
             .map(Cow::Owned)
             .map(Some)
             .with_context(|| format!("Unable to read environment variable {var}"))?,
+        StmtParam::SqlPageVersion => Some(Cow::Borrowed(env!("CARGO_PKG_VERSION"))),
     })
 }