Merge pull request #34 from pacien/develop

first working prototype

18 files changed, 1187 insertions, 0 deletions

diff --git a/compiler/.gitignore b/compiler/.gitignore
new file mode 100644
index 0000000..778e7ef
--- /dev/null
+++ b/compiler/.gitignore
@@ -0,0 +1,3 @@
+.stack-work/
+ldgallery-compiler.cabal
+*~
\ No newline at end of file
diff --git a/compiler/Setup.hs b/compiler/Setup.hs
new file mode 100644
index 0000000..9a994af
--- /dev/null
+++ b/compiler/Setup.hs
@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain
diff --git a/compiler/app/Main.hs b/compiler/app/Main.hs
new file mode 100644
index 0000000..1a42abf
--- /dev/null
+++ b/compiler/app/Main.hs
@@ -0,0 +1,91 @@
+-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2019-2020  Pacien TRAN-GIRARD
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+module Main where
+
+import Paths_ldgallery_compiler (version, getDataFileName)
+import Data.Version (showVersion)
+import System.FilePath ((</>))
+import System.Console.CmdArgs
+
+import Compiler
+import Files (readDirectory, copyTo)
+
+
+data Options = Options
+  { inputDir :: String
+  , outputDir :: String
+  , rebuilAll :: Bool
+  , withViewer :: Bool
+  } deriving (Show, Data, Typeable)
+
+options :: Options
+options = Options
+  { inputDir = "./"
+      &= typDir
+      &= name "i"
+      &= name "input-dir"
+      &= explicit
+      &= help "Gallery source directory (default=./)"
+  , outputDir = "./out"
+      &= typDir
+      &= name "o"
+      &= name "output-dir"
+      &= explicit
+      &= help "Generated gallery output path (default=./out)"
+  , rebuilAll = False
+      &= name "r"
+      &= name "rebuild-all"
+      &= explicit
+      &= help "Invalidate cache and recompile everything"
+  , withViewer = False
+      &= name "w"
+      &= name "with-viewer"
+      &= explicit
+      &= help "Include the static web viewer in the output"
+  }
+
+  &= summary ("ldgallery v" ++ (showVersion version) ++ " - a static web gallery generator with tags")
+  &= program "ldgallery"
+  &= help "Compile a gallery"
+  &= helpArg [explicit, name "h", name "help"]
+  &= versionArg [explicit, name "version"]
+
+
+main :: IO ()
+main =
+  do
+    opts <- cmdArgs options
+    compileGallery (inputDir opts) (galleryOutputDir "gallery" opts) (rebuilAll opts)
+    if (withViewer opts) then copyViewer (outputDir opts) else noop
+
+  where
+    galleryOutputDir :: FilePath -> Options -> FilePath
+    galleryOutputDir gallerySubdir opts =
+      if withViewer opts then outputBase </> gallerySubdir else outputBase
+      where outputBase = outputDir opts
+
+    copyViewer :: FilePath -> IO ()
+    copyViewer target =
+      putStrLn "Copying viewer webapp"
+      >>  getDataFileName "viewer"
+      >>= readDirectory
+      >>= copyTo target
+
+    noop :: IO ()
+    noop = return ()
diff --git a/compiler/data/.gitignore b/compiler/data/.gitignore
new file mode 100644
index 0000000..dd4395c
--- /dev/null
+++ b/compiler/data/.gitignore
@@ -0,0 +1 @@
+viewer
diff --git a/compiler/data/readme.md b/compiler/data/readme.md
new file mode 100644
index 0000000..9aded74
--- /dev/null
+++ b/compiler/data/readme.md
@@ -0,0 +1 @@
+Link `../../viewer/dist` to `./viewer` for full distribution.
diff --git a/compiler/package.yaml b/compiler/package.yaml
new file mode 100644
index 0000000..043985d
--- /dev/null
+++ b/compiler/package.yaml
@@ -0,0 +1,76 @@
+name:                ldgallery-compiler
+version:             0.1.0.0
+github:              "pacien/ldgallery"
+license:             AGPL-3
+author:              "Pacien TRAN-GIRARD, Guillaume FOUET"
+maintainer:          ""
+copyright:           "2019 Pacien TRAN-GIRARD, Guillaume FOUET"
+
+extra-source-files:
+- readme.md
+
+# Metadata used when publishing your package
+synopsis:            A static generator which turns a collection of tagged pictures into a searchable web gallery
+category:            Web
+description:         Please see the README on GitHub at <https://github.com/pacien/ldgallery>
+
+dependencies:
+- base >= 4.7 && < 5
+- containers
+- filepath
+- directory
+- text
+- aeson
+- yaml
+- cmdargs
+- JuicyPixels
+- JuicyPixels-extra
+- parallel-io
+- Glob
+- safe
+- time
+
+default-extensions:
+- DuplicateRecordFields
+- DeriveGeneric
+- DeriveDataTypeable
+- DeriveAnyClass
+- FlexibleContexts
+- NamedFieldPuns
+- OverloadedStrings
+
+ghc-options:
+- -Werror
+- -Wall
+- -Wcompat
+- -Widentities
+- -Wincomplete-uni-patterns
+- -Wredundant-constraints
+
+data-dir: data
+data-files: ["**/*"]
+
+library:
+  source-dirs: src
+
+executables:
+  ldgallery-compiler-exe:
+    main:                Main.hs
+    source-dirs:         app
+    ghc-options:
+    - -threaded
+    - -rtsopts
+    - -with-rtsopts=-N
+    dependencies:
+    - ldgallery-compiler
+
+tests:
+  ldgallery-compiler-test:
+    main:                Spec.hs
+    source-dirs:         test
+    ghc-options:
+    - -threaded
+    - -rtsopts
+    - -with-rtsopts=-N
+    dependencies:
+    - ldgallery-compiler
diff --git a/compiler/readme.md b/compiler/readme.md
new file mode 100644
index 0000000..e18b026
--- /dev/null
+++ b/compiler/readme.md
@@ -0,0 +1,20 @@
+# ldgallery-compiler
+
+
+## Build
+
+Building the _ldgallery compiler_ requires the [stack] tool.
+
+[stack]: https://haskellstack.org/
+
+Within the project's directory, use
+
+* `stack setup` to setup the development environment and compiler.
+* `stack build` to compile the project.
+* or `stack build --fast --file-watch` to automatically compile on file change.
+* `stack exec ldgallery-compiler-exe -- --help` to run the compiled program (and displaying its help text for instance).
+
+
+### Embedded viewer
+
+In order to allow the `ldgallery` command line tool to generate a full gallery which includes the _viewer_, a compiled version of the web app must be placed under `./data/viewer`.  The `--with-viewer` flag will otherwise not be functional.
diff --git a/compiler/src/Compiler.hs b/compiler/src/Compiler.hs
new file mode 100644
index 0000000..a347433
--- /dev/null
+++ b/compiler/src/Compiler.hs
@@ -0,0 +1,131 @@
+-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2019-2020  Pacien TRAN-GIRARD
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,