Merge pull request #55 from thiagoluga/docs/translate-tests-samples

docs: translate remaining Portuguese identifiers (tests + samples)

Author: thiagoluga

.github/workflows/sonar.yml

@@ -62,6 +62,7 @@ jobs:
             /d:sonar.token="${SONAR_TOKEN}" \
             /d:sonar.cs.vscoveragexml.reportsPaths=coverage.xml \
             /d:sonar.coverage.exclusions="benchmarks/**,samples/**" \
+            /d:sonar.cpd.exclusions="benchmarks/**,samples/**" \
             /d:sonar.qualitygate.wait=true
           dotnet build NeoReports.sln --configuration Release
           dotnet-coverage collect "dotnet test NeoReports.sln --configuration Release --no-build" -f xml -o coverage.xml

samples/01-sql-to-csv-local/Program.cs

@@ -5,15 +5,16 @@
 using NeoReports.Core.Pipeline;
 using NeoReports.Destinations.Local;
 using NeoReports.Formats.Csv;
+using NeoReports.Samples.SqlToCsvLocal;
 using NeoReports.Sources.Sql;
 using static NeoReports.Core.Building.ReportColumns;
 
 // Sample 01 — SQL Server -> CSV -> local filesystem (the first end-to-end report).
 //
-// Run against any SQL Server with a Vendas table:
+// Run against any SQL Server with a Sales table:
 //   dotnet run --project samples/01-sql-to-csv-local -- "<connection-string>"
 //
-// Expected schema: Vendas(Id BIGINT, Cliente NVARCHAR, Valor DECIMAL, Data DATETIME2).
+// Expected schema: Sales(Id BIGINT, Customer NVARCHAR, Amount DECIMAL, Date DATETIME2).
 
 var connectionString = args.Length > 0
     ? args[0]
@@ -22,31 +23,29 @@
 var services = new ServiceCollection();
 services.AddLogging(b => b.AddConsole().SetMinimumLevel(LogLevel.Information));
 
-services.AddReport<Venda>("vendas-mensal", b => b
+services.AddReport<Sale>("monthly-sales", b => b
     .From(Source.Sql(
             connectionString,
-            "SELECT Id, Cliente, Valor, Data FROM Vendas " +
+            "SELECT Id, Customer, Amount, Date FROM Sales " +
             "WHERE (@cursor IS NULL OR Id > @cursor) ORDER BY Id")
-        .Keyset<Venda, long>(v => v.Id, pageSize: 1000))
-    .Filter(v => v.Valor > 0)
+        .Keyset<Sale, long>(v => v.Id, pageSize: 1000))
+    .Filter(v => v.Amount > 0)
     .Columns(
-        Col<Venda, long>(v => v.Id, "ID Venda"),
-        Col<Venda, string>(v => v.Cliente, "Cliente"),
-        Col<Venda, decimal>(v => v.Valor, "Valor", format: "C2", culture: "pt-BR"),
-        Col<Venda, DateTime>(v => v.Data, "Data Venda", format: "yyyy-MM-dd"))
+        Col<Sale, long>(v => v.Id, "Sale ID"),
+        Col<Sale, string>(v => v.Customer, "Customer"),
+        Col<Sale, decimal>(v => v.Amount, "Amount", format: "C2", culture: "pt-BR"),
+        Col<Sale, DateTime>(v => v.Date, "Sale Date", format: "yyyy-MM-dd"))
     .To(Format.Csv(o => o.Delimiter(';').Encoding(Encoding.UTF8)))
     .UploadTo(Destination.Local("./out/{name}-{date:yyyy-MM-dd}.{ext}")));
 
 var provider = services.BuildServiceProvider();
 var runner = provider.GetRequiredService<IReportRunner>();
 
-var result = await runner.RunAsync("vendas-mensal");
+var result = await runner.RunAsync("monthly-sales");
 
 Console.WriteLine($"Status: {result.Status}");
 Console.WriteLine($"Records read/written: {result.Stats.RecordsRead}/{result.Stats.RecordsWritten}");
 foreach (var upload in result.Uploads)
     Console.WriteLine($"Uploaded: {upload.RemotePath} (success={upload.Success})");
 
 return result.Status == ReportRunStatus.Failed ? 1 : 0;
-
-internal sealed record Venda(long Id, string Cliente, decimal Valor, DateTime Data);

samples/01-sql-to-csv-local/Sale.cs

@@ -0,0 +1,4 @@
+namespace NeoReports.Samples.SqlToCsvLocal;
+
+/// <summary>The report row type for the sample, in a named namespace (not a top-level type).</summary>
+public sealed record Sale(long Id, string Customer, decimal Amount, DateTime Date);

samples/02-sql-to-xlsx-s3/Program.cs

@@ -4,6 +4,7 @@
 using NeoReports.Core.DependencyInjection;
 using NeoReports.Core.Pipeline;
 using NeoReports.Destinations.S3;
+using NeoReports.Samples.SqlToXlsxS3;
 using NeoReports.Sources.Sql;
 using static NeoReports.Core.Building.ReportColumns;
 // Import the format entry methods directly so Csv(...) and Xlsx(...) read cleanly and avoid the
@@ -25,32 +26,30 @@
 var services = new ServiceCollection();
 services.AddLogging(b => b.AddConsole().SetMinimumLevel(LogLevel.Information));
 
-services.AddReport<Venda>("vendas-mensal", b => b
+services.AddReport<Sale>("monthly-sales", b => b
     .From(Source.Sql(
             connectionString,
-            "SELECT Id, Cliente, Valor, Data FROM Vendas " +
+            "SELECT Id, Customer, Amount, Date FROM Sales " +
             "WHERE (@cursor IS NULL OR Id > @cursor) ORDER BY Id")
-        .Keyset<Venda, long>(v => v.Id, pageSize: 1000))
-    .Filter(v => v.Valor > 0)
+        .Keyset<Sale, long>(v => v.Id, pageSize: 1000))
+    .Filter(v => v.Amount > 0)
     .Columns(
-        Col<Venda, long>(v => v.Id, "ID Venda"),
-        Col<Venda, string>(v => v.Cliente, "Cliente"),
-        Col<Venda, decimal>(v => v.Valor, "Valor", format: "C2", culture: "pt-BR"),
-        Col<Venda, DateTime>(v => v.Data, "Data Venda", format: "yyyy-MM-dd"))
+        Col<Sale, long>(v => v.Id, "Sale ID"),
+        Col<Sale, string>(v => v.Customer, "Customer"),
+        Col<Sale, decimal>(v => v.Amount, "Amount", format: "C2", culture: "pt-BR"),
+        Col<Sale, DateTime>(v => v.Date, "Sale Date", format: "yyyy-MM-dd"))
     .To(Csv(o => o.Delimiter(';').Encoding(Encoding.UTF8)))
-    .To(Xlsx(o => o.SheetName("Vendas").AutoFilter()))
+    .To(Xlsx(o => o.SheetName("Sales").AutoFilter()))
     .UploadTo(Destination.S3(bucket, "reports/{name}/{date:yyyy-MM-dd}.{ext}")));
 
 var provider = services.BuildServiceProvider();
 var runner = provider.GetRequiredService<IReportRunner>();
 
-var result = await runner.RunAsync("vendas-mensal");
+var result = await runner.RunAsync("monthly-sales");
 
 Console.WriteLine($"Status: {result.Status}");
 Console.WriteLine($"Records read/written: {result.Stats.RecordsRead}/{result.Stats.RecordsWritten}");
 foreach (var upload in result.Uploads)
     Console.WriteLine($"Uploaded: {upload.Url} (success={upload.Success})");
 
 return result.Status == ReportRunStatus.Failed ? 1 : 0;
-
-internal sealed record Venda(long Id, string Cliente, decimal Valor, DateTime Data);

samples/02-sql-to-xlsx-s3/Sale.cs

@@ -0,0 +1,4 @@
+namespace NeoReports.Samples.SqlToXlsxS3;
+
+/// <summary>The report row type for the sample, in a named namespace (not a top-level type).</summary>
+public sealed record Sale(long Id, string Customer, decimal Amount, DateTime Date);

src/Formats/NeoReports.Formats.Xlsx/XlsxOptions.cs

@@ -1,7 +1,7 @@
 namespace NeoReports.Formats.Xlsx;
 
 /// <summary>
-/// Fluent options for the XLSX writer (<c>o.SheetName("Vendas").AutoFilter()</c>).
+/// Fluent options for the XLSX writer (<c>o.SheetName("Sales").AutoFilter()</c>).
 /// Defaults: sheet "Sheet1", a header row from each column's <c>DisplayName</c>, auto-filter off.
 /// </summary>
 public sealed class XlsxOptions

tests/NeoReports.AspNetCore.IntegrationTests/EndpointsTests.cs

@@ -29,7 +29,7 @@ public async Task List_reports_returns_registered_report()
         var reports = await client.GetFromJsonAsync<List<JsonElement>>("/api/reports", Json);
 
         reports.ShouldNotBeNull();
-        reports.ShouldContain(r => r.GetProperty("name").GetString() == "vendas");
+        reports.ShouldContain(r => r.GetProperty("name").GetString() == "sales");
     }
 
     [Fact]
@@ -39,7 +39,7 @@ public async Task Async_run_goes_queued_to_completed_and_downloads()
         var client = host.GetTestClient();
 
         // CA-9: async trigger returns 202 + jobId.
-        var run = await client.PostAsJsonAsync("/api/reports/vendas/run", new { parameters = (object?)null }, Json);
+        var run = await client.PostAsJsonAsync("/api/reports/sales/run", new { parameters = (object?)null }, Json);
         run.StatusCode.ShouldBe(HttpStatusCode.Accepted);
 
         var accepted = await run.Content.ReadFromJsonAsync<JsonElement>(Json);
@@ -65,7 +65,7 @@ public async Task Async_run_goes_queued_to_completed_and_downloads()
         download.Content.Headers.ContentDisposition!.FileName!.Trim('"').ShouldEndWith(".csv");
 
         var text = await download.Content.ReadAsStringAsync();
-        text.ShouldContain("ID;Cliente");   // header
+        text.ShouldContain("ID;Customer");   // header
         text.ShouldContain("1;C1");          // first row
         var dataLines = text.Split('\n', StringSplitOptions.RemoveEmptyEntries);
         dataLines.Length.ShouldBe(31);       // header + 30 rows
@@ -78,14 +78,14 @@ public async Task Sync_run_streams_single_output_with_content_disposition()
         var client = host.GetTestClient();
 
         // CA-10: sync streams the file directly.
-        var response = await client.PostAsJsonAsync("/api/reports/vendas/run?mode=sync", new { }, Json);
+        var response = await client.PostAsJsonAsync("/api/reports/sales/run?mode=sync", new { }, Json);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
         response.Content.Headers.ContentType!.MediaType.ShouldBe("text/csv");
         response.Content.Headers.ContentDisposition!.FileName!.Trim('"').ShouldEndWith(".csv");
 
         var text = await response.Content.ReadAsStringAsync();
-        text.ShouldContain("ID;Cliente");
+        text.ShouldContain("ID;Customer");
         text.ShouldContain("30;C30");
     }
 
@@ -94,7 +94,7 @@ public async Task Sync_run_rejects_multi_output_with_400()
     {
         using var host = await TestApp.StartAsync(services =>
         {
-            services.AddReport<Venda>("multi", b => b
+            services.AddReport<Sale>("multi", b => b
                 .From(new InMemorySource(rows: 5, pageSize: 10))
                 .Column(v => v.Id, "ID")
                 .To(Csv(o => o.Delimiter(';')))
@@ -157,7 +157,7 @@ public async Task Cancel_running_job_is_accepted()
         // A slow source keeps the job running long enough to cancel it deterministically.
         using var host = await TestApp.StartAsync(services =>
         {
-            services.AddReport<Venda>("slow", b => b
+            services.AddReport<Sale>("slow", b => b
                 .From(new InMemorySource(rows: 100_000, pageSize: 10, delay: TimeSpan.FromMilliseconds(20)))
                 .Column(v => v.Id, "ID")
                 .To(Csv(o => o.Delimiter(';'))));
@@ -185,7 +185,7 @@ public async Task Download_multi_output_returns_zip()
     {
         using var host = await TestApp.StartAsync(services =>
         {
-            services.AddReport<Venda>("multi", b => b
+            services.AddReport<Sale>("multi", b => b
                 .From(new InMemorySource(rows: 5, pageSize: 10))
                 .Column(v => v.Id, "ID")
                 .To(Csv(o => o.Delimiter(';')))

tests/NeoReports.AspNetCore.IntegrationTests/TestApp.cs

@@ -16,10 +16,10 @@
 namespace NeoReports.AspNetCore.IntegrationTests;
 
 /// <summary>Reference row type for the API tests.</summary>
-public sealed record Venda(long Id, string Cliente);
+public sealed record Sale(long Id, string Customer);
 
 /// <summary>In-memory batch source synthesizing a fixed number of rows, one page at a time.</summary>
-public sealed class InMemorySource : IBatchSource<Venda>
+public sealed class InMemorySource : IBatchSource<Sale>
 {
     private readonly long _rows;
     private readonly int _pageSize;
@@ -34,23 +34,23 @@ public InMemorySource(long rows, int pageSize, TimeSpan delay = default)
 
     public ReportSchema Schema { get; } = new(new[] { new ReportColumn("Id", ColumnType.Integer) });
 
-    public async Task<BatchResult<Venda>> ReadBatchAsync(BatchContext context, CancellationToken cancellationToken)
+    public async Task<BatchResult<Sale>> ReadBatchAsync(BatchContext context, CancellationToken cancellationToken)
     {
         if (_delay > TimeSpan.Zero)
             await Task.Delay(_delay, cancellationToken).ConfigureAwait(false);
 
         var last = context.Cursor is null ? 0L : long.Parse(context.Cursor, System.Globalization.CultureInfo.InvariantCulture);
         var start = last + 1;
         if (start > _rows)
-            return BatchResult<Venda>.Empty;
+            return BatchResult<Sale>.Empty;
 
         var end = Math.Min(start + _pageSize - 1, _rows);
-        var rows = new List<Venda>();
+        var rows = new List<Sale>();
         for (var id = start; id <= end; id++)
-            rows.Add(new Venda(id, $"C{id}"));
+            rows.Add(new Sale(id, $"C{id}"));
 
         var hasMore = end < _rows;
-        return new BatchResult<Venda>(rows, hasMore ? end.ToString(System.Globalization.CultureInfo.InvariantCulture) : null, hasMore);
+        return new BatchResult<Sale>(rows, hasMore ? end.ToString(System.Globalization.CultureInfo.InvariantCulture) : null, hasMore);
     }
 }
 
@@ -76,10 +76,10 @@ public static async Task<IHost> StartAsync(Action<IServiceCollection>? configure
                     }
                     else
                     {
-                        services.AddReport<Venda>("vendas", b => b
+                        services.AddReport<Sale>("sales", b => b
                             .From(new InMemorySource(rows: 30, pageSize: 10))
                             .Column(v => v.Id, "ID")
-                            .Column(v => v.Cliente, "Cliente")
+                            .Column(v => v.Customer, "Customer")
                             .To(Csv(o => o.Delimiter(';'))));
                     }
 

tests/NeoReports.Core.UnitTests/Fakes/TestFakes.cs

@@ -4,7 +4,7 @@
 namespace NeoReports.Core.UnitTests.Fakes;
 
 /// <summary>Reference row type used across the tests.</summary>
-public sealed record Venda(long Id, string Cliente, decimal Valor, DateTime Data);
+public sealed record Sale(long Id, string Customer, decimal Amount, DateTime Date);
 
 /// <summary>Minimal service provider that resolves nothing (factories under test ignore it).</summary>
 public sealed class EmptyServiceProvider : IServiceProvider

tests/NeoReports.Core.UnitTests/FileSystemArtifactStoreTests.cs

@@ -23,11 +23,11 @@ public async Task Save_then_list_round_trips_file_and_mime()
         var store = new FileSystemArtifactStore(_root);
         var src = MakeSourceFile("id;name\n1;Ana\n");
 
-        await store.SaveAsync("job-1", src, "vendas.csv", "text/csv", Ct);
+        await store.SaveAsync("job-1", src, "sales.csv", "text/csv", Ct);
 
         var artifacts = await store.ListAsync("job-1", Ct);
         var artifact = artifacts.ShouldHaveSingleItem();
-        artifact.FileName.ShouldBe("vendas.csv");
+        artifact.FileName.ShouldBe("sales.csv");
         artifact.MimeType.ShouldBe("text/csv");
         artifact.SizeBytes.ShouldBeGreaterThan(0);
         File.Exists(artifact.Path).ShouldBeTrue();