crypto-enigma 0.0.1.6 → 0.0.1.7
raw patch · 4 files changed
+42/−23 lines, 4 filesPVP ok
version bump matches the API change (PVP)
API changes (from Hackage documentation)
Files
- CHANGELOG.md +20/−7
- Crypto/Enigma.hs +1/−5
- README.md +19/−9
- crypto-enigma.cabal +2/−2
CHANGELOG.md view
@@ -1,24 +1,37 @@-See also: [code milestones](https://github.com/orome/crypto-enigma/milestones?state=closed).+See also: the list of [code releases] and [closed milestones]. -### 0.0.1.6+### [0.0.1.7] * Fix Hackage uploading and versioning errors. -### 0.0.1.5+### [0.0.1.6] +* Fix Hackage uploading and versioning errors.++### [0.0.1.5]+ * Fix readme formatting errors. -### 0.0.1.4+### [0.0.1.4] * Some minor spelling corrections and notes. * Added Documentation. * Added README. * Added CHANGELOG.-* Support for [build checks](https://travis-ci.org/orome/crypto-enigma).+* Support for [build checks]. -### 0.0.1.3+### [0.0.1.3] -Initial Hackage version. First upload of package to Hackage, +Initial Hackage version. First upload of package to Hackage, without ([successful](https://hackage.haskell.org/package/crypto-enigma-0.0.1.3/reports/1)) Hacakge-built documentation. Stable enough for use, but not reviewed.++[build checks]: https://travis-ci.org/orome/crypto-enigma/branches+[code releases]: https://github.com/orome/crypto-enigma/releases+[closed milestones]: https://github.com/orome/crypto-enigma/milestones?state=closed+[0.0.1.7]: https://github.com/orome/crypto-enigma/releases/tag/0.0.1.7+[0.0.1.6]: https://github.com/orome/crypto-enigma/releases/tag/0.0.1.6+[0.0.1.5]: https://github.com/orome/crypto-enigma/releases/tag/0.0.1.5+[0.0.1.4]: https://github.com/orome/crypto-enigma/releases/tag/0.0.1.4+[0.0.1.3]: https://github.com/orome/crypto-enigma/releases/tag/0.0.1.3
Crypto/Enigma.hs view
@@ -70,15 +70,11 @@ -- TBD - Use modular arithmetic package - http://hackage.haskell.org/package/modular-arithmetic -- TBD - Use Arrow more? -- TBD - EnigmaMachine as Monad instance?+-- TBD - Add more walkthroughs to documentation (either README or Haddock)? -- TBD - Proper testing script - <http://dev.stephendiehl.com/hask/#testing> <<<--- TBD - Make GitHub README - https://github.com/orome/crypto-enigma/issues/1--- TBD - Get Hackage documentation working - https://github.com/orome/crypto-enigma/issues/2--- TBD - Script for Hackage uploads -- TBD - Code review <<< -- REV - Move plugboard last (it's 'optional'?)? -- TBD - Note how this implementation differs by preserving all letters and full mappings so they can be examined. <<<--- TBD - Use 'length.nub $ take n $ (iterate step cfg)' for all combinations of rotors to show num of unique states for all combinations of rotors (or numbers of rotor turnovers).--- ASK - Another approach other than 'length.nub' and 'iterate' to test all configs? -- REV - Have lists and display omit plugboard stage if not used or present; distinguishing non-use and absence? -- REV - Show degenerate case in list and display examples?
README.md view
@@ -1,27 +1,37 @@-### crypto-enigma+## crypto-enigma -+[](https://www.haskell.org) [](https://hackage.haskell.org/package/crypto-enigma) --[](https://travis-ci.org/orome/crypto-enigma)+[](https://github.com/orome/crypto-enigma/blob/hackage/LICENSE)+[](https://travis-ci.org/orome/crypto-enigma/branches) An Enigma machine simulator with state and encoding display. This is adapted, as an exerecise in learning Haskell, from an earlier learning project written in Mathematica. It is my first Haskell program. -See also:+Full [documentation] — for the latest [release version] — is available on Hackage. +For other Haskell Enigma machines see:+ * [enigma-hs](https://github.com/kc1212/enigma-hs) * [crypto-classical](https://github.com/fosskers/crypto-classical)+* [enigma.lhs](https://gist.github.com/erantapaa/f071bc3f58d017f9280a)+* [henigma](https://github.com/erantapaa/henigma) --- ### Development status -[](https://travis-ci.org/orome/crypto-enigma)+[](https://travis-ci.org/orome/crypto-enigma/branches) -I'm currently experimenting with some Haskell language features and can't promise -[the development version](https://github.com/orome/crypto-enigma/tree/develop) -will work.+I'm currently learning and experimenting with some Haskell language features and can't promise the+[development version] will work. More detail about planned releases and activities can be found the list of+scheduled [milestones] and in the list of [open issues].++[documentation]: https://hackage.haskell.org/package/crypto-enigma+[release version]: https://github.com/orome/crypto-enigma/tree/hackage+[development version]: https://github.com/orome/crypto-enigma/tree/develop+[milestones]: https://github.com/orome/crypto-enigma/milestones+[open issues]: https://github.com/orome/crypto-enigma/issues
crypto-enigma.cabal view
@@ -3,7 +3,7 @@ -- PVP summary: +-+------- breaking API changes -- | | +----- non-breaking API additions -- | | | +--- code changes with no API change-version: 0.0.1.6+version: 0.0.1.7 synopsis: An Enigma machine simulator with display. description: The crypto-enigma package is an Enigma machine simulator with rich display and machine state details.@@ -38,7 +38,7 @@ type: git location: git://github.com/orome/crypto-enigma.git branch: hackage- tag: dist004+ tag: 0.0.1.7 library -- default-extensions: Trustworthy