Kephas.Scripting.CSharp 11.0.0-dev.3

Prefix Reserved
This is a prerelease version of Kephas.Scripting.CSharp.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Kephas.Scripting.CSharp --version 11.0.0-dev.3
                    
NuGet\Install-Package Kephas.Scripting.CSharp -Version 11.0.0-dev.3
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Kephas.Scripting.CSharp" Version="11.0.0-dev.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Kephas.Scripting.CSharp" Version="11.0.0-dev.3" />
                    
Directory.Packages.props
<PackageReference Include="Kephas.Scripting.CSharp" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Kephas.Scripting.CSharp --version 11.0.0-dev.3
                    
#r "nuget: Kephas.Scripting.CSharp, 11.0.0-dev.3"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=Kephas.Scripting.CSharp&version=11.0.0-dev.3&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Kephas.Scripting.CSharp&version=11.0.0-dev.3&prerelease
                    
Install as a Cake Tool

Templating

Introduction

The scripting area in Kephas handles dynamic code execution. The entry point is the IScriptProcessor singleton service, which returns a result through the ExecuteAsync method, provided with a script, execution arguments, and globals.

Usage

// normally you would get the processor injected into the service constructor.
var processor = injector.Resolve<IScriptProcessor>();

// the next line uses C# scripting, so you will need also to reference Kephas.Scripting.CSharp.
var result = processor.ExecuteAsync(new CSharpStringScript("name[..4] + age.ToString()"), new { name = "Johnny", age = 42 }));
Assert.Equals("John42", result);

// the next line uses Python scripting, so you will need also to reference Kephas.Scripting.Python.
var result = processor.ExecuteAsync(new PythonStringScript("name[..4] + str(age)"), new Expando { ["name"] = "Johnny", ["age"] = 42 }));
Assert.Equals("John42", result);

The ITemplateProcessor service

This service is the central piece providing the ProcessAsync method through which a template is processed. Typically, the output is written to the ITemplateProcessingContext.TextWriter, but, if this is not set by the user, it is the duty of the template processor to prepare the TextWriter and to return in the operation result the result returned by the processing engine.

DefaultTemplateProcessor is the default implementation of the ITemplateProcessor. Just like the other default implementations provided by the Kephas framework, it declares a low override priority, so that it can be easily overridden. By default, it delegates the template processing to a specific ITemplatingEngine handling the provided template. It identifies the engine based on the template's kind, which the engine declares using the [TemplateKind(...)] attribute.

Template engines

These services implement the ITemplatingEngine contract and handle specific template kinds. By default, the framework provides the InterpolationTemplatingEngine which handles simple string interpolations using the curly braces pattern: {variable}. All such variables are replaced with the values of the properties' with the same name in the model.

Controlling the template processing

The processing context

Additional to the template and the model, the processing methods receive also a context which can be used to further control the operations. Just like all the other context instances, it is a dynamic expandable object (IExpando) and it aggregates the provided template and the model. Through the Result and Exception properties, the behaviors (see below) can control the processing output.

The processing behaviors

The DefaultTemplateProcessor uses also ITemplateProcessing behavior services to further control the processing. Just like the ITemplateEngine services, they declare the template kinds they handle, and are invoked before and after the selected engine processes the template. They can cover various purposes: authorization, pre-processing/post-processing, audit, and whatever other functionality may be required.

The templates

A template implements ITemplate, basically providing a Kind (string), a Name (string), and an asynchronous content (GetContentAsync()). By default, the framework supports these templates:

  • StringTemplate: constructed using a string. If the Kind is not provided, 'interpolation' is considered instead.
  • StringBuilderTemplate: constructed using a StringBuilder. If the Kind is not provided, 'interpolation' is considered instead.
  • StreamTemplate: constructed using a Stream. If the Kind is not provided, 'interpolation' is considered instead.
  • FileTemplate: constructed using a file path. If the Kind is not provided, the file extension is considered instead.
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
11.1.0 702 4/13/2022
11.1.0-dev.4 183 4/6/2022
11.1.0-dev.3 174 3/30/2022
11.1.0-dev.2 178 3/23/2022
11.1.0-dev.1 170 3/23/2022
11.0.0 570 3/11/2022
11.0.0-dev.7 187 3/7/2022
11.0.0-dev.6 182 2/28/2022
11.0.0-dev.5 185 2/26/2022
11.0.0-dev.4 186 2/24/2022
11.0.0-dev.3 183 2/23/2022
11.0.0-dev.2 178 2/18/2022
11.0.0-dev.1 186 2/7/2022
10.3.0 549 1/18/2022
10.2.0 914 12/3/2021
10.1.0 4,979 11/23/2021
10.1.0-dev.7 236 11/17/2021
10.1.0-dev.6 206 11/16/2021
10.1.0-dev.5 220 11/10/2021
10.1.0-dev.4 206 11/8/2021
10.1.0-dev.3 192 11/8/2021
10.1.0-dev.2 214 11/4/2021
10.1.0-dev.1 210 11/3/2021
10.0.1 504 10/16/2021
10.0.0 471 10/13/2021
10.0.0-dev.4 201 10/13/2021
10.0.0-dev.3 222 10/11/2021
10.0.0-dev.2 270 10/8/2021
9.3.4 449 8/25/2021
9.3.3 440 8/25/2021
9.3.2 458 8/24/2021
9.3.1 445 8/12/2021
9.3.0 475 8/12/2021
9.2.0 456 6/17/2021
9.1.0 475 6/17/2021
9.1.0-dev.9 247 5/26/2021
9.1.0-dev.8 236 5/26/2021
9.1.0-dev.7 240 5/17/2021
9.1.0-dev.6 235 4/28/2021
9.1.0-dev.5 241 4/23/2021
9.1.0-dev.4 251 4/21/2021
9.1.0-dev.3 240 4/17/2021
9.1.0-dev.2 236 4/12/2021
9.1.0-dev.1 298 4/9/2021
9.0.5 460 3/31/2021
9.0.4 506 3/23/2021
9.0.3 501 3/20/2021
9.0.1 462 3/18/2021
9.0.0 483 3/17/2021
9.0.0-dev.4 244 3/4/2021
9.0.0-dev.3 256 3/1/2021
9.0.0-dev.2 276 2/22/2021
8.4.0 521 11/11/2020
8.3.0 534 10/28/2020
8.2.0 612 10/16/2020
8.1.0 644 9/23/2020
8.0.0 583 7/1/2020
8.0.0-dev.44 359 6/25/2020
8.0.0-dev.43 345 6/23/2020
8.0.0-dev.42 371 6/22/2020
8.0.0-dev.41 359 6/18/2020
8.0.0-dev.40 333 6/18/2020
8.0.0-dev.39 350 6/15/2020
8.0.0-dev.38 460 6/14/2020
8.0.0-dev.37 319 6/13/2020
8.0.0-dev.36 367 6/13/2020
8.0.0-dev.35 308 6/12/2020
8.0.0-dev.34 358 6/12/2020
8.0.0-dev.33 399 6/10/2020
8.0.0-dev.32 328 6/1/2020
8.0.0-dev.31 349 6/1/2020
8.0.0-dev.30 423 5/30/2020
8.0.0-dev.28 363 5/28/2020
8.0.0-dev.27 348 5/15/2020
8.0.0-dev.26 327 5/14/2020
8.0.0-dev.25 356 5/14/2020
8.0.0-dev.24 344 5/13/2020
8.0.0-dev.23 348 5/13/2020
8.0.0-dev.22 344 5/13/2020
8.0.0-dev.21 338 5/12/2020
8.0.0-dev.20 342 5/12/2020
8.0.0-dev.19 354 5/7/2020
8.0.0-dev.18 343 5/7/2020
8.0.0-dev.17 343 5/6/2020
8.0.0-dev.16 344 5/6/2020
8.0.0-dev.15 338 5/5/2020
8.0.0-dev.14 335 5/5/2020
8.0.0-dev.13 367 5/4/2020
7.6.0-dev.13 367 5/1/2020
7.6.0-dev.12 370 4/30/2020
7.6.0-dev.11 335 4/28/2020
7.6.0-dev.10 339 4/27/2020
7.6.0-dev.9 329 4/24/2020
7.6.0-dev.8 338 4/22/2020
7.6.0-dev.7 332 4/15/2020
7.6.0-dev.6 329 4/15/2020
7.6.0-dev.5 325 4/15/2020
7.6.0-dev.4 449 4/11/2020
7.6.0-dev.3 327 4/10/2020
7.6.0-dev.2 321 4/10/2020
7.6.0-dev.1 400 4/8/2020
7.5.2 680 3/20/2020
7.5.1 600 3/12/2020
7.5.0 609 3/10/2020
7.5.0-dev.18 359 3/5/2020
7.5.0-dev.17 357 3/5/2020
7.5.0-dev.16 374 3/4/2020
7.5.0-dev.15 321 3/3/2020
7.5.0-dev.14 333 3/3/2020
7.5.0-dev.13 324 2/29/2020
7.5.0-dev.12 441 2/29/2020
7.5.0-dev.10 320 2/25/2020
7.5.0-dev.9 364 2/20/2020
7.5.0-dev.8 392 2/18/2020
7.5.0-dev.7 323 2/18/2020
7.5.0-dev.6 346 2/14/2020
7.5.0-dev.5 368 2/12/2020
7.5.0-dev.4 342 2/11/2020
7.5.0-dev.3 315 2/11/2020
7.5.0-dev.2 456 2/8/2020
7.5.0-dev.1 346 2/7/2020
7.4.2 601 2/5/2020
7.4.1 673 2/3/2020
7.4.0 684 1/31/2020
7.4.0-dev.4 397 1/31/2020
7.4.0-dev.3 375 1/29/2020
7.4.0-dev.2 329 1/28/2020
7.4.0-dev.1 322 1/23/2020
7.3.1 695 1/21/2020
7.3.1-preview.7 332 1/21/2020
7.3.1-preview.1 363 1/20/2020
7.3.0 598 1/19/2020
7.2.6 683 1/18/2020
7.2.5 640 12/19/2019
7.2.4 651 12/19/2019
7.2.3 652 12/16/2019
7.2.2 617 12/9/2019
7.2.1 638 12/4/2019
7.2.0 590 11/26/2019
7.2.0-preview.10 334 11/20/2019
7.2.0-preview.9 338 11/19/2019
7.2.0-preview.8 336 11/18/2019
7.2.0-preview.6 346 11/14/2019
7.2.0-preview.5 347 11/14/2019
7.2.0-preview.4 329 11/14/2019
7.2.0-preview.2 335 11/11/2019
7.2.0-preview.1 338 11/9/2019
7.1.0 641 11/6/2019
7.1.0-preview.8 345 11/5/2019
7.1.0-preview.7 342 11/4/2019
7.1.0-preview.6 341 11/1/2019
7.1.0-preview.5 358 10/31/2019
7.1.0-preview.4 360 10/30/2019
7.1.0-preview.3 346 10/26/2019
7.1.0-preview.2 343 10/25/2019
7.1.0-preview.1 342 10/24/2019
7.0.0 628 10/16/2019
7.0.0-rc.41 351 10/15/2019
7.0.0-rc.40 364 10/15/2019
7.0.0-rc.39 356 10/12/2019
7.0.0-rc.38 347 10/11/2019
7.0.0-rc.37 347 10/10/2019
7.0.0-rc.36 342 10/9/2019
7.0.0-rc.35 346 10/8/2019
7.0.0-rc.34 350 10/8/2019
7.0.0-rc.33 343 10/7/2019
7.0.0-rc.32 340 10/5/2019
7.0.0-rc.31 349 10/3/2019
7.0.0-rc.30 355 10/1/2019
7.0.0-rc.28 354 10/1/2019
7.0.0-rc.27 341 9/30/2019
7.0.0-rc.26 357 9/30/2019
7.0.0-rc.25 338 9/27/2019
7.0.0-rc.24 344 9/27/2019
7.0.0-rc.23 335 9/26/2019
7.0.0-rc.22 346 9/25/2019
7.0.0-rc.21 348 9/24/2019
7.0.0-rc.20 352 9/23/2019
7.0.0-rc.19 341 9/20/2019
7.0.0-rc.18.1 347 9/20/2019
7.0.0-rc.18 354 9/20/2019
6.5.0-rc.17 362 9/19/2019
6.5.0-rc.16 366 9/18/2019
6.5.0-rc.15 366 9/18/2019
6.5.0-rc.14.1 368 9/18/2019
6.5.0-rc.14 368 9/17/2019
6.5.0-rc.13 357 9/16/2019
6.5.0-rc.12.2 357 9/13/2019
6.5.0-rc.12.1 361 9/12/2019
6.5.0-rc.12 362 9/12/2019
6.5.0-rc.11 359 9/11/2019
6.5.0-rc.10 354 9/10/2019
6.5.0-rc.9 350 9/9/2019
6.5.0-rc.8 349 9/6/2019
6.5.0-rc.7 360 9/6/2019
6.5.0-rc.6 361 9/6/2019
6.5.0-rc.5 353 9/2/2019
6.5.0-rc.4 358 9/2/2019
6.5.0-rc.3 348 8/30/2019
6.5.0-rc.2 377 8/29/2019
6.5.0-rc.1 361 8/28/2019
6.5.0-beta.5 364 8/28/2019
6.5.0-beta.4 365 8/27/2019
6.0.0 683 8/6/2019
6.0.0-rc.7 355 7/19/2019
6.0.0-rc.6 364 6/28/2019
6.0.0-rc.5 351 6/28/2019
6.0.0-rc.4 353 6/25/2019
6.0.0-rc.3 366 6/20/2019
6.0.0-rc.2 360 5/29/2019
6.0.0-rc.1 363 5/28/2019
6.0.0-beta.3 376 4/17/2019
5.3.0-beta.2 370 3/21/2019
5.3.0-beta.1 365 3/20/2019
5.2.0 679 3/19/2019
5.1.0 1,031 1/25/2019
5.0.0 1,086 12/21/2018
5.0.0-rc11 851 12/14/2018
5.0.0-rc10 663 11/16/2018
5.0.0-rc09 660 11/1/2018
5.0.0-rc08 627 10/31/2018
5.0.0-rc07 666 10/31/2018
5.0.0-rc06 667 10/30/2018
5.0.0-rc05 661 10/29/2018
5.0.0-rc04 693 10/29/2018
5.0.0-rc03 677 10/26/2018
5.0.0-rc02 666 10/25/2018
5.0.0-rc01 710 10/12/2018
5.0.0-beta03 714 9/21/2018
5.0.0-beta02 720 9/10/2018
5.0.0-beta01 721 9/7/2018
4.5.1 1,072 8/7/2018
4.5.0 1,050 8/7/2018
4.5.0-rc01 985 6/7/2018
4.5.0-beta09 981 6/7/2018

Please check https://github.com/kephas-software/kephas/releases for the change log.
           Also check the documentation and the samples from https://github.com/kephas-software/kephas/wiki and https://github.com/kephas-software/kephas/tree/master/Samples.