Skip to content

Commit dd2ee57

Browse files
SockworkOrangeSockworkOrange
authored
Merge pull request #7 from DaredevilOSS/added-options-doc
renamed all occurences of SqlcGenCsharp to SqlcGenRuby
2 parents 3415fef + f73a478 commit dd2ee57

26 files changed

+33
-30
lines changed

‎CodeGenerator/CodeGenerator.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
using Google.Protobuf;
22
using Plugin;
33
using RubyCodegen;
4-
using SqlcGenCsharp.Drivers;
4+
using SqlcGenRuby.Drivers;
55
using System;
66
using System.Collections.Generic;
77
using System.IO;
88
using System.Linq;
99
using System.Threading.Tasks;
1010
using File = Plugin.File;
1111

12-
namespace SqlcGenCsharp;
12+
namespace SqlcGenRuby;
1313

1414
public class CodeGenerator
1515
{

‎CodeGenerator/CodeGenerator.csproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<PropertyGroup>
44
<TargetFramework>net8.0</TargetFramework>
55
<Nullable>enable</Nullable>
6-
<RootNamespace>SqlcGenCsharp</RootNamespace>
6+
<RootNamespace>SqlcGenRuby</RootNamespace>
77
</PropertyGroup>
88

99
<ItemGroup>

‎Drivers/ClassMember.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
using System;
22

3-
namespace SqlcGenCsharp.Drivers;
3+
namespace SqlcGenRuby.Drivers;
44

55
public enum ClassMember
66
{

‎Drivers/DbDriver.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
using RubyCodegen;
33
using System.Collections.Generic;
44

5-
namespace SqlcGenCsharp.Drivers;
5+
namespace SqlcGenRuby.Drivers;
66

77
public abstract class DbDriver
88
{

‎Drivers/Drivers.csproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<PropertyGroup>
44
<TargetFramework>net8.0</TargetFramework>
55
<Nullable>enable</Nullable>
6-
<RootNamespace>SqlcGenCsharp.Drivers</RootNamespace>
6+
<RootNamespace>SqlcGenRuby.Drivers</RootNamespace>
77
</PropertyGroup>
88

99
<ItemGroup>

‎Drivers/MethodGen.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
using System.Collections.Generic;
44
using System.Linq;
55

6-
namespace SqlcGenCsharp.Drivers;
6+
namespace SqlcGenRuby.Drivers;
77

88
public class MethodGen(DbDriver dbDriver)
99
{

‎Drivers/Mysql2Driver.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
using System.Collections.Generic;
44
using System.Linq;
55

6-
namespace SqlcGenCsharp.Drivers;
6+
namespace SqlcGenRuby.Drivers;
77

88
public class Mysql2Driver : DbDriver
99
{

‎Drivers/PgDriver.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
using System.Linq;
55
using System.Text.RegularExpressions;
66

7-
namespace SqlcGenCsharp.Drivers;
7+
namespace SqlcGenRuby.Drivers;
88

99
public partial class PgDriver : DbDriver
1010
{

‎Drivers/Variable.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
namespace SqlcGenCsharp.Drivers;
1+
namespace SqlcGenRuby.Drivers;
22

33
public enum Variable
44
{

‎Extensions/Extensions.csproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<TargetFramework>net8.0</TargetFramework>
55
<ImplicitUsings>enable</ImplicitUsings>
66
<Nullable>enable</Nullable>
7-
<RootNamespace>SqlcGenCsharp</RootNamespace>
7+
<RootNamespace>SqlcGenRuby</RootNamespace>
88
</PropertyGroup>
99

1010
<ItemGroup>

‎Extensions/ListExtensions.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
namespace SqlcGenCsharp;
1+
namespace SqlcGenRuby;
22

33
public static class ListExtensions
44
{

‎Extensions/StringExtensions.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
using System.Text.RegularExpressions;
22

3-
namespace SqlcGenCsharp;
3+
namespace SqlcGenRuby;
44

55
public static partial class StringExtensions
66
{

‎GeneratedProtobuf/GeneratedProtobuf.csproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<PropertyGroup>
44
<TargetFramework>net8.0</TargetFramework>
55
<Nullable>enable</Nullable>
6-
<RootNamespace>SqlcGenCsharp</RootNamespace>
6+
<RootNamespace>SqlcGenRuby</RootNamespace>
77
</PropertyGroup>
88

99
<ItemGroup>

‎LocalRunner/App.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
namespace SqlcGenCsharp;
1+
namespace SqlcGenRuby;
22

33
public static class App
44
{

‎LocalRunner/LocalRunner.csproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<TargetFramework>net8.0</TargetFramework>
66
<PublishSingleFile>true</PublishSingleFile>
77
<RuntimeIdentifiers>osx-arm64;linux-x64</RuntimeIdentifiers>
8-
<RootNamespace>SqlcGenCsharp</RootNamespace>
8+
<RootNamespace>SqlcGenRuby</RootNamespace>
99
</PropertyGroup>
1010

1111
<ItemGroup>

‎PluginOptions/Options.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
using System.Text.Json;
55
using Enum = System.Enum;
66

7-
namespace SqlcGenCsharp;
7+
namespace SqlcGenRuby;
88

99
public enum DriverName
1010
{
@@ -22,7 +22,7 @@ public Options(GenerateRequest generateRequest)
2222
Enum.TryParse(rawOptions.DriverName, true, out DriverName outDriverName);
2323
DriverName = outDriverName;
2424
GenerateGemfile = rawOptions.GenerateGemfile;
25-
RubyVersion = RubyVersionExtensions.ParseName(rawOptions.RubyVersionPattern);
25+
RubyVersion = RubyVersionExtensions.ParseName(rawOptions.RubyVersion);
2626
}
2727

2828
public DriverName DriverName { get; }

‎PluginOptions/PluginOptions.csproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<PropertyGroup>
44
<TargetFramework>net8.0</TargetFramework>
55
<Nullable>enable</Nullable>
6-
<RootNamespace>SqlcGenCsharp</RootNamespace>
6+
<RootNamespace>SqlcGenRuby</RootNamespace>
77
</PropertyGroup>
88

99
<ItemGroup>

‎PluginOptions/RawOptions.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
using System.Text.Json.Serialization;
22

3-
namespace SqlcGenCsharp;
3+
namespace SqlcGenRuby;
44

55
internal class RawOptions
66
{
@@ -10,6 +10,6 @@ internal class RawOptions
1010
[JsonPropertyName("generateGemfile")]
1111
public bool GenerateGemfile { get; init; } // not generating Gemfile files by default
1212

13-
[JsonPropertyName("rubyVersionPattern")]
14-
public string RubyVersionPattern { get; init; } = "3.3";
13+
[JsonPropertyName("rubyVersion")]
14+
public string RubyVersion { get; init; } = "3.3";
1515
}

‎PluginOptions/RubyVersion.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
using System;
22
using System.Text.RegularExpressions;
33

4-
namespace SqlcGenCsharp;
4+
namespace SqlcGenRuby;
55

66
public record RubyVersion(short Major, short? Minor, short? Patch = null) : IComparable<RubyVersion>
77
{

‎README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,11 @@ sql:
3131
driver: mysql2
3232
```
3333
### Options Documentation
34-
TBD
34+
| Option | Possible values | Optional | Info |
35+
|-----------------|------------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------|
36+
| driver | <br/>values: `MySqlConnector`,`Npgsql` | No | Choosing the driver to use - refer to the [above](#supported-sql-engines) section on supported SQL engines. |
37+
| rubyVersion | default: `3.3`<br/>values: `3.1`, `3.2`, `3.3` | Yes | Determines the Ruby version the generated code should support.. |
38+
| generateGemfile | default: `false`<br/>values: `false`,`true` | Yes | Assists you with the integration of SQLC and Ruby by generating a `Gemfile` with the needed dependencies. |
3539

3640
## Supported SQL Engines
3741
- MySQL via [mysql2](https://rubygems.org/gems/mysql2) package - [Mysql2Driver](Drivers/Mysql2Driver.cs)

‎RubySyntax/Basic.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using SqlcGenCsharp;
1+
using SqlcGenRuby;
22

33
namespace RubyCodegen;
44

‎RubySyntax/Flows.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using SqlcGenCsharp;
1+
using SqlcGenRuby;
22

33
namespace RubyCodegen;
44

‎SqlcGenRuby/PluginRunner.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
using Google.Protobuf;
22
using Plugin;
33

4-
namespace SqlcGenCsharp;
4+
namespace SqlcGenRuby;
55

66
public static class PluginRunner
77
{

‎SqlcGenRuby/SqlcGenRuby.csproj

-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
<TargetFramework>net8.0</TargetFramework>
55
<ImplicitUsings>enable</ImplicitUsings>
66
<Nullable>enable</Nullable>
7-
<RootNamespace>SqlcGenCsharp</RootNamespace>
87
</PropertyGroup>
98

109
<ItemGroup>

‎WasmRunner/App.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
using SqlcGenCsharp;
1+
using SqlcGenRuby;
22

33
PluginRunner.Run();

‎WasmRunner/WasmRunner.csproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22
<PropertyGroup>
33
<TargetFramework>net8.0</TargetFramework>
4-
<RootNamespace>SqlcGenCsharp</RootNamespace>
4+
<RootNamespace>SqlcGenRuby</RootNamespace>
55
<OutputType>Exe</OutputType>
66
<RuntimeIdentifier>wasi-wasm</RuntimeIdentifier>
77
<JsonSerializerIsReflectionEnabledByDefault>true</JsonSerializerIsReflectionEnabledByDefault>

0 commit comments

Comments
 (0)