Merge branch 'feature/update-license-info' into develop

Author: delphidabbler

Src/DB.UMetaData.pas

@@ -125,6 +125,11 @@   TDBLicenseInfo = record
     property URL: string read fURL;
     ///  <summary>Full text of license.</summary>
     property Text: string read fText;
+    ///  <summary>Returns a string containing license name followed by any URL
+    ///  in parentheses.</summary>
+    ///  <remarks>If no URL is available then only the license name is returned.
+    ///  </remarks>
+    function NameWithURL: string;
   end;
 
   ///  <summary>Record providing informaton about the main database copyright.
@@ -938,6 +943,13 @@ constructor TDBLicenseInfo.Create(const AName, ASPDX, AURL, AText: string);
   fText := AText;
 end;
 
+function TDBLicenseInfo.NameWithURL: string;
+begin
+  Result := fName;
+  if fURL <> '' then
+    Result := Result + ' (' + fURL + ')';
+end;
+
 { TDBCopyrightInfo }
 
 constructor TDBCopyrightInfo.Create(const ADate, AHolder, AHolderURL: string);

Src/SWAG.UImporter.pas

@@ -9,7 +9,6 @@
  * CodeSnip format and adds them to the database.
 }
 
-// TODO -cDatabase: check BSD3URI const has valid license info
 
 unit SWAG.UImporter;
 
@@ -161,27 +160,20 @@ function TSWAGImporter.ExtraBoilerplate: IActiveText;
   sStatementPrefix = 'This snippet was imported from the ';
   sStatementLinkText = 'SWAG Pascal Archive';
   sStatementPostfix = '. ';
-  sLicensePrefix = 'Unless stated otherwise this snippet is licensed under '
-    + 'the ';
-  sLicenseLinkText = 'BSD 3-Clause License';
-  sLicensePostfix = '.';
-const
-  // URLs of web pages referenced from links in boilerplate
+  sLicense = 'The code snippets in the archive pages are generally freeware or '
+    + 'public domain as defined by any accompanying comments and copyright '
+    + 'statements. Contact the author if in doubt.';
+  // URL of web page referenced from links in boilerplate
   SWAGDBURI = 'https://github.com/delphidabbler/swag';
-  BSD3URI = 'http://opensource.org/licenses/BSD-3-Clause';
 var
-  // Active text attributes for links included in boilerplate
+  // Active text attributes for link included in boilerplate
   SWAGDBURIAttr: IActiveTextAttrs;
-  BSD3URIAttr: IActiveTextAttrs;
 begin
   if not Assigned(fExtraBoilerplate) then
   begin
     SWAGDBURIAttr := TActiveTextFactory.CreateAttrs(
       TActiveTextAttr.Create('href', SWAGDBURI)
     );
-    BSD3URIAttr := TActiveTextFactory.CreateAttrs(
-      TActiveTextAttr.Create('href', BSD3URI)
-    );
     fExtraBoilerplate := TActiveTextFactory.CreateActiveText;
     fExtraBoilerplate.AddElem(
       TActiveTextFactory.CreateActionElem(ekPara, fsOpen)
@@ -202,19 +194,7 @@ function TSWAGImporter.ExtraBoilerplate: IActiveText;
       TActiveTextFactory.CreateTextElem(sStatementPostfix)
     );
     fExtraBoilerplate.AddElem(
-      TActiveTextFactory.CreateTextElem(sLicensePrefix)
-    );
-    fExtraBoilerplate.AddElem(
-      TActiveTextFactory.CreateActionElem(ekLink, BSD3URIAttr, fsOpen)
-    );
-    fExtraBoilerplate.AddElem(
-      TActiveTextFactory.CreateTextElem(sLicenseLinkText)
-    );
-    fExtraBoilerplate.AddElem(
-      TActiveTextFactory.CreateActionElem(ekLink, BSD3URIAttr, fsClose)
-    );
-    fExtraBoilerplate.AddElem(
-      TActiveTextFactory.CreateTextElem(sLicensePostfix)
+      TActiveTextFactory.CreateTextElem(sLicense)
     );
     fExtraBoilerplate.AddElem(
       TActiveTextFactory.CreateActionElem(ekPara, fsClose)

Src/USaveUnitMgr.pas

@@ -96,9 +96,11 @@ implementation
   // Delphi
   SysUtils,
   // Project
-  UAppInfo, UUrl, UUtils;
+  DB.UMetaData,
+  UAppInfo,
+  UUrl,
+  UUtils;
 
-// TODO -cDatabase: get license info from database rather than use literal text.
 
 resourcestring
   // Dialog box title
@@ -113,11 +115,9 @@ implementation
   // Error message
   sErrorMsg = 'Filename is not valid for a Pascal unit';
   // Unit header comments
-  // TODO -cWeb: Change following to get license from database meta data
-  sLicense = 'This unit is copyright © %0:s by the Peter Johnson and Code '
-    + 'Snippets Database contributors and is licensed under the MIT license '
-    + '(http://opensource.org/licenses/MIT).';
-  sMainDescription = 'The unit was generated automatically and incorporates a '
+  sLicense = 'The unit is copyright © %0:s by %1:s and is licensed under '
+    + 'the %2:s.';
+  sMainDescription = 'This unit was generated automatically. It incorporates a '
     + 'selection of source code taken from the Code Snippets Database at %0:s.';
   sGenerated = 'Generated on : %0:s.';
   sGenerator = 'Generated by : %0:s %1:s.';
@@ -144,14 +144,26 @@ procedure TSaveUnitMgr.CheckFileName(const FileName: string;
 end;
 
 function TSaveUnitMgr.CreateHeaderComments: IStringList;
+var
+  DBMetaData: IDBMetaData;
 begin
   Result := TIStringList.Create;
   if fContainsMainDBSnippets then
   begin
-    // Result used for units that contain at snippet(s) from main database
-    Result.Add(Format(sLicense, [FormatDateTime('YYYY', Now)]));
+    // Result used for units that contain any snippet(s) from main database
+    Result.Add(Format(sMainDescription, [TURL.CodeSnippetsDBRepo]));
     Result.Add('');
-    Result.Add(Format(sMainDescription, [TURL.CodeSnipRepo]));
+    DBMetaData := TMainDBMetaDataFactory.MainDBMetaDataInstance;
+    Result.Add(
+      Format(
+        sLicense,
+        [
+          DBMetaData.GetCopyrightInfo.Date,
+          DBMetaData.GetCopyrightInfo.Holder,
+          DBMetaData.GetLicenseInfo.NameWithURL
+        ]
+      )
+    );
     Result.Add('');
     Result.Add(Format(sGenerated, [RFC1123DateStamp]));
     Result.Add(

Src/USnippetDoc.pas

@@ -52,10 +52,9 @@   TSnippetDoc = class(TObject)
     ///  <summary>Creates and returns an array of compiler compatibility
     ///  information for given snippet.</summary>
     function CompilerInfo(const Snippet: TSnippet): TCompileDocInfoArray;
-      {Gets compiler compatibility information for a snippet.
-        @param Snippet [in] Snippet for which compiler information is required.
-        @return Array of compiler compatibility information.
-      }
+    ///  <summary>Generates and returns a string containing information about
+    ///  the main database.</summary>
+    function MainDBInfo: string;
   strict protected
     ///  <summary>Initialise document.</summary>
     ///  <remarks>Does nothing. Descendant classes should perform any required
@@ -111,7 +110,12 @@ implementation
   // Delphi
   SysUtils,
   // Project
-  Compilers.UCompilers, DB.UMain, DB.USnippetKind, UStrUtils, UUrl;
+  Compilers.UCompilers,
+  DB.UMain,
+  DB.UMetaData,
+  DB.USnippetKind,
+  UStrUtils,
+  UUrl;
 
 
 { TSnippetDoc }
@@ -155,10 +159,6 @@ function TSnippetDoc.Generate(const Snippet: TSnippet): TEncodedData;
   sDependListTitle = 'Required snippets:';
   sXRefListTitle = 'See also:';
   sCompilers = 'Supported compilers:';
-  // TODO -cWeb: Change following to get license info from DB meta data
-  sMainDatabaseInfo = 'A snippet from the DelphiDabbler CodeSnip Database '
-   + '(%s), licensed under the MIT License '
-   + '(http://opensource.org/licenses/MIT).';
 begin
   Assert(Assigned(Snippet), ClassName + '.Create: Snippet is nil');
   // generate document
@@ -181,7 +181,7 @@ function TSnippetDoc.Generate(const Snippet: TSnippet): TEncodedData;
     RenderExtra(Snippet.Extra);
   if not Snippet.UserDefined then
     // database info written only if snippet is from main database
-    RenderDBInfo(Format(sMainDatabaseInfo, [TURL.CodeSnipRepo]));
+    RenderDBInfo(MainDBInfo);
   Result := FinaliseDoc;
 end;
 
@@ -190,6 +190,23 @@ procedure TSnippetDoc.InitialiseDoc;
   // Do nothing
 end;
 
+function TSnippetDoc.MainDBInfo: string;
+resourcestring
+  sMainDBInfo = 'A snippet from the DelphiDabbler Code Snippets Database '
+   + '(%0:s), licensed under the %1:s.';
+var
+  DBMetaData: IDBMetaData;
+begin
+  DBMetaData := TMainDBMetaDataFactory.MainDBMetaDataInstance;
+  Result := Format(
+    sMainDBInfo,
+    [
+      TURL.CodeSnipRepo,
+      DBMetaData.GetLicenseInfo.NameWithURL
+    ]
+  );
+end;
+
 function TSnippetDoc.SnippetsToStrings(const SnippetList: TSnippetList):
   IStringList;
 var

Src/USnippetSourceGen.pas

@@ -87,7 +87,12 @@ implementation
   // Delphi
   SysUtils,
   // Project
-  DB.USnippet, DB.USnippetKind, UAppInfo, UQuery, UUtils;
+  DB.UMetaData,
+  DB.USnippet,
+  DB.USnippetKind,
+  UAppInfo,
+  UQuery,
+  UUtils;
 
 
 { TSnippetSourceGen }
@@ -97,31 +102,59 @@ function TSnippetSourceGen.BuildHeaderComments: IStringList;
     @return String list containing comments.
   }
 var
-  Header: string; // format string for header comment
+  DBMetaData: IDBMetaData;
 resourcestring
   // Comment to be included at top of snippet
-  // header used if snippet includes code from main database
-  sMainHeader = 'This code snippet was generated by %0:s %1:s on %2:s. It '
-    + 'includes code taken from the DelphiDabbler Code Snippets database that '
-    + 'is covered by the MIT license (http://opensource.org/licenses/MIT).';
-  // header used if snippet contains only user defined snippets
-  sUserHeader = 'This user defined code snippet was generated by '
+  // when snippets include those from main database
+  sMainDBGenerator = 'This code snippet was generated by %0:s %1:s on %2:s.';
+  sMainDBLicense = 'It includes code taken from the DelphiDabbler Code '
+    + 'Snippets database that is copyright © %0:s by %1:s and is licensed '
+    + 'under the %2:s.';
+  // when snippets are all from user defined database
+  sUserGenerator = 'This user defined code snippet was generated by '
     + '%0:s %1:s on %2:s.';
 begin
   // Header depends on whether snippets contain any from main database or are
   // all user defined
+  Result := TIStringList.Create;
   if fContainsMainDBSnippets then
-    Header := sMainHeader
+  begin
+    Result.Add(
+      Format(
+        sMainDBGenerator,
+        [
+          TAppInfo.FullProgramName,
+          TAppInfo.ProgramReleaseInfo,
+          RFC1123DateStamp
+        ]
+      )
+    );
+    Result.Add('');
+    DBMetaData := TMainDBMetaDataFactory.MainDBMetaDataInstance;
+    Result.Add(
+      Format(
+        sMainDBLicense,
+        [
+          DBMetaData.GetCopyrightInfo.Date,
+          DBMetaData.GetCopyrightInfo.Holder,
+          DBMetaData.GetLicenseInfo.NameWithURL
+        ]
+      )
+    );
+  end
   else
-    Header := sUserHeader;
-  // Add the comments
-  Result := TIStringList.Create;
-  Result.Add(
-    Format(
-      Header,
-      [TAppInfo.FullProgramName, TAppInfo.ProgramReleaseInfo, RFC1123DateStamp]
-    )
-  );
+  begin
+    Result.Add(
+      Format(
+        sUserGenerator,
+        [
+          TAppInfo.FullProgramName,
+          TAppInfo.ProgramReleaseInfo,
+          RFC1123DateStamp
+        ]
+      )
+    );
+  end;
 end;
 
 class function TSnippetSourceGen.CanGenerate(View: IView): Boolean;

Src/UUrl.pas

@@ -24,9 +24,6 @@   TURL = record
       ///  <summary>URL of DelphiDabbler's account on GitHub repository.
       ///  </summary>
       DDabGitHub = 'https://github.com/delphidabbler';
-      ///  <summary>URL of the Code Snippet database's GitHub repository.
-      ///  </summary>
-      CodeSnippetsDBRepo = DDabGitHub + '/code-snippets';
       ///  <summary>URL of the SWAG database's GitHub repository.</summary>
       SWAGRepo = DDabGitHub + '/swag';
       ///  <summary>URL of the CodeSnip FAQ's GitHub repository.</summary>
@@ -44,6 +41,10 @@   TURL = record
       ///  <remarks>This is the CodeSnip FAQ project on GitHub.</remarks>
       CodeSnipFAQReadMe = CodeSnipFAQRepo + '/blob/master/README.md';
 
+      ///  <summary>URL of the Code Snippet database's GitHub repository.
+      ///  </summary>
+      CodeSnippetsDBRepo = DDabGitHub + '/code-snippets';
+
       ///  <summary>URL of the GitHub page where DelphiDabbler Code Snippets
       ///  database releases are hosted.</summary>
       CodeSnippetsDBReleases = CodeSnippetsDBRepo + '/releases';