Merge pull request #102 from tonystone/release-5.0.0

Release 5.0.0

CHANGELOG.md

@@ -1,29 +1,7 @@
 # Change Log
 All significant changes to this project will be documented in this file.
 
-## [5.0.0-beta.4](https://github.com/tonystone/tracelog/tree/5.0.0-beta.4)
-
-#### Updated
-- Corrected availability of FileWriter and FileStrategyRotate so that they compile correctly on iOS.
-
-## [5.0.0-beta.3](https://github.com/tonystone/tracelog/tree/5.0.0-beta.3)
-
-#### Added
-- Added protected data monitoring for `FileWriter.Strategy.fixed` on iOS for use with `AsyncConcurrencyModeOption.buffer(writeInterval:strategy:)`. This allows TraceLog to be started up before protected data is available on iOS.
-
-## [5.0.0-beta.2](https://github.com/tonystone/tracelog/tree/5.0.0-beta.2)
-
-#### Changed
-- Renamed `AsyncOption` to `AsyncConcurrencyModeOption`.
-- Changed `OutputStreamFormatter`, it now requires `var encoding: String.Encoding { get }`.
-- Renamed `FileWriter.FileStrategy` to `FileWriter.Strategy`.
-- Renamed `FileWriter.Strategy.RotateOption` to `FileWriter.Strategy.RotationOption`.
-
-#### Updated
-- `TextFormat` to add `var encoding: String.Encoding { get }` requirement.
-- `JSONFormat` to add `var encoding: String.Encoding { get }` requirement.
-
-## [5.0.0-beta.1](https://github.com/tonystone/tracelog/tree/5.0.0-beta.1)
+## [5.0.0](https://github.com/tonystone/tracelog/tree/5.0.0)
 
 #### Added
 - Added `OutputStreamFormatter` protocol to define formatters for use with byte output stream type Writers.
@@ -32,8 +10,9 @@ All significant changes to this project will be documented in this file.
 - Added `OutputStreamWriter` protocol to define types that write byte streams to their output and accept `OutputStreamFormatter` types to format the output.
 - Added `LogEntry` tuple type to `Writer` defining the formal types that a Writer writes.
 - Added `.buffer` option for `.async` concurrency modes to allow for buffering when the writer is not available to write to its endpoint.
+- Added protected data monitoring for `FileWriter.Strategy.fixed` on iOS for use with `AsyncConcurrencyModeOption.buffer(writeInterval:strategy:)`. This allows TraceLog to be started up before protected data is available on iOS.
 
-#### Changed
+#### Upated
 - Requires Swift 5 for compilation.
 - Changed parameters to `.async` to include options for configuration of the mode (`.async(options: Set<AsyncConcurrencyModeOption>)` and `.async(Writer, options: Set<AsyncConcurrencyModeOption>)`).
 - Changed `Writer` protocol `log()` method to `write(_ entry: Writer.LogEntry)` to make it easier to process messages by writers and formatters.
@@ -44,6 +23,12 @@ All significant changes to this project will be documented in this file.
  * Removed the `fileConfiguration` parameter replacing with new `strategy` enum.
  * It now accepts the new `OutputStreamFormatter` instances allowing you to customize the output log format (default is `TextFormat`.)
 - Changed `FileWriter` archive file name date format to "yyyyMMdd-HHmm-ss-SSS" (This was done for maximum compatibility between platforms and can be overridden in the FileConfiguration object passed at init.)
+- `TextFormat` to add `var encoding: String.Encoding { get }` requirement.
+- `JSONFormat` to add `var encoding: String.Encoding { get }` requirement.
+- Renamed `AsyncOption` to `AsyncConcurrencyModeOption`.
+- Changed `OutputStreamFormatter`, it now requires `var encoding: String.Encoding { get }`.
+- Renamed `FileWriter.FileStrategy` to `FileWriter.Strategy`.
+- Renamed `FileWriter.Strategy.RotateOption` to `FileWriter.Strategy.RotationOption`.
 
 #### Removed
 - Removed `TraceLogTestHarness` module.

CMakeLists.txt

@@ -7,7 +7,7 @@ message(STATUS " Build type: ${CMAKE_BUILD_TYPE}")
 message(STATUS "")
 
 # Constants
-set( LIB_VERSION "5.0.0-beta.2" )
+set( LIB_VERSION "5.0.0" )
 set( SWIFT_VERSION "5" )
 
 # Look for modules in the our root.
@@ -41,7 +41,7 @@ add_custom_target(pod-lint
 
 add_custom_target(documentation
  DEPENDS xcode-project generate-source .jazzy.yaml
- COMMAND jazzy --clean --module-version ${LIB_VERSION}
+ COMMAND bundle exec jazzy --clean --module-version ${LIB_VERSION}
  COMMAND cp ${CMAKE_SOURCE_DIR}/Sources/Documentation/Images/*.png ${CMAKE_SOURCE_DIR}/docs/img/
  WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}")
 

Gemfile

@@ -1,2 +1,3 @@
 source 'https://rubygems.org'
 gem 'cocoapods', '1.6.0'
+gem 'jazzy', '0.13.0'

README.md

@@ -1,4 +1,3 @@
-## ⚡️ Stay tuned for updates: upcoming version 5.0.0 (currently in beta)
 <p align="center">Please <a href="https://github.com/tonystone/tracelog/stargazers">star</a> this github repository to stay up to date.</p>
 
 # TraceLog ![license: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-lightgray.svg?style=flat)

TraceLog.podspec

@@ -9,7 +9,7 @@
 
 Pod::Spec.new do |s|
  s.name = "TraceLog"
- s.version = "5.0.0-beta.4"
+ s.version = "5.0.0"
  s.summary = "Dead Simple: logging the way it's meant to be!"
  s.description = <<-DESC
  TraceLog is a configurable debug logging system. It is unique in that it's configured

docs/Classes/ConsoleWriter.html

@@ -30,7 +30,7 @@
  <header class="header">
  <p class="header-col header-col--primary">
  <a class="header-link" href="../index.html">
- TraceLog Docs
+ TraceLog 5.0.0 Docs
  </a>
  (100% documented)
  </p>
@@ -60,7 +60,7 @@
  <nav class="navigation">
  <ul class="nav-groups">
  <li class="nav-group-name">
- <a class="nav-group-name-link" href="../User Guides.html">User Guides</a>
+ <a class="nav-group-name-link" href="../User%20Guides.html">User Guides</a>
  <ul class="nav-group-tasks">
  <li class="nav-group-task">
  <a class="nav-group-task-link" href="../quick-start.html">Quick Start</a>
@@ -148,7 +148,7 @@
  </ul>
  </li>
  <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Software Developer Kit (SDK).html">Software Developer Kit (SDK)</a>
+ <a class="nav-group-name-link" href="../Software%20Developer%20Kit%20%28SDK%29.html">Software Developer Kit (SDK)</a>
  <ul class="nav-group-tasks">
  <li class="nav-group-task">
  <a class="nav-group-task-link" href="../Protocols/Writer.html">Writer</a>
@@ -162,7 +162,7 @@
  </ul>
  </li>
  <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Supporting Types.html">Supporting Types</a>
+ <a class="nav-group-name-link" href="../Supporting%20Types.html">Supporting Types</a>
  <ul class="nav-group-tasks">
  <li class="nav-group-task">
  <a class="nav-group-task-link" href="../Enums/ConcurrencyMode.html">ConcurrencyMode</a>
@@ -201,7 +201,7 @@
  <article class="main-content">
 
  <section class="section">
- <div class="section-content">
+ <div class="section-content top-matter">
  <h1>ConsoleWriter</h1>
  <div class="declaration">
  <div class="language">
@@ -240,9 +240,11 @@ <h3 id='output-format' class='heading'>Output Format</h3>
  <div class="task-name-container">
  <a name="/Initialization"></a>
  <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a>
- <a href="#/Initialization">
- <h3 class="section-name">Initialization</h3>
- </a>
+ <div class="section-name-container">
+ <a class="section-name-link" href="#/Initialization"></a>
+ <h3 class="section-name"><p>Initialization</p>
+</h3>
+ </div>
  </div>
  <ul class="item-container">
  <li class="item">
@@ -265,7 +267,7 @@ <h3 class="section-name">Initialization</h3>
  <h4>Declaration</h4>
  <div class="language">
  <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">format</span><span class="p">:</span> <span class="kt"><a href="../Protocols/OutputStreamFormatter.html">OutputStreamFormatter</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/ConsoleWriter/Default.html">Default</a></span><span class="o">.</span><span class="n"><a href="../Classes/ConsoleWriter.html#/s:8TraceLog13ConsoleWriterC6formatAA21OutputStreamFormatter_pvp">format</a></span><span class="p">)</span></code></pre>
+ <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">format</span><span class="p">:</span> <span class="kt"><a href="../Protocols/OutputStreamFormatter.html">OutputStreamFormatter</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/ConsoleWriter/Default.html">Default</a></span><span class="o">.</span><span class="n"><a href="../Classes/ConsoleWriter.html#/s:8TraceLog13ConsoleWriterC6formatAA21OutputStreamFormatter_pvp">format</a></span><span class="p">)</span></code></pre>
 
  </div>
  </div>
@@ -297,9 +299,11 @@ <h4>Parameters</h4>
  <div class="task-name-container">
  <a name="/OutputStreamWriter%20conformance"></a>
  <a name="//apple_ref/swift/Section/OutputStreamWriter conformance" class="dashAnchor"></a>
- <a href="#/OutputStreamWriter%20conformance">
- <h3 class="section-name">OutputStreamWriter conformance</h3>
- </a>
+ <div class="section-name-container">
+ <a class="section-name-link" href="#/OutputStreamWriter%20conformance"></a>
+ <h3 class="section-name"><p>OutputStreamWriter conformance</p>
+</h3>
+ </div>
  </div>
  <ul class="item-container">
  <li class="item">
@@ -320,13 +324,11 @@ <h3 class="section-name">OutputStreamWriter conformance</h3>
  <p class="aside-title">See also</p>
  <code><a href="../Protocols/Writer.html">Writer</a></code> for more information about the <code>write</code> function.
 
-</div>
-<div class="aside aside-see-also">
+</div><div class="aside aside-see-also">
  <p class="aside-title">See also</p>
  &lsquo;Writer.LogEntry&rsquo; for a complete definition of the loggable entry.
 
-</div>
-<div class="aside aside-see-also">
+</div><div class="aside aside-see-also">
  <p class="aside-title">See also</p>
  <code><a href="../Enums/FailureReason.html">FailureReason</a></code> for failure return types.
 
@@ -377,9 +379,11 @@ <h4>Declaration</h4>
  <div class="task-name-container">
  <a name="/Default%20Values"></a>
  <a name="//apple_ref/swift/Section/Default Values" class="dashAnchor"></a>
- <a href="#/Default%20Values">
- <h3 class="section-name">Default Values</h3>
- </a>
+ <div class="section-name-container">
+ <a class="section-name-link" href="#/Default%20Values"></a>
+ <h3 class="section-name"><p>Default Values</p>
+</h3>
+ </div>
  </div>
  <ul class="item-container">
  <li class="item">
@@ -419,7 +423,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="http:https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

docs/Classes/ConsoleWriter/Default.html

@@ -30,7 +30,7 @@
  <header class="header">
  <p class="header-col header-col--primary">
  <a class="header-link" href="../../index.html">
- TraceLog Docs
+ TraceLog 5.0.0 Docs
  </a>
  (100% documented)
  </p>
@@ -60,7 +60,7 @@
  <nav class="navigation">
  <ul class="nav-groups">
  <li class="nav-group-name">
- <a class="nav-group-name-link" href="../../User Guides.html">User Guides</a>
+ <a class="nav-group-name-link" href="../../User%20Guides.html">User Guides</a>
  <ul class="nav-group-tasks">
  <li class="nav-group-task">
  <a class="nav-group-task-link" href="../../quick-start.html">Quick Start</a>
@@ -148,7 +148,7 @@
  </ul>
  </li>
  <li class="nav-group-name">
- <a class="nav-group-name-link" href="../../Software Developer Kit (SDK).html">Software Developer Kit (SDK)</a>
+ <a class="nav-group-name-link" href="../../Software%20Developer%20Kit%20%28SDK%29.html">Software Developer Kit (SDK)</a>
  <ul class="nav-group-tasks">
  <li class="nav-group-task">
  <a class="nav-group-task-link" href="../../Protocols/Writer.html">Writer</a>
@@ -162,7 +162,7 @@
  </ul>
  </li>
  <li class="nav-group-name">
- <a class="nav-group-name-link" href="../../Supporting Types.html">Supporting Types</a>
+ <a class="nav-group-name-link" href="../../Supporting%20Types.html">Supporting Types</a>
  <ul class="nav-group-tasks">
  <li class="nav-group-task">
  <a class="nav-group-task-link" href="../../Enums/ConcurrencyMode.html">ConcurrencyMode</a>
@@ -201,7 +201,7 @@
  <article class="main-content">
 
  <section class="section">
- <div class="section-content">
+ <div class="section-content top-matter">
  <h1>Default</h1>
  <div class="declaration">
  <div class="language">
@@ -220,9 +220,11 @@ <h1>Default</h1>
  <div class="task-name-container">
  <a name="/Available%20Defaults"></a>
  <a name="//apple_ref/swift/Section/Available Defaults" class="dashAnchor"></a>
- <a href="#/Available%20Defaults">
- <h3 class="section-name">Available Defaults</h3>
- </a>
+ <div class="section-name-container">
+ <a class="section-name-link" href="#/Available%20Defaults"></a>
+ <h3 class="section-name"><p>Available Defaults</p>
+</h3>
+ </div>
  </div>
  <ul class="item-container">
  <li class="item">
@@ -265,7 +267,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="http:https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>