Merge pull request jeffreyrosenbluth#6 from jeffreyrosenbluth/new

Drop lucid dependency

Author: jeffreyrosenbluth

.gitignore

@@ -0,0 +1,29 @@
+# Example executables
+examples/Explode
+examples/LineStyles
+examples/Pentaflake
+examples/AttrTest
+examples/FillRule
+examples/Temp
+examples/Opacity
+examples/Clipping
+examples/Text
+examples/TextScaling
+examples/TextSize
+# This is just used as scratch space
+examples/Temp.hs
+
+dist
+cabal-dev
+*.o
+*.hi
+*.chi
+*.chs.h
+.virthualenv
+*~
+.hsenv_*
+dist_*
+history
+TAGS
+.cabal-sandbox
+cabal.sandbox.config

README.md

@@ -1,25 +1,25 @@
 lucid-svg [![Hackage](https://img.shields.io/hackage/v/lucid-svg.svg?style=flat)](https://hackage.haskell.org/package/lucid-svg)
 =========
-Simple DSL for writing SVG, based on lucid
+Simple DSL for writing SVG, in the spirit of lucid.
 
 ## Example
 
 ``` haskell
 {-# LANGUAGE OverloadedStrings #-}
 
 import Lucid.Svg
- 
-svg :: Svg () -> Svg ()
-svg content = do
-  doctype_
-  with (svg11_ content) [width_ "300" , height_ "200"]
 
-contents :: Svg ()
-contents = do
-  rect_   [width_ "100%", height_ "100%", fill_ "red"]
-  circle_ [cx_ "150", cy_ "100", r_ "80", fill_ "green"]
-  text_   [x_ "150", y_ "125", font_size_ "60", text_anchor_ "middle", fill_ "white"] "SVG"
+svg :: Element -> Element
+svg content =
+     doctype
+  <> with (svg11_ content) [Version_ <<- "1.1", Width_ <<- "300", Height_ <<- "200"]
 
+contents :: Element
+contents =
+     rect_   [ Width_ <<- "100%", Height_ <<- "100%", "red" ->> Fill_]
+  <> circle_ [ Cx_ <<- "150", Cy_ <<- "100", R_ <<- "80", Fill_ <<- "green"]
+  <> text_   [ X_ <<- "150", Y_ <<- "125", Font_size_ <<- "60"
+             , Text_anchor_ <<- "middle", Fill_ <<- "white"] "SVG"
 
 main :: IO ()
 main = do

examples/path.hs

@@ -2,19 +2,20 @@
 
 import Lucid.Svg
 import Data.Monoid
+import Data.Text.Lazy as T
 
-svg :: Svg () -> Svg ()
-svg content = do
-  doctype_
-  with (svg11_ content) [width_ "325" , height_ "325"]
+svg :: Element -> Element
+svg content =
+      doctype
+   <> with (svg11_ content) [Width_ <<- "325", Height_ <<- "325"]
 
-contents :: Svg ()
-contents = do
-  path_ (
-    [ d_ (mA 10 80 <> qA 52.5 10 95 80 <> tA 180 80 <> z)
-    , stroke_ "blue"
-    , fill_ "orange"
-    ])
+contents :: Element
+contents =
+  path_
+    [ D_ <<- (mA 10 80 <> qA 52.5 10 95 80 <> tA 180 80 <> z)
+    , Stroke_ <<- "blue"
+    , Fill_ <<- "orange"
+    ]
 
 main :: IO ()
 main = do

examples/simple.hs

@@ -2,17 +2,17 @@
 
 import Lucid.Svg
 
-svg :: Svg () -> Svg ()
-svg content = do
-  doctype_
-  with (svg11_ content) [version_ "1.1", width_ "300" , height_ "200"]
-
-contents :: Svg ()
-contents = do
-  rect_   [width_ "100%", height_ "100%", fill_ "red"]
-  circle_ [cx_ "150", cy_ "100", r_ "80", fill_ "green"]
-  text_   [x_ "150", y_ "125", font_size_ "60", text_anchor_ "middle", fill_ "white"] "SVG"
+svg :: Element -> Element
+svg content =
+     doctype
+  <> with (svg11_ content) [Version_ <<- "1.1", Width_ <<- "300", Height_ <<- "200"]
 
+contents :: Element
+contents =
+     rect_   [ Width_ <<- "100%", Height_ <<- "100%", "red" ->> Fill_]
+  <> circle_ [ Cx_ <<- "150", Cy_ <<- "100", R_ <<- "80", Fill_ <<- "green"]
+  <> text_   [ X_ <<- "150", Y_ <<- "125", Font_size_ <<- "60"
+             , Text_anchor_ <<- "middle", Fill_ <<- "white"] "SVG"
 
 main :: IO ()
 main = do

lucid-svg.cabal

@@ -1,7 +1,7 @@
 name:                lucid-svg
-version:             0.6.0.0
-synopsis:            DSL for SVG using lucid for HTML
-description:         Easy to write SVG in the syle of lucid.
+version:             0.7.0.0
+synopsis:            DSL for composing SVG.
+description:         Easy to write SVG.
 homepage:            http://github.com/jeffreyrosenbluth/lucid-svg.git
 license:             BSD3
 license-file:        LICENSE
@@ -16,13 +16,15 @@ cabal-version:       >=1.10
 library
   ghc-options:         -Wall -rtsopts -O2
   exposed-modules:     Lucid.Svg,
+                       Lucid.Svg.Core,
                        Lucid.Svg.Path,
                        Lucid.Svg.Elements,
                        Lucid.Svg.Attributes
-  build-depends:       base          >= 4.5   && < 4.10,
-                       blaze-builder >= 0.2   && < 0.5,
-                       transformers  >= 0.2   && < 0.6,
-                       text          >= 0.11  && < 1.3,
-                       lucid         >= 2.9.2 && < 3.0
+  build-depends:       base                  >= 4.5   && < 4.10,
+                       blaze-builder         >= 0.4   && < 0.5,
+                       bytestring            >= 0.10  && < 0.11,
+                       hashable             >= 1.1   && < 1.3,
+                       text                  >= 0.11  && < 1.3,
+                       unordered-containers  >= 0.2 && < 0.2.7
   hs-source-dirs:      src
   default-language:    Haskell2010

src/Lucid/Svg.hs

@@ -15,55 +15,33 @@
 module Lucid.Svg
   ( -- * Intro
     -- $intro
-    -- * Types
-    Svg
-    -- * Rendering
-  , prettyText
     -- * Re-exports
+    module Lucid.Svg.Core
   , module Lucid.Svg.Path
   , module Lucid.Svg.Elements
   , module Lucid.Svg.Attributes
-    -- * From Lucid.Base
-  , renderText
-  , renderBS
-  , renderTextT
-  , renderBST
-  , renderToFile
-    -- ** Running
-    -- $running
-  , execHtmlT
-  , evalHtmlT
-  , runHtmlT
-    -- ** Types
-  , Attribute(..)
-    -- ** Classes
-    -- $overloaded
-  , Term(..)
-  , ToHtml(..)
-  , With(..)
+  , (<>)
+  -- * Rendering
+  , prettyText
   ) where
 
 import           Data.Functor.Identity
 import           Data.Int               (Int64)
 import           Data.Monoid
-import           Data.Text.Lazy
 import           Data.Text.Lazy         as LT
 import           Data.Text.Lazy.Builder as B
-import           Lucid.Base
-import qualified Lucid.Svg.Attributes   as A
-import           Lucid.Svg.Attributes   hiding (cursor_, filter_, path_, style_)
+import           Lucid.Svg.Core
+import           Lucid.Svg.Attributes
 import           Lucid.Svg.Elements
 import           Lucid.Svg.Path
 
-type Svg = SvgT Identity
-
-prettyText :: Svg a -> Text
+prettyText :: Element -> Text
 prettyText svg = B.toLazyText $ LT.foldr go mempty text Nothing (-1)
-  where 
+  where
     text = renderText svg
-    go c f Nothing n 
+    go c f Nothing n
       | c == '<' || c == '/' = f (Just c) n
-    go c f (Just '<') n 
+    go c f (Just '<') n
       | c == '?' = "<?" <> f Nothing n
       | c == '!' = "<!" <> f Nothing n
       | c == '/' = "\n"
@@ -78,81 +56,63 @@ prettyText svg = B.toLazyText $ LT.foldr go mempty text Nothing (-1)
     go '>' f (Just _) n = "/>" <> f Nothing (n-1)
     go c f s n =  s' <> B.singleton c <> f Nothing n
       where  s' = maybe mempty B.singleton s
-    
+
 -- $intro
 --
--- SVG elements and attributes in Lucid-Svg are written with a postfix ‘@_@’. 
+-- SVG elements in Lucid-Svg are written with a postfix ‘@_@’.
 -- Some examples:
 --
 -- 'path_', 'circle_', 'color_', 'scale_'
 --
--- Note: If you're testing in the REPL you need to add a type annotation to
--- indicate that you want SVG. In normal code your top-level
--- declaration signatures handle that.
---
--- Plain text is written using the @OverloadedStrings@ and
--- @ExtendedDefaultRules@ extensions, and is automatically escaped: 
+-- Plain text is written using the @OverloadedStrings@
+-- extension, and is automatically escaped:
 --
--- As in Lucid, elements nest by function application:
+-- As in Lucid, elements nest by function application (unlike Lucid, there
+-- is no Monad instance for 'Element's and an 'Attribute' list is always required):
 --
--- >>> g_ (text_ "Hello SVG") :: Svg ()
+-- >>> g_ [] (text_ [] "Hello SVG")
 -- <g><text>Hello SVG</text></g>
 --
--- and elements are juxtaposed via monoidal append or monadic sequencing:
+-- and elements are juxtaposed via monoidal append:
 --
--- >>> text_ "Hello" <> text_ "SVG" :: Svg ()
+-- >>> text_ [] "Hello" <> text_ [] "SVG"
 -- <text>Hello</text><text>SVG</text>
 --
--- >>> do text_ "Hello"; text_ "SVG" :: Svg ()
--- <text>Hello</text><text>SVG</text>
+-- Attributes are set by providing an argument list. Each argument is set
+-- using the 'bindAttr' function or operators, '<<-' and '->>'.
 --
--- Attributes are set by providing an argument list. In contrast to HTML
--- many SVG elements have no content, only attributes.
---
--- >>> rect_ [width_ "100%", height_ "100%", fill_ "red"] :: Svg ()
+-- >>> rect_ [Width_  <<- "100%", Height_  <<- "100%", "red" ->> Fill_] nil
 -- <rect height="100%" width="100%" fill="red"></rect>
 --
--- Attributes and elements that share the same name are not conflicting
--- unless they appear on the list in the note below:
---
--- >>> mask_ [mask_ "attribute"] "element" :: Svg ()
--- <mask mask="attribute">element</mask>
---
--- Note: The following element and attribute names overlap and cannot be
--- handled polymorphically since doing so would create conflicting functional
--- dependencies. The unqualifed name refers to the element.
--- We qualify the attribute name as @A@. For example, 'path_' and 'A.path_'.
---            
--- 'colorProfile_', 'cursor_', 'filter_', 'path_', and 'style_'
---
 -- Path data can be constructed using the functions in 'Lucid.Svg.Path'
 -- and combined monoidally:
 --
 -- @
--- path_ (
---   [ d_ (mA 10 80 <> qA 52.5 10 95 80 <> tA 180 80 <> z)
---   , stroke_ "blue"
---   , fill_ "orange"
---   ])
+-- path_
+--   [ D  <<- (mA 10 80 <> qA 52.5 10 95 80 <> tA 180 80 <> z)
+--   , Stroke_  <<- "blue"
+--   , Fill_  <<- "orange"
+--   ]
 -- @
--- > <path d="M 10,80 Q 52.5,10 95,80 T 180,80 Z" stroke="blue" fill="orange"></path>
+-- > <path d="M 10,80 Q 52.5,10 95,80 T 180,80 Z" stroke="blue" fill="orange"/>
 --
 -- __A slightly longer example__:
---  
+--
 -- > import Lucid.Svg
--- > 
--- > svg :: Svg () -> Svg ()
--- > svg content = do
--- >   doctype_
--- >   with (svg11_ content) [version_ "1.1", width_ "300" , height_ "200"]
--- > 
--- > contents :: Svg ()
--- > contents = do
--- >   rect_ [width_ "100%", height_ "100%", fill_ "red"]
--- >   circle_ [cx_ "150", cy_ "100", r_ "80", fill_ "green"]
--- >   text_ [x_ "150", y_ "125", fontSize_ "60", textAnchor_ "middle", fill_ "white"] "SVG"
--- > 
--- > 
+-- >
+-- > svg :: Element -> Element
+-- > svg content =
+-- >      doctype
+-- >   <> with (svg11_ content) [Version_ <<- "1.1", Width_ <<- "300" , Height_ <<- "200"]
+-- >
+-- > contents :: Element
+-- > contents =
+-- >      rect_ [Width_  <<- "100%", Height_  <<- "100%", Fill_  <<- "red"]
+-- >   <> circle_ [Cx_  <<- "150", Cy_  <<- "100", R_  <<- "80", Fill_  <<- "green"]
+-- >   <> text_ [ X_  <<- "150", Y_  <<- "125", FontSize_  <<- "60"
+-- >            , TextAnchor_  <<- "middle", Fill_  <<- "white" ] "SVG"
+-- >
+-- >
 -- > main :: IO ()
 -- > main = do
 -- >   print $ svg contents