##
# Package for the user's dashboard.
#
# ## Controllers
#
# * {Dashboard::Controller::Dashboard}
#
# ## Models
#
# * {Dashboard::Model::Widget}
#
# ## Generic Modules & Classes
#
# * {Dashboard::Widget}
# * {Dashboard::WidgetError}
#
# @since 2012-01-16
#
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 rearranged,
    # 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 2012-01-08
    # @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 2012-01-08
      #
      def index; end

      ##
      # Updates the sort order of all the widgets for the currently logged in
      # user.
      #
      # @since 2012-01-15
      #
      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 2012-01-15
      #
      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 2012-01-15
      #
      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