luciano/honeysql
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove honey.specs (for now) #146

Browse source
This commit is contained in:
Sean Corfield 2021-04-10 03:58:29 -07:00
parent 8a1e2cca71
commit f393a61010
2 changed files with 2 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/differences-from-1-x.md
View file

@ -15,7 +15,7 @@ HoneySQL 1.x supported Clojure 1.7 and later. HoneySQL 2.x requires Clojure 1.9
HoneySQL 2.x uses the group ID `com.github.seancorfield` with the original artifact ID of `honeysql`, in line with the recommendations in Inside Clojure's post about the changes in the Clojure CLI: [Deprecated unqualified lib names](https://insideclojure.org/2020/07/28/clj-exec/); also Clojars [Verified Group Names policy](https://github.com/clojars/clojars-web/wiki/Verified-Group-Names).
In addition, HoneySQL 2.x contains different namespaces so you can have both versions on your classpath without introducing any conflicts. The primary API is now in `honey.sql` and the helpers are in `honey.sql.helpers`. A Spec for the DSL data structure will be available in `honey.specs` at some point (work in progress).
In addition, HoneySQL 2.x contains different namespaces so you can have both versions on your classpath without introducing any conflicts. The primary API is now in `honey.sql` and the helpers are in `honey.sql.helpers`.
### HoneySQL 1.x
@ -64,8 +64,7 @@ com.github.seancorfield/honeysql {:mvn/version "2.x"}
The new namespaces are:
* `honey.sql` -- the primary API (just `format` now),
* `honey.sql.helpers` -- helper functions to build the DSL,
* `honey.specs` -- a description of the DSL using `clojure.spec.alpha`.
* `honey.sql.helpers` -- helper functions to build the DSL.
Supported Clojure versions: 1.9 and later.

13
src/honey/specs.clj
View file

@ -1,13 +0,0 @@
;; copyright (c) 2020-2021 sean corfield, all rights reserved
(ns honey.specs
"Optional namespace containing `clojure.spec` representations of
the data format used as the underlying DSL for HoneySQL."
(:require [clojure.spec.alpha :as s]))
(s/def ::sql-expression any?)
(s/def ::dsl (s/map-of simple-keyword?
(s/coll-of ::sql-expression
:kind vector?
:min-count 1)))