Multiple updates

Author: gorriecoe

README.md

@@ -1,13 +1,18 @@
 # Silverstripe Style Guide
 
-Creates a page listing common elements to developers style.
-
+Creates a page listing common elements to help developers style.
+
 ## Installation
-
-```
-composer require plato-creative/silverstripe-styleguide 1.*
+
+Composer is the recommended way of installing SilverStripe modules.
 ```
-
-Run Dev Build
-
-The styles will be available at /styleguide
+composer require plato-creative/silverstripe-styleguide
+```
+
+Flush
+
+## Requirements
+
+- silverstripe/framework 3.*
+- silverstripe/cms 3.*
+- joshtronic/php-loremipsum 3.*

_config/routes.yml

@@ -3,4 +3,4 @@ Name: styleguideroutes
 ---
 Director:
   rules:
-    'styleguide': 'StyleGuide'
+    styleguide: 'StyleGuideController'

code/controllers/StyleGuide.php

@@ -0,0 +1,120 @@
+<?php
+
+/**
+ * StyleGuideController
+ * @package silverstripe
+ * @subpackage silverstripe-styleguide
+ */
+class StyleGuideController extends Page_Controller
+{
+    private static $title = 'Style Guide';
+
+    private static $show_contents = true;
+
+    /**
+     * Defines methods that can be called directly
+     * @var array
+     */
+    private static $allowed_actions = array(
+        'index'
+    );
+
+    public function index()
+    {
+        if(Director::isLive() && !Permission::check('CMS_ACCESS_CMSMain')) {
+            return Security::permissionFailure($this);
+        }
+
+        Requirements::css(STYLEGUIDE_DIR . '/css/styleguide.css');
+
+        return $this->renderWith(array(
+            __CLASS__,
+            'Page'
+        ));
+    }
+
+    public function getStyles()
+    {
+        $config = SiteConfig::current_site_config();
+        $theme = $config->Theme;
+        if ($theme) {
+            Config::inst()->update('SSViewer', 'theme_enabled', true);
+            Config::inst()->update('SSViewer', 'theme', $theme);
+        }
+
+        $manifest = SS_TemplateLoader::instance()->getManifest();
+
+        $templates = ArrayList::create();
+
+        foreach($manifest->getTemplates() as $templateName => $templateInfo) {
+            $themeexists = $theme && isset($templateInfo['themes'][$theme]) && isset($templateInfo['themes'][$theme]['Styles']);
+
+            if ((isset($templateInfo['Styles']) || $themeexists) && !isset($templates[$templateName])) {
+                $templates->push(ArrayData::create(array(
+                    'Anchor' => $this->Link . '#' . trim($templateName),
+                    'AnchorAttr' => 'id="' . trim($templateName) .'"',
+                    'Name' => trim(str_replace('_', ' ',$templateName)),
+                    'Layout' => $this->renderWith(array($templateName))
+                )));
+            }
+        }
+
+        return $templates;
+    }
+
+    public function getShowContents()
+    {
+        return $this->config()->get('show_contents');
+    }
+
+    public function getLink()
+    {
+        return Controller::join_links('styleguide');
+    }
+
+    public function getTitle()
+    {
+        return $this->config()->get('title');
+    }
+
+    public function getMenuTitle()
+    {
+        return $this->Title;
+    }
+
+    public function Word()
+    {
+        $lorem = new joshtronic\LoremIpsum();
+        return $lorem->word();
+    }
+
+    public function Words($count = 5)
+    {
+        $lorem = new joshtronic\LoremIpsum();
+        return $lorem->words($count);
+    }
+
+    public function Sentence()
+    {
+        $lorem = new joshtronic\LoremIpsum();
+        return $lorem->sentence();
+    }
+
+    public function Sentences($count = 5)
+    {
+        $lorem = new joshtronic\LoremIpsum();
+        return $lorem->sentences($count);
+    }
+
+    public function Paragraph()
+    {
+        $lorem = new joshtronic\LoremIpsum();
+        return $lorem->paragraph();
+    }
+
+    public function Paragraphs($count = 5)
+    {
+        $lorem = new joshtronic\LoremIpsum();
+        return $lorem->paragraphs($count);
+    }
+}

code/controllers/StyleGuideController.php

@@ -4,16 +4,11 @@
     "type": "silverstripe-module",
     "keywords": ["silverstripe", "style", "guide", "development"],
     "license": "BSD-3-Clause",
-    "authors": [
-    {
-        "name": "Gorrie Coe",
-        "email": "gorriecoe@gmail.com"
-    }
-    ],
     "require":
     {
-        "silverstripe/framework": "3.*",
-    	"silverstripe/cms": "3.*"
+        "silverstripe/framework": "^3.5",
+    	"silverstripe/cms": "^3.5",
+        "joshtronic/php-loremipsum": "^1.0"
     },
     "extra": {
         "installer-name": "styleguide"

composer.json

@@ -2,30 +2,18 @@ $grey: #808080;
 $dark-grey: #222;
 $white: #fff;
 $font-family: "HelveticaNeue","Helvetica","Arial",sans-serif;
+$font-size: 14px;
 
 .styleGuideMaster{
     border: 1px solid $grey;
     padding: 1em;
-    position: fixed;
-    top: 0;
-    right: 0;
-    bottom: 0;
-    left: 0;
-    z-index: 9999;
-    background-color: $white;
     overflow: auto;
+    position: relative;
 }
 
-.styleGuideNav{
-    position: fixed;
-    top: 0;
-    bottom: 0;
-    left: 0;
-    width: 20%;
+.styleGuideContents{
     margin: 0;
-    background: $dark-grey none repeat scroll 0% 0%;
-    color: $white;
-    font-family: $font-family;
+    font-family: $font-family !important;
     text-transform: uppercase;
     overflow: auto;
     ul{
@@ -39,26 +27,27 @@ $font-family: "HelveticaNeue","Helvetica","Arial",sans-serif;
         display: block;
     }
     a{
-        font-size: 14px!important;
-        color: $grey;
+        font-size: $font-size !important;
+        color: $grey !important;
         text-decoration: none;
         display: block;
-        line-height: 1;
-        padding: 0.5em 1em;
+        line-height: $font-size * 3 !important;
+        padding: 0 1em;
         transition: color 0.15s ease-out 0s;
         cursor: pointer;
         &:hover,
         &:focus{
-            color: $white;
-            background: $dark-grey none repeat scroll 0% 0%;
+            color: $white !important;
+            background: $dark-grey none repeat scroll 0% 0% !important;
         }
     }
 }
+
 .styleGuideGroups{
-    position: absolute;
     left: 20%;
     padding: 2em;
 }
+
 .styleGuideGroup{
     clear: both;
     &:after{
@@ -67,12 +56,13 @@ $font-family: "HelveticaNeue","Helvetica","Arial",sans-serif;
         clear: both;
     }
 }
+
 .styleGuideTitle{
     margin: 2em 0px;
-    font-family: $font-family;
-    font-size: 14px!important;
+    font-family: $font-family !important;
+    font-size: $font-size !important;
     text-transform: uppercase;
     font-weight: normal;
     padding: 1em 0px;
-    border-bottom: 1px solid $grey;
+    border-bottom: 1px solid $grey !important;
 }

css/styleguide.css

@@ -0,0 +1,33 @@
+<div class="styleGuideMaster">
+    <% if Styles %>
+        <h1>{$Title}</h1>
+        <% if ShowContents %>
+            <div class="styleGuideContents">
+                <ul>
+                    <% loop Styles %>
+                        <li>
+                            <a href="{$Anchor}">
+                                {$Name}
+                            </a>
+                        </li>
+                    <% end_loop %>
+                </ul>
+            </div>
+        <% end_if %>
+
+        <div class="styleGuideGroups">
+            <% loop Styles %>
+                <div {$AnchorAttr} class="styleGuideGroup">
+                    <p class="styleGuideTitle">{$Name}</p>
+                    <div class="styleGuideLayout">
+                        {$Layout}
+                    </div>
+                </div>
+            <% end_loop %>
+        </div>
+    <% else %>
+        <p>
+            No styles found
+        </p>
+    <% end_if %>
+</div>