diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,5 @@ +# Revision history for heckle + +## 0.1.0.0 -- YYYY-mm-dd + +* First version. Released on an unsuspecting world. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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 [yyyy] [name of copyright owner] + + 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. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/heckle.cabal b/heckle.cabal new file mode 100644 --- /dev/null +++ b/heckle.cabal @@ -0,0 +1,38 @@ +-- Initial heckle.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/ + +name: heckle +version: 0.1.0.0 +synopsis: Jekyll in Haskell +description: Lightweight static site compiler for markdown posts +license: Apache-2.0 +license-file: LICENSE +author: Rushi Shah + +maintainer: 2016rshah@gmail.com + +-- copyright: +category: Web +build-type: Simple +extra-source-files: ChangeLog.md +cabal-version: >=1.10 + +executable heckle + main-is: Main.hs + other-modules: Heckle + -- other-extensions: + build-depends: base <=4.8.0 + , blaze-html >= 0.8.1.1 + , containers >= 0.5.5.1 + , directory >=1.2 && <1.3 + , pandoc >= 1.17.0.3 + , pandoc-types >= 1.16.1 + , process >= 1.2.0.0 + , split >=0.2 && <0.3 + , tagsoup >= 0.13.10 + hs-source-dirs: src + default-language: Haskell2010 + +source-repository head + type: git + location: https://github.com/2016rshah/heckle.git diff --git a/src/Heckle.hs b/src/Heckle.hs new file mode 100644 --- /dev/null +++ b/src/Heckle.hs @@ -0,0 +1,78 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE FlexibleInstances #-} + +module Heckle where + +--Blaze HTML +import Text.Blaze.Html5 as H hiding (main, map) +import Text.Blaze.Html5.Attributes as A +import Text.Blaze.Html.Renderer.Pretty + +--Pandoc +import Text.Pandoc.Options +import Text.Pandoc.Readers.Markdown +import Text.Pandoc.Definition +import Text.Pandoc.Writers.HTML + +--TagSoup +import Text.HTML.TagSoup + +--Other +import Data.List.Split +import Control.Applicative +import Data.Map.Lazy as Map (lookup) +import Control.Monad + +data Post = Post { + filename :: String + , pd :: Pandoc + , postTitle :: String + , postDate :: String + } + deriving (Eq, Show) + +getMD :: FilePath -> Either String String +getMD s = case splitOn "." s of + [fn, "md"] -> Right fn + _ -> Left "Not a PDF file" + +getMeta :: (Meta -> [Inline]) -> Pandoc -> Either String String +getMeta f (Pandoc m _) = case f m of + [] -> Left "Couldn't find it" + ((Str s):xs) -> Right s + (_:xs) -> Left "Not a string??" + +createPost :: Show a => String -> Either a Pandoc -> Either String Post +createPost _ (Left e) = Left (show e) +createPost fn (Right pd) = + Post <$> pure fn <*> pure pd <*> getMeta docTitle pd <*> getMeta docDate pd + +filenameToPost :: String -> IO (Either String Post) +filenameToPost fn = do + native <- fmap (readMarkdown def) (readFile ("posts/" ++ fn ++ ".md")) + return (createPost fn native) + +writeHTML :: Post -> IO () +writeHTML p = do + let html = writeHtmlString def (pd p) + writeFile ("posts/" ++ (filename p) ++ ".html") html + +postsToHtml :: [Post] -> Html +postsToHtml xs = do + ul ! A.id "blog-posts" $ + forM_ xs h + where + h s = li ! class_ "blog-post" $ do + a ! class_ "post-link" ! href (stringValue ("posts/"++filename s++".html")) $ toHtml (postTitle s) + H.div ! class_ "post-date" $ toHtml (postDate s) + +injectPosts :: String -> Html -> Either String String +injectPosts layout ul = case splitFile of + [beginning, end] -> Right (renderTags (beginning ++ parseTags (show ul) ++ end)) + _ -> Left "Broken layout file" + where + splitFile = splitOn [(TagOpen "ul" [("id","blog-posts")]), (TagClose "ul")] (parseTags layout) + +instance Show Html where + show = renderHtml diff --git a/src/Main.hs b/src/Main.hs new file mode 100644 --- /dev/null +++ b/src/Main.hs @@ -0,0 +1,55 @@ +module Main where + +import System.Directory +import Data.Either +import Data.List +import System.Environment (getArgs) +import System.Process (readProcess) +import Heckle + +main = do + args <- getArgs + case args of + ["build"] -> do + putStrLn "Building" + ----get all md files from directory + putStrLn "Getting directory contents" + fileNames <- fmap (rights . map getMD) (getDirectoryContents "posts") + + --turn the list of files into a list of posts + putStrLn "Turning directory contents into posts" + postsToBeCreated <- (mapM filenameToPost fileNames) + --print postsToBeCreated + --postsToBeCreated <- (mapM fileNameToPost fileNames) + let posts = (reverse . rights) postsToBeCreated -- need to sort here when you add in support for dates + let brokenPosts = lefts postsToBeCreated + if length (brokenPosts) > 1 + then print brokenPosts + else putStrLn "All posts are well formed" + --print posts + + --convert posts to their html + mapM_ writeHTML posts + + --generate a ul from the list of posts + putStrLn "Turning posts into an HTML element" + let generatedHtml = postsToHtml posts + print generatedHtml + + --read the layout file + putStrLn "Reading the layout file" + layoutFile <- readFile "index.html.hkl" + + --put the ul into the layout file + putStrLn "Inserting HTML element into layout file" + let injectedOutput = layoutFile `injectPosts` generatedHtml + case injectedOutput of + (Left e) -> putStrLn e + (Right s) -> do + --put the results into the index.html file + putStrLn "Writing resulting file into index.html" + writeFile "index.html" s + putStrLn "Success building!" + + _ -> print "That's not a valid command" +