refactor: Moving WriteHelp + Resource Strings

Author: gcarreno

generator/Common/generate.console.pas

@@ -0,0 +1,64 @@
+unit Generate.Console;
+
+{$mode ObjFPC}{$H+}
+
+interface
+
+uses
+  Classes
+, SysUtils
+;
+
+const
+  cShortOptHelp: Char    = 'h';
+  cLongOptHelp           = 'help';
+  cShortOptVersion: Char = 'v';
+  cLongOptVersion        = 'version';
+  cShortOptInput: Char   = 'i';
+  cLongOptInput          = 'input-file';
+  cShortOptOutput: Char  = 'o';
+  cLongOptOutput         = 'output-file';
+  cShortOptNumner: Char  = 'n';
+  cLongOptNumber         = 'line-count';
+
+
+resourcestring
+  rsAppTitle = 'One Billion Row Challenge Generator';
+  rsGeneratorVersion = 'generator v%s';
+  rsErrorMessage = 'ERROR: %s';
+  rsMissingInputFlag = 'Missing input file flag.';
+  rsMissingOutputFlag = 'Missing output file flag.';
+  rsMissingLineCountFlag = 'Missing line count flag.';
+  rsInvalidInteger = 'ERROR: Invalid integer "%s".';
+  rsInvalidLineNumber = 'Number of lines should be a positive number, greater than 0.';
+  rsInputFile = 'Input Filename: "%s"';
+  rsOutputFile = 'Output Filename: "%s"';
+  rsLineCount = 'Line Count: %.n';
+
+var
+  inputFilename: String = '';
+  outputFilename: String = '';
+  lineCount: Int64 = 0;
+
+procedure WriteHelp;
+
+
+implementation
+
+procedure WriteHelp;
+begin
+  WriteLn('Generates the measurement file with the specified number of lines');
+  WriteLn;
+  WriteLn('USAGE');
+  WriteLn('  generator <flags>');
+  WriteLn;
+  WriteLn('FLAGS');
+  WriteLn('  -h|--help                      Writes this help message and exits');
+  WriteLn('  -v|--version                   Writes the version and exits');
+  WriteLn('  -i|--input-file <filename>     The file containing the Weather Stations');
+  WriteLn('  -o|--output-file <filename>    The file that will contain the generated lines');
+  WriteLn('  -n|--line-count <number>       The amount of lines to be generated');
+end;
+
+end.
+

generator/Common/version.inc

@@ -1 +1 @@
-'0.2'
+'0.3'

generator/Lazarus/src/generator.lpi

@@ -131,7 +131,7 @@
     <RunParams>
       <FormatVersion Value="2"/>
     </RunParams>
-    <Units Count="2">
+    <Units Count="3">
       <Unit0>
         <Filename Value="generator.lpr"/>
         <IsPartOfProject Value="True"/>
@@ -141,6 +141,11 @@
         <IsPartOfProject Value="True"/>
         <UnitName Value="Generate.Common"/>
       </Unit1>
+      <Unit2>
+        <Filename Value="../../Common/generate.console.pas"/>
+        <IsPartOfProject Value="True"/>
+        <UnitName Value="Generate.Console"/>
+      </Unit2>
     </Units>
   </ProjectOptions>
   <CompilerOptions>

generator/Lazarus/src/generator.lpr

@@ -9,28 +9,13 @@
   Classes
 , SysUtils
 , CustApp
+, Generate.Console
 , Generate.Common
 ;
 
 const
   cVersion = {$I version.inc};
 
-  cShortOptHelp: Char    = 'h';
-  cLongOptHelp           = 'help';
-  cShortOptVersion: Char = 'v';
-  cLongOptVersion        = 'version';
-  cShortOptInput: Char   = 'i';
-  cLongOptInput          = 'input-file';
-  cShortOptOutput: Char  = 'o';
-  cLongOptOutput         = 'output-file';
-  cShortOptNumner: Char  = 'n';
-  cLongOptNumber         = 'line-count';
-
-var
-  inputFilename: String = '';
-  outputFilename: String = '';
-  lineCount: Int64 = 0;
-
 type
 
   { TOneBRCGenerator }
@@ -43,7 +28,6 @@   TOneBRCGenerator = class(TCustomApplication)
   public
     constructor Create(TheOwner: TComponent); override;
     destructor Destroy; override;
-    procedure WriteHelp; virtual;
   published
   end;
 
@@ -73,7 +57,7 @@ procedure TOneBRCGenerator.DoRun;
   if ErrorMsg<>'' then
   begin
     //ShowException(Exception.Create(ErrorMsg));
-    WriteLn('ERROR: ', ErrorMsg);
+    WriteLn(Format(rsErrorMessage, [ ErrorMsg ]));
     Terminate;
     Exit;
   end;
@@ -88,7 +72,7 @@ procedure TOneBRCGenerator.DoRun;
 
   if HasOption(cShortOptVersion, cLongOptVersion) then
   begin
-    WriteLn('generator v', cVersion);
+    WriteLn(Format(rsGeneratorVersion, [ cVersion ]));
     Terminate;
     Exit;
   end;
@@ -102,7 +86,7 @@ procedure TOneBRCGenerator.DoRun;
   end
   else
   begin
-    WriteLn('ERROR: Missing input file flag');
+    WriteLn(Format(rsErrorMessage, [ rsMissingInputFlag ]));
     Terminate;
     Exit;
   end;
@@ -116,7 +100,7 @@ procedure TOneBRCGenerator.DoRun;
   end
   else
   begin
-    WriteLn('ERROR: Missing output file flag');
+    WriteLn(Format(rsErrorMessage, [ rsMissingOutputFlag ]));
     Terminate;
     Exit;
   end;
@@ -130,30 +114,30 @@ procedure TOneBRCGenerator.DoRun;
     tmpLineCount:= StringReplace(tmpLineCount, '_', '', [rfReplaceAll]);
     if not TryStrToInt64(tmpLineCount, lineCount) then
     begin
-      WriteLn('ERROR: Invalid integer "',tmpLineCount,'"');
+      WriteLn(Format(rsInvalidInteger, [ tmpLineCount ]));
       Terminate;
       Exit;
     end;
     if not (lineCount > 0) then
     begin
-      WriteLn('ERROR: Number of lines should be a positive number, greater than 0.');
+      WriteLn(Format(rsErrorMessage, [ rsInvalidLineNumber ]));
       Terminate;
       Exit;
     end;
   end
   else
   begin
-    WriteLn('ERROR: Missing line count flag');
+    WriteLn(Format(rsErrorMessage, [ rsMissingLineCountFlag ]));
     Terminate;
     Exit;
   end;
 
   inputFilename:= ExpandFileName(inputFilename);
   outputFilename:= ExpandFileName(outputFilename);
 
-  WriteLn('Input File : ', inputFilename);
-  WriteLn('Output File: ', outputFilename);
-  WriteLn('Line Count : ', Format('%.0n', [ Double(lineCount) ]));
+  WriteLn(Format(rsInputFile, [ inputFilename ]));
+  WriteLn(Format(rsOutputFile, [ outputFilename ]));
+  WriteLn(Format(rsLineCount, [ Double(lineCount) ]));
   WriteLn;
 
   FGenerator:= TGenerator.Create(inputFilename, outputFilename, lineCount);
@@ -163,7 +147,7 @@ procedure TOneBRCGenerator.DoRun;
     except
       on E: Exception do
       begin
-        WriteLn('ERROR: ', E.Message);
+        WriteLn(Format(rsErrorMessage, [ E.Message ]));
       end;
     end;
   finally
@@ -185,27 +169,11 @@ destructor TOneBRCGenerator.Destroy;
   inherited Destroy;
 end;
 
-procedure TOneBRCGenerator.WriteHelp;
-begin
-  { add your help code here }
-  WriteLn('Generates the measurement file with the specified number of lines');
-  WriteLn;
-  WriteLn('USAGE');
-  WriteLn('  generator <flags>');
-  WriteLn;
-  WriteLn('FLAGS');
-  WriteLn('  -h|--help                      Writes this help message and exits');
-  WriteLn('  -v|--version                   Writes the version and exits');
-  WriteLn('  -i|--input-file <filename>     The file containing the Weather Stations');
-  WriteLn('  -o|--output-file <filename>    The file that will contain the generated lines');
-  WriteLn('  -n|--line-count <number>       The amount of lines to be generated');
-end;
-
 var
   Application: TOneBRCGenerator;
 begin
   Application:=TOneBRCGenerator.Create(nil);
-  Application.Title:='One Billion Row Challenge Generator';
+  Application.Title:= rsAppTitle;
   Application.Run;
   Application.Free;
 end.