halogen-routing

3 years ago · 2f8ad34611
--- a/halogen-routing/.gitignore
+++ b/halogen-routing/.gitignore
@@ -0,0 +1,12 @@
 /bower_components/
 /node_modules/
 /.pulp-cache/
 /output/
 /generated-docs/
 /.psc-package/
 /.psc*
 /.purs*
 /.psa*
 /.spago
 /.cache
 /dist
--- a/halogen-routing/LICENSE
+++ b/halogen-routing/LICENSE
@@ -0,0 +1,201 @@
                                Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright 2020 Ken Aguilar

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
--- a/halogen-routing/Makefile
+++ b/halogen-routing/Makefile
@@ -0,0 +1,17 @@
 build-all:
 	spago build && npm install

 build:
 	spago build

 bundle:
 	spago bundle-app --main Main --to dist/app.js && ./node_modules/.bin/parcel build html/index.html

 bundle-watch:
 	spago bundle-app --main Main --to dist/app.js --watch

 clean:
 	rm -rf .cache .spago node_modules .psci_modules output dist

 start:
 	./node_modules/.bin/http-server dist
--- a/halogen-routing/README.md
+++ b/halogen-routing/README.md
@@ -0,0 +1,27 @@
 # spago-halogen-scaffold

 ### Clone the project
 ```sh
 git clone https://taezos.org/taezos/spago-halogen-scaffold.git <your-project-name>
 ```
 Rename the following sections:
 - **package.json** - rename the `name` field to your desired project name.
 - **spago.dhall** - rename the `name` field to your desired project name.

 Build the entire project, this includes spago and npm packages.
 ```sh
 make build-all
 ```
 Build spago packages.
 ```sh
 make build
 ```
 Bundle the project
 ```sh
 make bundle
 ```
 Run the project, make sure bundle has been created.
 ```sh
 make start
 ```

--- a/halogen-routing/html/index.html
+++ b/halogen-routing/html/index.html
@@ -0,0 +1,11 @@
 <!doctype html>

 <html lang="en">
 <head>
  <meta charset="utf-8">
  <title>Halogen Basic</title>
 </head>
 <body>
  <script src="../dist/app.js"></script>
 </body>
 </html>
--- a/halogen-routing/package-lock.json
+++ b/halogen-routing/package-lock.json
--- a/halogen-routing/package.json
+++ b/halogen-routing/package.json
@@ -0,0 +1,25 @@
 {
  "name": "spago-halogen-scaffold",
  "version": "1.0.0",
  "description": "Build the scaffold ``` sh make bundle ```",
  "main": "index.js",
  "directories": {
    "test": "test"
  },
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "gitea@taezos.org:taezos/spago-halogen-scaffold.git"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "parcel-bundler": "^1.12.4"
  },
  "dependencies": {
    "http-server": "^0.12.1"
  }
 }
--- a/halogen-routing/packages.dhall
+++ b/halogen-routing/packages.dhall
@@ -0,0 +1,128 @@
 {-
 Welcome to your new Dhall package-set!

 Below are instructions for how to edit this file for most use
 cases, so that you don't need to know Dhall to use it.

 ## Warning: Don't Move This Top-Level Comment!

 Due to how `dhall format` currently works, this comment's
 instructions cannot appear near corresponding sections below
 because `dhall format` will delete the comment. However,
 it will not delete a top-level comment like this one.

 ## Use Cases

 Most will want to do one or both of these options:
 1. Override/Patch a package's dependency
 2. Add a package not already in the default package set

 This file will continue to work whether you use one or both options.
 Instructions for each option are explained below.

 ### Overriding/Patching a package

 Purpose:
 - Change a package's dependency to a newer/older release than the
    default package set's release
 - Use your own modified version of some dependency that may
    include new API, changed API, removed API by
    using your custom git repo of the library rather than
    the package set's repo

 Syntax:
 Replace the overrides' "{=}" (an empty record) with the following idea
 The "//" or "⫽" means "merge these two records and
  when they have the same value, use the one on the right:"
 -------------------------------
 let override =
  { packageName =
      upstream.packageName // { updateEntity1 = "new value", updateEntity2 = "new value" }
  , packageName =
      upstream.packageName // { version = "v4.0.0" }
  , packageName =
      upstream.packageName // { repo = "https://www.example.com/path/to/new/repo.git" }
  }
 -------------------------------

 Example:
 -------------------------------
 let overrides =
  { halogen =
      upstream.halogen // { version = "master" }
  , halogen-vdom =
      upstream.halogen-vdom // { version = "v4.0.0" }
  }
 -------------------------------

 ### Additions

 Purpose:
 - Add packages that aren't already included in the default package set

 Syntax:
 Replace the additions' "{=}" (an empty record) with the following idea:
 -------------------------------
 let additions =
  { package-name =
       { dependencies =
           [ "dependency1"
           , "dependency2"
           ]
       , repo =
           "https://example.com/path/to/git/repo.git"
       , version =
           "tag ('v4.0.0') or branch ('master')"
       }
  , package-name =
       { dependencies =
           [ "dependency1"
           , "dependency2"
           ]
       , repo =
           "https://example.com/path/to/git/repo.git"
       , version =
           "tag ('v4.0.0') or branch ('master')"
       }
  , etc.
  }
 -------------------------------

 Example:
 -------------------------------
 let additions =
  { benchotron =
      { dependencies =
          [ "arrays"
          , "exists"
          , "profunctor"
          , "strings"
          , "quickcheck"
          , "lcg"
          , "transformers"
          , "foldable-traversable"
          , "exceptions"
          , "node-fs"
          , "node-buffer"
          , "node-readline"
          , "datetime"
          , "now"
          ]
      , repo =
          "https://github.com/hdgarrood/purescript-benchotron.git"
      , version =
          "v7.0.0"
      }
  }
 -------------------------------
 -}


 let upstream =
      https://github.com/purescript/package-sets/releases/download/psc-0.13.6-20200226/packages.dhall sha256:3a52562e05b31a7b51d12d5b228ccbe567c527781a88e9028ab42374ab55c0f1

 let overrides = {=}

 let additions = {=}

 in  upstream // overrides // additions
--- a/halogen-routing/spago.dhall
+++ b/halogen-routing/spago.dhall
@@ -0,0 +1,16 @@
 {-
 Welcome to a Spago project!
 You can edit this file as you like.
 -}
 { name = "my-project"
 , dependencies =
    [ "console"
    , "effect"
    , "halogen"
    , "psci-support"
    , "routing"
    , "routing-duplex"
    ]
 , packages = ./packages.dhall
 , sources = [ "src/**/*.purs", "test/**/*.purs" ]
 }
--- a/halogen-routing/src/AppM.purs
+++ b/halogen-routing/src/AppM.purs
@@ -0,0 +1,29 @@
 module AppM where

 import Prelude
 -- Internal Service
 import Service.Navigate
 import Service.Route
 -- Effect
 import Effect.Class ( class MonadEffect, liftEffect )
 -- Aff
 import Effect.Aff ( Aff )
 import Effect.Aff.Class ( class MonadAff )
 -- Routing
 import Routing.Hash ( setHash )
 import Routing.Duplex ( print )
 newtype AppM a = AppM ( Aff a )

 runAppM :: AppM ~> Aff
 runAppM ( AppM m ) = m

 derive newtype instance functorAppM :: Functor AppM
 derive newtype instance applyAppM :: Apply AppM
 derive newtype instance applicativeAppM :: Applicative AppM
 derive newtype instance bindAppM :: Bind AppM
 derive newtype instance monadAppM :: Monad AppM
 derive newtype instance monadEffectAppM :: MonadEffect AppM
 derive newtype instance monadAffAppM :: MonadAff AppM

 instance navigateAppM :: Navigate AppM where
  navigate = liftEffect <<< setHash <<< print routeCodec
--- a/halogen-routing/src/Component/Router.purs
+++ b/halogen-routing/src/Component/Router.purs
@@ -0,0 +1,107 @@
 module Component.Router where

 import Prelude
 import Data.Maybe ( Maybe(..), fromMaybe )
 import Data.Either ( hush )
 -- Internal Page
 import Page.Home as Home
 import Page.About as About
 -- Internal Service
 import Service.Route
 import Service.Navigate
 -- Web
 import Web.Event.Event ( preventDefault )
 import Web.UIEvent.MouseEvent ( toEvent, MouseEvent )
 -- Effect
 import Effect.Class ( class MonadEffect, liftEffect )
 -- Routing
 import Routing.Duplex
 import Routing.Hash
 -- Halogen
 import Halogen as H
 import Halogen.HTML as HH
 import Halogen.HTML.Properties as HP
 import Halogen.HTML.Events as HE

 type State =
  { route :: Maybe Route
  }

 data Query a = Navigate Route a

 data Action
  = Initialize
  | GoTo Route MouseEvent

 type ChildSlots =
  ( home :: Home.Slot Unit
  , about :: About.Slot Unit
  )

 component
  :: forall i o m
  . MonadEffect m
  => Navigate m
  => H.Component HH.HTML Query i o m
 component =
  H.mkComponent
  { initialState: const { route: Nothing }
  , render
  , eval: H.mkEval $ H.defaultEval
    { handleAction = handleAction
    , handleQuery = handleQuery
    , initialize = Just Initialize
    }
  }

 render :: forall m. State -> H.ComponentHTML Action ChildSlots m
 render st = navbar $ case st.route of
  Nothing -> HH.h1_ [ HH.text "Oh no! That page wasn't found" ]
  Just route -> case route of
    Home -> HH.slot Home._home unit Home.component unit absurd
    About -> HH.slot About._about unit About.component unit absurd

 handleAction
  :: forall o m
  . MonadEffect m
  => Navigate m
  => Action
  -> H.HalogenM State Action ChildSlots o m Unit
 handleAction = case _ of
  Initialize -> do
    initialRoute <- hush <<< ( parse routeCodec ) <$> H.liftEffect getHash
    navigate $ fromMaybe Home initialRoute
  GoTo route e -> do
    liftEffect $ preventDefault ( toEvent e )
    mRoute <- H.gets _.route
    when ( mRoute /= Just route ) $ navigate route

 handleQuery :: forall a o m. Query a -> H.HalogenM State Action ChildSlots o m ( Maybe a )
 handleQuery = case _ of
  Navigate route a -> do
    mRoute <- H.gets _.route
    when ( mRoute /= Just route ) $
      H.modify_ _ { route = Just route }
    pure ( Just a )

 navbar :: forall a . HH.HTML a Action -> HH.HTML a Action
 navbar html =
  HH.div_
  [ HH.ul_
    [ HH.li_
      [ HH.a
        [ HP.href "#"
        , HE.onClick ( Just <<< GoTo Home )
        ]
        [ HH.text "Home" ]
      ]
    , HH.li_
      [ HH.a
        [ HP.href "#"
        , HE.onClick ( Just <<< GoTo About )
        ]
        [ HH.text "About" ]
      ]
    ]
  , html
  ]
--- a/halogen-routing/src/Main.purs
+++ b/halogen-routing/src/Main.purs
@@ -0,0 +1,37 @@
 module Main where

 import Prelude
 import Data.Maybe ( Maybe(..) )
 -- Internal
 import AppM ( runAppM )
 -- Internal Components
 import Component.Router as Router
 -- Internal Service
 import Service.Route
 -- Effect
 import Effect ( Effect )
 import Effect.Class ( liftEffect )
 -- Aff
 import Effect.Aff ( Aff, launchAff_ )
 -- Routing
 import Routing.Duplex ( parse )
 import Routing.Hash ( matchesWith )
 -- Halogen
 import Halogen as H
 import Halogen.HTML as HH
 import Halogen.Aff as HA
 import Halogen.VDom.Driver ( runUI )

 main :: Effect Unit
 main = HA.runHalogenAff do
  body <- HA.awaitBody
  let
    rootComponent :: H.Component HH.HTML Router.Query {} Void Aff
    rootComponent = H.hoist runAppM Router.component

  halogenIO <- runUI rootComponent {} body

  void $ liftEffect $ matchesWith ( parse routeCodec ) \mOld new ->
    when ( mOld /= Just new ) do
      launchAff_ $ halogenIO.query $ H.tell $ Router.Navigate new
  pure unit
--- a/halogen-routing/src/Page/About.purs
+++ b/halogen-routing/src/Page/About.purs
@@ -0,0 +1,23 @@
 module Page.About where

 import Prelude
 import Data.Symbol ( SProxy(..) )
 -- Halogen
 import Halogen as H
 import Halogen.HTML as HH

 type Slot p = forall query. H.Slot query Void p

 _about :: SProxy "about"
 _about = SProxy

 component :: forall q i o m. H.Component HH.HTML q i o m
 component =
  H.mkComponent
  { initialState: identity
  , render
  , eval: H.mkEval H.defaultEval
  }

 render :: forall state action m. state -> H.ComponentHTML action () m
 render _ = HH.h1_ [ HH.text "About Page" ]
--- a/halogen-routing/src/Page/Home.purs
+++ b/halogen-routing/src/Page/Home.purs
@@ -0,0 +1,23 @@
 module Page.Home where

 import Prelude
 import Data.Symbol ( SProxy(..) )
 -- Halogen
 import Halogen as H
 import Halogen.HTML as HH

 type Slot p = forall query. H.Slot query Void p

 _home :: SProxy "home"
 _home = SProxy

 component :: forall q i o m. H.Component HH.HTML q i o m
 component =
  H.mkComponent
  { initialState: identity
  , render
  , eval: H.mkEval H.defaultEval
  }

 render :: forall state action m. state -> H.ComponentHTML action () m
 render _ = HH.h1_ [ HH.text "Home Page" ]
--- a/halogen-routing/src/Service/Navigate.purs
+++ b/halogen-routing/src/Service/Navigate.purs
@@ -0,0 +1,14 @@
 module Service.Navigate where

 import Prelude

 -- Internal Route
 import Service.Route
 -- Halogen
 import Halogen

 class Monad m <= Navigate m where
  navigate :: Route -> m Unit

 instance navigateHalogenM :: Navigate m => Navigate ( HalogenM state action slots msg m ) where
  navigate = lift <<< navigate
--- a/halogen-routing/src/Service/Route.purs
+++ b/halogen-routing/src/Service/Route.purs
@@ -0,0 +1,26 @@
 module Service.Route where

 import Prelude
 import Data.Generic.Rep ( class Generic )
 import Data.Generic.Rep.Show ( genericShow )
 -- Routing
 import Routing.Duplex ( RouteDuplex', root )
 import Routing.Duplex.Generic ( noArgs, sum )
 import Routing.Duplex.Generic.Syntax ((/))

 data Route
  = Home
  | About

 derive instance genericRoute :: Generic Route _
 derive instance eqRoute :: Eq Route
 derive instance ordRoute :: Ord Route

 instance showRoute :: Show Route where
  show = genericShow

 routeCodec :: RouteDuplex' Route
 routeCodec = root $ sum
  { "Home": noArgs
  , "About": "about" / noArgs
  }
--- a/halogen-routing/test/Main.purs
+++ b/halogen-routing/test/Main.purs
@@ -0,0 +1,11 @@
 module Test.Main where

 import Prelude

 import Effect (Effect)
 import Effect.Class.Console (log)

 main :: Effect Unit
 main = do
  log "🍝"
  log "You should add some tests."