Merge pull request #15 from tidesdb/minor-adjustments-code-style-comment-headers-additions

Added clang format, added code_formatter.sh, formatted code, added he…

Author: guycipher

.clang-format

@@ -0,0 +1,7 @@
+BasedOnStyle: Google
+IndentWidth: 4
+ColumnLimit: 100
+AllowShortFunctionsOnASingleLine: None
+KeepEmptyLinesAtTheStartOfBlocks: false
+AlignConsecutiveMacros: true
+BreakBeforeBraces: Allman

.github/workflows/build_and_test_lua.yml

@@ -35,6 +35,7 @@ jobs:
         cd tidesdb
         cmake -DTIDESDB_WITH_SANITIZER=OFF --debug-output  -S . -B build && make -C build/
         sudo cmake --install build
+        sudo ldconfig
 
 
     - name: Install Lua and Lua development files

.gitignore

@@ -42,3 +42,8 @@ luac.out
 #cmake build artifacts
 build
 
+cmake-build-debug
+.idea
+build
+.vscode
+

CMakeLists.txt

@@ -5,11 +5,13 @@ set(CMAKE_C_STANDARD 23)
 set(PROJECT_VERSION 0.1.0)
 add_compile_options(-Wextra -Wall)
 
-find_package(Lua 5.3 REQUIRED)
+# set CMP0156 policy
+cmake_policy(SET CMP0156 NEW)
+
+find_library(LIBRARY_TIDEDB NAMES tidesdb REQUIRED) # require tidesdb library
 
-find_library(LIBRARY_TIDEDB NAMES tidesdb)
+find_package(Lua 5.3 REQUIRED)
 
 add_library(tidesdb_lua SHARED tidesdb-lua.c)
 target_include_directories(tidesdb_lua PRIVATE ${LUA_INCLUDE_DIR})
-target_link_libraries(tidesdb_lua ${LIBRARY_TIDEDB})
-target_link_libraries(tidesdb_lua ${LUA_LIBRARIES})
+target_link_libraries(tidesdb_lua ${LUA_LIBRARIES} tidesdb)

code_formatter.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+# Before submitting a PR, run this script to format the source code.
+
+EXCLUDE_DIRS="external\|cmake-build-debug\|.idea|build|cmake"
+
+find . -type f -name "*.c" -o -name "*.h" | grep -v "$EXCLUDE_DIRS" | xargs clang-format -i

spec/tidesdb_spec.lua

@@ -1,3 +1,22 @@
+--[[
+ *
+ * Copyright (C) TidesDB
+ *
+ * Original Author: Evgeny Kornev
+ *
+ * Licensed under the Mozilla Public License, v. 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.mozilla.org/en-US/MPL/2.0/
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+]]
 package.cpath = 'tidesdb-lua/build/?.so;build/?.so;' .. package.cpath
 
 describe("load", function()

test_lua.lua

@@ -1,3 +1,22 @@
+--[[
+ *
+ * Copyright (C) TidesDB
+ *
+ * Original Author: Evgeny Kornev
+ *
+ * Licensed under the Mozilla Public License, v. 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.mozilla.org/en-US/MPL/2.0/
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+]]
 local lib = require("libtidesdb_lua")
 
 local code, message

tidesdb-lua.c

@@ -1,6 +1,6 @@
 /*
  *
- * Copyright (C) Evgeny Kornev
+ * Copyright (C) TidesDB
  *
  * Original Author: Evgeny Kornev
  *
@@ -16,13 +16,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 #include <lua.h>
 #include <lauxlib.h>
 #include <lualib.h>
 #include <stdio.h>
 #include <string.h>
-#include <tidesdb.h>
+#include <tidesdb/tidesdb.h>
 
 #define LUA_RET_CODE()                     \
     if(ret)                                \