bogdanpolak / dataset-generator Goto Github PK

Add code

function Create_ABC_DataSet: TDataSet;
var
  ds: TFDMemTable;
begin
  ds := TFDMemTable.Create(Self);
  // Old code
  ds.First;
  Result := ds;
end;

Can't generate mock data in TFDMemTable for TBCDField.

1. No data for ftBCD
2. Incorrect AddField: FieldDefs.Add('Price', ftBCD, 2); (two size parameters)

• WHEN: Generator.DataSetType:= dstClientDataSet;
• THEN: actualCode := Generator.GenFunction; actualCode is not compiling (TClientDataSet can't be assigned to TFDMemTable):

function CreateDataSet (aOwner: TComponent): TDataSet;
var
  ds: TFDMemTable;
begin
  ds := TClientDataSet.Create(AOwner);

Refactoring

• Refactor method: TDSGenerator.GenFunction not to use Execute (string lists)

Remove protected methods from TDSGenerator (exposed for unit tests) and delete class TDSGeneratorUnderTest

Refine the possibility of decomposition this item into several smaller Stories

1. Remove Test.Common.TTestGenerate
   • tests are too difficult to read because of the reusability
2. Refactor component class name: TGenerateDataSet
3. Rename test classes and test units
4. Add method constructing dataset: ds := GivenSampleDataSet (aOwner)
5. Add fOwner: TComponent to manage dataset memory
6. Add helper: TAssert.AreStringListsEqual (expectedCode, generatedCode) - comparing by lines
7. Add new testing unit TestGenerator

  TAppendMode = (amMultilineAppend, amSinglelineAppend, amAppendRows);

amAppendRows mode:

  ds.AppendRows([
    [1, 'Team integration', EncodeDate(2019, 09, 16), 1.2, 1200],
    [2, 'Progress retrospective', Null, Null, 950]
  ]);

Improve divide long string litterals (76+ chars):

• The algorithm should divide whole worlds (line lenght less or equal to 76 chars).

Example:

Should:

FieldByName('Description').Value :=
  'Covers Dependency Injection, you''ll learn about Constructor Injection' +
  ', Property Injection, and Method Injection and about the right and' +
  ' wrong way to use it';

Now:

FieldByName('Description').Value :=
  'Covers Dependency Injection, you''ll learn about Constructor Injection, Pro' +
  'perty Injection, and Method Injection and about the right andwrong way to u' +
  'se it';

Refactor code in src folder info one unit to allow easy copy to other Delphi projects

1. No changes:

unit {UnitName};

default: fUnitName = uSampleDataSet
2) factory method interface declaration:

function GivienDataSet (aOwner: TComponent): TDataSet;

3. factory method implementation:

function GivienDataSet  (aOwner: TComponent): TDataSet;
begin

GenerateAndSaveToFile is generating invalid file: unit name is default uSampleDataSet and file name is provided though parameter doesn't changes unit name

Method GenerateAndSaveToFile call:

TDSGenerator.GenerateAndSaveToFile(aDataSet, 
    'FakeDataSet.Historical.pas');

generates:

unit uSampleDataSet;

but expected is:

unit FakeDataSet.Historical;

Build new sample project with TOrdersView:

function TOrdersView.SelectMonth;
var
  aDate: TDateTime;
begin
  aDate := fMonthSelector.Execute;
  aDataSet := fDataSetFactory.ConstructSelectDataset(
    SQL_SELECT_CustomerOrders_FromOneMonth, 
    [YearOf(aDate), MonthOf(aDate)] );
  SetMasterDataset(aDataSet);
end;

And test ImpactSales with Fake dataset:

procedure TestOrdersView.Setup;
begin
  fOwner := TComponent.Create;
  fOrderModelMock := TMock<IOrdersModel>.Create;
  fOrdersView := TOrdersView.Create(fOrderModelMock);
  // ...
end;

procedure TestOrdersView.Test_CalculateCurrentImpact;
var
  aFakeOrdersDataSet: TDataSet;
  actualImpact: Extended;
begin
  aFakeOrdersDataSet := CreateDataSet(fOwner);
  fOrdersView.SetMasterDataset(aFakeOrdersDataSet);
  
  actualImpact := fOrdersView.GetCurrentImpact;

  Assert.AreEqual(0.054, actualImpact, 0.0000001);
end;

1. Update unit tests: Append and whole Generator
2. implement new feature:

  ds.First;
{$ENDREGION}

Implement:

• Score calculation for one order based on Total Order Value and Product Category
• Score range [0 .. 100]
• Display in TMemo

Related to: #39

Remove protected methods from TDSGenerator (exposed for unit tests) and delete class TDSGeneratorUnderTest

Refine the possibility of decomposition this item into several smaller Stories

Should be:

  with ds do
  begin
    Append;
    FieldByName('ISBN').Value := '978-0321127426';
    FieldByName('Title').Value := 'Patterns of Enterprise Application Architecture';
    Post;
  end;
  with ds do
  begin
    Append;
    FieldByName('ISBN').Value := '978-1849689121';
    FieldByName('Title').Value := 
      'Applied Architecture Patterns on the Microsoft Platform (Second Edit'+
      'ion)';
    Post;
  end;

Now is:

  with ds do
  begin
    Append;
      FieldByName('ISBN').Value := '978-0321127426';
      FieldByName('Title').Value := 'Patterns of Enterprise Application Architecture';
    Post;
    Append;
      FieldByName('ISBN').Value := '978-1849689121';
      FieldByName('Title').Value := 
        'Applied Architecture Patterns on the Microsoft Platform (Second Edit'+
        'ion)';
    Post;
  end;

Sample

function CreateDataSet (AOwner: TComponent): Data.DB.TDataSet;
var
  ds: TFDMemTable;
begin
  ds := TFDMemTable.Create(AOwner);
  with ds do
  begin
    FieldDefs.Add('id', ftInteger);
    FieldDefs.Add('text1', ftWideString, 30);
    FieldDefs.Add('date1', ftDate);
    FieldDefs.Add('float1', ftFloat);
    FieldDefs.Add('currency1', ftCurrency);
    CreateDataSet;
    AppendRecord([1, 'Ala ma kota', EncodeDate(2019, 09, 16), 1.2, 1200]);
    AppendRecord([2, 'Ala ma kota', System.Variants.Null, Null, 950]);
  end;
  ds.First;
  Result := ds;
end;

procedure TForm1.Button1Click(Sender: TObject);
var
  Generator: TGenerateDataSetCode;
begin
  Generator := TGenerateDataSetCode.Create(Self);
  Generator.DataSet := CreateDataSet(Generator);
  GenerateDataSetCode.Execute;
  Memo1.Lines := GenerateDataSetCode.Code;
  Generator.Free;
end;

Memo1 content

ds := TFDMemTable.Create(AOwner);
with ds do
begin
  FieldDefs.Add(''id'', ftInteger);
  FieldDefs.Add(''text1'', ftWideString, 30);
  FieldDefs.Add(''date1'', ftDate);
  FieldDefs.Add(''float1'', ftFloat);
  FieldDefs.Add(''currency1'', ftCurrency);
  CreateDataSet;
end;
with ds do
begin
  Append;
  FieldByName(''id'').Value := 1;
  FieldByName(''text1'').Value := ''Ala ma kota'';
  FieldByName(''date1'').Value := EncodeDate(2019,9,16);
  FieldByName(''float1'').Value := 1.2;
  FieldByName(''currency1'').Value := 1200;
  Post;
end;
with ds do
begin
  Append;
  FieldByName(''id'').Value := 2;
  FieldByName(''text1'').Value := ''Ala ma kota'';
  FieldByName(''currency1'').Value := 950;
  Post;
end;

New properties

Add properties to component TGenerateDataSetCode

• `Header: TStrings read FHeader write FHeader;
• Footer as above

Add option:

type
  TAppendMode = (amMultilineAppends, amSinglelineAppends);

  TDSGenerator = class (TComponent)
    property AppendMode: TAppendMode ... ;

In the first mode component is generating same code as before, but in new mode (amSinglelineAppends) it should generate single AppendRecord method for the whole data row:

with ds do
begin
  AppendRecord ([ 1, ''Ala ma kota'', EncodeDate(2019,9,16), 1.2, 1200]);
  AppendRecord ([2, ''Ala ma kota'', Null, 950]);
  Post;
end;

Option

type
  TGeneratorMode = genAll (default), genStructure, genAppend);

  TDSGenerator = class(TComponent)
  // ...
    property GeneratorMode: TGeneratorMode ...;

One Code property
Change:

//    property CodeWithStructure: TStrings read FCodeWithStructue;
//    property CodeWithAppendData: TStrings read FCodeWithAppendData;
    property Code: TStrings read FCode

has influence on methods:

• GenerateAsString
• GenerateAsArray

Add method generating:

1. Generate whole unit (PAS) code to stream (file)
   • GenerateAndSaveToStream (ds, stream)
   • GenerateAndSaveToFile (ds, fileName)

Generate TBlobFields encoded as Base64
Add new property:
GenerateBlobFields: boolean - default: `False'

Related to:
bogdanpolak/class-helpers#40

https://github.com/bogdanpolak/class-helpers/blob/master/src/Helper.TBytes.pas

• TBytesHelper.GenerateBase64Code()
• TBytesHelper.InitialiseFromBase64String()

Checkout: Frame.ByteAndStreamHelpers.pas:
https://github.com/bogdanpolak/class-helpers/blob/master/examples/01-playground/Frame.ByteAndStreamHelpers.pas

Removed version-bumper sources from this project. Left here only bumper configuration with README and link for the sources

Current sources are in https://github.com/bogdanpolak/version-bumper

version-bumper.md:

## Tool: Version Bumper - console application
repo: https://github.com/bogdanpolak/version-bumper

1. Rename unit
2. Rename project to Memory DataSet Generator
3. Update Supported Delphi version to 11.2
4. Update unit header title and project link

{* ------------------------------------------------------------------------
 * ♥
 * ♥ DataSet to Delphi Code (create TFDMemTable with the data)
 * ♥
 * Component: TDSGenerator
 * Project: https://github.com/bogdanpolak/datasetToDelphiCode
 * ------------------------------------------------------------------------ }

Remove with sections:

ds.Append;
ds.FieldByName(''id'').Value := 1;
ds.FieldByName(''text1'').Value := ''Alice has a cat';
ds.Post;
ds.Append;
ds.FieldByName(''id'').Value := 2;
ds.FieldByName(''text1'').Value := ''Cat has a'';
ds.Post;

Generated long string literals can have variable length: default = 76 chars

Change property Code: TStrings read FCode; into:

 property CodeWithStructure: TStrings read FCode;
 property CodeWithAppendData: TStrings read FCode;

1. Update unit tests
2. Update the component
3. Update a documentation

New documentation

Structure creation = CodeWithStructure

ds := TFDMemTable.Create(AOwner);
with ds do
begin
  FieldDefs.Add(''id'', ftInteger);
  FieldDefs.Add(''text1'', ftWideString, 30);
  FieldDefs.Add(''date1'', ftDate);
  FieldDefs.Add(''float1'', ftFloat);
  FieldDefs.Add(''currency1'', ftCurrency);
  CreateDataSet;
end;

Data insertion = CodeWithAppendData :

with ds do
begin
  Append;
  FieldByName(''id'').Value := 1;
  FieldByName(''text1'').Value := ''Ala ma kota'';
  FieldByName(''date1'').Value := EncodeDate(2019,9,16);
  FieldByName(''float1'').Value := 1.2;
  FieldByName(''currency1'').Value := 1200;
  Post;
  Append;
  FieldByName(''id'').Value := 2;
  FieldByName(''text1'').Value := ''Ala ma kota'';
  FieldByName(''currency1'').Value := 950;
  Post;
end;

Method: TDSGenerator.GenerateAppendsBlock is not persisting original dataset position (current row / record).

Update items:

1. Add section "Fakes vs mocks"
2. MaxRows property
   • default = 100
3. Update docs and samples to - [Pack Append Section - remove with]

Replace TMemo with Scorecards Tiles

Related to #39

Stary:

  with ds do
  begin
    Append;
...
  end;

Nowy:

{$REGION 'Append data to MemTable'}
  with ds do
  begin
    Append;
...
  end;
  {$ENDREGION}

1. Generate factory method code to clipboard
   • GenerateAndSaveToClipboard (ds)

actual:

TGeneratorMode = (genAll, genStructure, genAppend, genUnit, genFunction);

expected:

TGeneratorMode= (genStructure, genAppend, genFunction, genUnit);

Default mode = genFunction

Create new option MaxInserts :

1. MaxInserts = 0 (generate all rows)
2. MaxInserts = n (generate n rows)

Code Generator TGenerateDataSetCode should have property IndentationText: string

Add property IndentationText
Given developer willing to set up indentation text for each line of the generated code
When ...
And ..
Then ...

convert double apostrophes '' into single ' in sample code used in main README.md

Investigate:

TGeneratorOptions = record
  IndentationText: String;
  DataSetType: TDataSetType;
  AppendMode: TAppendMode;
  MaxRows: Integer;
end;

and overloaded methods:

GenerateAsString(ds: TDataSet; const options: TGeneratorOptions): string;
GenerateAsArray(ds: TDataSet; const options: TGeneratorOptions): TArray<String>;
GenerateAndSaveToStream(ds: TDataSet; aStream: TStream; const options: TGeneratorOptions);
GenerateAndSaveToFile(ds: TDataSet; const aFileName: string; const options: TGeneratorOptions);
GenerateAndSaveClipboard(ds: TDataSet; const options: TGeneratorOptions);

Warning: [dcc32 Warning] Comp.Generator.DataSetCode.pas(71): W1009 Redeclaration of 'UnitName' hides a member in the base class in:

type
  TDSGenerator = class(TComponent)
    ...
    property UnitName: string read fUnitName write fUnitName;
  end;

Rename fUnitName -> fNameOfUnit
Serach for UnitName in tests and samples (warning code can be compiled even with partial rename)

Add signature and register component version in this.

Discussion: Please suggest signature templete (how to automaticly verify version?). Maybe version can be write down in component const section?

Add new option:

  TGenerateDataSetType = (genClientDS, genFDMemTable);
...
  GenerateDataSet: TGenerateDataSetType;

Update function Gen_UnitHeader according to Proxy generator changes:

function TDataProxyGenerator.Gen_UnitHeader: string;
begin
  Result :=
    {} 'unit Proxy.' + fObjectName + ';'+ sLineBreak +
    {} sLineBreak;
end;

Refactor option TGeneratorMode to:

  TGeneratorMode = (genStructure, genAppend, genFunction, genUnit);

with default value = genFunction

UPDATE DOC

Divide long string litterals into chunks, each 76 characters lenght. Algotrhim shuld divide whole worlds (line lenght less or equal to 76 chars).
Should be:

    FieldByName('Description').Value :=
      'Covers Dependency Injection, you''ll learn about Constructor Injection' +
      ', Property Injection, and Method Injection and about the right and' +
      ' wrong way to use it';

Info

Property should be used for each indentation. Requires #10.

Test

• Test with one tab indentation

Warning! Could require big refactoring in test code (templates with indentation: use right arrow char (→ ◇ ↩ ↦ ▷)

1. folder: generators => sample
2. project: generators/Dataset2Code.dproj => sample/DemoGenerateDataSet.dproj
3. project: tests/DUnitxDatasetToCode.dproj => tests/TestDSGenerator.dproj

In working directory of project in Windows machine there are some uncommitted changes

Update main README file and samples:

1. Describe usage scenario (unit tests)
2. TDSGenerator component usage
3. Methods:
   • GenerateAsString
   • GenerateAsArray
   • GenerateAndSaveToStream / GenerateAndSaveToFile
   • GenerateAndSaveToClipboard
4. Options
   • IdentationText
   • GenerateCode
   • AppendMode
   • GenerateDataSet
5. Component Class TDSGenerator

Update project sample

not delivered in current version (1.2) where it was requested