Rename and tidy up

Author: Daniel Harvey

README.md

@@ -10,10 +10,11 @@ Broadly, yes. Whether it's performant or not is yet to be seen.
 
 ### Can I try it?
 
-Uhh. Sure.
+Uhh. Sure. To see a somewhat terrible looking proof of concept, crack open the
+following incantations:
 
 `git clone https://github.com/danieljharvey/purescript-stylesheet`
 
 `spago install`
 
-`yarn start` and then `open index.html`. Joy!
+`yarn build` and then `open index.html`. Joy!

package.json

@@ -7,8 +7,8 @@
   "license": "MIT",
   "scripts": {
     "pscid:build": "spago build",
-    "build:test": "spago bundle-app --main Testing --to index.js",
-    "build:test:watch": "spago bundle-app --main Testing -w --to index.js"
+    "build": "spago bundle-app --main Testing --to index.js",
+    "build:watch": "spago bundle-app --main Testing -w --to index.js"
   },
   "dependencies": {
     "purescript": "^0.13.2"

src/Main.purs

@@ -1,11 +1,13 @@
-module PursUI (module Types, module Internal) where
+module Stylesheet (module Types, module Internal) where
 
-import PursUI.Types.Primitives (CSSSelector(..), CSSText(..), InsertMediaRule(..), InsertRule(..), MediaQueryText(..), StyleSheetId(..), UnpackedMediaRule, UnpackedRule) as Types
-import PursUI.Types.VirtualStyleSheet (VirtualStyleSheet(..), getStyleSheetId) as Types
-import PursUI.Types.PursUI (PursUI, createBlankStyleSheet, getCSSStyleSheet, readVirtualStyleSheet) as Types
-import PursUI.Types.CSSRuleSet (CSSRule(..), CSSRuleSet(..), Props, fun, makeStyle, media, str, testProps) as Types
-import PursUI.Types.StyleRuleSet (ClassRule(..), MediaRule(..), RuleType(..), StyleRuleSet(..), classRule, mediaRule, wrapInRuleSet) as Types
+import Stylesheet.Types.Primitives (CSSSelector(..), CSSText(..),
+InsertMediaRule(..), InsertRule(..), MediaQueryText(..), StylesheetId(..), UnpackedMediaRule, UnpackedRule) as Types
+import Stylesheet.Types.VirtualStylesheet (VirtualStylesheet(..), getStylesheetId) as Types
+import Stylesheet.Types.Stylesheet (Stylesheet(..), createBlankStylesheet,
+getCSSStylesheet, readVirtualStylesheet) as Types
+import Stylesheet.Types.CSSRuleSet (CSSRule(..), CSSRuleSet(..), fun, media, str) as Types
+import Stylesheet.Types.StyleRuleSet (ClassRule(..), MediaRule(..), RuleType(..), StyleRuleSet(..), classRule, mediaRule, wrapInRuleSet) as Types
 
-import PursUI.DomActions (createAndReturnCSSMediaRule, createStyleTag, findMediaQueryByQuery, findRuleBySelector, getFilteredRuleList, getMediaRuleMediaText, getStyleRuleDeclarationText, getStyleRuleSelectorText, getUnpackedMediaRules, getUnpackedStyleRules, insertRecursive, insertRule, unpackMediaRule, unpackRule) as Internal
-import PursUI.StyleLens (createHashedInsertRule, getClasses, keep, processStyle) as Internal 
-import PursUI.AddStyle (addStyle) as Internal
+import Stylesheet.Internal.DomActions (createAndReturnCSSMediaRule, createStyleTag, findMediaQueryByQuery, findRuleBySelector, getFilteredRuleList, getMediaRuleMediaText, getStyleRuleDeclarationText, getStyleRuleSelectorText, getUnpackedMediaRules, getUnpackedStyleRules, insertRecursive, insertRule, unpackMediaRule, unpackRule) as Internal
+import Stylesheet.Internal.ProcessStyles (createHashedInsertRule, getClasses, keep, processStyle) as Internal 
+import Stylesheet.Internal.AddStyle (addStyle) as Internal

src/PursUI/AddStyle.purs

@@ -0,0 +1,30 @@
+module Stylesheet.Internal.AddStyle where
+
+import Prelude (discard, pure)
+import Effect (Effect)
+import Data.Foldable (foldMap)
+
+import Stylesheet.Types.Stylesheet (Stylesheet(..), addVirtualStylesheet)
+import Stylesheet.Types.CSSRuleSet (CSSRuleSet)
+import Stylesheet.Types.Primitives (CSSSelector)
+import Stylesheet.Types.VirtualStylesheet
+
+import Stylesheet.Internal.ProcessStyles (getClasses, keep, processStyle) 
+
+-- | This is the top level big dog of a function, as such
+-- | We provide the big Stylesheet doing-things-lump
+-- | a function from props -> Styles
+-- | some props
+-- | and we get back a bunch of CSSSelectors (classes)
+addStyle 
+  :: forall p props
+   . Stylesheet p
+  -> CSSRuleSet props
+  -> props
+  -> Effect (Array CSSSelector)
+addStyle stylesheet styleRule props = do
+  let rules = keep (processStyle styleRule props)
+      virtualStylesheet = foldMap (fromItem) rules
+      classes = foldMap (getClasses) rules 
+  addVirtualStylesheet stylesheet virtualStylesheet 
+  pure classes 

src/PursUI/Types/CSSRuleSet.purs

@@ -1,20 +1,20 @@
-module PursUI.DomActions where
+module Stylesheet.Internal.DomActions where
 
 import Prelude
 import Data.Maybe (Maybe(..))
 import Data.Traversable (find, traverse, traverse_)
 import Effect (Effect)
 import Effect.Uncurried (runEffectFn1)
-import PursUI.Types.Primitives (CSSSelector(..), CSSText(..), InsertMediaRule(..), InsertRule(..), MediaQueryText(..), StyleSheetId(..), UnpackedMediaRule, UnpackedRule)
+import Stylesheet.Types.Primitives 
 import CSSOM.Main (class HasRuleList, CSSMediaRule, CSSRuleList, CSSRules, CSSStyleRule, CSSStyleSheet, IndexedRule, createStyleTagJS, deleteRule', getFilteredRuleListJS, getMediaRuleMediaTextJS, getRuleList', getStyleRuleDeclarationTextJS, getStyleRuleSelectorTextJS, insertRule')
 
 -- this takes all the raw calls and builds up a few actually useful functions
 -- for CSSOM manipulation
 
 createStyleTag
-  :: StyleSheetId
+  :: StylesheetId
   -> Effect CSSStyleSheet
-createStyleTag (StyleSheetId s)
+createStyleTag (StylesheetId s)
   = runEffectFn1 createStyleTagJS s
 
 -- | Get all the rules of a stylesheet, split by type

src/PursUI/Types/PursUI.purs

@@ -1,9 +1,9 @@
-module PursUI.StyleLens where
+module Stylesheet.Internal.ProcessStyles where
 
 import Prelude (flap, map, pure, show, ($), (<<<), (<>))
-import PursUI.Types.CSSRuleSet (CSSRule(..), CSSRuleSet(..))
-import PursUI.Types.StyleRuleSet
-import PursUI.Types.Primitives (CSSSelector(..), CSSText, InsertMediaRule(..), InsertRule(..))
+import Stylesheet.Types.CSSRuleSet (CSSRule(..), CSSRuleSet(..))
+import Stylesheet.Types.StyleRuleSet
+import Stylesheet.Types.Primitives (CSSSelector(..), CSSText, InsertMediaRule(..), InsertRule(..))
 import Data.Array (concatMap)
 import Data.Foldable (foldr)
 import Data.Hashable (hash)
@@ -26,9 +26,7 @@ processStyle ruleSet props
           Lens f          -> classRule (f props')
           MediaQuery s as -> mediaRule s (process as)
 
--- for now we'll discard media query ones
--- and just output the basic bullshit
-
+-- | This creates a unique hash of the CSS that we'll use to make the classname
 createHashedInsertRule :: CSSText -> InsertRule
 createHashedInsertRule css
   = InsertRule selector css
@@ -39,6 +37,8 @@ createHashedInsertRule css
     selector
       = CSSClassSelector <<< appendPrefix <<< show <<< hash $ css
 
+-- | This commits the rendered StyleRuleSet into InsertMediaRules that we can
+-- | store and apply to the CSSOM
 keep :: StyleRuleSet -> Array InsertMediaRule
 keep (StyleRuleSet rules)
   = foldr fold [] rules
@@ -53,6 +53,8 @@ keep (StyleRuleSet rules)
           MediaType (MediaRule query rules')
             -> pure (InsertMediaQuery query (keep (StyleRuleSet rules')))
 
+-- | Get the generated CSS classes from the CSS. These are generated from
+-- | hashes of the content
 getClasses :: InsertMediaRule -> Array CSSSelector
 getClasses (InsertStyleRule (InsertRule selector _))
   = pure selector