Bring up-to-date w/ current Midje, cljs

FORMULAS-BACKLOG-AND-FEATURE-IDEAS.md

@@ -0,0 +1,53 @@
+
+* [x] improve formula failure reporting
+   a. [x] report the first failure
+   b. [x] make sure the fact count only increases once per formula  
+
+* [x] make number of generated facts per formula dynamically bindable
+   a. [x] throw an exception if this value is set < 1
+
+* [x] figure out how to make syntax validation errors show something more sensible than the 
+      error message you'd see for a problem with a fact validation problem 
+
+* [x] don't run more tests than need be if there is already failure in this formula's batch.
+
+* [x] syntax validate thata formula only has one check in it  
+  a. [x] need to make this more thorough... right now the only test of this feature checks a 
+     simple provided case, but needs to work with against-background, background and 
+     other more interesting cases 
+  b. [ ] it is more thorough now, but let's make it *seriously* thoough :)
+
+* [x] formula macro calls a (constantly []) version of shrink on failures  
+
+* [x] add future-formula (and variant names)  
+
+* [x] cleaner syntax for overriding number of trials per formula. Use the 
+      *num-trials* var just for global changes or changes to be visible 
+      for groups of formulas.
+
+* [x] validate that opt-map is only used with valid keys.
+
+* [x] validate that :num-trials is 1+
+
+* [ ] Work with Meikel Brandmeyer to combine ClojureCheck's Generators with Shrink.
+      implement shrinking. Report only the first fully shrunken failure
+         [ ] 'shrink' depends on domain of 'generate'
+
+* [ ] ability to override shrink function on a per generator basis
+   a. [ ] ablity to not shrink at all on a per generator basis (make a nice syntactic 
+          sugar for this... as it is one of the cases of the above.
+
+* [ ] fix strange error if you run (formula [a 1] 1 =>)
+      ... since the formula macro splices in :formula :formula-in-progress
+      possibly solution is to not using fact macro inside of formula, 
+      but instead do something like tabular
+
+
+* [ ] if line numbers shift, then ensure that they always report correctly -- so far I 
+      don't know if this even needs to change, since it seems to work fine.  Think about 
+      it and decide if tests to prevent regressions are useful here.
+
+* [ ] consider implementing with @marick's metaconstant syntax
+   a. [ ] if we do metaconstant style, implement generator overriding
+
+* [ ] figure out what part of t-formulas is registering as a lot more than 1 report per formula. (100???)

HISTORY.md

@@ -1,28 +1,9 @@
-1.3.2-SNAPSHOT
--------------
-* throws now accepts any extending Throwable. For example, this now passes:
-  (throw (NullPointerException.)) => (throws Exception)
-* each item in the right hand side of =streams=> will evaluate lazily:
-  (provided
-     (volatile-fn) =streams=> [(throw (Exception.) (throw (Exception.)) :evaluates-succesfully] 
-* new function midje.sweet/expose-testables will allow you to write facts against 
-  functions defined with the metadata of ^{:testable true} [or ^:testable, 
-  or #^testable depending on which Clojure version you're running] 
-* Can now have prerequisites that throw Throwables using =throws=>
-    (provided (foo) =throws=> (Exception.))
-* Chatty checkers can destructure their single argument.                                           
-* tabular no longer requires variables names to begin with '?'
-* throws checker has been updated: args are now any combination, in
-  any order of messages (or regexes), predicates, or 0 or 1 Throwable classes
-* many more common syntax mistakes give helpful error messages
-* prevented an infinite loop caused by ill-formed tabular facts
-* fact doc-strings now show in report output
-  i. nested facts show nested doc-strings
-  ii. tabular's doc-string shows in a similar manner
-* =stream=> prerequisites give helpful error messages when they run out of items to return
-* removed reflection warnings
 
 
+1.4.0 (forthcoming)
+------------- 
+See https://github.com/marick/Midje/wiki/New-in-1.4
+
 1.3.1 
 ---------
 * Fix mysterious type conversion error in some cases

HOW-TO-RELEASE

@@ -1,33 +1,22 @@
-The process for pushing a new version is too complicated and
-manual. 
-
-
 * Update HISTORY
 * Do the THINGS TO CHECK BEFORE DEPLOYING (below)
-* Run configuration tests (HOW-TO-CONFIGURATION-TEST
-  with midje-version set to a non-snapshot value.
-  (Note that this uploads.)
 
-* DO NOT CLEAN.
-* Use bin/update-project-files and bin/version to set the examples
-  appropriately. For example:
-      bin/update-project-files 1.3.0
-      bin/version 1.3.0 1.2.1 1.2.0
-* bin/gather-downloads
+* rake fresh
+* rake upload
+
 * Update README.md (including version number)
 * Commit
 * git tag -a -m "message" v.x.x.x   ;; git push --tags
 * Push to github
 
-* Update example page, if needed.
-* Try out downloads.
+THINGS TO CHECK BEFORE DEPLOYING:
 
+* `lein multi deps; lein multi midje`
 
-THINGS TO CHECK BEFORE DEPLOYING:
 * uncomment the `:warn-on-reflection true` line in project.clj, and run `lein midje`
   to check for any reflection warning inadvertently added. (there will be warnings from
   libraries we use that we cannot remove)
 
 * Check for any public vars that shouldn't be visible to users. Hide them.
   (map str (vals (ns-publics 'midje.sweet))) 
-  (pp)
+  (pp)

README.md

@@ -1,8 +1,10 @@
 Available via [clojars](http://clojars.org/search?q=midje)   
-Current stable version: [midje "1.3.1"]    
-Development version: [midje "1.3.2-SNAPSHOT"]
+Current stable version: [midje "1.4.0"] [Changes from 1.3](https://github.com/marick/Midje/wiki/New-in-1.4)    
+Development version: [midje "1.5.0-SNAPSHOT"]  
 
-[User guide](https://github.com/marick/Midje/wiki)
+
+[User guide](https://github.com/marick/Midje/wiki)    
+[Tutorial](https://github.com/marick/Midje-quickstart/wiki)
 
 About Midje
 =======================
@@ -46,40 +48,27 @@ that are more useful for testing than `odd?` is.
 Learning Midje
 =======================
 
+There is a [tutorial introduction](https://github.com/marick/Midje-quickstart/wiki).
 Midje's features are described in the **[user
 guide](https://github.com/marick/Midje/wiki)**. If
 anything there is unclear, ask in the [mailing
-list](http://groups.google.com/group/midje).
+list](http://groups.google.com/group/midje) or in the #midje
+channel on freenode.
 If you like videos of people programming, here's an
 [8-minute infomercial](http://www.youtube.com/watch?v=a7YtkcIiLGI) that concentrates on transitioning from
 clojure.test. 
-If
-you like looking straight at code, [this heavily annotated
-example](http://github.com/marick/Midje/blob/master/examples/basic/test/basic/core_test.clj)
-  has a bunch. If you want to run that example, you
-  can download it:
-
-1.   [Click here](http://github.com/marick/Midje/raw/master/downloads/examples.zip).
-2.   In a shell, go to the directory your browser unpacked the example into. It should be named `examples`.
-3.   Go to `examples/basic/`.
-4.   Type "./run" or "lein test".
-5.   The facts in `test/*/core_test.clj` will be checked.
-
-You can [download
-everything](http://github.com/marick/Midje/downloads) to get
-more examples.
-
-Or in the #midje channel on freenode!
 
 Contributors
 ==============
 * Sean T. Allen
 * Alex Baranosky
 * Phillip Calçado
 * Stuart Halloway
+* Wilkes Joiner
 * Ben Mabey
 * Alan Malloy
 * Brian Marick
 * Bob Martin
+* Dmitri Naumov
 * Sébastien RoccaSerra
-* Wilkes Joiner
+* Greg Spurrier

Rakefile

@@ -8,8 +8,8 @@ def jar_name
   unless /midje\s+"(\d+\.\d+\.\d+(-RC\d+)?)"/ =~ text ||
          /midje\s+"(\d+\.\d+(\.\d+)*-SNAPSHOT)"/ =~ text || 
          /midje\s+"(\d+\.\d-alpha\d)"/ =~ text || 
-         /midje\s+"(\d+\.\d-beta\d)"/ =~ text
-    puts "Couldn't find version in project file."
+         /midje\s+"(\d+\.\d\.\d-beta\d)"/ =~ text
+    puts "Rake task error: couldn't find version in project file."
     exit 1
   end
   jar = "midje-#{$1}.jar"