Merge pull request #363 from michaelJustin/362-code-cleanup

michaelJustin · web-flow · commit ea38fd0af252 · 2025-05-17T22:06:31.000+02:00
362 code cleanup
diff --git a/source/djContextConfig.pas b/source/djContextConfig.pas
@@ -39,8 +39,7 @@ interface
   (**
    * Context configuration.
    *)
-  TdjContextConfig = class(TdjAbstractConfig, IContextConfig)
-  end;
+  TdjContextConfig = class(TdjAbstractConfig, IContextConfig);
 
 implementation
 
diff --git a/source/djContextHandlerCollection.pas b/source/djContextHandlerCollection.pas
@@ -75,7 +75,6 @@ constructor TdjContextHandlerCollection.Create;
 begin
   inherited Create;
 
-  // logging -----------------------------------------------------------------
   {$IFDEF DARAJA_LOGGING}
   Logger := TdjLoggerFactory.GetLogger('dj.' + TdjContextHandlerCollection.ClassName);
   {$ENDIF DARAJA_LOGGING}
diff --git a/source/djHTTPConnector.pas b/source/djHTTPConnector.pas
@@ -60,10 +60,8 @@   TdjHTTPConnector = class(TdjAbstractConnector)
     HostAndPort: string;
 
     procedure Trace(const S: string);
-
     procedure OnCommand(AContext: TIdContext;
       ARequestInfo: TdjRequest; AResponseInfo: TdjResponse);
-
   protected
     // TdjLifeCycle overrides
     procedure DoStart; override;
@@ -78,15 +76,13 @@   TdjHTTPConnector = class(TdjAbstractConnector)
      * @param Handler the request handler
      *)
     constructor Create(const Handler: IHandler); virtual;
-
     (**
      * Destructor.
      *)
     destructor Destroy; override;
 
     // properties
     property HTTPServer: TdjHTTPServer read FHTTPServer;
-
   end;
 
 implementation
diff --git a/source/djHandlerWrapper.pas b/source/djHandlerWrapper.pas
@@ -61,9 +61,7 @@   TdjHandlerWrapper = class(TdjAbstractHandlerContainer)
     // getter / setter
     function GetHandler: IHandler;
     procedure SetHandler(const Value: IHandler);
-
     procedure Trace(const S: string);
-
   protected
     (**
      * Get a HTTP session.
diff --git a/source/djPathMap.pas b/source/djPathMap.pas
@@ -117,7 +117,7 @@   TdjPathMap = class(TStringList)
 implementation
 
 uses
-  djInterfaces, djTypes,
+  djTypes,
   SysUtils;
 
 { TdjPathMap }
diff --git a/source/djServer.pas b/source/djServer.pas
@@ -99,15 +99,7 @@   TdjServer = class(TdjServerBase)
     procedure StopContextHandlers;
   protected
     // TdjLifeCycle overrides
-    (**
-     * Execute the custom start code.
-     * @sa TdjLifeCycle
-     *)
     procedure DoStart; override;
-    (**
-     * Execute the custom start code.
-     * @sa TdjLifeCycle
-     *)
     procedure DoStop; override;
   public
     (**
diff --git a/source/djServerContext.pas b/source/djServerContext.pas
@@ -42,9 +42,7 @@ interface
    * A subclass of the Indy context class is used for
    * future extensions.
    *)
-  TdjServerContext = class(TIdServerContext)
-  public
-  end;
+  TdjServerContext = class(TIdServerContext);
 
   TdjServerContextClass = class of TdjServerContext;
 
diff --git a/source/djWebAppContext.pas b/source/djWebAppContext.pas
@@ -39,9 +39,7 @@ interface
   (**
    * Main context handler class.
    *)
-  TdjWebAppContext = class(TdjWebComponentContextHandler)
-  public
-  end;
+  TdjWebAppContext = class(TdjWebComponentContextHandler);
 
 implementation
 
diff --git a/source/djWebComponent.pas b/source/djWebComponent.pas
@@ -59,7 +59,6 @@   TdjWebComponent = class(TdjGenericWebComponent)
     {$ENDIF DARAJA_LOGGING}
 
     procedure DoCachedGet(Request: TdjRequest; Response: TdjResponse); virtual;
-
   protected
     (**
      * Called by the server to handle a DELETE request.
@@ -138,22 +137,10 @@   TdjWebComponent = class(TdjGenericWebComponent)
 
   public
     constructor Create;
-
     destructor Destroy; override;
 
-    (**
-     * Dispatches client requests to the protected service method.
-     *
-     * @note a custom Web Component should not override this method.
-     *
-     * @param Context HTTP server context
-     * @param Request HTTP request
-     * @param Response HTTP response
-     * @throws EWebComponentException if an exception occurs that interferes with the component's normal operation
-     *)
     procedure Service(Context: TdjServerContext; Request: TdjRequest; Response:
       TdjResponse); override;
-
   end;
 
   (**
@@ -181,17 +168,16 @@ constructor TdjWebComponent.Create;
 begin
   inherited Create;
 
-  // logging -----------------------------------------------------------------
-{$IFDEF DARAJA_LOGGING}
+  {$IFDEF DARAJA_LOGGING}
   Logger := TdjLoggerFactory.GetLogger('dj.' + TdjWebComponent.ClassName);
-{$ENDIF DARAJA_LOGGING}
+  {$ENDIF DARAJA_LOGGING}
 
-{$IFDEF LOG_CREATE}Trace('Created');{$ENDIF}
+  {$IFDEF LOG_CREATE}Trace('Created');{$ENDIF}
 end;
 
 destructor TdjWebComponent.Destroy;
 begin
-{$IFDEF LOG_DESTROY}Trace('Destroy');{$ENDIF}
+  {$IFDEF LOG_DESTROY}Trace('Destroy');{$ENDIF}
 
   inherited;
 end;
@@ -306,9 +292,9 @@ procedure TdjWebComponent.Service(Context: TdjServerContext;
       end;
   else
     begin
-{$IFDEF DARAJA_LOGGING}
+        {$IFDEF DARAJA_LOGGING}
         Logger.Error('Unknown HTTP method');
-{$ENDIF DARAJA_LOGGING}
+        {$ENDIF DARAJA_LOGGING}
     end;
   end;
 end;
diff --git a/source/djWebComponentConfig.pas b/source/djWebComponentConfig.pas
@@ -39,8 +39,7 @@ interface
   (**
    * Web Component configuration.
    *)
-  TdjWebComponentConfig = class(TdjAbstractConfig, IWebComponentConfig)
-  end;
+  TdjWebComponentConfig = class(TdjAbstractConfig, IWebComponentConfig);
 
 implementation
 
diff --git a/source/djWebComponentContextHandler.pas b/source/djWebComponentContextHandler.pas
@@ -56,7 +56,10 @@   TdjWebComponentContextHandler = class(TdjContextHandler)
     AutoStartSession: Boolean;
 
     procedure Trace(const S: string);
-
+  protected
+    // IHandler interface
+    procedure Handle(const Target: string; Context: TdjServerContext;
+      Request: TdjRequest; Response: TdjResponse); override;
   protected
     (**
      * @param Target Request target
@@ -66,7 +69,6 @@   TdjWebComponentContextHandler = class(TdjContextHandler)
      *)
     procedure DoHandle(const Target: string; Context: TdjServerContext;
       Request: TdjRequest; Response: TdjResponse);
-
   public
     (**
      * Constructor.
@@ -146,11 +148,6 @@   TdjWebComponentContextHandler = class(TdjContextHandler)
      *)
     function Add(FilterClass: TdjWebFilterClass;
       const UrlPattern: string): TdjWebFilterHolder; overload;
-
-    // IHandler interface
-    procedure Handle(const Target: string; Context: TdjServerContext;
-      Request: TdjRequest; Response: TdjResponse); override;
-
   end;
 
 implementation
diff --git a/source/djWebComponentHandler.pas b/source/djWebComponentHandler.pas
@@ -419,20 +419,20 @@ procedure TdjWebComponentHandler.CreateOrUpdateMapping(const UrlPattern: string;
 
 procedure TdjWebComponentHandler.CheckUniqueName(Holder: TdjWebComponentHolder);
 var
-  I: Integer;
+  CH: TdjWebComponentHolder;
   Msg: string;
 begin
   // fail if there is a different Holder with the same name
-  for I := 0 to WebComponents.Count - 1 do
+  for CH in WebComponents do
   begin
-    if (WebComponents[I].Name = Holder.Name) then
+    if (CH.Name = Holder.Name) then
     begin
       Msg := Format(
         rsTheWebComponentSCanNotBeAddedBecauseClassSIsAlr,
-        [Holder.Name, WebComponents[I].WebComponentClass.ClassName]);
+        [Holder.Name, CH.WebComponentClass.ClassName]);
       Trace(Msg);
 
-      raise EWebComponentException.Create(Msg);
+      raise EWebComponentException.Create(Msg); // todo test
     end;
   end;
 end;
@@ -591,15 +591,15 @@ function TdjWebComponentHandler.FindComponent(const ATarget: string):
 
 function TdjWebComponentHandler.FindHolder(WebComponentClass: TdjWebComponentClass): TdjWebComponentHolder;
 var
-  I: Integer;
+  CH: TdjWebComponentHolder;
 begin
   Result := nil;
 
-  for I := 0 to WebComponents.Count - 1 do
+  for CH in WebComponents do
   begin
-    if WebComponents[I].WebComponentClass = WebComponentClass then
+    if CH.WebComponentClass = WebComponentClass then
     begin
-      Result := WebComponents[I];
+      Result := CH;
       Break;
     end;
   end;
diff --git a/source/djWebComponentHolder.pas b/source/djWebComponentHolder.pas
@@ -62,8 +62,8 @@   TdjWebComponentHolder = class(TdjGenericHolder<TdjWebComponent>)
     // TdjLifeCycle overrides
     procedure DoStart; override;
     procedure DoStop; override;
-  public // todo
-    // ??? IHandler interface
+  public
+    // IHandler interface
     procedure Handle(Context: TdjServerContext; Request: TdjRequest;
       Response: TdjResponse);
   public
diff --git a/source/djWebComponentHolders.pas b/source/djWebComponentHolders.pas
@@ -56,14 +56,14 @@   TdjWebComponentHolders = class(TObjectList<TdjWebComponentHolder>)
      * @param WebComponentName The name of the web component to check.
      * @return True if the web component name exists, otherwise False.
      *)
-    function Contains(WebComponentName: string): Boolean;
+    function Contains(const WebComponentName: string): Boolean;
   end;
 
 implementation
 
 { TdjWebComponentHolders }
 
-function TdjWebComponentHolders.Contains(WebComponentName: string): Boolean;
+function TdjWebComponentHolders.Contains(const WebComponentName: string): Boolean;
 var
   Holder: TdjWebComponentHolder;
 begin
diff --git a/source/djWebFilter.pas b/source/djWebFilter.pas
@@ -47,10 +47,10 @@ interface
   TdjWebFilter = class(TdjGenericWebFilter)
   private
     {$IFDEF DARAJA_LOGGING}
-    {%H-}Logger: ILogger;
+    Logger: ILogger;
     {$ENDIF DARAJA_LOGGING}
   public
-
+    constructor Create;
   end;
 
   (**
@@ -60,5 +60,16 @@   TdjWebFilterClass = class of TdjWebFilter;
 
 implementation
 
+{ TdjWebFilter }
+
+constructor TdjWebFilter.Create;
+begin
+  inherited Create;
+
+  {$IFDEF DARAJA_LOGGING}
+  Logger := TdjLoggerFactory.GetLogger('dj.' + TdjWebFilter.ClassName);
+  {$ENDIF DARAJA_LOGGING}
+end;
+
 end.
 
diff --git a/source/djWebFilterChain.pas b/source/djWebFilterChain.pas
@@ -50,10 +50,10 @@   TdjWebFilterChain = class(TInterfacedObject, IWebFilterChain)
     {$IFDEF DARAJA_LOGGING}
     Logger: ILogger;
     {$ENDIF DARAJA_LOGGING}
-    procedure Trace(const S: string);
-  private
     FChain: IWebFilterChain;
     FHolder: TdjWebFilterHolder;
+
+    procedure Trace(const S: string);
   protected
     // IWebFilterChain
     procedure DoFilter(Context: TdjServerContext; Request: TdjRequest; Response:
@@ -76,7 +76,6 @@ constructor TdjWebFilterChain.Create(Holder: TdjWebFilterHolder;
 begin
   inherited Create;
 
-  // logging -----------------------------------------------------------------
   {$IFDEF DARAJA_LOGGING}
   Logger := TdjLoggerFactory.GetLogger('dj.' + TdjWebFilterChain.ClassName);
   {$ENDIF DARAJA_LOGGING}
diff --git a/source/djWebFilterHolder.pas b/source/djWebFilterHolder.pas
@@ -57,17 +57,12 @@   TdjWebFilterHolder = class(TdjGenericHolder<TdjWebFilter>)
     FConfig: IWebFilterConfig;
     FClass: TdjWebFilterClass;
     FWebFilter: TdjWebFilter;
+
     function GetClass: TdjWebFilterClass;
     procedure Trace(const S: string);
   protected
     // TdjLifeCycle overrides
-    (**
-     * Start the filter.
-     *)
     procedure DoStart; override;
-    (**
-     * Stop the filter.
-     *)
     procedure DoStop; override;
   public
     (**
@@ -135,7 +130,6 @@ constructor TdjWebFilterHolder.Create(WebFilterClass: TdjWebFilterClass);
   FConfig := TdjWebFilterConfig.Create;
   FClass := WebFilterClass;
 
-  // logging -----------------------------------------------------------------
   {$IFDEF DARAJA_LOGGING}
   Logger := TdjLoggerFactory.GetLogger('dj.' + TdjWebFilterHolder.ClassName);
   {$ENDIF DARAJA_LOGGING}
diff --git a/test/unittests/Unittests.lpi b/test/unittests/Unittests.lpi
@@ -94,7 +94,7 @@
     <PathDelim Value="\"/>
     <SearchPaths>
       <IncludeFiles Value="$(ProjOutDir);..\..\..\Indy\Lib\Core"/>
-      <OtherUnitFiles Value="..\..\source;..\..\source\optional;..\..\..\Indy\Lib\Core;..\..\..\Indy\Lib\Protocols;..\..\..\Indy\Lib\System"/>
+      <OtherUnitFiles Value="..\..\source;..\..\source\optional;..\..\..\Indy\Lib\Core;..\..\..\Indy\Lib\Protocols;..\..\..\Indy\Lib\System;..\..\..\slf4p\src\main"/>
       <UnitOutputDirectory Value="lib\$(TargetCPU)-$(TargetOS)"/>
     </SearchPaths>
     <Parsing>
