sibu 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6eb3cad54639de1385e45c0465b10aabeb58612
-  data.tar.gz: 456b3d03e871ddf4d74efec50ac7439361843591
+  metadata.gz: 6916799ff35b88c15850f4911c93517a43e8ba1f
+  data.tar.gz: ef515f1129ed26fdf3f156794e79ac402a37011d
 SHA512:
-  metadata.gz: 6ac41267562d922d72f7b6d61fc70a9adf039b53b6f2b23fdb611e7630667545831a1fb7d337aa65fdde806d32612cc0f32261b8147d26332966f4e4d1749c19
-  data.tar.gz: c8bd6917787c516117e671d09ebe3a57c4fd402f28dfbe2b6065260cc57d54c561b0016b478e71ce33dd6bb56764a049bec7492e507a0debb2934407f03c9632
+  metadata.gz: 471eee1cd3b1388651e1771f65396748f48a5e59826552fda85588373cbd2e8df68fa6d0b0a99f6c33f43b0291cba853dd36ded178aa3ec6f2dadd510d968095
+  data.tar.gz: 913ed58b8942eb16f66b492536e7466927835ff9be32523335c3ec13dc3a1898d0f81aeeedbfda4eb6e38e41ef7a6491f698b5dccc1e334fb12fc160e255faf9

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/helpers/sibu/pages_helper.rb

@@ -35,29 +35,53 @@ module Sibu
       end
     end
 
-    [:h1, :h2, :h3, :h4, :h5, :h6, :span].each do |t|
-      define_method(t) do |elt, html_opts = {}, &block|
-        defaults = {"id" => elt.is_a?(Hash) ? elt["id"] : elt, "text" => Sibu::DEFAULT_TEXT}
+    [:h1, :h2, :h3, :h4, :h5, :h6, :span, :p, :li].each do |t|
+      define_method(t) do |elt, opts = {}, &block|
+        t_id = elt.is_a?(Hash) ? elt["id"] : elt
+        defaults = {"id" => t_id, "text" => (t == :p ? Sibu::DEFAULT_PARAGRAPH : Sibu::DEFAULT_TEXT)}
         content = defaults.merge(elt.is_a?(Hash) ? elt : (select_element(elt) || {}))
-        html_opts.merge!({data: {id: elt_id(elt), type: "text"}}) if action_name != 'show'
+        html_opts = {"id" => t_id}.merge(opts.except(:repeat, :children).stringify_keys)
+        @sb_section = (@sb_section || []) + [t_id]
+        if action_name != 'show'
+          html_opts.merge!({
+                               "data-id" => @sb_section[1..-1].join('|'),
+                               "data-type" => (t == :p ? "paragraph" : "text"),
+                               "data-repeat" => opts.delete(:repeat),
+                               "data-children" => opts.delete(:children)
+                           })
+        end
         if block
-          @sb_section = (@sb_section || []) + [elt_id(elt)]
-          html_output = content_tag(t, capture(content, nested_elements(elt), &block), html_opts)
-          @sb_section -= [elt_id(elt)]
-          html_output
+          if t == :p
+            html_output = content_tag(:div, content_tag(t, capture(content, nested_elements(elt), &block)), html_opts)
+          else
+            html_output = content_tag(t, capture(content, nested_elements(t_id), &block), html_opts)
+          end
         else
-          content_tag(t, raw(content["text"]).html_safe, html_opts)
+          if t == :p
+            html_output = content_tag(:div, content_tag(t, raw(content["text"]).html_safe, html_opts), html_opts)
+          else
+            html_output = content_tag(t, raw(content["text"]).html_safe, html_opts)
+          end
         end
+        @sb_section -= [t_id]
+        html_output
       end
     end
 
-    [:div, :section, :article, :aside, :header, :footer, :nav, :main, :ul].each do |t|
-      define_method(t) do |elt, html_opts = {}, &block|
+    [:div, :section, :article, :aside, :header, :footer, :nav, :main, :ul, :ol, :wrapper].each do |t|
+      define_method(t) do |elt, opts = {}, &block|
         t_id = elt.is_a?(Hash) ? elt["id"] : elt
         @sb_section = (@sb_section || []) + [t_id]
-        html_opts = {"id" => t_id}.merge(html_opts)
-        html_opts.merge!(@sb_section.length == 1 ? {"data-sb-id" => t_id, "data-sb-entity" => @sb_entity == @site ? 'site' : 'page'} : {"data-id" => elt_id(elt), "data-type" =>  "group", "data-repeat" => false, "data-children" => false}) if action_name != 'show'
-        html_output = content_tag(t, capture(current_elt(elt), nested_elements(t_id), &block), html_opts)
+        html_opts = {"id" => t_id}.merge(opts.except(:repeat, :children).stringify_keys)
+        if action_name != 'show'
+          html_opts.merge!({
+                               "data-id" => @sb_section[1..-1].join('|'),
+                               "data-type" => "group",
+                               "data-repeat" => opts.delete(:repeat),
+                               "data-children" => opts.delete(:children)
+                           })
+        end
+        html_output = t == :wrapper ? capture(current_elt(elt), nested_elements(t_id), &block) : content_tag(t, capture(current_elt(elt), nested_elements(t_id), &block), html_opts)
         @sb_section -= [t_id]
         html_output
       end
@@ -88,14 +112,6 @@ module Sibu
       items.blank? ? [{"id" => "el#{Time.current.to_i}"}] : items
     end
 
-    def p(elt, opts = {})
-      repeat = opts.delete(:repeat)
-      defaults = {"id" => elt.is_a?(Hash) ? elt["id"] : elt, "text" => Sibu::DEFAULT_PARAGRAPH}
-      content = defaults.merge(elt.is_a?(Hash) ? elt : (select_element(elt) || {}))
-      opts.merge!({data: {id: elt_id(elt), repeat: repeat, type: "paragraph"}}) if action_name != 'show'
-      content_tag(:div, content_tag(:p, raw(content["text"]).html_safe), opts)
-    end
-
     def img(elt, opts = {})
       wrapper = opts.delete(:wrapper)
       repeat = opts.delete(:repeat)

data/app/views/layouts/sibu/edit_content.html.erb

@@ -212,7 +212,7 @@
     function initInnerOverlays(section) {
         var editables = section.querySelectorAll("[data-type]");
         for (var i = 0; i < editables.length; i++) {
-            if (editables[i].getAttribute("data-type") !== 'group' || editables[i].getAttribute("data-repeat") !== 'false' || editables[i].getAttribute("data-children") !== 'false') {
+            if (editables[i].getAttribute("data-type") !== 'group' || editables[i].getAttribute("data-repeat") === 'true' || editables[i].getAttribute("data-children") === 'true') {
                 editables[i].addEventListener("mouseenter", function(evt) {
                     evt.stopPropagation();
                     evt.currentTarget.classList.add("sb-editable");
@@ -233,27 +233,29 @@
     }
 
     function initOverlays() {
-        var container = document.querySelector("#edit_overlays"), sections = document.querySelectorAll("[data-sb-id]");
-        container.innerHTML = "";
+        setTimeout(function() {
+            var container = document.querySelector("#edit_overlays"), sections = document.querySelectorAll("[data-sb-id]");
+            container.innerHTML = "";
 
-        for (var i = 0; i < sections.length; i++) {
-            var sectionBox = sections[i].getBoundingClientRect();
-            var yOffset = sectionBox.top - document.querySelector(".sibu_content_panel").getBoundingClientRect().top;
-            var width = sections[i].offsetWidth, height = (sections[i].offsetHeight === 0 ? childrenHeight(sections[i]) : sections[i].offsetHeight);
-            var overlay = document.createElement("div");
-            overlay.setAttribute("data-sb-overlay", sections[i].getAttribute("data-sb-id"));
-            overlay.innerHTML = "Modifier";
-            container.appendChild(overlay);
-            overlay.style.top = yOffset + "px";
-            overlay.style.left = sectionBox.left + "px";
-            overlay.style.width = width + "px";
-            overlay.style.height = height + "px";
-            overlay.addEventListener("click", (function(section, offsetLeft, offsetTop, editWidth, editHeight) {
-                return function(evt) {
-                    setEditMode(section, evt.currentTarget, offsetLeft, offsetTop, editWidth, editHeight);
-                };
-            })(sections[i], sectionBox.left, yOffset, width, height));
-        }
+            for (var i = 0; i < sections.length; i++) {
+                var sectionBox = sections[i].getBoundingClientRect();
+                var yOffset = sectionBox.top - document.querySelector(".sibu_content_panel").getBoundingClientRect().top;
+                var width = sections[i].offsetWidth, height = (sections[i].offsetHeight === 0 ? childrenHeight(sections[i]) : sections[i].offsetHeight);
+                var overlay = document.createElement("div");
+                overlay.setAttribute("data-sb-overlay", sections[i].getAttribute("data-sb-id"));
+                overlay.innerHTML = "Modifier";
+                container.appendChild(overlay);
+                overlay.style.top = yOffset + "px";
+                overlay.style.left = sectionBox.left + "px";
+                overlay.style.width = width + "px";
+                overlay.style.height = height + "px";
+                overlay.addEventListener("click", (function(section, offsetLeft, offsetTop, editWidth, editHeight) {
+                    return function(evt) {
+                        setEditMode(section, evt.currentTarget, offsetLeft, offsetTop, editWidth, editHeight);
+                    };
+                })(sections[i], sectionBox.left, yOffset, width, height));
+            }
+        }, 800);
     }
 
     function childrenHeight(parentElt) {

data/lib/sibu/version.rb

@@ -1,3 +1,3 @@
 module Sibu
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sibu
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jean-Baptiste Vilain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails