zen 0.3 → 0.4

data/lib/zen/package/dashboard/lib/dashboard.rb

@@ -0,0 +1,28 @@
+Zen::Package.add do |p|
+  p.name       = :dashboard
+  p.title      = 'dashboard.titles.index'
+  p.author     = 'Yorick Peterse'
+  p.url        = 'http://zen-cms.com/'
+  p.about      = 'dashboard.description'
+  p.root       = __DIR__('dashboard')
+  p.migrations = __DIR__('../migrations')
+
+  p.menu 'dashboard.titles.index', '/admin'
+end
+
+require __DIR__('dashboard/model/widget')
+require __DIR__('dashboard/controller/dashboard')
+require __DIR__('dashboard/widget')
+require __DIR__('dashboard/widget/welcome')
+
+Zen::Event.listen :after_new_user do |user|
+  Dashboard::Model::Widget.create(
+    :user_id => user.id,
+    :name    => 'welcome',
+    :order   => 0
+  )
+end
+
+Zen::Event.listen :post_start do
+  Zen::Language.load('dashboard')
+end

data/lib/zen/package/dashboard/lib/dashboard/controller/dashboard.rb

@@ -0,0 +1,154 @@
+##
+# Package for the user's dashboard.
+#
+# ## Controllers
+#
+# * {Dashboard::Controller::Dashboard}
+#
+# ## Models
+#
+# * {Dashboard::Model::Widget}
+#
+# ## Generic Modules & Classes
+#
+# * {Dashboard::Widget}
+# * {Dashboard::WidgetError}
+#
+# @since 16-01-2012
+#
+module Dashboard
+  module Controller
+    ##
+    # Shows the dashboard for the currently logged in user. The dashboard shows
+    # a list of user specific widgets. These widgets can be re-arranged,
+    # disabled/enabled and the columns for these widgets can also be customized.
+    #
+    # When you open up the dashboard for the first time only one widget will be
+    # displayed, the "Welcome" widget. This widget gives a very short
+    # introduction to how widgets work and how to navigate around the
+    # application.
+    #
+    # ![Default Dashboard](../../images/dashboard/dashboard.png)
+    #
+    # Of course the default widget isn't very useful after the first time you've
+    # read it so you might want to turn it off and enable some other widgets
+    # instead. This can be done by first opening the options menu by clicking on
+    # the "Options" button and then choosing which widgets you'd like to be
+    # displayed.
+    #
+    # ![Available Widgets](../../images/dashboard/options.png)
+    #
+    # In this image two widgets are available, "Welcome" (activated by default
+    # for each new user) and the "Recent Entries" widget. In order to activate
+    # the "Recent Entries" widget all you have to do is check the checkbox. Once
+    # done it will be added to your dashboard as shown in the image below.
+    #
+    # ![Added Widget](../../images/dashboard/added.png)
+    #
+    # The options menu also allows you to change the amount of columns for each
+    # row. You can choose between 1 and 4 columns.
+    #
+    # ![Widget Columns](../../images/dashboard/columns.png)
+    #
+    # ## Available Widgets
+    #
+    # Zen comes with the following widgets:
+    #
+    # * Welcome: gives a short introduction to widgets and how to navigate
+    #   around the application.
+    # * Recent Entries: a widget that displays the 10 most recent entries.
+    #
+    # @since 08-01-2012
+    # @map   /admin
+    #
+    class Dashboard < Zen::Controller::AdminController
+      map   '/admin'
+      title 'dashboard.titles.%s'
+
+      serve :css, ['admin/dashboard/css/dashboard'], :name => 'dashboard'
+      serve :javascript, ['admin/dashboard/js/dashboard'], :name => 'dashboard'
+
+      set_layout nil => [:widget_state, :widget_order, :widget_columns],
+        :admin => [:index]
+
+      ##
+      # Shows all the active widgets and allows the user to manage these widgets
+      # or add new ones.
+      #
+      # @since 08-01-2012
+      #
+      def index; end
+
+      ##
+      # Updates the sort order of all the widgets for the currently logged in
+      # user.
+      #
+      # @since 15-01-2012
+      #
+      def widget_order
+        ::Dashboard::Widget::REGISTERED.each do |name, widget|
+          _name = name.to_s
+
+          if request.POST[_name] and request.POST[_name] =~ /\d+/
+            row = ::Dashboard::Model::Widget[
+              :name    => _name,
+              :user_id => user.id
+            ]
+
+            unless row.nil?
+              row.update(:order => request.POST[_name])
+            end
+          end
+        end
+      end
+
+      ##
+      # Enables or disables a widget for the currently logged in user.
+      #
+      # @since 15-01-2012
+      #
+      def widget_state
+        widget  = request.POST['widget']
+        enabled = request.POST['enabled'] == '1' ? true : false
+
+        if !widget.nil? and !widget.empty? \
+        and ::Dashboard::Widget::REGISTERED.key?(widget.to_sym)
+          row = ::Dashboard::Model::Widget[
+            :name    => widget,
+            :user_id => user.id
+          ]
+
+          if enabled == true
+            if row.nil?
+              last_order = ::Dashboard::Model::Widget.last_order(user.id)
+
+              ::Dashboard::Model::Widget.create(
+                :name    => widget,
+                :user_id => user.id,
+                :order   => last_order + 1
+              )
+
+              respond(::Dashboard::Widget[widget].html, 201)
+            end
+          else
+            row.destroy
+          end
+        end
+      end
+
+      ##
+      # Updates the amount of widget columns to use for the currently logged in
+      # user.
+      #
+      # @since 15-01-2012
+      #
+      def widget_columns
+        columns = request.POST['columns']
+
+        if !columns.nil? and !columns.empty? and columns =~ /\d+/
+          user.update(:widget_columns => columns)
+        end
+      end
+    end # Dashboard
+  end # Controller
+end # Zen

data/lib/zen/package/dashboard/lib/dashboard/language/en/dashboard.rb

@@ -0,0 +1,35 @@
+Zen::Language::Translation.add do |trans|
+  trans.language = 'en'
+  trans.name     = 'dashboard'
+
+  trans.translate do |t|
+    t['titles.index']           = 'Dashboard'
+    t['buttons.options']        = 'Options'
+    t['labels.columns']         = 'Columns'
+    t['labels.active_widgets']  = 'Active Widgets'
+    t['labels.documentation']   = 'Documentation'
+    t['labels.github']          = 'Github Project'
+    t['labels.mailing_list']    = 'Mailing List'
+    t['widgets.titles.welcome'] = 'Welcome'
+
+    t['widgets.welcome.content.paragraph_1'] = <<TXT.strip
+Welcome to Zen %s. What you are seeing here is the dashboard of your website.
+This little box here is called a "widget". Widgets are displayed on the
+dashboard and contain small amounts of data such as this help message or a list
+of recent entries. Don't like a widget? You can customize the active widgets by
+clicking the "Options" button at the top right.
+TXT
+
+    t['widgets.welcome.content.paragraph_2'] = <<TXT.strip
+To the left is the name of your website, a few user specific actions and the
+main navigation menu. You can use this menu to navigate through the
+administration panel of your website. Clicking on the name of your website (or
+on the "Dashboard" link) will bring you back to this page.
+TXT
+
+    t['widgets.welcome.content.paragraph_3'] = 'For more information see the ' \
+      'following links:'
+
+    t['description'] = 'Dashboard with custom widgets for each user.'
+  end
+end

data/lib/zen/package/dashboard/lib/dashboard/language/nl/dashboard.rb

@@ -0,0 +1,36 @@
+Zen::Language::Translation.add do |trans|
+  trans.language = 'nl'
+  trans.name     = 'dashboard'
+
+  trans.translate do |t|
+    t['titles.index']           = 'Dashboard'
+    t['buttons.options']        = 'Opties'
+    t['labels.columns']         = 'Kolommen'
+    t['labels.active_widgets']  = 'Actieve widgets'
+    t['labels.documentation']   = 'Documentatie'
+    t['labels.github']          = 'Github project'
+    t['labels.mailing_list']    = 'Discussie groep'
+    t['widgets.titles.welcome'] = 'Welkom'
+
+    t['widgets.welcome.content.paragraph_1'] = <<TXT.strip
+Welkom bij Zen %s. Wat u nu voor u ziet is het dashboard van uw website. Dit
+kleine blok heet een "widget". Widgets worden weergegeven op het dashboard en
+bevatten kleine hoeveelheden aan data zoals dit help bericht of een lijst met
+recente artikelen. Vind u een bepaalde widget maar niks? Geen probleem. Widgets
+kunnen aan of uit worden gezet door op de knop "Opties" te klikken, deze knop
+vind u in de rechter bovenhoek van deze pagina.
+TXT
+
+    t['widgets.welcome.content.paragraph_2'] = <<TXT.strip
+Aan de linker kant van deze pagina vind u de naam van uw website, een paar
+gebruikers specifieke acties en het hoofd navigatie menu. Met dit menu kunt u
+rond navigeren door het beheerders paneel van uw website. Door op de naam te
+klikken (of op de "Dashboard" link) komt u weer terug op deze pagina.
+TXT
+
+    t['widgets.welcome.content.paragraph_3'] = 'Zie de volgende links voor ' \
+      'meer informatie:'
+
+    t['description'] = 'Dashboard met aanpasbare widgets voor elke gebruiker.'
+  end
+end

data/lib/zen/package/dashboard/lib/dashboard/model/widget.rb

@@ -0,0 +1,45 @@
+module Dashboard
+  module Model
+    ##
+    # Model for the table that contains the active widgets for a user.
+    #
+    # @since 12-01-2012
+    #
+    class Widget < Sequel::Model
+      many_to_one :users, :class => 'Users::Model::User'
+
+      ##
+      # Returns an integer containing the order of the last widget. If no
+      # widgets were found 0 is returned.
+      #
+      # @since  15-01-2012
+      # @param  [Fixnum] user_id The ID of the user for which to retrieve the
+      #  widget order.
+      # @return [Fixnum]
+      #
+      def self.last_order(user_id)
+        rows = select(:order) \
+          .filter(:user_id => user_id) \
+          .order(:order.desc) \
+          .limit(1) \
+          .all
+
+        if rows.empty?
+          return 0
+        else
+          return rows[0].order
+        end
+      end
+
+      ##
+      # Validates the model instance before saving it in the database.
+      #
+      # @since 13-01-2012
+      #
+      def validate
+        validates_presence([:name, :order, :user_id])
+        validates_integer(:user_id)
+      end
+    end # Widget
+  end # Model
+end # Dashboard

data/lib/zen/package/dashboard/lib/dashboard/public/admin/dashboard/css/dashboard.css

@@ -0,0 +1,74 @@
+.widget
+{
+    border:         1px solid #aaa;
+    background:     #fff;
+    float:          left;
+    margin-bottom:  30px;
+    min-height:     150px;
+    vertical-align: top;
+    width:          100%;
+}
+
+    .widget header
+    {
+        cursor:  move;
+        padding: 0px 15px!important;
+    }
+
+    .widget header h1
+    {
+        font-size: 20px;
+    }
+
+/* Different styles for the various column widths. */
+.columns_2 .widget, .columns_3 .widget, .columns_4 .widget
+{
+    margin-right: 2%;
+}
+
+.columns_2 .widget
+{
+    width: 47.9%;
+}
+
+.columns_3 .widget
+{
+    width: 30.9%;
+}
+
+.columns_4 .widget
+{
+    width: 22.9%;
+}
+
+/* Styles for the box that allows users to customize the dashboard layout. */
+#widget_options
+{
+    background:    #f2f2f2;
+    border-left:   1px solid #ccc;
+    border-right:  1px solid #ccc;
+    border-bottom: 1px solid #ccc;
+    display:       none;
+    margin:        0 15px;
+    padding:       15px;
+
+    box-shadow:         0px 0px 2px #ccc;
+    -webkit-box-shadow: 0px 0px 2px #ccc;
+    -moz-box-shadow:    0px 0px 2px #ccc;
+}
+
+    #widget_options label
+    {
+        width: 200px;
+    }
+
+    #widget_options #widget_columns
+    {
+        margin-bottom: 15px;
+    }
+
+#toggle_options
+{
+    float:  right;
+    margin: 3px 0px 0px 0px;
+}

data/lib/zen/package/dashboard/lib/dashboard/public/admin/dashboard/js/dashboard.js

@@ -0,0 +1,102 @@
+window.addEvent('domready', function()
+{
+    var widgets    = $('widgets');
+    var options_fx = new Fx.Slide('widget_options',
+    {
+        duration:   'normal',
+        transition: Fx.Transitions.Pow.easeOut
+    });
+
+    options_fx.hide();
+
+    // The options div is hidden by default, without doing this the div would be
+    // displayed for a split second before it's hidden using Fx.Slide. However,
+    // Fx.Slide doesn't use the "display" property so it has to be removed
+    // manually.
+    $('widget_options').setStyle('display', 'block');
+
+    $('toggle_options').addEvent('click', function()
+    {
+        options_fx.toggle();
+    });
+
+    // Allow users to sort the widgets.
+    var sortable_widgets = new Sortables('widgets',
+    {
+        handle:  'header',
+        opacity: 0.5,
+        revert:  true,
+        clone:   true,
+        onSort:  function(el)
+        {
+            var order = {};
+
+            // Build the new order for all the widgets. The "widget_" prefix is
+            // removed before the values are being sent to the server.
+            sortable_widgets.serialize().clean().each(function(val, index)
+            {
+                order[val.replace(/widget_/, '')] = index;
+            });
+
+            new Request(
+            {
+                url:    '/admin/widget_order',
+                method: 'POST',
+                data:   order
+            }).send();
+        }
+    });
+
+    // Update the amount of columns based on the clicked radio button.
+    $$('#widget_columns input[type="radio"]').addEvent('click', function()
+    {
+        var columns = this.get('value');
+
+        widgets.set('class', 'widgets ' + 'columns_' + columns);
+
+        new Request(
+        {
+            url:    '/admin/widget_columns',
+            method: 'POST',
+            data:   {columns: columns}
+        }).send();
+    });
+
+    // Toggle the visibility of a widget and update its state in the database.
+    $$('#active_widgets input[type="checkbox"]').addEvent('click', function()
+    {
+        var el      = $(this.get('value'));
+        var name    = this.get('value').replace(/^widget_/, '');
+        var enabled = '0';
+
+        if ( this.get('checked') === true )
+        {
+            enabled = '1';
+        }
+        else
+        {
+            if ( el ) el.destroy();
+        }
+
+        // Request.HTML doesn't really offer any benefits in this case so using
+        // plain Request is fine.
+        var request = new Request(
+        {
+            url:       '/admin/widget_state',
+            method:    'POST',
+            data:      {widget: name, enabled: enabled},
+            onSuccess: function(response)
+            {
+                if ( response && request.status === 201 )
+                {
+                    response = Elements.from(response);
+
+                    widgets.adopt(response);
+                    sortable_widgets.addItems(response);
+                }
+            }
+        });
+
+        request.send();
+    });
+});