Skip to content

Commit 3e9d372

Browse files
blosavioblosavio
committed
all latest changes for bump to version 2
1 parent 8cfe9e0 commit 3e9d372

11 files changed

+125
-845
lines changed

‎README.md

Lines changed: 55 additions & 54 deletions
Large diffs are not rendered by default.

‎changelog.edn

Lines changed: 1 addition & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,3 @@
11
[(load-file "resources/changelog_entries/changelog_v0.edn")
22
(load-file "resources/changelog_entries/changelog_v1.edn")
3-
(load-file "resources/changelog_entries/changelog_v2.edn")]
4-
5-
(comment Release notes ; changelog.edn
6-
"A human- and machine-readable `changelog.edn` will accompany each Speculoos
7-
release at the project's root directory. `changelog.edn` is tail-appended file
8-
constructed from all previous releases, possibly automatically-composed of
9-
per-release release-log.edn files in a sub-directory.
10-
11-
Each release is a map describing each change. Each change map has the
12-
following keys with appropriate associated values:
13-
14-
:date {:year :month :date :index <optional, if more than one per day>}
15-
:responsible {:name :email}
16-
:contributors [{:name :email} ...] <included as needed>
17-
18-
:change
19-
:initial-release
20-
:security
21-
22-
:performance-improvement
23-
:preformance-regression
24-
:memory-improvement
25-
:memory-regression
26-
:network-resource-improvement
27-
:network-resource-regression
28-
29-
:api-change
30-
31-
:relaxed-requirements
32-
:increased-requirements
33-
34-
:documentation
35-
36-
:tests
37-
:bug-fix
38-
:deprecated-something
39-
40-
:name-change
41-
:function-argument-signature-change
42-
:removed-fn
43-
44-
:policy-change (i.e., considered good-form to...)
45-
:meta-data
46-
47-
:error-messsage-improved/changed
48-
:default-changed
49-
:improved-output (e.g., handles more unicode; processes more numeric types)
50-
51-
:website-change
52-
:documentation-change
53-
54-
:implementation-change
55-
:source-formatting-change (i.e., indentation, spacing, capitalization, parentheses location)
56-
57-
:release-note-change (omissions, corrections)
58-
59-
60-
:comment a string for whatever seems useful <optional>
61-
62-
:maturity
63-
:proof-of-concept
64-
:experimental
65-
:pre-alpha
66-
:alpha
67-
:beta
68-
:release
69-
70-
:urgency
71-
:none
72-
:low
73-
:high
74-
75-
:status
76-
:active
77-
:stable
78-
:inactive
79-
:experimental
80-
:deprecated
81-
:mature
82-
83-
:breaking?
84-
:nil if initial public release
85-
false if and only if all changes are non-breaking
86-
true otherwise
87-
88-
[tentative policy: bug fixes are non-breaking changes]")
3+
(load-file "resources/changelog_entries/changelog_v2.edn")]

‎changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ Also updated documentation to correspond to new function names.</div></li><li><d
88
`data-with-specs` to properly handle scalars within a set.</div></li><li><div>Removed un-needed/redundant api.clj and api.html pages because
99
they&apos;re automatically generated by Codox.</div></li><li><div>Added a `*max-tries*` dynamic var that governs random sample
1010
generators.</div></li><li><div>Added tests to verify handling of sequences emitted by
11-
`interpose`, `interleave`, `lazy-cat`, `mapcat`, and `zipmap`.</div></li><li><div>Added `lazy-seq?` utility predicate.</div></li><li><div>Various documentation edits spanning 2024July10 through 2024July26.</div></li></ul></div><hr /></section><section><h3>version 0</h3><p>2024 June 6<br />Brad Losavio (blosavio@sagevisuals.com)<br /><em>Description: </em>Initial public release.<br /><em>Project status: </em><a href="https://github.com/metosin/open-source/blob/main/project-status.md">experimental</a><br /><em>Urgency: </em>low<br /><em>Breaking: </em>no</p><p></p><div><h4>Breaking changes</h4><ul></ul><h4>Non-breaking changes</h4><ul></ul></div><hr /></section><section><h4>Changelog info</h4><p id="info">A human- and machine-readable <code>changelog.edn</code> will accompany each version at the project&apos;s root directory. <code>changelog.edn</code> is tail-appended file constructed from all previous releases, possibly automatically-composed of per-version <code>changelog-v<em>N</em>.edn</code> files in a sub-directory.</p><p>A <code>changelog.md</code> file, intended for display on the web, is generated by a script. This script also contains specifications describing the changelog data.</p><p>Tentative policy: Bug fixes are non-breaking changes.</p></section><p id="page-footer">Copyright © 2024 Brad Losavio.<br />Compiled 2024 November 09.<span id="uuid"><br />d571f801-3b49-4fd9-a5f3-620e034d0a8d</span></p></body>
11+
`interpose`, `interleave`, `lazy-cat`, `mapcat`, and `zipmap`.</div></li><li><div>Added `lazy-seq?` utility predicate.</div></li><li><div>Various documentation edits spanning 2024July10 through 2024July26.</div></li></ul></div><hr /></section><section><h3>version 0</h3><p>2024 June 6<br />Brad Losavio (blosavio@sagevisuals.com)<br /><em>Description: </em>Initial public release.<br /><em>Project status: </em><a href="https://github.com/metosin/open-source/blob/main/project-status.md">experimental</a><br /><em>Urgency: </em>low<br /><em>Breaking: </em>no</p><p></p><div><h4>Breaking changes</h4><ul></ul><h4>Non-breaking changes</h4><ul></ul></div><hr /></section><section><h4>Changelog info</h4><p id="info">A human- and machine-readable <code>changelog.edn</code> will accompany each version at the project&apos;s root directory. <code>changelog.edn</code> is tail-appended file constructed from all previous releases, possibly automatically-composed of per-version <code>changelog-v<em>N</em>.edn</code> files in a sub-directory.</p><p>A <code>changelog.md</code> file, intended for display on the web, is generated by a script. This script also contains specifications describing the changelog data.</p><p>Tentative policy: Bug fixes are non-breaking changes.</p></section><p id="page-footer">Copyright © 2024 Brad Losavio.<br />Compiled 2024 November 11.<span id="uuid"><br />d571f801-3b49-4fd9-a5f3-620e034d0a8d</span></p></body>

‎doc/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!DOCTYPE html PUBLIC ""
22
"">
3-
<html><head><meta charset="UTF-8" /><title>Speculoos version 2-SNAPSHOT5</title><link rel="stylesheet" type="text/css" href="default.css" /><link rel="stylesheet" type="text/css" href="highlight.css" /><script type="text/javascript" src="highlight.min.js"></script><script type="text/javascript" src="jquery.min.js"></script><script type="text/javascript" src="page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Speculoos</span> <span class="project-version">version 2-SNAPSHOT5</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>speculoos</span></div></div></li><li class="depth-2 branch"><a href="speculoos.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="speculoos.function-specs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>function-specs</span></div></a></li><li class="depth-2"><a href="speculoos.utility.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utility</span></div></a></li></ul><ul class="index-link"><li class="depth-1"><a href="https://github.com/blosavio/speculoos">Project Home</a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Speculoos</span> <span class="project-version">version 2-SNAPSHOT5</span></span></h1><h5 class="license">Released under the <a href="https://opensource.org/license/mit">MIT License</a></h5><div class="doc"><p>A library for validating Clojure data.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[com.sagevisuals/speculoos "version 2-SNAPSHOT5"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="speculoos.core.html">speculoos.core</a></h3><div class="doc"><div class="markdown"><p>This namespace provides functions to validate Clojure data. They operate on any heterogeneous, arbitrarily-nested data structure.</p>
3+
<html><head><meta charset="UTF-8" /><title>Speculoos version 2</title><link rel="stylesheet" type="text/css" href="default.css" /><link rel="stylesheet" type="text/css" href="highlight.css" /><script type="text/javascript" src="highlight.min.js"></script><script type="text/javascript" src="jquery.min.js"></script><script type="text/javascript" src="page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Speculoos</span> <span class="project-version">version 2</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>speculoos</span></div></div></li><li class="depth-2 branch"><a href="speculoos.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="speculoos.function-specs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>function-specs</span></div></a></li><li class="depth-2"><a href="speculoos.utility.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utility</span></div></a></li></ul><ul class="index-link"><li class="depth-1"><a href="https://github.com/blosavio/speculoos">Project Home</a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Speculoos</span> <span class="project-version">version 2</span></span></h1><h5 class="license">Released under the <a href="https://opensource.org/license/mit">MIT License</a></h5><div class="doc"><p>A library for validating Clojure data.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[com.sagevisuals/speculoos "version 2"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="speculoos.core.html">speculoos.core</a></h3><div class="doc"><div class="markdown"><p>This namespace provides functions to validate Clojure data. They operate on any heterogeneous, arbitrarily-nested data structure.</p>
44
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="speculoos.core.html#var-all-paths">all-paths</a> </li><li> <a href="speculoos.core.html#var-clamp">clamp</a> </li><li> <a href="speculoos.core.html#var-only-invalid">only-invalid</a> </li><li> <a href="speculoos.core.html#var-only-valid">only-valid</a> </li><li> <a href="speculoos.core.html#var-ordinal-get">ordinal-get</a> </li><li> <a href="speculoos.core.html#var-ordinal-get-in">ordinal-get-in</a> </li><li> <a href="speculoos.core.html#var-recover-literal-path">recover-literal-path</a> </li><li> <a href="speculoos.core.html#var-reduce-indexed">reduce-indexed</a> </li><li> <a href="speculoos.core.html#var-valid-collections.3F">valid-collections?</a> </li><li> <a href="speculoos.core.html#var-valid-macro.3F">valid-macro?</a> </li><li> <a href="speculoos.core.html#var-valid-scalars.3F">valid-scalars?</a> </li><li> <a href="speculoos.core.html#var-valid.3F">valid?</a> </li><li> <a href="speculoos.core.html#var-validate">validate</a> </li><li> <a href="speculoos.core.html#var-validate-collections">validate-collections</a> </li><li> <a href="speculoos.core.html#var-validate-macro-with">validate-macro-with</a> </li><li> <a href="speculoos.core.html#var-validate-scalars">validate-scalars</a> </li><li> <a href="speculoos.core.html#var-validate-with-path-spec">validate-with-path-spec</a> </li></ul></div></div><div class="namespace"><h3><a href="speculoos.function-specs.html">speculoos.function-specs</a></h3><div class="doc"><div class="markdown"><p>This namespace provides facilities to apply specifications to and validate functions. Roughly speaking, trying to replicate the instrumentation and testing capabilities of <a href="https://clojure.org/guides/spec#_instrumentation_and_testing">spec.alpha</a> .</p>
55
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="speculoos.function-specs.html#var-assoc-metadata-f.21">assoc-metadata-f!</a> </li><li> <a href="speculoos.function-specs.html#var-dissoc-metadata-f.21">dissoc-metadata-f!</a> </li><li> <a href="speculoos.function-specs.html#var-exercise-fn">exercise-fn</a> </li><li> <a href="speculoos.function-specs.html#var-inject-specs.21">inject-specs!</a> </li><li> <a href="speculoos.function-specs.html#var-instrument">instrument</a> </li><li> <a href="speculoos.function-specs.html#var-recognized-spec-keys">recognized-spec-keys</a> </li><li> <a href="speculoos.function-specs.html#var-unject-specs.21">unject-specs!</a> </li><li> <a href="speculoos.function-specs.html#var-unstrument">unstrument</a> </li><li> <a href="speculoos.function-specs.html#var-validate-argument-return-relationship">validate-argument-return-relationship</a> </li><li> <a href="speculoos.function-specs.html#var-validate-fn">validate-fn</a> </li><li> <a href="speculoos.function-specs.html#var-validate-fn-with">validate-fn-with</a> </li><li> <a href="speculoos.function-specs.html#var-validate-higher-order-fn">validate-higher-order-fn</a> </li><li> <a href="speculoos.function-specs.html#var-wrapping-fn">wrapping-fn</a> </li></ul></div></div><div class="namespace"><h3><a href="speculoos.utility.html">speculoos.utility</a></h3><div class="doc"><div class="markdown"><p>Utility functions to make using and interacting with Speculoos nicer.</p>
66
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="speculoos.utility.html#var-*ordinal-offset*">*ordinal-offset*</a> </li><li> <a href="speculoos.utility.html#var-*such-that-max-tries*">*such-that-max-tries*</a> </li><li> <a href="speculoos.utility.html#var-.3D10th">=10th</a> </li><li> <a href="speculoos.utility.html#var-.3D11th">=11th</a> </li><li> <a href="speculoos.utility.html#var-.3D12th">=12th</a> </li><li> <a href="speculoos.utility.html#var-.3D1st">=1st</a> </li><li> <a href="speculoos.utility.html#var-.3D2nd">=2nd</a> </li><li> <a href="speculoos.utility.html#var-.3D3rd">=3rd</a> </li><li> <a href="speculoos.utility.html#var-.3D4th">=4th</a> </li><li> <a href="speculoos.utility.html#var-.3D5th">=5th</a> </li><li> <a href="speculoos.utility.html#var-.3D6th">=6th</a> </li><li> <a href="speculoos.utility.html#var-.3D7th">=7th</a> </li><li> <a href="speculoos.utility.html#var-.3D8th">=8th</a> </li><li> <a href="speculoos.utility.html#var-.3D9th">=9th</a> </li><li> <a href="speculoos.utility.html#var-all-specs-okay">all-specs-okay</a> </li><li> <a href="speculoos.utility.html#var-apathetic">apathetic</a> </li><li> <a href="speculoos.utility.html#var-basic-collection-spec-from-data">basic-collection-spec-from-data</a> </li><li> <a href="speculoos.utility.html#var-clamp-every">clamp-every</a> </li><li> <a href="speculoos.utility.html#var-clamp-in*">clamp-in*</a> </li><li> <a href="speculoos.utility.html#var-collections-without-predicates">collections-without-predicates</a> </li><li> <a href="speculoos.utility.html#var-data-from-spec">data-from-spec</a> </li><li> <a href="speculoos.utility.html#var-defpred">defpred</a> </li><li> <a href="speculoos.utility.html#var-exercise">exercise</a> </li><li> <a href="speculoos.utility.html#var-in.3F">in?</a> </li><li> <a href="speculoos.utility.html#var-inspect-fn">inspect-fn</a> </li><li> <a href="speculoos.utility.html#var-lazy-seq.3F">lazy-seq?</a> </li><li> <a href="speculoos.utility.html#var-non-predicates">non-predicates</a> </li><li> <a href="speculoos.utility.html#var-pred-sym-.3Egen-sym">pred-sym-&gt;gen-sym</a> </li><li> <a href="speculoos.utility.html#var-predicate-.3Egenerator">predicate-&gt;generator</a> </li><li> <a href="speculoos.utility.html#var-predicates-without-collections">predicates-without-collections</a> </li><li> <a href="speculoos.utility.html#var-predicates-without-scalars">predicates-without-scalars</a> </li><li> <a href="speculoos.utility.html#var-scalars-with-predicates">scalars-with-predicates</a> </li><li> <a href="speculoos.utility.html#var-scalars-without-predicates">scalars-without-predicates</a> </li><li> <a href="speculoos.utility.html#var-seq-regex">seq-regex</a> </li><li> <a href="speculoos.utility.html#var-sore-thumb">sore-thumb</a> </li><li> <a href="speculoos.utility.html#var-spec-from-data">spec-from-data</a> </li><li> <a href="speculoos.utility.html#var-swap-non-predicates">swap-non-predicates</a> </li><li> <a href="speculoos.utility.html#var-thoroughly-valid-collections.3F">thoroughly-valid-collections?</a> </li><li> <a href="speculoos.utility.html#var-thoroughly-valid-scalars.3F">thoroughly-valid-scalars?</a> </li><li> <a href="speculoos.utility.html#var-thoroughly-valid.3F">thoroughly-valid?</a> </li><li> <a href="speculoos.utility.html#var-unfindable-generators">unfindable-generators</a> </li><li> <a href="speculoos.utility.html#var-validate-predicate-.3Egenerator">validate-predicate-&gt;generator</a> </li></ul></div></div></div></body></html>

0 commit comments

Comments
 (0)