zen 0.3 → 0.4

data/lib/zen/package/dashboard/lib/dashboard/view/admin/index.xhtml

@@ -0,0 +1,29 @@
+<section>
+    <header class="with_search">
+        <h1>#{lang('dashboard.titles.index')}</h1>
+
+        <button class="button" id="toggle_options">
+            #{lang('dashboard.buttons.options')}
+        </button>
+    </header>
+
+    <div id="widget_options">
+        <div id="widget_columns">
+            <label>#{lang('dashboard.labels.columns')}</label>
+
+            #{Dashboard::Widget.columns_html}
+        </div>
+
+        <div id="active_widgets">
+            <label>#{lang('dashboard.labels.active_widgets')}</label>
+
+            #{Dashboard::Widget.checkbox_html}
+        </div>
+    </div>
+
+    <div class="body">
+        <div id="widgets" class="columns_#{user.widget_columns}">
+            #{Dashboard::Widget.html}
+        </div>
+    </div>
+</section>

data/lib/zen/package/dashboard/lib/dashboard/view/admin/widget/welcome.xhtml

@@ -0,0 +1,28 @@
+<p>#{lang('dashboard.widgets.welcome.content.paragraph_1' ) % Zen::VERSION}</p>
+
+<p>#{lang('dashboard.widgets.welcome.content.paragraph_2')}</p>
+
+<p>#{lang('dashboard.widgets.welcome.content.paragraph_3')}</p>
+
+<ul>
+    <li>
+        <a href="http://zen-cms.com/documentation/index.html"
+        title="#{lang('dashboard.labels.documentation')}">
+            #{lang('dashboard.labels.documentation')}
+        </a>
+    </li>
+
+    <li>
+        <a href="http://github.com/zen-cms/zen-core"
+        title="#{lang('dashboard.labels.github')}">
+            #{lang('dashboard.labels.github')}
+        </a>
+    </li>
+
+    <li>
+        <a href="https://groups.google.com/forum/#!forum/zen-cms"
+        title="#{lang('dashboard.labels.mailing_list')}">
+            #{lang('dashboard.labels.mailing_list')}
+        </a>
+    </li>
+</ul>

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

@@ -0,0 +1,292 @@
+module Dashboard
+  # Error class for the widgets system.
+  class WidgetError < StandardError; end
+
+  ##
+  # Widgets are small blocks of content displayed on a user's dashboard. These
+  # widgets can contain data such as recent entries, a help message or a graph
+  # showing the website's traffic.
+  #
+  # In order to create a new widget you should call {Dashboard::Widget.add} and
+  # pass a block to it. In this block you can set the following attributes:
+  #
+  # * name: the unique name of the widget.
+  # * title: the title of the widget, can either be a language string or a
+  #   regular one.
+  # * data: an object that responds to ``#call()`` and returns the content of
+  #   the widget. This object is evaluated in the context of the current
+  #   controller instance ({Dashboard::Controller::Dashboard}). If you're using
+  #   a lambda you *have to* specify a first parameter as ``#instance_eval``
+  #   will always pass the evaluated instance as a parameter. If you don't want
+  #   to do this you can use ``Proc.new { }`` or simply ``proc { }`` as an
+  #   alternative.
+  #
+  # An example of adding a widget is the following:
+  #
+  #     Dashboard::Widget.add do |w|
+  #       w.name  = :example_widget
+  #       w.title = 'dashboard.titles.example_widget'
+  #       w.data  = lambda do |instance|
+  #         return render_view(:example_view)
+  #       end
+  #     end
+  #
+  # Once a widget has been registered it can be retrieved using
+  # {Dashboard::Widget#[]}:
+  #
+  #     Dashboard::Widget[:example_widget] # => <Dashboard::Widget ...>
+  #
+  # @since 08-01-2012
+  #
+  class Widget
+    include Zen::Validation
+    include Ramaze::Trinity
+    include Ramaze::Helper::ACL
+
+    # Hash containing all the registered widgets.
+    REGISTERED = {}
+
+    # Array containing the amount of widget columns.
+    COLUMNS = [1, 2, 3, 4]
+
+    # The name of the widget as a symbol.
+    attr_reader :name
+
+    # The title of the widget (displayed on the dashboard).
+    attr_writer :title
+
+    # A permission required to view a widget.
+    attr_accessor :permission
+
+    # An object that responds to #call() and returns the content of the widget.
+    # When called the first parameter is set to ``Ramaze::Current.action``
+    # allowing you to use methods such as ``render_view``.
+    attr_accessor :data
+
+    class << self
+      ##
+      # Adds a new widget. Widgets are defined as following:
+      #
+      #     Dashboard::Widget.add do |w|
+      #       w.name  = :recent_entries
+      #       w.title = 'Recent Entries'
+      #       w.data  = lambda do |action|
+      #         return action.node.render_view(:example)
+      #       end
+      #     end
+      #
+      # @since 08-01-2012
+      #
+      def add
+        widget = self.new
+
+        yield(widget)
+        widget.validate
+
+        REGISTERED[widget.name] = widget
+      end
+
+      ##
+      # Retrieves the widget for the given name.
+      #
+      # @example
+      #  Dashboard::Widget[:recent_entries]
+      #
+      # @since 08-01-2012
+      #
+      def [](name)
+        name = name.to_sym
+
+        unless REGISTERED.key?(name)
+          raise(WidgetError, "The widget \"#{name}\" does not exist")
+        end
+
+        return REGISTERED[name]
+      end
+
+      ##
+      # Generates the HTML for all active widgets and sorts them by the user's
+      # sort order.
+      #
+      # @since  14-01-2012
+      # @return [String]
+      #
+      def html
+        html    = ''
+        widgets = Dashboard::Model::Widget.select(:name) \
+          .filter(:user_id => user.id) \
+          .order(:order.asc)
+
+        widgets.each do |row|
+          name  = row.name
+          html += Widget[name].html if Widget[name].allowed?
+        end
+
+        return html
+      end
+
+      ##
+      # Builds the HTML for the radio buttons that can be used to change the
+      # amount of widget columns.
+      #
+      # @since  15-01-2012
+      # @return [String]
+      #
+      def columns_html
+        g       = Ramaze::Gestalt.new
+        current = user.widget_columns
+
+        COLUMNS.each do |c|
+          params = {
+            :name  => 'widget_columns',
+            :type  => 'radio',
+            :value => c,
+            :id    => 'widget_columns_%s' % c
+          }
+
+          params[:checked] = 'checked' if c == current
+
+          g.span(:class => 'radio_wrap') do
+            g.input(params)
+
+            g.out << c
+          end
+        end
+
+        return g.to_s
+      end
+
+      ##
+      # Generates a chunk of HTML that contains various checkboxes to toggle the
+      # state of all widgets.
+      #
+      # @since  14-01-2012
+      # @return [String]
+      #
+      def checkbox_html
+        g      = Ramaze::Gestalt.new
+        active = Dashboard::Model::Widget.select(:name) \
+          .filter(:user_id => user.id) \
+          .map { |r| r.name.to_sym }
+
+        REGISTERED.each do |name, widget|
+          next unless widget.allowed?
+
+          params = {
+            :type  => 'checkbox',
+            :name  => 'active_widgets[]',
+            :value => 'widget_%s' % name,
+            :id    => 'toggle_widget_%s' % name
+          }
+
+          params[:checked] = 'checked' if active.include?(name)
+
+          g.span(:class => 'checkbox_wrap') do
+            g.input(params)
+
+            g.out << widget.title
+          end
+        end
+
+        return g.to_s
+      end
+
+      private
+
+      ##
+      # Returns the current user model.
+      #
+      # @since  15-01-2012
+      # @return [Users::Model::User]
+      def user
+        return Ramaze::Current.action.node.request.env[
+          Ramaze::Helper::UserHelper::RAMAZE_HELPER_USER
+        ]
+      end
+    end # class << self
+
+    ##
+    # Sets the name of the widget and converts it to a symbol.
+    #
+    # @since 11-01-2012
+    # @param [#to_sym] name The name of the widget.
+    #
+    def name=(name)
+      @name = name.to_sym
+    end
+
+    ##
+    # Returns the title of the widget. If the title is set to a valid language
+    # string the value of that string is returned, otherwise the raw title is
+    # returned.
+    #
+    # @since  11-01-2012
+    # @return [String]
+    #
+    def title
+      begin
+        return lang(@title)
+      rescue
+        return @title
+      end
+    end
+
+    ##
+    # Checks if the user is allowed to view the current widget.
+    #
+    # @since  16-01-2012
+    # @return [TrueClass|Falseclass]
+    #
+    def allowed?
+      return true if @permission.nil?
+      return user_authorized?(@permission)
+    end
+
+    ##
+    # Validates the instance of the widget.
+    #
+    # @since 11-01-2012
+    #
+    def validate
+      validates_presence([:name, :title, :data])
+
+      if REGISTERED.key?(name)
+        raise(Zen::ValidationError, "The widget \"#{name}\" already exists")
+      end
+    end
+
+    ##
+    # Returns a string containing the full HTML for the widget. The HTML of each
+    # widget looks like the following:
+    #
+    #     <section class="widget" id="widget_example">
+    #         <header>
+    #             <h1>Example</h1>
+    #         </header>
+    #
+    #         <div class="body">
+    #             Widget content
+    #         </div>
+    #     </section>
+    #
+    # @since  12-01-2012
+    # @return [String]
+    #
+    def html
+      g      = Ramaze::Gestalt.new
+      action = Ramaze::Current.action
+
+      g.section(:class => 'widget', :id => 'widget_' + name.to_s) do
+        g.header do
+          g.h1(title)
+        end
+
+        g.div(:class => 'body') do
+          action.instance.instance_eval(&data)
+        end
+      end
+
+      return g.to_s
+    end
+  end # Widget
+end # Dashboard

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

@@ -0,0 +1,9 @@
+# The welcome widget shows a welcome message explaining a few things about Zen.
+# It also shows a list of links to common resources such as the documentation.
+Dashboard::Widget.add do |w|
+  w.name  = :welcome
+  w.title = 'dashboard.widgets.titles.welcome'
+  w.data  = lambda do |instance|
+    return render_file(__DIR__('../view/admin/widget/welcome.xhtml'))
+  end
+end

data/lib/zen/package/dashboard/migrations/1326411254_create_schema.rb

@@ -0,0 +1,28 @@
+Sequel.migration do
+  up do
+    create_table :widgets do
+      primary_key :id
+
+      String  :name,  :null => false
+      Integer :order, :null => false
+
+      foreign_key :user_id, :users, :on_delete => :cascade,
+        :on_update => :cascade, :key => :id
+    end
+
+    add_column :users, :widget_columns, Integer, :default => 1
+
+    rows = []
+
+    Zen.database[:users].select(:id).each do |user|
+      rows << {:user_id => user[:id], :order => 0, :name => 'welcome'}
+    end
+
+    Zen.database[:widgets].multi_insert(rows)
+  end
+
+  down do
+    drop_table  :widgets
+    drop_column :users, :widget_columns
+  end
+end

data/lib/zen/package/extensions/lib/extensions.rb

@@ -6,15 +6,15 @@ Zen::Package.add do |p|
   p.about  = 'extensions.description'
   p.root   = __DIR__('extensions')
 
-  p.menu(
-    'extensions.titles.index',
+  p.menu 'extensions.titles.index',
     '/admin/extensions',
     :permission => :show_extension
-  )
 
   p.permission :show_extension, 'extensions.permissions.show'
 end
 
-Zen::Language.load('extensions')
-
 require __DIR__('extensions/controller/extensions')
+
+Zen::Event.listen :post_start do
+  Zen::Language.load('extensions')
+end

data/lib/zen/package/extensions/lib/extensions/view/admin/extensions/index.xhtml

@@ -6,81 +6,86 @@
     <div class="tabs">
         <ul>
             <li>
-                <a href="#packages">#{lang('extensions.labels.packages')}</a>
+                <a class="icon box"
+                href="#packages">#{lang('extensions.labels.packages')}</a>
             </li>
             <li>
-                <a href="#themes">#{lang('extensions.labels.themes')}</a>
+                <a class="icon template"
+                href="#themes">#{lang('extensions.labels.themes')}</a>
             </li>
             <li>
-                <a href="#languages">#{lang('extensions.labels.languages')}</a>
+                <a class="icon globe"
+                href="#languages">#{lang('extensions.labels.languages')}</a>
             </li>
         </ul>
     </div>
 
-    <div id="packages">
-        <table class="no_sort">
-            <thead>
-                <tr>
-                    <th>#{lang('extensions.labels.package')}</th>
-                    <th>#{lang('extensions.labels.author')}</th>
-                    <th>#{lang('extensions.labels.description')}</th>
-                </tr>
-            </thead>
-            <tbody>
-                <?r Zen::Package::REGISTERED.each do |name, package| ?>
-                <tr>
-                    <td>#{package.formatted_title}</td>
-                    <td>#{package.author}</td>
-                    <td>#{package.about}</td>
-                </tr>
-                <?r end ?>
-            </tbody>
-        </table>
-    </div>
+    <div class="body">
+        <div id="packages">
+            <table class="no_sort">
+                <thead>
+                    <tr>
+                        <th>#{lang('extensions.labels.package')}</th>
+                        <th>#{lang('extensions.labels.author')}</th>
+                        <th>#{lang('extensions.labels.description')}</th>
+                    </tr>
+                </thead>
+                <tbody>
+                    <?r Zen::Package::REGISTERED.each do |name, package| ?>
+                    <tr>
+                        <td>#{package.formatted_title}</td>
+                        <td>#{package.author}</td>
+                        <td>#{package.about}</td>
+                    </tr>
+                    <?r end ?>
+                </tbody>
+            </table>
+        </div>
 
-    <div id="themes">
-        <table class="no_sort">
-            <thead>
-                <tr>
-                    <th>#{lang('extensions.labels.theme')}</th>
-                    <th>#{lang('extensions.labels.author')}</th>
-                    <th>#{lang('extensions.labels.description')}</th>
-                </tr>
-            </thead>
-            <tbody>
-                <?r Zen::Theme::REGISTERED.each do |name, theme| ?>
-                <tr>
-                    <td>#{theme.formatted_name}</td>
-                    <td>#{theme.author}</td>
-                    <td>#{theme.about}</td>
-                </tr>
-                <?r end ?>
-            </tbody>
-        </table>
-    </div>
+        <div id="themes">
+            <table class="no_sort">
+                <thead>
+                    <tr>
+                        <th>#{lang('extensions.labels.theme')}</th>
+                        <th>#{lang('extensions.labels.author')}</th>
+                        <th>#{lang('extensions.labels.description')}</th>
+                    </tr>
+                </thead>
+                <tbody>
+                    <?r Zen::Theme::REGISTERED.each do |name, theme| ?>
+                    <tr>
+                        <td>#{theme.formatted_name}</td>
+                        <td>#{theme.author}</td>
+                        <td>#{theme.about}</td>
+                    </tr>
+                    <?r end ?>
+                </tbody>
+            </table>
+        </div>
 
-    <div id="languages">
-        <table class="no_sort">
-            <thead>
-                <tr>
-                    <th>#{lang('extensions.labels.language')}</th>
-                    <th>#{lang('extensions.labels.rtl')}</th>
-                    <th>#{lang('extensions.labels.loaded_translations')}</th>
-                </tr>
-            </thead>
-            <tbody>
-                <?r Zen::Language::REGISTERED.each do |name, lang| ?>
-                <tr>
-                    <td>#{lang.title}</td>
-                    <td>
-                        #{lang(
-                          "zen_general.special.boolean_hash.#{lang.rtl}"
-                        )}
-                    </td>
-                    <td>#{lang.collections.keys.length}</td>
-                </tr>
-                <?r end ?>
-            </tbody>
-        </table>
-    </div>
+        <div id="languages">
+            <table class="no_sort">
+                <thead>
+                    <tr>
+                        <th>#{lang('extensions.labels.language')}</th>
+                        <th>#{lang('extensions.labels.rtl')}</th>
+                        <th>#{lang('extensions.labels.loaded_translations')}</th>
+                    </tr>
+                </thead>
+                <tbody>
+                    <?r Zen::Language::REGISTERED.each do |name, lang| ?>
+                    <tr>
+                        <td>#{lang.title}</td>
+                        <td>
+                            #{lang(
+                              "zen_general.special.boolean_hash.#{lang.rtl}"
+                            )}
+                        </td>
+                        <td>#{lang.collections.keys.length}</td>
+                    </tr>
+                    <?r end ?>
+                </tbody>
+            </table>
+        </div>
+</div>
 </section>