Skip to content

Commit 4c8032e

Browse files
delphidabblerdelphidabbler
committed
Merge tag 'v2.0.1' into develop
2 parents 151e4af + d703ba9 commit 4c8032e

File tree

11 files changed

+86
-91
lines changed

11 files changed

+86
-91
lines changed

‎csdb/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ From v2.0.0 all notable changes to this project will be documented in this file.
88
99
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
1010

11+
## v2.0.1 of 2021/10/12
12+
13+
* Add new unit tests and demo code for _some_ snippets from the database. All such code was added to a new `tests` directory. See `tests/README.md` for details.
14+
* Fix minor errors in documentation.
15+
16+
> Other than to update the `VERSION` file there were no changes to any snippets or associated meta-data in this release.
17+
1118
## v2.0.0 of 2020/05/02
1219

1320
Initial release of v2 of the collection.

‎csdb/MakeRelease.sh

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
#
66
# Build tool for Windows to package up files ready for release.
77
#
8-
# This file is licensed under the MIT license, copyright © 2020 Peter Johnson,
9-
# https://gravatar.com/delphidabbler
8+
# This file is licensed under the MIT license, copyright © 2020-2021 Peter
9+
# Johnson, https://gravatar.com/delphidabbler
1010
#
1111
#
1212
# Two packages are made, each in a zip file: one containing the collection and
@@ -32,6 +32,7 @@ RELEASE_FILE_STUB="${RELEASE_DIR}/csdb-v${VERSION}"
3232

3333
COLLECTION_ZIP_FILE="${RELEASE_FILE_STUB}-data.zip"
3434
DOCS_ZIP_FILE="${RELEASE_FILE_STUB}-docs.zip"
35+
TESTS_ZIP_FILE="${RELEASE_FILE_STUB}-tests.zip"
3536

3637
echo Creating CSDB release $1
3738
echo
@@ -45,4 +46,7 @@ zip -j -q $COLLECTION_ZIP_FILE ./collection/*
4546
echo Zipping documentation
4647
zip -j -q $DOCS_ZIP_FILE ./docs/*
4748

49+
echo Zipping tests
50+
zip -q -r $TESTS_ZIP_FILE ./tests/*
51+
4852
echo Done

‎csdb/README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,29 @@ Version 2 is designed to be able to be used by other applications in addition to
1616

1717
Anyone is welcome to write applications or web pages that access the snippets in the collection, subject to the terms of the license (see below). You should read the collection's documentation which explains the file format in detail.
1818

19-
> **WARNING:** Implementors **must not** read the collection data directly from this GitHub repository - that could generate more than the permitted amount of traffic. Instead you must download a release from the _Releases_ tab and either distribute the collection with the application or host it on a web server.
19+
> **WARNING:** Implementers **must not** read the collection data directly from this GitHub repository - that could generate more than the permitted amount of traffic. Instead you must download a release from the _Releases_ tab and either distribute the collection with the application or host it on a web server.
2020
2121
## Documentation
2222

2323
The collection data format is fully documented in the file `collection-format.html` in the `docs` directory.
2424

25+
## Tests
26+
27+
Unit tests and demonstration projects are available for _some_ of the snippets in the database.
28+
29+
Source code for these tests and demonstrations is available in the `tests` directory. There is a sub-directory for each category where such code is available.
30+
31+
See the `README.md` file in the `tests` directory for full details.
32+
2533
## Releases
2634

2735
Releases can be found on the `releases` tab on the GitHub project page.
2836

29-
Each release comprises two zip files, as follows (replace `X.Y.X` in the file names with the release version number):
37+
From v2.0.1, each release comprises three zip files, as follows (replace `X.Y.X` in the file names with the release version number):
3038

31-
* `csdb-vX.Y.Z-data.zip` - Contains all the data in the collection. Required by applications that access the collection.
32-
* `csdb-vX.Y.Z-docs.zip` - Contains the documentation developers need to understand the structure of the data.
39+
* `csdb-vX.Y.Z-data.zip` - Contains all the data in the collection. Required by applications that access the collection.
40+
* `csdb-vX.Y.Z-docs.zip` - Contains the documentation developers need to understand the structure of the data.
41+
* `csdb-vX.Y.Z-tests.zip` - Contains the unit tests and demo code.
3342

3443
## Change Log
3544

@@ -39,4 +48,6 @@ The project's change log can be found in `CHANGELOG.md` in the collection's base
3948

4049
All snippets in this collection (stored in `.dat` files in the `collections` directory) are licensed under the MIT license and are copyright © 2005-2020, [Peter Johnson](https://gravatar.com/delphidabbler) and Contributors. The full license and a list of contributors can be found in the `LICENSE` and `CONTRIBUTORS` files in the `collection` sub-directory.
4150

42-
All other files in this project are licensed under the MIT license and are copyright © 2020, [Peter Johnson](https://gravatar.com/delphidabbler).
51+
Certain files in the `tests` directory contain copies of snippets extracted from the collection. These files are identified as such in the comments at the start of the file. The files are licensed under the same license as the `.dat` files in the `collections` directory. See the paragraph above for details.
52+
53+
All other files in this project are licensed under the MIT license and are copyright © 2020-2021, [Peter Johnson](https://gravatar.com/delphidabbler).

‎csdb/collection/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.0.0
1+
2.0.1

‎csdb/tests/Cat-Arrays/UArraysCatSnippets.pas

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
{
2+
* This file was generated from the DelphiDabbler Code Snippets Database.
3+
* The source code is licensed under the MIT license, copyright © 2005-2021,
4+
* Peter Johnson (https://gravatar.com/delphidabbler) and Contributors. The
5+
* full license and a list of contributors can be found in the `LICENSE` and
6+
* `CONTRIBUTORS` files at
7+
* https://github.com/delphidabbler/code-snippets/tree/master/csdb/collection
8+
}
9+
110
unit UArraysCatSnippets;
211

312
{$UNDEF Generics}

‎csdb/tests/Cat-Date/UDateCatSnippets.pas

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
11
{
2-
* This unit may be freely distributed and used on the condition that this
3-
* comment is not removed from the unit.
4-
*
5-
* The unit was generated automatically from a selection of source code taken
6-
* from the Code Snippets Database at http://delphidabbler.com/url/csdb.
7-
*
8-
* The source code contained in this unit is made available on an "AS IS" basis,
9-
* WITHOUT WARRANTY OF ANY KIND, either express or implied. The code is used
10-
* entirely at your own risk.
11-
*
12-
* Generated on : Thu, 03 Oct 2013 11:03:43 GMT.
13-
* Generated by : DelphiDabbler CodeSnip Release 4.8.1.
14-
*
15-
* The latest version of CodeSnip is available from the DelphiDabbler website at
16-
* http://delphidabbler.com/url/codesnip-home.
2+
* This file was generated from the DelphiDabbler Code Snippets Database.
3+
* The source code is licensed under the MIT license, copyright © 2005-2021,
4+
* Peter Johnson (https://gravatar.com/delphidabbler) and Contributors. The
5+
* full license and a list of contributors can be found in the `LICENSE` and
6+
* `CONTRIBUTORS` files at
7+
* https://github.com/delphidabbler/code-snippets/tree/master/csdb/collection
178
}
189

1910
unit UDateCatSnippets;
@@ -277,7 +268,7 @@ function DateMonthEnd(const DT: TDateTime): TDateTime;
277268
function DateMonthStart(const DT: TDateTime): TDateTime;
278269
{Returns the first day of the month containing the given date.}
279270
var
280-
Day, Month, Year: Word;
271+
Day, Month, Year: Word;
281272
begin
282273
SysUtils.DecodeDate(DT, Year, Month, Day);
283274
Result := SysUtils.EncodeDate(Year, Month, 1);

‎csdb/tests/Cat-Drive/UDriveCatSnippets.pas

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
11
{
2-
* This unit may be freely distributed and used on the condition that this
3-
* comment is not removed from the unit.
4-
*
5-
* The unit was generated automatically from a selection of source code taken
6-
* from the Code Snippets Database at http://www.delphidabbler.com/codesnip.
7-
*
8-
* The source code contained in this unit is made available on an "AS IS" basis,
9-
* WITHOUT WARRANTY OF ANY KIND, either express or implied. The code is used
10-
* entirely at your own risk.
11-
*
12-
* Generated on : Thu, 27 May 2010 15:23:00 GMT.
13-
* Generated by : DelphiDabbler CodeSnip Release 3.6.0.
14-
*
15-
* The latest version of CodeSnip is available from the DelphiDabbler website at
16-
* http://www.delphidabbler.com/software/codesnip.
2+
* This file was generated from the DelphiDabbler Code Snippets Database.
3+
* The source code is licensed under the MIT license, copyright © 2005-2021,
4+
* Peter Johnson (https://gravatar.com/delphidabbler) and Contributors. The
5+
* full license and a list of contributors can be found in the `LICENSE` and
6+
* `CONTRIBUTORS` files at
7+
* https://github.com/delphidabbler/code-snippets/tree/master/csdb/collection
178
}
189

1910
unit UDriveCatSnippets;
@@ -256,7 +247,7 @@ procedure ListDrives(const List: Classes.TStrings);
256247
begin
257248
// Get buffer size and allocate it
258249
BufSize := Windows.GetLogicalDriveStrings(0, nil);
259-
GetMem(Drives, BufSize * SizeOf(Char));
250+
GetMem(Drives, BufSize * SizeOf(Char));
260251
try
261252
// Get #0 delimited drives list and convert to string list
262253
if Windows.GetLogicalDriveStrings(BufSize, Drives) = 0 then

‎csdb/tests/Cat-Hex/UHexCatSnippets.pas

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
11
{
2-
* This unit may be freely distributed and used on the condition that this
3-
* comment is not removed from the unit.
4-
*
5-
* The unit was generated automatically from a selection of source code taken
6-
* from the Code Snippets Database at http://www.delphidabbler.com/codesnip.
7-
*
8-
* The source code contained in this unit is made available on an "AS IS" basis,
9-
* WITHOUT WARRANTY OF ANY KIND, either express or implied. The code is used
10-
* entirely at your own risk.
11-
*
12-
* Generated on : Mon, 22 Feb 2010 13:20:24 GMT.
13-
* Generated by : DelphiDabbler CodeSnip Release 3.5.1.
14-
*
15-
* The latest version of CodeSnip is available from the DelphiDabbler website at
16-
* http://www.delphidabbler.com/software/codesnip.
2+
* This file was generated from the DelphiDabbler Code Snippets Database.
3+
* The source code is licensed under the MIT license, copyright © 2005-2021,
4+
* Peter Johnson (https://gravatar.com/delphidabbler) and Contributors. The
5+
* full license and a list of contributors can be found in the `LICENSE` and
6+
* `CONTRIBUTORS` files at
7+
* https://github.com/delphidabbler/code-snippets/tree/master/csdb/collection
178
}
189

1910
unit UHexCatSnippets;

‎csdb/tests/Cat-Maths/UMathsCatSnippets.pas

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
11
{
2-
* This unit may be freely distributed and used on the condition that this
3-
* comment is not removed from the unit.
4-
*
5-
* The unit was generated automatically from a selection of source code taken
6-
* from the Code Snippets Database at http://www.delphidabbler.com/url/csdb.
7-
*
8-
* The source code contained in this unit is made available on an "AS IS" basis,
9-
* WITHOUT WARRANTY OF ANY KIND, either express or implied. The code is used
10-
* entirely at your own risk.
11-
*
12-
* Generated on : Thu, 18 Apr 2013 23:27:42 GMT.
13-
* Generated by : DelphiDabbler CodeSnip Release 4.4.0.
14-
*
15-
* The latest version of CodeSnip is available from the DelphiDabbler website at
16-
* http://www.delphidabbler.com/url/codesnip-home.
2+
* This file was generated from the DelphiDabbler Code Snippets Database.
3+
* The source code is licensed under the MIT license, copyright © 2005-2021,
4+
* Peter Johnson (https://gravatar.com/delphidabbler) and Contributors. The
5+
* full license and a list of contributors can be found in the `LICENSE` and
6+
* `CONTRIBUTORS` files at
7+
* https://github.com/delphidabbler/code-snippets/tree/master/csdb/collection
178
}
189

1910
unit UMathsCatSnippets;
@@ -167,7 +158,7 @@ procedure MinMidMax(const A, B, C: Double; out Min, Mid, Max: Double); overload;
167158
floating point numbers, A, B and C and returns them in Min, Mid and Max
168159
respectively.}
169160

170-
procedure MinMidMax(const A, B, C: Extended; out Min, Mid, Max: Extended);
161+
procedure MinMidMax(const A, B, C: Extended; out Min, Mid, Max: Extended);
171162
overload;
172163
{Finds the minimum, middle and maximum values of three extended precision
173164
floating point numbers, A, B and C and returns them in Min, Mid and Max
@@ -756,7 +747,7 @@ procedure MinMidMax(const A, B, C: Double; out Min, Mid, Max: Double); overload;
756747
end;
757748
end;
758749

759-
procedure MinMidMax(const A, B, C: Extended; out Min, Mid, Max: Extended);
750+
procedure MinMidMax(const A, B, C: Extended; out Min, Mid, Max: Extended);
760751
overload;
761752
{Finds the minimum, middle and maximum values of three extended precision
762753
floating point numbers, A, B and C and returns them in Min, Mid and Max

‎csdb/tests/Cat-String/UStringCatSnippets.pas

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
{
2+
* This file was generated from the DelphiDabbler Code Snippets Database.
3+
* The source code is licensed under the MIT license, copyright © 2005-2021,
4+
* Peter Johnson (https://gravatar.com/delphidabbler) and Contributors. The
5+
* full license and a list of contributors can be found in the `LICENSE` and
6+
* `CONTRIBUTORS` files at
7+
* https://github.com/delphidabbler/code-snippets/tree/master/csdb/collection
8+
}
9+
110
unit UStringCatSnippets;
211

312
{$IFNDEF FPC}
@@ -35,7 +44,7 @@ function IsNumeric(Value: string; const AllowFloat: Boolean;
3544

3645
function SplitString(const AText, ADelimiter: string): Classes.TStringList;
3746

38-
procedure ParseStr(const StrToParse: string; const Delimiter: Char;
47+
procedure ParseStr(const StrToParse: string; const Delimiter: Char;
3948
const Words: Classes.TStringList);
4049

4150
implementation
@@ -97,7 +106,7 @@ function SplitString(const AText, ADelimiter: string): Classes.TStringList;
97106
Result.Add(LTxt);
98107
end;
99108

100-
procedure ParseStr(const StrToParse: string; const Delimiter: Char;
109+
procedure ParseStr(const StrToParse: string; const Delimiter: Char;
101110
const Words: Classes.TStringList);
102111
var
103112
TmpInStr: string;

‎csdb/tests/Cat-WinSys/UWinSysCatSnippets.pas

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
11
{
2-
* This unit may be freely distributed and used on the condition that this
3-
* comment is not removed from the unit.
4-
*
5-
* The unit was generated automatically from a selection of source code taken
6-
* from the Code Snippets Database at http://www.delphidabbler.com/codesnip.
7-
*
8-
* The source code contained in this unit is made available on an "AS IS" basis,
9-
* WITHOUT WARRANTY OF ANY KIND, either express or implied. The code is used
10-
* entirely at your own risk.
11-
*
12-
* Generated on : Thu, 27 May 2010 16:17:52 GMT.
13-
* Generated by : DelphiDabbler CodeSnip Release 3.6.0.
14-
*
15-
* The latest version of CodeSnip is available from the DelphiDabbler website at
16-
* http://www.delphidabbler.com/software/codesnip.
2+
* This file was generated from the DelphiDabbler Code Snippets Database.
3+
* The source code is licensed under the MIT license, copyright © 2005-2021,
4+
* Peter Johnson (https://gravatar.com/delphidabbler) and Contributors. The
5+
* full license and a list of contributors can be found in the `LICENSE` and
6+
* `CONTRIBUTORS` files at
7+
* https://github.com/delphidabbler/code-snippets/tree/master/csdb/collection
178
}
189

1910
unit UWinSysCatSnippets;
@@ -148,7 +139,7 @@ function GetRegistryString(const RootKey: Windows.HKEY;
148139

149140
function IsMediaCenterOS: Boolean;
150141
const
151-
SM_MEDIACENTER = 87; // metrics flag not defined in Windows unit
142+
SM_MEDIACENTER = 87; // metrics flag not defined in Windows unit
152143
begin
153144
Result := Windows.GetSystemMetrics(SM_MEDIACENTER) <> 0;
154145
end;
@@ -162,7 +153,7 @@ function IsRemoteSession: Boolean;
162153

163154
function IsTabletOS: Boolean;
164155
const
165-
SM_TABLETPC = 86; // metrics flag not defined in Windows unit
156+
SM_TABLETPC = 86; // metrics flag not defined in Windows unit
166157
begin
167158
Result := Windows.GetSystemMetrics(SM_TABLETPC) <> 0;
168159
end;

0 commit comments

Comments
 (0)