zen 0.4.2 → 0.4.3

data/lib/zen/package/menus/lib/menus/model/menu_item.rb

@@ -13,12 +13,12 @@ module Menus
     #  end
     #
     # @since 0.2a
-    # @event before_new_menu_item
-    # @event after_new_menu_item
-    # @event before_edit_menu_item
-    # @event after_edit_menu_item
-    # @event before_delete_menu_item
-    # @event after_delete_menu_item
+    # @event before\_new\_menu\_item
+    # @event after\_new\_menu\_item
+    # @event before\_edit\_menu\_item
+    # @event after\_edit\_menu\_item
+    # @event before\_delete\_menu\_item
+    # @event after\_delete\_menu\_item
     #
     class MenuItem < Sequel::Model
       include Zen::Model::Helper
@@ -26,7 +26,7 @@ module Menus
       ##
       # Array containing the columns that can be set by the user.
       #
-      # @since 17-02-2012
+      # @since 2012-02-17
       #
       COLUMNS = [
         :parent_id, :name, :url, :sort_order, :html_class, :html_id, :menu_id
@@ -48,7 +48,7 @@ module Menus
       ##
       # Searches for a set of menu items.
       #
-      # @since  16-10-2011
+      # @since  2011-10-16
       # @param  [String] query The search query.
       # @return [Mixed]
       #
@@ -89,7 +89,7 @@ module Menus
       ##
       # Hook that is called before creating a new object.
       #
-      # @since 28-02-2012
+      # @since 2012-02-28
       #
       def before_create
         # Set the sort order based on the order of the last item.
@@ -112,7 +112,7 @@ module Menus
       ##
       # Hook that is executed before creating or saving an object.
       #
-      # @since 03-01-2012
+      # @since 2012-01-03
       #
       def before_save
         sanitize_fields([:name, :url, :html_class, :html_id])

data/lib/zen/package/menus/lib/menus/public/admin/menus/js/lib/nested_sortables.js

@@ -13,7 +13,7 @@
  * * Added the methods serializeArray() and serializeItems().
  * * Replaced various while() loops with calls to getParents() and the like.
  *
- * @since 11-02-2012
+ * @since 2012-02-11
  */
 var NestedSortables = new Class(
 {
@@ -23,7 +23,7 @@ var NestedSortables = new Class(
      * Object containing all the options that can be set in the secondary
      * parameter of the constructor.
      *
-     * @since 11-02-2012
+     * @since 2012-02-11
      */
     options:
     {
@@ -76,7 +76,7 @@ var NestedSortables = new Class(
     /**
      * Creates a new instance of the class.
      *
-     * @since 11-02-2012
+     * @since 2012-02-11
      * @param {string} list The ID of the list container.
      * @param {object} options Object containing custom options to set. See
      *  NestedSortables.options for all the available options.
@@ -105,7 +105,7 @@ var NestedSortables = new Class(
     /**
      * Starts dragging an element.
      *
-     * @since 11-02-2012
+     * @since 2012-02-11
      * @param {Event} event
      */
     start: function(event)
@@ -175,7 +175,7 @@ var NestedSortables = new Class(
     /**
      * Event that is called whenever an element is collapsed.
      *
-     * @since 11-02-2012
+     * @since 2012-02-11
      * @param {Event} event
      */
     collapse: function(event)
@@ -217,7 +217,7 @@ var NestedSortables = new Class(
     /**
      * Stops an event.
      *
-     * @since 11-02-2012
+     * @since 2012-02-11
      * @param {Event} event
      */
     stop: function(event)
@@ -229,7 +229,7 @@ var NestedSortables = new Class(
     /**
      * Gets the depth of an element.
      *
-     * @since  11-02-2012
+     * @since  2012-02-11
      * @param  {Element} el
      * @param  {boolean} add
      * @return {number}
@@ -244,7 +244,7 @@ var NestedSortables = new Class(
     /**
      * Removes the events of various elements.
      *
-     * @since 11-02-2012
+     * @since 2012-02-11
      */
     detach: function()
     {
@@ -259,7 +259,7 @@ var NestedSortables = new Class(
     /**
      * Stops the process of dragging an element.
      *
-     * @since 11-02-2012
+     * @since 2012-02-11
      * @param {Event} event
      * @param {Element} el
      */
@@ -289,7 +289,7 @@ var NestedSortables = new Class(
     /**
      * Method that is called whenever an element is being moved.
      *
-     * @since 11-02-2012
+     * @since 2012-02-11
      * @param {Event} event
      * @param {Element} el
      */
@@ -478,7 +478,7 @@ var NestedSortables = new Class(
      * there are no sub elements or an object of sub elements (with the same
      * structure).
      *
-     * @since  11-02-2012
+     * @since  2012-02-11
      * @param  {Function} fn
      * @param  {Element} base
      * @return {object}
@@ -514,7 +514,7 @@ var NestedSortables = new Class(
      * Builds an array containing all the menu items and their parent IDs. This
      * array is sorted based on the sort order specified by the user.
      *
-     * @since  11-02-2012
+     * @since  2012-02-11
      * @return {array}
      */
     serializeArray: function()
@@ -523,7 +523,7 @@ var NestedSortables = new Class(
     },
 
     /**
-     * @since 11-02-2012
+     * @since 2012-02-11
      * @see   NestedSortables.serializeArray()
      */
     serializeItems: function(items, parent_id)

data/lib/zen/package/menus/lib/menus/public/admin/menus/js/menu_items.js

@@ -4,7 +4,7 @@
  * Allows users to sort menu items and assign them to parent items by dragging
  * them.
  *
- * @since 09-02-2012
+ * @since 2012-02-09
  */
 window.addEvent('domready', function()
 {

data/lib/zen/package/sections/lib/sections.rb

@@ -20,13 +20,18 @@ Zen::Package.add do |p|
   p.permission :edit_section_entry  , 'section_entries.permissions.edit'
   p.permission :new_section_entry   , 'section_entries.permissions.new'
   p.permission :delete_section_entry, 'section_entries.permissions.delete'
+
+  p.permission :show_revision, 'revisions.permissions.show'
+  p.permission :restore_revision, 'revisions.permissions.restore'
 end
 
 require __DIR__('sections/model/section')
+require __DIR__('sections/model/revision')
 require __DIR__('sections/model/section_entry')
 require __DIR__('sections/model/section_entry_status')
 require __DIR__('sections/controller/sections')
 require __DIR__('sections/controller/section_entries')
+require __DIR__('sections/controller/revisions')
 require __DIR__('sections/widget/recent_entries')
 
 Zen::Controller::FrontendController.helper(:section_frontend)
@@ -35,3 +40,17 @@ Zen::Event.listen :post_start do
   Zen::Language.load('sections')
   Zen::Language.load('section_entries')
 end
+
+Settings::SettingsGroup.add do |group|
+  group.title = 'sections.tabs.content'
+  group.name  = :content
+end
+
+Settings::Setting.add do |setting|
+  setting.title       = 'revisions.labels.maximum'
+  setting.description = 'revisions.descriptions.maximum'
+  setting.name        = :maximum_revisions
+  setting.group       = :content
+  setting.type        = 'textbox'
+  setting.default     = 10
+end

data/lib/zen/package/sections/lib/sections/controller/revisions.rb

@@ -0,0 +1,184 @@
+module Sections
+  module Controller
+    ##
+    # In Zen a section entry's data is saved as a separate revision each time
+    # you save it manually or when it's saved automatically (every 10 minutes).
+    # Storing entries in separate revisions means you're able to revert to
+    # specific revisions by simply clicking the "Restore" link for a specific
+    # revision. No longer do you have to worry about accidently removing data
+    # without being able to easily revert that change.
+    #
+    # Revisions can be viewed as well as being restored by clicking on the
+    # "Revisions" link in the section entries overview. Once you've clicked this
+    # link you'll be presented with an overview similar to this one:
+    #
+    # ![Revisions Overview](../../images/sections/revisions.png)
+    #
+    # This overview lets you compare two revisions as well as restoring
+    # revisions.
+    #
+    # ## Comparing Revisions
+    #
+    # Comparing revisions makes it easy to see what has changed between two
+    # given revisions. In order to compare two revisions you must select the
+    # old and the new revision to compare. This can be done by checking the
+    # checkboxes in the "Old" and "New" column for the revisions you want to
+    # compare. Once you've selected the two revisions and have clicked on the
+    # "Compare" button you'll be presented with a set of differences between the
+    # two revisions.
+    #
+    # ![Revision Differences](../../images/sections/revisions_diff.png)
+    #
+    # Each field that had its value changed will be displayed with the changed
+    # data next to it. When showing such differences the following information
+    # is available for each field:
+    #
+    # * The line numbers of the old and new data. The numbers on the left are
+    #   the old line numbers, the numbers on the right are the line numbers for
+    #   the new revision.
+    # * Lines that were deleted. These are displayed in red and are prefixed
+    #   with a minus (`-`) sign.
+    # * Lines that were added. These lines are displayed in green and are
+    #   prefixed with a plus (`+`) sign.
+    #
+    # In case of the image above this means that line 1 was not changed and that
+    # lines 2 and 3 were added in the revision selected in the "New" column.
+    #
+    # A more expanded example of comparing differences between revisions:
+    #
+    # ![Revision Differences With Multiple Fields]
+    # (../../images/sections/revisions_diff_multiple.png)
+    #
+    # This example shows the result of comparing two revisions that contain
+    # changes for multiple custom fields.
+    #
+    # <div class="note todo">
+    #     <p>
+    #         <strong>Note:</strong>
+    #         If there are no differences between a revision a notice will be
+    #         displayed instead of the set of changes.
+    #     </p>
+    # </div>
+    #
+    # ## Restoring Revisions
+    #
+    # Restoring revisions makes it easy to revert a set of changes without
+    # having to manually make these changes to a section entry, or worse: fiddle
+    # around with database backups.
+    #
+    # Restoring revisions is quite easy, once you've decided which revision you
+    # want to restore all you need to do is click the "Restore" link of the
+    # specific revision. Restoring a revision will result in the following two
+    # actions:
+    #
+    # * The revision ID of the entry is set to the ID of the revision you want
+    #   to restore.
+    # * All newer revisions are deleted.
+    #
+    # ## Revision Limit
+    #
+    # Every time a section entry is saved a new revision will be created. To
+    # prevent the revisions table from filling up with thousands of revisions
+    # these revisions will be removed after a certain number has been exceeded.
+    #
+    # By default the oldest revision will be removed if there are more than 10
+    # revisions for a section entry. This limit can be changed by going to the
+    # settings manager. For more information about using the settings manager
+    # refer to {Settings::Controller::Settings Managing Settings}.
+    #
+    # @since 2012-04-30
+    # @map   /admin/revisions
+    #
+    class Revisions < Zen::Controller::AdminController
+      map    '/admin/revisions'
+      title  'revisions.titles.%s'
+      helper :section, :revision
+
+      ##
+      # Shows an overview of the revisions for a given section entry ID.
+      #
+      # @since 2012-04-30
+      # @param [Fixnum|String] section_id The ID of the section the entry
+      #  belongs to.
+      # @param [Fixnum|String] id The ID of the section entry for which to show
+      #  the revisions.
+      # @permission show_revision
+      #
+      def index(section_id, id)
+        authorize_user!(:show_revision)
+
+        validate_section(section_id)
+
+        @entry     = validate_section_entry(id, section_id)
+        @revisions = @entry.revisions
+        @entry_url = SectionEntries.a(
+          @entry.title,
+          :edit,
+          @entry.section_id,
+          @entry.id
+        )
+
+        # Compare two revisions if both IDs are specified.
+        if request.POST['old_revision_id'] and request.POST['new_revision_id']
+          @old_rev_id = request.POST['old_revision_id']
+          @new_rev_id = request.POST['new_revision_id']
+          @diff       = revision_diff(@entry, @old_rev_id, @new_rev_id)
+        end
+
+        set_breadcrumbs(
+          Sections.a(
+            lang('sections.titles.index'),
+            :index
+          ),
+          SectionEntries.a(
+            lang('section_entries.titles.index'),
+            :index,
+            section_id
+          ),
+          lang('revisions.titles.index')
+        )
+      end
+
+      ##
+      # Sets the revision ID of a section entry to a specific revision, deleting
+      # newer revisions.
+      #
+      # @since 2012-05-03
+      # @param [Fixnum|String] revision_id The ID of the revision to restore.
+      # @permission restore_revision
+      #
+      def restore(revision_id)
+        authorize_user!(:restore_revision)
+
+        revision = validate_revision(revision_id)
+
+        if revision
+          entry = revision.section_entry
+
+          begin
+            entry.update(:revision_id => revision.id)
+          rescue => e
+            Ramaze::Log.error(e)
+
+            message(:error, lang('revisions.errors.restore'))
+            redirect_referer
+          end
+
+          begin
+            Model::Revision \
+              .filter(:section_entry_id => entry.id) { id > revision.id } \
+              .delete
+
+            message(:success, lang('revisions.success.restore'))
+          rescue => e
+            Ramaze::Log.error(e)
+
+            message(:error, lang('revisions.errors.restore'))
+          end
+
+          redirect_referer
+        end
+      end
+    end # Revisions
+  end # Controller
+end # Sections

data/lib/zen/package/sections/lib/sections/controller/section_entries.rb

@@ -90,10 +90,10 @@ module Sections
     #
     # This controller uses the following permissions:
     #
-    # * show_section_entry
-    # * new_section_entry
-    # * edit_section_entry
-    # * delete_section_entry
+    # * show\_section\_entry
+    # * new\_section\_entry
+    # * edit\_section\_entry
+    # * delete\_section\_entry
     #
     # @since  0.1
     # @map    /admin/section-entries
@@ -267,7 +267,7 @@ module Sections
       # Automatically saves a section entry. This is needed to take care of the
       # custom fields, something the helper method itself can not do.
       #
-      # @since 17-02-2012
+      # @since 2012-02-17
       #
       def autosave
         entry        = Model::SectionEntry[request.params['id']]

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

@@ -5,17 +5,20 @@
 #
 # * {Sections::Controller::Sections}
 # * {Sections::Controller::SectionEntries}
+# * {Sections::Controller::Revisions}
 #
 # ## Helpers
 #
 # * {Ramaze::Helper::Section}
 # * {Ramaze::Helper::SectionFrontend}
+# * {Ramaze::Helper::Revision}
 #
 # ## Models
 #
 # * {Sections::Model::Section}
 # * {Sections::Model::SectionEntry}
 # * {Sections::Model::SectionEntryStatus}
+# * {Sections::Model::Revision}
 #
 module Sections
   #:nodoc:
@@ -127,10 +130,10 @@ module Sections
     #
     # ## Used Permissions
     #
-    # * show_section
-    # * new_section
-    # * edit_section
-    # * delete_section
+    # * show\_section
+    # * new\_section
+    # * edit\_section
+    # * delete\_section
     #
     # @since  0.1
     # @map    /admin/sections
@@ -152,10 +155,10 @@ module Sections
         }
 
         @custom_field_group_pk_hash = ::CustomFields::Model::CustomFieldGroup \
-          .pk_hash(:name).invert
+          .to_hash(:id, :name).invert
 
         @category_group_pk_hash = ::Categories::Model::CategoryGroup \
-          .pk_hash(:name).invert
+          .to_hash(:id, :name).invert
       end
 
       ##