From 35f34f8d242e03fb486482231a82904ec0f9825d Mon Sep 17 00:00:00 2001 From: Axel Kesseler Date: Mon, 23 Dec 2019 03:54:01 +0100 Subject: [PATCH 1/2] Package migration (**BREAKING CHANGES**) --- README.md | 18 +++ ...j => Plexdata.CsvParser.NET.help.shfbproj} | 22 ++-- ...j => Plexdata.CsvParser.NET.wiki.shfbproj} | 22 ++-- code/src/HISTORY.md | 10 ++ .../Attributes/CsvDocumentAttributeTests.cs | 1 - .../Attributes/CsvIgnoreAttributeTests.cs | 1 - .../Constants/ColumnSeparatorsTests.cs | 2 +- .../Internals/ItemDescriptorTests.cs | 2 +- .../ProcessHelperTests.cs | 4 +- .../Internals/TypeConverterTests.cs | 2 +- .../Internals/TypeDescriptorTests.cs | 2 +- .../Internals/TypeProcessorTests.cs | 2 +- .../Plexdata.CsvParser.NET.Tests.csproj | 2 +- .../Processors/CsvExporterTests.cs | 2 +- .../Processors/CsvSettingsTests.cs | 2 +- .../Properties/AssemblyInfo.cs | 4 +- .../Internals/Internals.cs | 28 +++++ .../{Helpers => Internals}/ProcessHelper.cs | 3 +- .../Plexdata.CsvParser.NET.csproj | 105 +++++++----------- .../Plexdata.CsvParser.NET.nuspec | 22 ---- .../Processors/CsvExporter.cs | 1 - .../Processors/CsvImporter.cs | 1 - .../Processors/CsvReader.cs | 2 +- .../Processors/CsvWriter.cs | 2 +- .../Properties/AssemblyInfo.cs | 67 ----------- .../Summaries/AttributesNamespace.cs | 37 ++++++ .../Summaries/ConstantsNamespace.cs | 37 ++++++ .../Summaries/InternalsNamespace.cs | 37 ++++++ .../Summaries/ProcessorsNamespace.cs | 37 ++++++ .../Properties/AssemblyInfo.cs | 4 +- code/src/TODOs.md | 1 - code/src/post-build.cmd | 2 +- 32 files changed, 277 insertions(+), 207 deletions(-) rename code/hlp/{Plexdata.CsvParser.NET.shfbproj => Plexdata.CsvParser.NET.help.shfbproj} (82%) rename code/hlp/{Plexdata.CsvParser.NET-api.shfbproj => Plexdata.CsvParser.NET.wiki.shfbproj} (82%) rename code/src/Plexdata.CsvParser.NET.Tests/{Helpers => Internals}/ProcessHelperTests.cs (99%) create mode 100644 code/src/Plexdata.CsvParser.NET/Internals/Internals.cs rename code/src/Plexdata.CsvParser.NET/{Helpers => Internals}/ProcessHelper.cs (99%) delete mode 100644 code/src/Plexdata.CsvParser.NET/Plexdata.CsvParser.NET.nuspec delete mode 100644 code/src/Plexdata.CsvParser.NET/Properties/AssemblyInfo.cs create mode 100644 code/src/Plexdata.CsvParser.NET/Summaries/AttributesNamespace.cs create mode 100644 code/src/Plexdata.CsvParser.NET/Summaries/ConstantsNamespace.cs create mode 100644 code/src/Plexdata.CsvParser.NET/Summaries/InternalsNamespace.cs create mode 100644 code/src/Plexdata.CsvParser.NET/Summaries/ProcessorsNamespace.cs diff --git a/README.md b/README.md index 35db98a..a772690 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ +

+ + + + + + + + + + + + + + + +

+ ## Plexdata CSV Parser The _Plexdata CSV Parser_ represents a library that allows importing and exporting of CSV files based on a user-defined class. Further, it is possible to configure the importing and exporting behavior. diff --git a/code/hlp/Plexdata.CsvParser.NET.shfbproj b/code/hlp/Plexdata.CsvParser.NET.help.shfbproj similarity index 82% rename from code/hlp/Plexdata.CsvParser.NET.shfbproj rename to code/hlp/Plexdata.CsvParser.NET.help.shfbproj index 5eb8577..a328b98 100644 --- a/code/hlp/Plexdata.CsvParser.NET.shfbproj +++ b/code/hlp/Plexdata.CsvParser.NET.help.shfbproj @@ -13,24 +13,24 @@ Documentation Documentation - .NET Framework 4.7.2 - chm\ + Cross-platform (.NET Core/.NET Standard) + help\ Plexdata.CsvParser.NET en-US - - + + HtmlHelp1 C# VS2013 True - False + True False False OnlyWarningsAndErrors Plexdata.CsvParser.NET - 1.0.2 + 1.1.0 Guid AboveNamespaces True @@ -81,18 +81,12 @@ Copyright &#169%3b 2019 - plexdata.de http://www.plexdata.de/ - The attributes namespace contains classes to be used to tag own classes as CSV document as well as to tag class properties as CSV columns. - The constants namespace contains classes that support an easy access to all constant values provided by the library. - The internals namespace contains classes that should not be used by the outside world. - The processors namespace contains classes to import or export CSV files as well as to configure the importer's and the exporter's behaviour. - - The namespace contains all supported helper classes. &lt%3bp&gt%3bThe CSV Parser represents a library that allows importing and exporting of CSV files. Also, it is possible to configure the importing and exporting behavior.&lt%3b/p&gt%3b &lt%3bp&gt%3bMain feature of this library is that users only need to create an own class representing a single line of a CSV file. Thereafter, this custom class is used either together with the importer or together with the exporter to process CSV files. &lt%3b/p&gt%3b &lt%3bp&gt%3bFinally, it would also be possible %28assuming a proper configuration is used%29 to write a CSV output according to the rules of RFC 4180. For more information about RFC 4180 please visit the web-site under &lt%3ba target=&quot%3b_blank&quot%3b href=&quot%3bhttps://www.ietf.org/rfc/rfc4180.txt&quot%3b&gt%3bhttps://www.ietf.org/rfc/rfc4180.txt&lt%3b/a&gt%3b.&lt%3b/p&gt%3b &lt%3bp&gt%3b&lt%3bstrong&gt%3bTarget Framework&lt%3b/strong&gt%3b&lt%3b/p&gt%3b -&lt%3bp&gt%3bCurrent target framework of this library is the &lt%3bi&gt%3b.NET Framework v4.7.2&lt%3b/i&gt%3b.&lt%3b/p&gt%3b +&lt%3bp&gt%3bCurrent target framework of this library is the &lt%3bi&gt%3b.NET Standard v2.0&lt%3b/i&gt%3b.&lt%3b/p&gt%3b &lt%3bp&gt%3b&lt%3bstrong&gt%3bLicense&lt%3b/strong&gt%3b&lt%3b/p&gt%3b &lt%3bp&gt%3bThe software has been published under the terms of &lt%3ba target=&quot%3b_blank&quot%3b href=&quot%3bhttp://www.plexdata.de/licenses/mit.html&quot%3b&gt%3bMIT License&lt%3b/a&gt%3b.&lt%3b/p&gt%3b @@ -100,8 +94,6 @@ False 2 100 - development%40plexdata.de - Development diff --git a/code/hlp/Plexdata.CsvParser.NET-api.shfbproj b/code/hlp/Plexdata.CsvParser.NET.wiki.shfbproj similarity index 82% rename from code/hlp/Plexdata.CsvParser.NET-api.shfbproj rename to code/hlp/Plexdata.CsvParser.NET.wiki.shfbproj index 6394af8..a4306f5 100644 --- a/code/hlp/Plexdata.CsvParser.NET-api.shfbproj +++ b/code/hlp/Plexdata.CsvParser.NET.wiki.shfbproj @@ -13,24 +13,24 @@ Documentation Documentation - .NET Framework 4.7.2 - api\ + Cross-platform (.NET Core/.NET Standard) + wiki\ Plexdata.CsvParser.NET en-US - - + + Markdown C# Markdown True - False + True False False OnlyWarningsAndErrors Plexdata.CsvParser.NET - 1.0.2 + 1.1.0 Guid AboveNamespaces True @@ -81,18 +81,12 @@ Copyright &#169%3b 2019 - plexdata.de http://www.plexdata.de/ - The attributes namespace contains classes to be used to tag own classes as CSV document as well as to tag class properties as CSV columns. - The constants namespace contains classes that support an easy access to all constant values provided by the library. - The internals namespace contains classes that should not be used by the outside world. - The processors namespace contains classes to import or export CSV files as well as to configure the importer's and the exporter's behaviour. - - The namespace contains all supported helper classes. &lt%3bp&gt%3bThe CSV Parser represents a library that allows importing and exporting of CSV files. Also, it is possible to configure the importing and exporting behavior.&lt%3b/p&gt%3b &lt%3bp&gt%3bMain feature of this library is that users only need to create an own class representing a single line of a CSV file. Thereafter, this custom class is used either together with the importer or together with the exporter to process CSV files. &lt%3b/p&gt%3b &lt%3bp&gt%3bFinally, it would also be possible %28assuming a proper configuration is used%29 to write a CSV output according to the rules of RFC 4180. For more information about RFC 4180 please visit the web-site under &lt%3ba target=&quot%3b_blank&quot%3b href=&quot%3bhttps://www.ietf.org/rfc/rfc4180.txt&quot%3b&gt%3bhttps://www.ietf.org/rfc/rfc4180.txt&lt%3b/a&gt%3b.&lt%3b/p&gt%3b &lt%3bp&gt%3b&lt%3bstrong&gt%3bTarget Framework&lt%3b/strong&gt%3b&lt%3b/p&gt%3b -&lt%3bp&gt%3bCurrent target framework of this library is the &lt%3bi&gt%3b.NET Framework v4.7.2&lt%3b/i&gt%3b.&lt%3b/p&gt%3b +&lt%3bp&gt%3bCurrent target framework of this library is the &lt%3bi&gt%3b.NET Standard v2.0&lt%3b/i&gt%3b.&lt%3b/p&gt%3b &lt%3bp&gt%3b&lt%3bstrong&gt%3bLicense&lt%3b/strong&gt%3b&lt%3b/p&gt%3b &lt%3bp&gt%3bThe software has been published under the terms of &lt%3ba target=&quot%3b_blank&quot%3b href=&quot%3bhttp://www.plexdata.de/licenses/mit.html&quot%3b&gt%3bMIT License&lt%3b/a&gt%3b.&lt%3b/p&gt%3b @@ -100,8 +94,6 @@ False 2 100 - development%40plexdata.de - Development diff --git a/code/src/HISTORY.md b/code/src/HISTORY.md index e4b6c4a..77255d3 100644 --- a/code/src/HISTORY.md +++ b/code/src/HISTORY.md @@ -1,5 +1,15 @@ +**1.1.0** +- Package migration from .NET Framework 4.7.2 to .NET Standard 2.0 (**BREAKING CHANGES**). +- Internal project restructuring. +- Files to generate help outputs renamed. +- Namespace summaries moved into project classes. +- Adding of _Shields_ links. +- Version number increased. +- Package release on `nuget.org`. +- Wiki and release update on _GitHub_. + **1.0.2** - Adding functionality of writing CSV content from a two-dimensional matrix. diff --git a/code/src/Plexdata.CsvParser.NET.Tests/Attributes/CsvDocumentAttributeTests.cs b/code/src/Plexdata.CsvParser.NET.Tests/Attributes/CsvDocumentAttributeTests.cs index 495d5fa..cf28f86 100644 --- a/code/src/Plexdata.CsvParser.NET.Tests/Attributes/CsvDocumentAttributeTests.cs +++ b/code/src/Plexdata.CsvParser.NET.Tests/Attributes/CsvDocumentAttributeTests.cs @@ -24,7 +24,6 @@ using NUnit.Framework; using Plexdata.CsvParser.Attributes; -using System; namespace Plexdata.CsvParser.Tests.Attributes { diff --git a/code/src/Plexdata.CsvParser.NET.Tests/Attributes/CsvIgnoreAttributeTests.cs b/code/src/Plexdata.CsvParser.NET.Tests/Attributes/CsvIgnoreAttributeTests.cs index 70ea11b..edc9617 100644 --- a/code/src/Plexdata.CsvParser.NET.Tests/Attributes/CsvIgnoreAttributeTests.cs +++ b/code/src/Plexdata.CsvParser.NET.Tests/Attributes/CsvIgnoreAttributeTests.cs @@ -24,7 +24,6 @@ using NUnit.Framework; using Plexdata.CsvParser.Attributes; -using System; namespace Plexdata.CsvParser.Tests.Attributes { diff --git a/code/src/Plexdata.CsvParser.NET.Tests/Constants/ColumnSeparatorsTests.cs b/code/src/Plexdata.CsvParser.NET.Tests/Constants/ColumnSeparatorsTests.cs index d2dbf1e..566daba 100644 --- a/code/src/Plexdata.CsvParser.NET.Tests/Constants/ColumnSeparatorsTests.cs +++ b/code/src/Plexdata.CsvParser.NET.Tests/Constants/ColumnSeparatorsTests.cs @@ -26,7 +26,7 @@ using Plexdata.CsvParser.Constants; using System; -namespace Plexdata.CsvParser.Tests.Attributes +namespace Plexdata.CsvParser.Tests.Constants { [TestFixture] [TestOf(nameof(ColumnSeparators))] diff --git a/code/src/Plexdata.CsvParser.NET.Tests/Internals/ItemDescriptorTests.cs b/code/src/Plexdata.CsvParser.NET.Tests/Internals/ItemDescriptorTests.cs index e9babe5..e819dbe 100644 --- a/code/src/Plexdata.CsvParser.NET.Tests/Internals/ItemDescriptorTests.cs +++ b/code/src/Plexdata.CsvParser.NET.Tests/Internals/ItemDescriptorTests.cs @@ -29,7 +29,7 @@ using System.Globalization; using System.Reflection; -namespace Plexdata.CsvParser.Tests.Attributes +namespace Plexdata.CsvParser.Tests.Internals { [TestFixture] [TestOf(nameof(ItemDescriptor))] diff --git a/code/src/Plexdata.CsvParser.NET.Tests/Helpers/ProcessHelperTests.cs b/code/src/Plexdata.CsvParser.NET.Tests/Internals/ProcessHelperTests.cs similarity index 99% rename from code/src/Plexdata.CsvParser.NET.Tests/Helpers/ProcessHelperTests.cs rename to code/src/Plexdata.CsvParser.NET.Tests/Internals/ProcessHelperTests.cs index bedc362..1b3447c 100644 --- a/code/src/Plexdata.CsvParser.NET.Tests/Helpers/ProcessHelperTests.cs +++ b/code/src/Plexdata.CsvParser.NET.Tests/Internals/ProcessHelperTests.cs @@ -23,14 +23,14 @@ */ using NUnit.Framework; -using Plexdata.CsvParser.Helpers; +using Plexdata.CsvParser.Internals; using Plexdata.CsvParser.Processors; using System; using System.Collections.Generic; using System.Globalization; using System.Text; -namespace Plexdata.CsvParser.Tests.Helpers +namespace Plexdata.CsvParser.Tests.Internals { [TestFixture] [TestOf(nameof(ProcessHelper))] diff --git a/code/src/Plexdata.CsvParser.NET.Tests/Internals/TypeConverterTests.cs b/code/src/Plexdata.CsvParser.NET.Tests/Internals/TypeConverterTests.cs index a7500a3..d68c5e9 100644 --- a/code/src/Plexdata.CsvParser.NET.Tests/Internals/TypeConverterTests.cs +++ b/code/src/Plexdata.CsvParser.NET.Tests/Internals/TypeConverterTests.cs @@ -30,7 +30,7 @@ using System.Globalization; using System.Reflection; -namespace Plexdata.CsvParser.Tests.Attributes +namespace Plexdata.CsvParser.Tests.Internals { [TestFixture] [TestOf(nameof(TypeConverter))] diff --git a/code/src/Plexdata.CsvParser.NET.Tests/Internals/TypeDescriptorTests.cs b/code/src/Plexdata.CsvParser.NET.Tests/Internals/TypeDescriptorTests.cs index c8bdba7..bbbe3af 100644 --- a/code/src/Plexdata.CsvParser.NET.Tests/Internals/TypeDescriptorTests.cs +++ b/code/src/Plexdata.CsvParser.NET.Tests/Internals/TypeDescriptorTests.cs @@ -27,7 +27,7 @@ using Plexdata.CsvParser.Internals; using System; -namespace Plexdata.CsvParser.Tests.Attributes +namespace Plexdata.CsvParser.Tests.Internals { [TestFixture] [TestOf(nameof(TypeDescriptor))] diff --git a/code/src/Plexdata.CsvParser.NET.Tests/Internals/TypeProcessorTests.cs b/code/src/Plexdata.CsvParser.NET.Tests/Internals/TypeProcessorTests.cs index 342d876..39351e6 100644 --- a/code/src/Plexdata.CsvParser.NET.Tests/Internals/TypeProcessorTests.cs +++ b/code/src/Plexdata.CsvParser.NET.Tests/Internals/TypeProcessorTests.cs @@ -28,7 +28,7 @@ using System; using System.Linq; -namespace Plexdata.CsvParser.Tests.Attributes +namespace Plexdata.CsvParser.Tests.Internals { [TestFixture] [TestOf(nameof(TypeProcessor))] diff --git a/code/src/Plexdata.CsvParser.NET.Tests/Plexdata.CsvParser.NET.Tests.csproj b/code/src/Plexdata.CsvParser.NET.Tests/Plexdata.CsvParser.NET.Tests.csproj index b7bf8fe..e7d1b3e 100644 --- a/code/src/Plexdata.CsvParser.NET.Tests/Plexdata.CsvParser.NET.Tests.csproj +++ b/code/src/Plexdata.CsvParser.NET.Tests/Plexdata.CsvParser.NET.Tests.csproj @@ -53,8 +53,8 @@ - + diff --git a/code/src/Plexdata.CsvParser.NET.Tests/Processors/CsvExporterTests.cs b/code/src/Plexdata.CsvParser.NET.Tests/Processors/CsvExporterTests.cs index a3a0c0f..a067c2b 100644 --- a/code/src/Plexdata.CsvParser.NET.Tests/Processors/CsvExporterTests.cs +++ b/code/src/Plexdata.CsvParser.NET.Tests/Processors/CsvExporterTests.cs @@ -31,7 +31,7 @@ using System.IO; using System.Text; -namespace Plexdata.CsvParser.Tests.Attributes +namespace Plexdata.CsvParser.Tests.Processors { [TestFixture] [TestOf(nameof(CsvExporter))] diff --git a/code/src/Plexdata.CsvParser.NET.Tests/Processors/CsvSettingsTests.cs b/code/src/Plexdata.CsvParser.NET.Tests/Processors/CsvSettingsTests.cs index 22f85de..edf7286 100644 --- a/code/src/Plexdata.CsvParser.NET.Tests/Processors/CsvSettingsTests.cs +++ b/code/src/Plexdata.CsvParser.NET.Tests/Processors/CsvSettingsTests.cs @@ -26,7 +26,7 @@ using Plexdata.CsvParser.Processors; using System; -namespace Plexdata.CsvParser.Tests.Attributes +namespace Plexdata.CsvParser.Tests.Processors { [TestFixture] [TestOf(nameof(CsvSettings))] diff --git a/code/src/Plexdata.CsvParser.NET.Tests/Properties/AssemblyInfo.cs b/code/src/Plexdata.CsvParser.NET.Tests/Properties/AssemblyInfo.cs index 9ea4ba6..bc33cec 100644 --- a/code/src/Plexdata.CsvParser.NET.Tests/Properties/AssemblyInfo.cs +++ b/code/src/Plexdata.CsvParser.NET.Tests/Properties/AssemblyInfo.cs @@ -59,5 +59,5 @@ // You can specify all the values or you can default the Build and Revision Numbers // by using the '*' as shown below: // [assembly: AssemblyVersion("1.0.*")] -[assembly: AssemblyVersion("1.0.2")] -[assembly: AssemblyFileVersion("1.0.2")] +[assembly: AssemblyVersion("1.1.0")] +[assembly: AssemblyFileVersion("1.1.0")] diff --git a/code/src/Plexdata.CsvParser.NET/Internals/Internals.cs b/code/src/Plexdata.CsvParser.NET/Internals/Internals.cs new file mode 100644 index 0000000..529aa39 --- /dev/null +++ b/code/src/Plexdata.CsvParser.NET/Internals/Internals.cs @@ -0,0 +1,28 @@ +/* + * MIT License + * + * Copyright (c) 2019 plexdata.de + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +using System.Runtime.CompilerServices; + +// Make internal classes visible for testing... +[assembly: InternalsVisibleTo("Plexdata.CsvParser.NET.Tests")] \ No newline at end of file diff --git a/code/src/Plexdata.CsvParser.NET/Helpers/ProcessHelper.cs b/code/src/Plexdata.CsvParser.NET/Internals/ProcessHelper.cs similarity index 99% rename from code/src/Plexdata.CsvParser.NET/Helpers/ProcessHelper.cs rename to code/src/Plexdata.CsvParser.NET/Internals/ProcessHelper.cs index ab9fc3d..1b48c6b 100644 --- a/code/src/Plexdata.CsvParser.NET/Helpers/ProcessHelper.cs +++ b/code/src/Plexdata.CsvParser.NET/Internals/ProcessHelper.cs @@ -22,7 +22,6 @@ * SOFTWARE. */ -using Plexdata.CsvParser.Internals; using Plexdata.CsvParser.Processors; using System; using System.Collections.Generic; @@ -30,7 +29,7 @@ using System.Linq; using System.Text; -namespace Plexdata.CsvParser.Helpers +namespace Plexdata.CsvParser.Internals { /// /// This internal helper class provides functionality to process any CSV-based diff --git a/code/src/Plexdata.CsvParser.NET/Plexdata.CsvParser.NET.csproj b/code/src/Plexdata.CsvParser.NET/Plexdata.CsvParser.NET.csproj index bb8f992..8bec200 100644 --- a/code/src/Plexdata.CsvParser.NET/Plexdata.CsvParser.NET.csproj +++ b/code/src/Plexdata.CsvParser.NET/Plexdata.CsvParser.NET.csproj @@ -1,73 +1,50 @@ - - - + + - Debug - AnyCPU - {B889E9F3-AB10-469E-B541-61BE45DC879B} - Library - Properties - Plexdata.CsvParser + netstandard2.0 Plexdata.CsvParser.NET - v4.7.2 - 512 - + Plexdata.CsvParser + false + plexdata.de + plexdata.de + Copyright © 2019 - plexdata.de + LICENSE.md + https://github.com/akesseler/Plexdata.CsvParser + https://github.com/akesseler/Plexdata.CsvParser/blob/master/icon.png?raw=true + This library is a simple CSV file parser. It uses attributes on classes that define which of the properties are used as CSV file columns. + CSV file parser reader writer importer exporter comma separated value + See project history under https://github.com/akesseler/Plexdata.CsvParser/blob/master/code/src/HISTORY.md + 1.1.0 + 1.1.0 + 1.1.0 - - true - full - false - bin\Debug\ - DEBUG;TRACE - prompt - 4 - bin\Debug\Plexdata.CsvParser.NET.xml - true + + + bin\$(Configuration) + bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml + false + - - pdbonly - true - bin\Release\ - TRACE - prompt - 4 - bin\Release\Plexdata.CsvParser.NET.xml + + + bin\$(Configuration) + bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml + true + + - - - - - - - - + + - - - - - - - - - - - - - - - - - + - - - - - - - "$(SolutionDir)post-build.cmd" "$(SolutionDir)..\hlp\" $(ConfigurationName) "$(SolutionDir)..\hlp\chm\*.chm" - - \ No newline at end of file + + + + + + + + diff --git a/code/src/Plexdata.CsvParser.NET/Plexdata.CsvParser.NET.nuspec b/code/src/Plexdata.CsvParser.NET/Plexdata.CsvParser.NET.nuspec deleted file mode 100644 index ab7715d..0000000 --- a/code/src/Plexdata.CsvParser.NET/Plexdata.CsvParser.NET.nuspec +++ /dev/null @@ -1,22 +0,0 @@ - - - - $id$ - $version$ - $title$ - $author$ - $author$ - https://github.com/akesseler/Plexdata.CsvParser/blob/master/LICENSE.md - https://github.com/akesseler/Plexdata.CsvParser - https://github.com/akesseler/Plexdata.CsvParser/blob/master/icon.png?raw=true - false - $description$ - Introduction of a plain-text CSV-writer. - Copyright © 2019 - plexdata.de - CSV file parser reader writer importer exporter comma separated value - - - - - - diff --git a/code/src/Plexdata.CsvParser.NET/Processors/CsvExporter.cs b/code/src/Plexdata.CsvParser.NET/Processors/CsvExporter.cs index ecc518b..ea30715 100644 --- a/code/src/Plexdata.CsvParser.NET/Processors/CsvExporter.cs +++ b/code/src/Plexdata.CsvParser.NET/Processors/CsvExporter.cs @@ -22,7 +22,6 @@ * SOFTWARE. */ -using Plexdata.CsvParser.Helpers; using Plexdata.CsvParser.Internals; using System; using System.Collections.Generic; diff --git a/code/src/Plexdata.CsvParser.NET/Processors/CsvImporter.cs b/code/src/Plexdata.CsvParser.NET/Processors/CsvImporter.cs index 1e5b3f8..9a32de3 100644 --- a/code/src/Plexdata.CsvParser.NET/Processors/CsvImporter.cs +++ b/code/src/Plexdata.CsvParser.NET/Processors/CsvImporter.cs @@ -22,7 +22,6 @@ * SOFTWARE. */ -using Plexdata.CsvParser.Helpers; using Plexdata.CsvParser.Internals; using System; using System.Collections.Generic; diff --git a/code/src/Plexdata.CsvParser.NET/Processors/CsvReader.cs b/code/src/Plexdata.CsvParser.NET/Processors/CsvReader.cs index 2de2399..bdf2ed5 100644 --- a/code/src/Plexdata.CsvParser.NET/Processors/CsvReader.cs +++ b/code/src/Plexdata.CsvParser.NET/Processors/CsvReader.cs @@ -22,7 +22,7 @@ * SOFTWARE. */ -using Plexdata.CsvParser.Helpers; +using Plexdata.CsvParser.Internals; using System; using System.Collections.Generic; using System.IO; diff --git a/code/src/Plexdata.CsvParser.NET/Processors/CsvWriter.cs b/code/src/Plexdata.CsvParser.NET/Processors/CsvWriter.cs index 3ce8944..59958ce 100644 --- a/code/src/Plexdata.CsvParser.NET/Processors/CsvWriter.cs +++ b/code/src/Plexdata.CsvParser.NET/Processors/CsvWriter.cs @@ -22,7 +22,7 @@ * SOFTWARE. */ -using Plexdata.CsvParser.Helpers; +using Plexdata.CsvParser.Internals; using System; using System.Collections.Generic; using System.Globalization; diff --git a/code/src/Plexdata.CsvParser.NET/Properties/AssemblyInfo.cs b/code/src/Plexdata.CsvParser.NET/Properties/AssemblyInfo.cs deleted file mode 100644 index 307122c..0000000 --- a/code/src/Plexdata.CsvParser.NET/Properties/AssemblyInfo.cs +++ /dev/null @@ -1,67 +0,0 @@ -/* - * MIT License - * - * Copyright (c) 2019 plexdata.de - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. - */ - -using System.Reflection; -using System.Runtime.CompilerServices; -using System.Runtime.InteropServices; - -// General Information about an assembly is controlled through the following -// set of attributes. Change these attribute values to modify the information -// associated with an assembly. -[assembly: AssemblyTitle("Plexdata.CsvParser.NET")] -[assembly: AssemblyDescription("This library is a simple CSV file parser. It uses attributes on classes that define which of the properties are used as CSV file columns.")] -#if DEBUG -[assembly: AssemblyConfiguration("DEBUG")] -#else -[assembly: AssemblyConfiguration("RELEASE")] -#endif -[assembly: AssemblyCompany("plexdata.de")] -[assembly: AssemblyProduct("Plexdata.CsvParser.NET")] -[assembly: AssemblyCopyright("Copyright © 2019 - plexdata.de")] -[assembly: AssemblyTrademark("")] -[assembly: AssemblyCulture("")] - -// Setting ComVisible to false makes the types in this assembly not visible -// to COM components. If you need to access a type in this assembly from -// COM, set the ComVisible attribute to true on that type. -[assembly: ComVisible(false)] - -// The following GUID is for the ID of the typelib if this project is exposed to COM -[assembly: Guid("b889e9f3-ab10-469e-b541-61be45dc879b")] - -// Version information for an assembly consists of the following four values: -// -// Major Version -// Minor Version -// Build Number -// Revision -// -// You can specify all the values or you can default the Build and Revision Numbers -// by using the '*' as shown below: -// [assembly: AssemblyVersion("1.0.*")] -[assembly: AssemblyVersion("1.0.2")] -[assembly: AssemblyFileVersion("1.0.2")] - -// Make internal classes visible for testing... -[assembly: InternalsVisibleTo("Plexdata.CsvParser.NET.Tests")] diff --git a/code/src/Plexdata.CsvParser.NET/Summaries/AttributesNamespace.cs b/code/src/Plexdata.CsvParser.NET/Summaries/AttributesNamespace.cs new file mode 100644 index 0000000..b156e75 --- /dev/null +++ b/code/src/Plexdata.CsvParser.NET/Summaries/AttributesNamespace.cs @@ -0,0 +1,37 @@ +/* + * MIT License + * + * Copyright (c) 2019 plexdata.de + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +namespace Plexdata.CsvParser.Attributes +{ + /// + /// The namespace contains + /// all supported attributes of the Plexdata CSV Parser. + /// + /// + /// This namespace contains classes to be used to tag own classes as CSV + /// document as well as to tag class properties as CSV columns. + /// + [System.Runtime.CompilerServices.CompilerGenerated] + class NamespaceDoc { } +} \ No newline at end of file diff --git a/code/src/Plexdata.CsvParser.NET/Summaries/ConstantsNamespace.cs b/code/src/Plexdata.CsvParser.NET/Summaries/ConstantsNamespace.cs new file mode 100644 index 0000000..c9b8492 --- /dev/null +++ b/code/src/Plexdata.CsvParser.NET/Summaries/ConstantsNamespace.cs @@ -0,0 +1,37 @@ +/* + * MIT License + * + * Copyright (c) 2019 plexdata.de + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +namespace Plexdata.CsvParser.Constants +{ + /// + /// The namespace contains all + /// supported constant values of the Plexdata CSV Parser. + /// + /// + /// This namespace contains classes that support an easy access to all constant + /// values provided by the library. + /// + [System.Runtime.CompilerServices.CompilerGenerated] + class NamespaceDoc { } +} \ No newline at end of file diff --git a/code/src/Plexdata.CsvParser.NET/Summaries/InternalsNamespace.cs b/code/src/Plexdata.CsvParser.NET/Summaries/InternalsNamespace.cs new file mode 100644 index 0000000..914d67a --- /dev/null +++ b/code/src/Plexdata.CsvParser.NET/Summaries/InternalsNamespace.cs @@ -0,0 +1,37 @@ +/* + * MIT License + * + * Copyright (c) 2019 plexdata.de + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +namespace Plexdata.CsvParser.Internals +{ + /// + /// The namespace contains all + /// supported internal classes of the Plexdata CSV Parser. + /// + /// + /// This namespace contains classes which are used internally only. Users + /// are unable to use classes that belong to this namespace. + /// + [System.Runtime.CompilerServices.CompilerGenerated] + class NamespaceDoc { } +} \ No newline at end of file diff --git a/code/src/Plexdata.CsvParser.NET/Summaries/ProcessorsNamespace.cs b/code/src/Plexdata.CsvParser.NET/Summaries/ProcessorsNamespace.cs new file mode 100644 index 0000000..208e74b --- /dev/null +++ b/code/src/Plexdata.CsvParser.NET/Summaries/ProcessorsNamespace.cs @@ -0,0 +1,37 @@ +/* + * MIT License + * + * Copyright (c) 2019 plexdata.de + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +namespace Plexdata.CsvParser.Processors +{ + /// + /// The namespace contains all + /// supported processor classes of the Plexdata CSV Parser. + /// + /// + /// This namespace contains classes to import or export CSV files as well + /// as to configure the importer´s and the exporter´s behaviour. + /// + [System.Runtime.CompilerServices.CompilerGenerated] + class NamespaceDoc { } +} \ No newline at end of file diff --git a/code/src/Plexdata.CsvParser.Tester/Properties/AssemblyInfo.cs b/code/src/Plexdata.CsvParser.Tester/Properties/AssemblyInfo.cs index acb3a29..802e287 100644 --- a/code/src/Plexdata.CsvParser.Tester/Properties/AssemblyInfo.cs +++ b/code/src/Plexdata.CsvParser.Tester/Properties/AssemblyInfo.cs @@ -59,5 +59,5 @@ // You can specify all the values or you can default the Build and Revision Numbers // by using the '*' as shown below: // [assembly: AssemblyVersion("1.0.*")] -[assembly: AssemblyVersion("1.0.2")] -[assembly: AssemblyFileVersion("1.0.2")] +[assembly: AssemblyVersion("1.1.0")] +[assembly: AssemblyFileVersion("1.1.0")] diff --git a/code/src/TODOs.md b/code/src/TODOs.md index be68326..7ae9f4f 100644 --- a/code/src/TODOs.md +++ b/code/src/TODOs.md @@ -2,6 +2,5 @@ **TODOs** -- Support a CsvWriter in the same manner as done for CsvReader. - Migrating the library to .NET Standard v2.1 as soon as it is released. diff --git a/code/src/post-build.cmd b/code/src/post-build.cmd index 1130d47..e4392d5 100644 --- a/code/src/post-build.cmd +++ b/code/src/post-build.cmd @@ -8,7 +8,7 @@ set MSB="C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\MSBuild\1 if "%CFG%" == "Release" ( cd %SRC% - %MSB% /p:Configuration=%CFG% Plexdata.CsvParser.NET.shfbproj + %MSB% /p:Configuration=%CFG% Plexdata.CsvParser.NET.help.shfbproj cd "%PWD%" move /y %OUT% "%PWD%" ) else ( From 34e084a2f61182ad0e4c72fb24279570c34e0abc Mon Sep 17 00:00:00 2001 From: Axel Kesseler Date: Mon, 23 Dec 2019 04:08:54 +0100 Subject: [PATCH 2/2] Package migration (**BREAKING CHANGES**) --- code/hlp/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/code/hlp/README.md b/code/hlp/README.md index d2b26bf..a35637f 100644 --- a/code/hlp/README.md +++ b/code/hlp/README.md @@ -1,18 +1,18 @@ ## Overview -The help file project named ``Plexdata.CsvParser.NET.shfbproj`` has been created using [Sandcastle Help File Builder](https://ewsoftware.github.io/SHFB/html/bd1ddb51-1c4f-434f-bb1a-ce2135d3a909.htm) version v2018.7.8.0. +The help file project named `Plexdata.CsvParser.NET.help.shfbproj` has been created using [Sandcastle Help File Builder](https://ewsoftware.github.io/SHFB/html/bd1ddb51-1c4f-434f-bb1a-ce2135d3a909.htm) version v2018.7.8.0. ## Building the Help -Usually, there should be no need to change this file because of the CHM help file is automatically created during release build of the project sources via ``MSBuild.exe``. But if you like, you can download _Sandcastle Help File Builder_ from [https://github.com/EWSoftware/SHFB/releases](https://github.com/EWSoftware/SHFB/releases) and modify the project help fitting your own needs. +Usually, there should be no need to change this file because of the CHM help file is automatically created during release build of the project sources via `MSBuild.exe`. But if you like, you can download _Sandcastle Help File Builder_ from [https://github.com/EWSoftware/SHFB/releases](https://github.com/EWSoftware/SHFB/releases) and modify the project help fitting your own needs. For example you may like to create an HTML version of the project API documentation. In such a case just download and install the _Sandcastle Help File Builder_ as mentioned above. Then follow the steps below: -- As first, you should create a copy of the help file project ``Plexdata.CsvParser.NET.shfbproj`` and rename it, for instance, into ``Plexdata.CsvParser.NET-HTML.shfbproj``. +- As first, you should create a copy of the help file project `Plexdata.CsvParser.NET.help.shfbproj` and rename it, for instance, into `Plexdata.CsvParser.NET.html.shfbproj`. - As next, open this new file with the _Sandcastle Help File Builder_. - Thereafter, show tab _Project Properties_ and move to section _Build_. - Now un-tick the _HTML help 1 (chm)_ setting and tick the setting _Website (HTML/ASP.NET)_ instead. -- Then you should change the output path accordingly. For this purpose move to section _Paths_ and modify the value of box _Help content output path_. For example you could change this path into ``html\``. +- Then you should change the output path accordingly. For this purpose move to section _Paths_ and modify the value of box _Help content output path_. For example you could change this path into `html\`. - Finally, rebuild the whole help. After a successful build you will find the result inside the project file’s sub-folder you named above.