sibu 0.9.3 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5863fe5be538035f122d5bca9adf79b3003d14c
-  data.tar.gz: c54c068d10c247f59e1ff89993ce824421d9f8c6
+  metadata.gz: b274fec919e722e48ba571e1ee3379f037af6372
+  data.tar.gz: 4da5793bc66501214bbb5c9a5a38b00890b4754e
 SHA512:
-  metadata.gz: 0f610a0d5e30ae5d3808bd3dace1aaad977cb12f0ad9dcca17cc538c87b38fda947476768dd517a062406ce48c21a7c23563d6ff16b7e260b85a183752ace900
-  data.tar.gz: a399ffcf3ddc03508e37a404ad5c934d506af3cd1c4ca4a61f7d52437a74b798dcc073b2ff0f262b0a3fba1898c460aa55d2677fdf88fb8adee6cbf676936224
+  metadata.gz: '085bf4d2059a0f51494b062332fa6c9e9ada4313d6be6c4ee4799c8f0418d0fc4967d1c2ac967e7f750651866abb1fb249997e6f10e71d067c912fb5ecb5081e'
+  data.tar.gz: f26e18f34db37e935cdf4f891fa7033bc585a78421f32b950974460f1a777e97174cf8b728b9f95c452c6d2ffdd7fff2e82e2fbe6163e235fd5633cd0b250f88

data/README.md

@@ -1,9 +1,13 @@
-# Sibu - A site builder engine for Ruby on Rails
-This is an engine for Ruby on Rails that enables creation of static
-websites in a simple & wysiwyg way.
+# Sibu
+Sibu is an engine to build websites. It focuses on :
+- Maintaining a simple data model, so it can be exported & imported in many formats
+- Increasing the productivity of web developers by using a Domain Specific Language for page edition
+- Providing non-technical users with a simple and accessible site administration interface
 
 ## Usage
-How to use my plugin.
+Sibu is currently implemented as a Ruby on Rails engine. Therefore its setup requires a host Ruby on Rails application, that can be created via :
+
+`rails new my_app`
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -22,6 +26,79 @@ Or install it yourself as:
 $ gem install sibu
 ```
 
+Once the installation is complete, make sure that you copy the database migrations to your application :
+```bash
+rake sibu:install:migrations
+```
+
+And finally run the migrations to update your database model :
+```bash
+rake db:migrate
+```
+
+## Configuration
+Configuration is provided via the `sibu` key of the Rails application configuration. Typically, this would be done in a `sibu.rb` file in the `config/initializers` folder of your Rails application.
+The example below lists the configuration options available :
+```ruby
+Rails.application.config.sibu = {
+
+  # Title metatag of the admin interface
+  title: 'My website administration',
+
+  # Stylesheet to use to style the admin interface
+  stylesheet: 'my_user_css',
+
+  # Javascript to include in the admin interface
+  javascript: 'my_user_js',
+
+  # Path to the admin interface header partial
+  top_panel: 'shared/user/top_panel',
+
+  # Path to the main content edition partial - must include a yield to delegate content display to the Sibu engine
+  content_panel: 'shared/user/content_panel',
+
+  # Path to the admin interface footer partial
+  bottom_panel: 'shared/user/bottom_panel',
+
+  # Name of the method that will be used to authenticate admin users - this method must be available to Sibu controllers
+  auth_filter: :authenticate_user!,
+
+  # Name of the method that will retrieve the current user - this method must be available to Sibu controllers
+  current_user: 'current_user',
+
+  # A flag to indicate that the Sibu instance should offer a separate environment for each user
+  multi_user: true,
+
+  # A proc to identify super-admin users in a multi-users setup (optional)
+  admin_filter: Proc.new {|usr| usr.is_admin},
+
+  # When active, users will be able to override the colors and fonts of the sites templates (optional)
+  custom_styles: true,
+
+  # Lists of colors and fonts available for sites templates customization - Only used when custom_styles is set to true (optional)
+  primary_colors: ['#23527c', '#00B1BF', '#BECD00'],
+  secondary_colors: ['#E2007A', '#aaaaa1', '#be6432'],
+  primary_fonts: ['Intro', 'Lato', 'SourceSansPro'],
+  secondary_fonts: ['Aleo', 'Bodoni', 'Cinzel'],
+
+  # The domain name that will host the admin interface (should be different from the website domain name)
+  host: 'localhost',
+
+  # A partial for 404 error pages
+  not_found: 'shared/templates/not_found',
+
+  # Dimensions of the images to use in the website - Uploaded images will be automatically resized in the provided formats
+  images: {large: 1600, medium: 800, small: 320},
+
+  # Versions available for the created websites
+  versions: [['Français', 'fr'], ['Anglais', 'en']],
+
+  # A proc to override the default ordering of the sections when editing content (optional)
+  sections_ordering: Proc.new {|sections| sections.sort_by {|s| SECTIONS_TABS.index(s['category'])}}
+}
+```
+
+
 ## Improvements
   - Use a specific controller & helper for site display
   - Move page templates to SiteTemplate model

data/app/assets/javascripts/sibu/sibu.js.erb

@@ -1,5 +1,3 @@
-//= require jquery
-//= require jquery_ujs
 //= require sibu/common
 //= require ../quill/quill
 //= require ../tabs/van11y-accessible-tab-panel-aria
@@ -140,7 +138,7 @@ function displayCurrentCenter(img, centerPos) {
 }
 
 function refreshAfterEdit(reload, sectionId) {
-    var baseUrl = window.location.href.split('?')[0];
+    var baseUrl = window.location.href.split('?')[0].replace(/#.+/, '');
     if (reload) {
         if (sectionId) {
             window.location.href = baseUrl + '?edit_section=' + sectionId;
@@ -152,6 +150,22 @@ function refreshAfterEdit(reload, sectionId) {
     }
 }
 
+function setLinkMode(elt) {
+    var selected = elt.value,
+        enabledElts = document.querySelector("#link_" + selected).querySelectorAll("#element_value, #element_target");
+    for (var i = 0; i < enabledElts.length; i++) {
+        enabledElts[i].removeAttribute("disabled");
+    }
+
+    var linkModes = document.querySelectorAll(".sibu_edit_form .link_mode");
+    for (var j = 0; j < linkModes.length; j++) {
+        if(linkModes[j].getAttribute("id") !== ("link_" + selected)) {
+            linkModes[j].querySelector("#element_value").setAttribute("disabled", "disabled");
+            linkModes[j].querySelector("#element_target").setAttribute("disabled", "disabled");
+        }
+    }
+}
+
 function initSectionsPanel() {
 
 }

data/app/assets/javascripts/tabs/van11y-accessible-tab-panel-aria.js

@@ -160,9 +160,10 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
      * @param  {Node} node Default document
      * @return {Array}
      */
+    // Note : patched to target only direct child nodes having .js-tabs class
     var $listTabs = function $listTabs() {
         var node = arguments.length <= 0 || arguments[0] === undefined ? doc : arguments[0];
-        return [].slice.call(node.querySelectorAll('.' + TABS_JS));
+        return [].slice.call(node.querySelectorAll(':scope > .' + TABS_JS));
     };
 
     /**
@@ -178,10 +179,10 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
             var hx = tabs_node.hasAttribute(TABS_DATA_HX) === true ? tabs_node.getAttribute(TABS_DATA_HX) : '';
             var hxGeneratedClass = tabs_node.hasAttribute(TABS_DATA_GENERATED_HX_CLASS) === true ? tabs_node.getAttribute(TABS_DATA_GENERATED_HX_CLASS) : TABS_HX_DEFAULT_CLASS;
             var existingHx = tabs_node.hasAttribute(TABS_DATA_EXISTING_HX) === true ? tabs_node.getAttribute(TABS_DATA_EXISTING_HX) : '';
-            var $tabList = [].slice.call(tabs_node.querySelectorAll('.' + TABS_JS_LIST));
-            var $tabListItems = [].slice.call(tabs_node.querySelectorAll('.' + TABS_JS_LISTITEM));
-            var $tabListLinks = [].slice.call(tabs_node.querySelectorAll('.' + TABS_JS_LISTLINK));
-            var $tabListPanels = [].slice.call(tabs_node.querySelectorAll('.' + TABS_JS_CONTENT));
+            var $tabList = [].slice.call(tabs_node.querySelectorAll(':scope > .' + TABS_JS_LIST));
+            var $tabListItems = [].slice.call(tabs_node.querySelectorAll(':scope > .' + TABS_JS_LIST + ' > .' + TABS_JS_LISTITEM));
+            var $tabListLinks = [].slice.call(tabs_node.querySelectorAll(':scope > .' + TABS_JS_LIST + ' > .' + TABS_JS_LISTITEM + ' > .' + TABS_JS_LISTLINK));
+            var $tabListPanels = [].slice.call(tabs_node.querySelectorAll(':scope > .' + TABS_JS_CONTENT));
             var noTabSelected = true;
 
             // container
@@ -300,35 +301,91 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
     };
 
     /* listeners */
-    var bindListeners = function() {
-        ['click', 'keydown'].forEach(function (eventName) {
-            //let isCtrl = false;
-
-            doc.body.addEventListener(eventName, function (e) {
+    ['click', 'keydown'].forEach(function (eventName) {
+        //let isCtrl = false;
+
+        doc.body.addEventListener(eventName, function (e) {
+
+            // click on a tab link or on something IN a tab link
+            var parentLink = searchParent(e.target, TABS_JS_LISTLINK);
+            if ((hasClass(e.target, TABS_JS_LISTLINK) === true || parentLink !== '') && eventName === 'click') {
+                var linkSelected = hasClass(e.target, TABS_JS_LISTLINK) === true ? e.target : findById(parentLink);
+                var parentTabId = searchParent(e.target, TABS_JS);
+                var parentTab = findById(parentTabId);
+                //let $parentListItems = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_LISTITEM));
+                var $parentListLinks = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_LISTLINK));
+                var $parentListContents = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_CONTENT));
+
+                // aria selected false on all links
+                unSelectLinks($parentListLinks);
+                // add aria-hidden on all tabs contents
+                unSelectContents($parentListContents);
+                // add aria selected on selected link + show linked panel
+                selectLink(linkSelected);
+
+                e.preventDefault();
+            }
 
-                // click on a tab link or on something IN a tab link
-                var parentLink = searchParent(e.target, TABS_JS_LISTLINK);
-                if ((hasClass(e.target, TABS_JS_LISTLINK) === true || parentLink !== '') && eventName === 'click') {
-                    var linkSelected = hasClass(e.target, TABS_JS_LISTLINK) === true ? e.target : findById(parentLink);
-                    var parentTabId = searchParent(e.target, TABS_JS);
-                    var parentTab = findById(parentTabId);
-                    //let $parentListItems = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_LISTITEM));
-                    var $parentListLinks = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_LISTLINK));
-                    var $parentListContents = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_CONTENT));
+            // Key down on tabs
+            if ((hasClass(e.target, TABS_JS_LISTLINK) === true || parentLink !== '') && eventName === 'keydown') {
+                //let linkSelected = hasClass( e.target, TABS_JS_LISTLINK) === true ? e.target : findById( parentLink );
+                var parentTabId = searchParent(e.target, TABS_JS);
+                var parentTab = findById(parentTabId);
+                var $parentListItems = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_LISTITEM));
+                var $parentListLinks = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_LISTLINK));
+                var $parentListContents = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_CONTENT));
+                var firstLink = $parentListItems[0].querySelector('.' + TABS_JS_LISTLINK);
+                var lastLink = $parentListItems[$parentListItems.length - 1].querySelector('.' + TABS_JS_LISTLINK);
+
+                // strike home on a tab => 1st tab
+                if (e.keyCode === 36) {
+                    unSelectLinks($parentListLinks);
+                    unSelectContents($parentListContents);
+                    selectLink(firstLink);
 
-                    // aria selected false on all links
+                    e.preventDefault();
+                }
+                // strike end on a tab => last tab
+                else if (e.keyCode === 35) {
                     unSelectLinks($parentListLinks);
-                    // add aria-hidden on all tabs contents
                     unSelectContents($parentListContents);
-                    // add aria selected on selected link + show linked panel
-                    selectLink(linkSelected);
+                    selectLink(lastLink);
 
                     e.preventDefault();
                 }
+                // strike up or left on the tab => previous tab
+                else if ((e.keyCode === 37 || e.keyCode === 38) && !e.ctrlKey) {
+                    if (firstLink.getAttribute(ATTR_SELECTED) === 'true') {
+                        unSelectLinks($parentListLinks);
+                        unSelectContents($parentListContents);
+                        selectLink(lastLink);
+
+                        e.preventDefault();
+                    } else {
+                        selectLinkInList($parentListItems, $parentListLinks, $parentListContents, 'prev');
+                        e.preventDefault();
+                    }
+                }
+                // strike down or right in the tab => next tab
+                else if ((e.keyCode === 40 || e.keyCode === 39) && !e.ctrlKey) {
+                    if (lastLink.getAttribute(ATTR_SELECTED) === 'true') {
+                        unSelectLinks($parentListLinks);
+                        unSelectContents($parentListContents);
+                        selectLink(firstLink);
+
+                        e.preventDefault();
+                    } else {
+                        selectLinkInList($parentListItems, $parentListLinks, $parentListContents, 'next');
+                        e.preventDefault();
+                    }
+                }
+            }
 
-                // Key down on tabs
-                if ((hasClass(e.target, TABS_JS_LISTLINK) === true || parentLink !== '') && eventName === 'keydown') {
-                    //let linkSelected = hasClass( e.target, TABS_JS_LISTLINK) === true ? e.target : findById( parentLink );
+            // Key down in tab panels
+            var parentTabPanelId = searchParent(e.target, TABS_JS_CONTENT);
+            if (parentTabPanelId !== '' && eventName === 'keydown') {
+                (function () {
+                    var linkSelected = findById(findById(parentTabPanelId).getAttribute(ATTR_LABELLEDBY));
                     var parentTabId = searchParent(e.target, TABS_JS);
                     var parentTab = findById(parentTabId);
                     var $parentListItems = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_LISTITEM));
@@ -337,130 +394,71 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
                     var firstLink = $parentListItems[0].querySelector('.' + TABS_JS_LISTLINK);
                     var lastLink = $parentListItems[$parentListItems.length - 1].querySelector('.' + TABS_JS_LISTLINK);
 
-                    // strike home on a tab => 1st tab
-                    if (e.keyCode === 36) {
-                        unSelectLinks($parentListLinks);
-                        unSelectContents($parentListContents);
-                        selectLink(firstLink);
-
+                    // strike up + ctrl => go to header
+                    if (e.keyCode === 38 && e.ctrlKey) {
+                        setTimeout(function () {
+                            linkSelected.focus();
+                        }, 0);
                         e.preventDefault();
                     }
-                    // strike end on a tab => last tab
-                    else if (e.keyCode === 35) {
-                        unSelectLinks($parentListLinks);
-                        unSelectContents($parentListContents);
-                        selectLink(lastLink);
-
+                    // strike pageup + ctrl => go to prev header
+                    if (e.keyCode === 33 && e.ctrlKey) {
+                        // go to header
+                        linkSelected.focus();
                         e.preventDefault();
-                    }
-                    // strike up or left on the tab => previous tab
-                    else if ((e.keyCode === 37 || e.keyCode === 38) && !e.ctrlKey) {
+                        // then previous
                         if (firstLink.getAttribute(ATTR_SELECTED) === 'true') {
                             unSelectLinks($parentListLinks);
                             unSelectContents($parentListContents);
                             selectLink(lastLink);
-
-                            e.preventDefault();
                         } else {
                             selectLinkInList($parentListItems, $parentListLinks, $parentListContents, 'prev');
-                            e.preventDefault();
                         }
                     }
-                    // strike down or right in the tab => next tab
-                    else if ((e.keyCode === 40 || e.keyCode === 39) && !e.ctrlKey) {
+                    // strike pagedown + ctrl => go to next header
+                    if (e.keyCode === 34 && e.ctrlKey) {
+                        // go to header
+                        linkSelected.focus();
+                        e.preventDefault();
+                        // then next
                         if (lastLink.getAttribute(ATTR_SELECTED) === 'true') {
                             unSelectLinks($parentListLinks);
                             unSelectContents($parentListContents);
                             selectLink(firstLink);
-
-                            e.preventDefault();
                         } else {
                             selectLinkInList($parentListItems, $parentListLinks, $parentListContents, 'next');
-                            e.preventDefault();
                         }
                     }
-                }
-
-                // Key down in tab panels
-                var parentTabPanelId = searchParent(e.target, TABS_JS_CONTENT);
-                if (parentTabPanelId !== '' && eventName === 'keydown') {
-                    (function () {
-                        var linkSelected = findById(findById(parentTabPanelId).getAttribute(ATTR_LABELLEDBY));
-                        var parentTabId = searchParent(e.target, TABS_JS);
-                        var parentTab = findById(parentTabId);
-                        var $parentListItems = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_LISTITEM));
-                        var $parentListLinks = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_LISTLINK));
-                        var $parentListContents = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_CONTENT));
-                        var firstLink = $parentListItems[0].querySelector('.' + TABS_JS_LISTLINK);
-                        var lastLink = $parentListItems[$parentListItems.length - 1].querySelector('.' + TABS_JS_LISTLINK);
-
-                        // strike up + ctrl => go to header
-                        if (e.keyCode === 38 && e.ctrlKey) {
-                            setTimeout(function () {
-                                linkSelected.focus();
-                            }, 0);
-                            e.preventDefault();
-                        }
-                        // strike pageup + ctrl => go to prev header
-                        if (e.keyCode === 33 && e.ctrlKey) {
-                            // go to header
-                            linkSelected.focus();
-                            e.preventDefault();
-                            // then previous
-                            if (firstLink.getAttribute(ATTR_SELECTED) === 'true') {
-                                unSelectLinks($parentListLinks);
-                                unSelectContents($parentListContents);
-                                selectLink(lastLink);
-                            } else {
-                                selectLinkInList($parentListItems, $parentListLinks, $parentListContents, 'prev');
-                            }
-                        }
-                        // strike pagedown + ctrl => go to next header
-                        if (e.keyCode === 34 && e.ctrlKey) {
-                            // go to header
-                            linkSelected.focus();
-                            e.preventDefault();
-                            // then next
-                            if (lastLink.getAttribute(ATTR_SELECTED) === 'true') {
-                                unSelectLinks($parentListLinks);
-                                unSelectContents($parentListContents);
-                                selectLink(firstLink);
-                            } else {
-                                selectLinkInList($parentListItems, $parentListLinks, $parentListContents, 'next');
-                            }
-                        }
-                    })();
-                }
-
-                // click on a tab link
-                var parentLinkToPanelId = searchParent(e.target, TABS_JS_LINK_TO_TAB);
-                if ((hasClass(e.target, TABS_JS_LINK_TO_TAB) === true || parentLinkToPanelId !== '') && eventName === 'click') {
-                    var panelSelectedId = hasClass(e.target, TABS_JS_LINK_TO_TAB) === true ? e.target.getAttribute('href').replace('#', '') : findById(parentLinkToPanelId).replace('#', '');
-                    var panelSelected = findById(panelSelectedId);
-                    var buttonPanelSelected = findById(panelSelected.getAttribute(ATTR_LABELLEDBY));
-                    var parentTabId = searchParent(e.target, TABS_JS);
-                    var parentTab = findById(parentTabId);
-                    //let $parentListItems = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_LISTITEM));
-                    var $parentListLinks = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_LISTLINK));
-                    var $parentListContents = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_CONTENT));
-
-                    unSelectLinks($parentListLinks);
-                    unSelectContents($parentListContents);
-                    selectLink(buttonPanelSelected);
+                })();
+            }
 
-                    e.preventDefault();
-                }
-            }, true);
-        });
-    };
+            // click on a tab link
+            var parentLinkToPanelId = searchParent(e.target, TABS_JS_LINK_TO_TAB);
+            if ((hasClass(e.target, TABS_JS_LINK_TO_TAB) === true || parentLinkToPanelId !== '') && eventName === 'click') {
+                var panelSelectedId = hasClass(e.target, TABS_JS_LINK_TO_TAB) === true ? e.target.getAttribute('href').replace('#', '') : findById(parentLinkToPanelId).replace('#', '');
+                var panelSelected = findById(panelSelectedId);
+                var buttonPanelSelected = findById(panelSelected.getAttribute(ATTR_LABELLEDBY));
+                var parentTabId = searchParent(e.target, TABS_JS);
+                var parentTab = findById(parentTabId);
+                //let $parentListItems = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_LISTITEM));
+                var $parentListLinks = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_LISTLINK));
+                var $parentListContents = [].slice.call(parentTab.querySelectorAll('.' + TABS_JS_CONTENT));
+
+                unSelectLinks($parentListLinks);
+                unSelectContents($parentListContents);
+                selectLink(buttonPanelSelected);
+
+                e.preventDefault();
+            }
+        }, true);
+    });
 
     var onLoad = function onLoad() {
         attach();
-        bindListeners();
         document.removeEventListener('DOMContentLoaded', onLoad);
     };
 
     document.addEventListener('DOMContentLoaded', onLoad);
 
-    window.van11yAccessibleTabPanelAria = attach;
+    window.sibuVan11yAccessibleTabPanelAria = attach;
 })(document);