Remove Python and include any shell scripts

Python has been removed due to lack of possibility to embed. You can anyway use Python scripts as shell scripts with shebangs.

Author: markcda

.depl/config.yaml

@@ -48,7 +48,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: cargo clippy --no-default-features --features=tests,python,lua,rhai
+            - bash_c: cargo clippy --no-default-features --features=lua,rhai
               show_success_output: true
       - title: Format
         info: cargo-format@0.1.0
@@ -70,7 +70,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: cargo build --release --no-default-features --features=tests,python,lua,rhai
+            - bash_c: cargo build --release --no-default-features --features=lua,rhai
       - title: Test
         info: cargo-test@0.1.0
         tags:
@@ -83,7 +83,7 @@ pipelines:
             - rust
           commands:
             - bash_c: cp tests/*.py .
-            - bash_c: cargo test --lib --no-default-features --features=tests,python,lua,rhai
+            - bash_c: cargo test --lib --no-default-features --features=lua,rhai
       - title: Compress
         info: upx-compress@0.1.0
         tags:

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "smart-patcher"
 description = "Patcher based on rules"
-version = "0.3.0-1"
+version = "0.4.0"
 edition = "2024"
 license = "MIT"
 authors = ["Klimenty Titov <aclo.create@gmail.com>"]
@@ -10,20 +10,18 @@ repository = "https://github.com/impulse-sw/smart-patcher"
 [dependencies]
 anyhow = "1"
 clap = { version = "4", features = ["derive"] }
-difference-rs = { optional = true, version = "3.2.0" }
+difference-rs = "3.2.0"
 mimalloc = "0.1"
 mlua = { optional = true, version = "0.11", features = ["anyhow", "lua54", "vendored"] }
-pyo3 = { optional = true, version = "0.25", features = ["auto-initialize"] }
 regex = "1"
 rhai = { optional = true, version = "1" }
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
+uuid = { version = "1.18.0", features = ["v4"] }
 walkdir = "2.5"
 
 [features]
-default = ["tests", "generate-patches"]
-tests = ["dep:difference-rs"]
-generate-patches = ["python", "lua", "rhai"]
-python = ["dep:pyo3"]
+default = []
+generate-patches = ["lua", "rhai"]
 lua = ["dep:mlua"]
 rhai = ["dep:rhai"]

README.md

@@ -4,7 +4,8 @@ Patcher based on rules. Written for [Deployer](https://github.com/impulse-sw/dep
 
 Features:
 
-- script support (Python, Lua, Rhai) - to find, replace, or decode/encode
+- embedded script support (Lua, Rhai) - to find, replace, or decode/encode
+- any shell command support - to find, replace, or decode/encode
 - regexes
 
 ## Build
@@ -38,7 +39,7 @@ Also you can use `smart-patcher` as library and even specify needed features:
 
 ```toml
 [dependencies]
-smart-patcher = { version = "0.3.0", default-features = false, features = ["python", "lua", "rhai"] }
+smart-patcher = { version = "0.4", features = ["lua", "rhai"] }
 ```
 
 ## Patches
@@ -92,7 +93,7 @@ There are several rule types to cut text sections step by step:
 2. `not_contains` - nearly the same
 3. `before` and `after` - cuts the patchable area before and after specified regular expression matches
 4. `cursor_at_begin` and `cursor_at_end` - moves the `inplace` cursor at begin or at end of the text area
-5. `find_by_{lua,python,rhai}` - cuts the section by Lua/Python/Rhai script
+5. `find_by_{lua,sh,rhai}` - cuts the section by Lua/Rhai or shell script
 
 This is how a step by step set looks like:
 
@@ -109,7 +110,7 @@ This is how a step by step set looks like:
       "after": "...but after this."
     },
     {
-      "find_by_python": "some_script_afterall.py"
+      "find_by_sh": "some_script_afterall.py"
     }
   ]
 }
@@ -152,12 +153,20 @@ See the `tests/test_v5.py` example (and `tests/test_v5.docx` file). This is simp
 ```json
 {
   "decoder": {
-    "python": "tests/test_v5.py"
+    "sh": "tests/test_v5.py"
   },
   "encoder": {
-    "python": "tests/test_v5.py"
+    "sh": "tests/test_v5.py"
   },
 }
 ```
 
-You can also specify `lua` and `rhai` values instead of `python`.
+You can also specify `lua` and `rhai` values instead of `sh`.
+
+### 5. Shell vs Rhai/Lua (`0.3` -> `0.4` migration)
+
+If `lua` or `rhai` feature is enabled, `smart-patcher` can patch files without any external runtime dependencies. Unfortunately, Python can't be embedded within `smart-patcher` due to `pyo3` library, therefore now you can choose to shebang your Python scripts and use them again.
+
+Nevertheless, API was slightly changed. Requests are written in JSON files and responses are read from JSON files too. See Python scripts implementations in `tests` folder to see how them are adapted to new `smart-patcher`.
+
+For novices, in `smart-patcher v0.4` you can propose any scripts to handle next patch tasks: find, replace, and decode from/encode to any binary data. For Rhai/Lua scripts, you should write functions with proposed names (`find`, `replace`, `decode` and `encode`), and for shell scripts you should use file system I/O and JSON utilities to read requests and write responses in paths provided by command arguments.

examples/patch4.json

@@ -10,7 +10,7 @@
           "after": "new "
         },
         {
-          "find_by_python": "../tests/test_v4.py"
+          "find_by_sh": "../tests/test_v4.py"
         }
       ],
       "insert": " v2"

examples/patch5.json

@@ -7,10 +7,10 @@
         }
       ],
       "decoder": {
-        "python": "../tests/test_v5.py"
+        "sh": "../tests/test_v5.py"
       },
       "encoder": {
-        "python": "../tests/test_v5.py"
+        "sh": "../tests/test_v5.py"
       },
       "patch_area": [],
       "insert": {

examples/patch8.json

@@ -4,7 +4,7 @@
       "files": [],
       "patch_area": [],
       "replace": {
-        "by_python": "../tests/test_v8.py"
+        "by_sh": "../tests/test_v8.py"
       }
     }
   ]

examples/patch9.json

@@ -4,7 +4,7 @@
       "files": [],
       "patch_area": [],
       "replace": {
-        "by_python": "../tests/test_v9.py"
+        "by_sh": "../tests/test_v9.py"
       }
     }
   ]

src/cmd.rs

@@ -14,7 +14,6 @@ pub(crate) enum SmartPatcherExecType {
   /// Apply patches
   Apply(PatchParams),
 
-  #[cfg(feature = "tests")]
   /// Test run
   Test(PatchParams),
 

src/lib.rs

@@ -8,20 +8,19 @@
 //! - regex support
 //! - Python, Lua and Rhai scripts support (featured by `python`, `lua` and `rhai`)
 //!
-//! See [PatchFile] for further details.
+//! See [`PatchFile`] for further details.
 
-#![feature(let_chains)]
+#![feature(let_chains, exit_status_error)]
 #![deny(missing_docs)]
 
 pub(crate) mod patch;
 pub(crate) mod regex;
 
 #[cfg(feature = "lua")]
 pub(crate) mod lua_exec;
-#[cfg(feature = "python")]
-pub(crate) mod python_exec;
 #[cfg(feature = "rhai")]
 pub(crate) mod rhai_exec;
+pub(crate) mod sh_exec;
 
 pub use crate::patch::{AreaRule, DecodeBy, EncodeBy, FilePath, Patch, PatchFile, Replacer};
 pub use crate::regex::RegexIR;

src/main.rs

@@ -1,4 +1,4 @@
-#![feature(let_chains)]
+#![feature(let_chains, exit_status_error)]
 #![deny(warnings, clippy::todo, clippy::unimplemented)]
 
 pub(crate) mod cmd;
@@ -7,10 +7,9 @@ pub(crate) mod regex;
 
 #[cfg(feature = "lua")]
 pub(crate) mod lua_exec;
-#[cfg(feature = "python")]
-pub(crate) mod python_exec;
 #[cfg(feature = "rhai")]
 pub(crate) mod rhai_exec;
+pub(crate) mod sh_exec;
 
 use mimalloc::MiMalloc;
 
@@ -36,7 +35,6 @@ fn main() -> anyhow::Result<()> {
 
       patches.patch(&params.work_at, &patch_dir)?;
     }
-    #[cfg(feature = "tests")]
     SmartPatcherExecType::Test(params) => {
       let mut patch_dir = params.patch.clone();
       patch_dir.pop();