ema/CHANGELOG.md

# Revision history for ema

## 0.8.0.0 (Unreleased)

This releases brings a significant rewrite of Ema. If you choose to upgrade your apps from 0.6, see https://ema.srid.ca/howto/upgrade for guidance.

- GHC 9.0 support
- Better handling of URL anchors (#83; #87)
- `routeUrl` uses `UrlDirect` by default. Use `routeUrlWith` if you want to change that.
- Ema status indicator now works independently (requires no Tailwind)
- Multisite rewrite (Ema is mostly rewritten)
  - Add the notion of route `Prism_` (first-class values), along with a `IsRoute` class to define them.
    - Optional generic deriving of route prisms, so you do not have to hand-write them.
    - Automatic isomorphism checks ensures that encoding and decoding are isomorphic.
  - Composable Ema apps 
    - There are two ways of composing Ema apps. Using heterogenous lists (see `Ema.Route.Lib.Multi`), or by defining a top-level route type (see `Ex04_Multi.hs`).
  - Replace `LVar` with `Dynamic`.
    - Ema still uses `LVar` internally (for live server updates), but on the user-side one only needs to provide a `Dynamic` which is a tuple of initial value and an updating function. The [unionmount](https://github.com/srid/unionmount/pull/1) library was changed to provide this tuple.
  - Add `EmaSite` typeclass to "connect them all"
    - `SiteArg`: Type of value to pass from the environment.
    - `siteInput`: Define the `Dynamic` model for the site.
    - `siteOutput`: Asset (eg: HTML) to produce for each route.

## 0.6.0.0 -- 2022-02-05

- Websocket API: Add `ema.switchRoute` to switch to other routes in live server.
- Smaller core: remove helpers and examples (examples can be enabled by a flag)
  - Helpers
    - `Ema.Helpers.PathTree` moved to separate package *pathtree*.
    - `Ema.Helpers.FileSystem` moved to separate package *unionmount*.
    - `Ema.Helpers.Markdown` moved to separate package *commonmark-simple*.
    - `Ema.Helpers.Blaze` is no more. See `ema-template` if you need a ready made template using blaze HTML and TailwindCSS.
  - Examples `with-examples` cabal flag is made False by default. Examples are not exposed modules.
  - `Ema.Route.Slug` moved to separate package *url-slug*

## 0.4.0.0 -- 2022-01-19

- Pin TailwindCSS to 2.x, because the 3.x broke our CDN url
- Remove unused Cabal deps (#61)
- `Tailwind.layoutWith`: don't hardcode `<body>` attrs
- Tailwind: module revamped and renamed to `Tailwind.Helper.Blaze`
- `runEma` and friends: 
  - return the monadic's action's return value or generated files (dependent type)
- CLI: add `run` subcommand that takes `--host` and `--port` (and remove environment hacks of $HOST and $PORT)

## 0.2.0.0 -- 2021-11-21

- TODO(doc) runEma's action gets the `CLI.Action` as argument, to prevent the `gen` command from needing to monitoring files.
- Live Server
  - Avoid unncessary DOM patch on page load
  - Handle invalid routes gracefully without breaking websocket
  - Re-add `<script>` tags on hot reload
  - Scroll to top on route switches
  - Use secure websockets when on HTTPS
  - Bind to loopback (127.0.0.1) for security reasons
  - Do not handle target=_blank links in websocket route switch
- `Asset` type
  - Introduce the `Asset` type to distinguishing between static files and generated files. The later can be one of `Html` or `Other`, allowing the live server to handle them sensibly.
  - `Ema` typeclass: 
    - Drop `staticAssets` in favour of `allRoutes` (renamed from `staticRoutes`) returning all routes including both generated and static routes.
    - Drop `Slug` and use plain `FilePath`. Route encoder and decoder deal directly with the on-disk path of the generated (or static) files.
  - Make the render function (which `runEma` takes) return a `Asset LByteString` instead of `LByteString` such that it can handle all routes, and handle static files as well as generation of non-HTML content (eg: RSS)
  - Allow copying static files anywhere on the filesystem
- `routeUrl`: 
  - Unicode normalize as well URI encode route URLs
  - now returns relative URLs (ie. without the leading `/`)
    - Use the `<base>` tag to specify an explicit prefix for relative URLs in generated HTML. This way hosting on GitHub Pages without CNAME will continue to have functional links.
  - Fix: prevent encoding of non-HTML paths
  - Now takes the `model` type as argument, inasmuch as `encodeRoute` takes it as as well (to accomodate scenarios where route path can only be computed depending on model state; storing slug aliases for instance)
  - Add `routeUrlWith` for non-pretty URLs
- `Ema.Slug`
  - Add `Ord`, `Generic`, `Data` and Aeson instances to `Slug`
  - Unicode normalize slugs using NFC
  - Add `decodeSlug` and `encodeSlug`
- Add default implementation based on Enum for `allRoutes`
- Warn, without failing, on missing static assets during static generation
- Static generation
  - Use block buffering to prevent logging from slowing down site generation
  - Write .nojekyll
- CLI
  - Removed `-C` argument (orthogonal to Ema)
- Helpers
  - Helpers.FileSystem
    - Add Union mount support; re-exported from `unionmount` library
    - enrich FileAction type to distinguish between existance and new and update states
  - Helpers.Tailwind
    - add overflow-y-scroll to body
    - Add twind shim *before* application's head
    - CDN: Use latest version always.
  - Helpers.Markdown
    - add helpers to parse markdown; `parseMarkdownWithFrontMatter` and `parseMarkdown`
- Examples
  - ~~Remove Ex03_Documentation.hs (moved to separate repo, `ema-docs`)~~ Back to ./docs, but using Emanote.
  - Add Ex03_Basic.hs example

## 0.1.0.0 -- 2021-04-26

* First version. Released on an unsuspecting world.
initial commit of WIP code 2021-04-19 18:07:52 +03:00			`# Revision history for ema`

Expand changelog 2022-06-08 19:01:51 +03:00			`## 0.8.0.0 (Unreleased)`

doc: misc 2022-06-22 17:38:56 +03:00			`This releases brings a significant rewrite of Ema. If you choose to upgrade your apps from 0.6, see https://ema.srid.ca/howto/upgrade for guidance.`
Fix a static site generation bug in Ex02_Basic.hs 2022-02-08 19:15:45 +03:00
Changelog and cabal ver 2022-04-07 19:36:09 +03:00			`- GHC 9.0 support`
Handle switching local anchors 2022-03-24 21:58:35 +03:00			`- Better handling of URL anchors (#83; #87)`
routeUrl: use direct by default 2022-06-11 19:01:42 +03:00			- `routeUrl` uses `UrlDirect` by default. Use `routeUrlWith` if you want to change that.
Vanilla CSS Status Indicator (#123) * Rewrote tailwind css as inline vanilla css * Explicitly set font-size, tab-size, line-height * Add box-sizing + adjust width/height This will subtract border and padding from the element width/height making it consistent across different resolutions. * Link to original version * Add to changelog Co-authored-by: Sridhar Ratnakumar <srid@srid.ca> 2022-07-28 19:02:35 +03:00			`- Ema status indicator now works independently (requires no Tailwind)`
docs: cleanup 0.6 docs no longer necessary 2022-06-11 23:17:24 +03:00			`- Multisite rewrite (Ema is mostly rewritten)`
Finalize the naming/types of `IsRoute` class (#119) * Rename allRoutes -> routeUniverse Because, it is consistent with routeEncoder. All types/methods are now prefixed with "route": - RouteModel - routeEncoder - routeUniverse * Drop RouteEncoder, exposing the underlying prism (albeist as Prism_ out of necessity) * rename module names as well * Even mkRoutePrism is redundant; use toPrism_ Especially it puts the model argument in the function argument itself, just like routeUniverse. * Drop applyRoutePrism (fromPrism_ is good enough) * Extract eitherPrism * Expose giso * Drop singletonRoutePrism (this is just "only" from optics-core) * Update docs 2022-07-18 19:27:07 +03:00			- Add the notion of route `Prism_` (first-class values), along with a `IsRoute` class to define them.
			`- Optional generic deriving of route prisms, so you do not have to hand-write them.`
Expand changelog 2022-06-08 19:01:51 +03:00			`- Automatic isomorphism checks ensures that encoding and decoding are isomorphic.`
			`- Composable Ema apps`
Move Multi.hs to route lib package 2022-06-28 02:35:07 +03:00			- There are two ways of composing Ema apps. Using heterogenous lists (see `Ema.Route.Lib.Multi`), or by defining a top-level route type (see `Ex04_Multi.hs`).
Expand changelog 2022-06-08 19:01:51 +03:00			- Replace `LVar` with `Dynamic`.
			- Ema still uses `LVar` internally (for live server updates), but on the user-side one only needs to provide a `Dynamic` which is a tuple of initial value and an updating function. The [unionmount](https://github.com/srid/unionmount/pull/1) library was changed to provide this tuple.
			- Add `EmaSite` typeclass to "connect them all"
			- `SiteArg`: Type of value to pass from the environment.
			- `siteInput`: Define the `Dynamic` model for the site.
			- `siteOutput`: Asset (eg: HTML) to produce for each route.
Fix a static site generation bug in Ex02_Basic.hs 2022-02-08 19:15:45 +03:00
Release 0.6; and unexpose examples 2022-02-05 20:05:54 +03:00			`## 0.6.0.0 -- 2022-02-05`
js: Add ema.switchRoute 2022-01-29 21:46:24 +03:00
			- Websocket API: Add `ema.switchRoute` to switch to other routes in live server.
Disable examples by default This, in addition previous commits, resolves #68 2022-02-05 19:08:00 +03:00			`- Smaller core: remove helpers and examples (examples can be enabled by a flag)`
			`- Helpers`
			- `Ema.Helpers.PathTree` moved to separate package pathtree.
			- `Ema.Helpers.FileSystem` moved to separate package unionmount.
			- `Ema.Helpers.Markdown` moved to separate package commonmark-simple.
			- `Ema.Helpers.Blaze` is no more. See `ema-template` if you need a ready made template using blaze HTML and TailwindCSS.
Release 0.6; and unexpose examples 2022-02-05 20:05:54 +03:00			- Examples `with-examples` cabal flag is made False by default. Examples are not exposed modules.
Ema.Route.Slug moved to hackage 2022-02-05 19:55:40 +03:00			- `Ema.Route.Slug` moved to separate package url-slug
js: Add ema.switchRoute 2022-01-29 21:46:24 +03:00
Release 0.4.0.0 2022-01-20 06:03:11 +03:00			`## 0.4.0.0 -- 2022-01-19`
Unbreak after Tailwind 3.x release 2021-12-10 02:37:17 +03:00
			`- Pin TailwindCSS to 2.x, because the 3.x broke our CDN url`
Advance nixpkgs 2021-12-19 19:23:06 +03:00			`- Remove unused Cabal deps (#61)`
layoutWith: Don't hardcode body attrs 2022-01-02 20:09:13 +03:00			- `Tailwind.layoutWith`: don't hardcode `<body>` attrs
Release 0.4.0.0 2022-01-20 06:03:11 +03:00			- Tailwind: module revamped and renamed to `Tailwind.Helper.Blaze`
Return generated files 2022-01-09 00:06:07 +03:00			- `runEma` and friends:
runEma: return dependently typed action result 2022-01-09 04:01:45 +03:00			`- return the monadic's action's return value or generated files (dependent type)`
Add run command taking --host and --port 2022-01-09 21:40:33 +03:00			- CLI: add `run` subcommand that takes `--host` and `--port` (and remove environment hacks of $HOST and $PORT)
Unbreak after Tailwind 3.x release 2021-12-10 02:37:17 +03:00
Publish 0.2 2021-11-22 02:16:03 +03:00			`## 0.2.0.0 -- 2021-11-21`
Move docs to separate repo 2021-04-27 00:42:00 +03:00
Pass cli action to model runner 2021-05-26 05:40:56 +03:00			- TODO(doc) runEma's action gets the `CLI.Action` as argument, to prevent the `gen` command from needing to monitoring files.
Re-evaluate script tags on reload (#45) 2021-06-10 04:57:30 +03:00			`- Live Server`
Avoid unnecessary DOM patch on initial page load 2021-06-18 01:04:48 +03:00			`- Avoid unncessary DOM patch on page load`
Re-evaluate script tags on reload (#45) 2021-06-10 04:57:30 +03:00			`- Handle invalid routes gracefully without breaking websocket`
			- Re-add `<script>` tags on hot reload
Don't scroll to top when hot reloading current page Fixes #43 2021-06-18 01:05:08 +03:00			`- Scroll to top on route switches`
Use secure websocket on HTTPS (#46) 2021-07-10 16:13:13 +03:00			`- Use secure websockets when on HTTPS`
Bind to loopback by default Can be overriden using $HOST Also advance nixpkgs 2021-09-06 23:40:38 +03:00			`- Bind to loopback (127.0.0.1) for security reasons`
websocket: don't handle target=_blank links For https://github.com/srid/emanote/issues/129 2021-09-26 18:52:14 +03:00			`- Do not handle target=_blank links in websocket route switch`
Docs and changelog 2021-05-22 20:06:27 +03:00			- `Asset` type
			- Introduce the `Asset` type to distinguishing between static files and generated files. The later can be one of `Html` or `Other`, allowing the live server to handle them sensibly.
			- `Ema` typeclass:
			- Drop `staticAssets` in favour of `allRoutes` (renamed from `staticRoutes`) returning all routes including both generated and static routes.
			- Drop `Slug` and use plain `FilePath`. Route encoder and decoder deal directly with the on-disk path of the generated (or static) files.
			- Make the render function (which `runEma` takes) return a `Asset LByteString` instead of `LByteString` such that it can handle all routes, and handle static files as well as generation of non-HTML content (eg: RSS)
Support static files outside source directory (#39) * Try to fix it, WIP * docsx 2021-05-26 05:50:05 +03:00			`- Allow copying static files anywhere on the filesystem`
Docs and changelog 2021-05-22 20:06:27 +03:00			- `routeUrl`:
			`- Unicode normalize as well URI encode route URLs`
			- now returns relative URLs (ie. without the leading `/`)
			- Use the `<base>` tag to specify an explicit prefix for relative URLs in generated HTML. This way hosting on GitHub Pages without CNAME will continue to have functional links.
Fix routeUrl bug in non-HTML paths encoding 2021-05-27 23:25:43 +03:00			`- Fix: prevent encoding of non-HTML paths`
Allow encodeRoute (thus routeUrl) take `model` as argument 2021-06-03 03:01:24 +03:00			- Now takes the `model` type as argument, inasmuch as `encodeRoute` takes it as as well (to accomodate scenarios where route path can only be computed depending on model state; storing slug aliases for instance)
Add routeUrlWith (#49) * Add routeUrlWith * Add FromJSON instance * docs 2021-06-28 02:11:34 +03:00			- Add `routeUrlWith` for non-pretty URLs
Unicode normalize slugs Ref: https://github.com/srid/neuron/issues/611 2021-05-07 00:58:36 +03:00			- `Ema.Slug`
slug: add aeson instances 2021-05-16 00:52:23 +03:00			- Add `Ord`, `Generic`, `Data` and Aeson instances to `Slug`
Unicode normalize slugs Ref: https://github.com/srid/neuron/issues/611 2021-05-07 00:58:36 +03:00			`- Unicode normalize slugs using NFC`
Docs and changelog 2021-05-22 20:06:27 +03:00			- Add `decodeSlug` and `encodeSlug`
			- Add default implementation based on Enum for `allRoutes`
			`- Warn, without failing, on missing static assets during static generation`
Prevent logging from slowing down static generation 2021-06-10 00:13:47 +03:00			`- Static generation`
			`- Use block buffering to prevent logging from slowing down site generation`
Write .nojekyll 2021-07-01 17:38:42 +03:00			`- Write .nojekyll`
Remove -C option 2021-06-28 18:05:48 +03:00			`- CLI`
			- Removed `-C` argument (orthogonal to Ema)
Add tree helpers 2021-05-08 15:57:20 +03:00			`- Helpers`
			`- Helpers.FileSystem`
Move filesystem code to separate library 2021-11-22 01:47:24 +03:00			- Add Union mount support; re-exported from `unionmount` library
More thorough FileAction type delineation 2021-09-12 18:42:58 +03:00			`- enrich FileAction type to distinguish between existance and new and update states`
Add tree helpers 2021-05-08 15:57:20 +03:00			`- Helpers.Tailwind`
			`- add overflow-y-scroll to body`
			`- Add twind shim before application's head`
Use latest version of tailwind CDN 2021-06-18 00:37:49 +03:00			`- CDN: Use latest version always.`
Publish 0.2 2021-11-22 02:16:03 +03:00			`- Helpers.Markdown`
Add tree helpers 2021-05-08 15:57:20 +03:00			- add helpers to parse markdown; `parseMarkdownWithFrontMatter` and `parseMarkdown`
Unicode normalize slugs Ref: https://github.com/srid/neuron/issues/611 2021-05-07 00:58:36 +03:00			`- Examples`
Adjust tutorial for new template 2021-05-19 20:20:10 +03:00			- ~~Remove Ex03_Documentation.hs (moved to separate repo, `ema-docs`)~~ Back to ./docs, but using Emanote.
Unicode normalize slugs Ref: https://github.com/srid/neuron/issues/611 2021-05-07 00:58:36 +03:00			`- Add Ex03_Basic.hs example`
Move docs to separate repo 2021-04-27 00:42:00 +03:00
Prep for hackage release 2021-04-26 21:22:49 +03:00			`## 0.1.0.0 -- 2021-04-26`
initial commit of WIP code 2021-04-19 18:07:52 +03:00
			`* First version. Released on an unsuspecting world.`