zen 0.4.2 → 0.4.3

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

@@ -5,12 +5,12 @@ module Sections
     # Model that represents a single section.
     #
     # @since 0.1
-    # @event before_new_section
-    # @event after_new_section
-    # @event before_edit_section
-    # @event after_edit_section
-    # @event before_delete_section
-    # @event after_delete_section
+    # @event before\_new\_section
+    # @event after\_new\_section
+    # @event before\_edit\_section
+    # @event after\_edit\_section
+    # @event before\_delete\_section
+    # @event after\_delete\_section
     #
     class Section < Sequel::Model
       include Zen::Model::Helper
@@ -18,7 +18,7 @@ module Sections
       ##
       # Array containing all the columns that can be set by the user.
       #
-      # @since 17-02-2012
+      # @since 2012-02-17
       #
       COLUMNS = [
         :name,
@@ -64,7 +64,7 @@ module Sections
       # @example
       #  Sections::Model::Section.search('pages')
       #
-      # @since  16-10-2011
+      # @since  2011-10-16
       # @param  [String] query The search query.
       # @return [Mixed]
       #
@@ -101,7 +101,7 @@ module Sections
       ##
       # Hook that is executed before creating or saving an object.
       #
-      # @since 03-01-2012
+      # @since 2012-01-03
       #
       def before_save
         sanitize_fields([:name, :slug, :description, :comment_format])

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

@@ -5,12 +5,12 @@ module Sections
     # Model that represents a singe section entry.
     #
     # @since 0.1
-    # @event before_new_section_entry
-    # @event after_new_section_entry
-    # @event before_edit_section_entry
-    # @event after_edit_section_entry
-    # @event before_delete_section_entry
-    # @event after_delete_section_entry
+    # @event before\_new\_section\_entry
+    # @event after\_new\_section\_entry
+    # @event before\_edit\_section\_entry
+    # @event after\_edit\_section\_entry
+    # @event before\_delete\_section\_entry
+    # @event after\_delete\_section\_entry
     #
     class SectionEntry < Sequel::Model
       include Zen::Model::Helper
@@ -18,7 +18,7 @@ module Sections
       ##
       # Array containing all the columns that can be set by the user.
       #
-      # @since 17-02-2012
+      # @since 2012-02-17
       #
       COLUMNS = [
         :title,
@@ -37,6 +37,11 @@ module Sections
         :class => 'CustomFields::Model::CustomFieldValue',
         :eager => [:custom_field]
 
+      one_to_many :revisions,
+        :class => 'Sections::Model::Revision',
+        :eager => [:user],
+        :order => :id.desc
+
       many_to_one :user,
         :class => 'Users::Model::User'
 
@@ -76,7 +81,7 @@ module Sections
       # Searches for a set of section entries based on the specified search
       # query.
       #
-      # @since  16-10-2011
+      # @since  2011-10-16
       # @param  [String] query The search query.
       # @return [Mixed]
       #
@@ -217,9 +222,11 @@ module Sections
         # Index the custom field values hash so that the keys are the IDs of the
         # custom fields and the values the instances of
         # CustomFields::Model::CustomFieldValue.
-        custom_field_values.each do |val|
-          values[val.custom_field_id] = val
-        end
+        CustomFields::Model::CustomFieldValue \
+          .filter(:section_entry_id => id, :revision_id => revision_id) \
+          .each do |val|
+            values[val.custom_field_id] = val
+          end
 
         # Build the hash containing all the details of each field
         groups.each do |group|
@@ -244,11 +251,39 @@ module Sections
         return result
       end
 
+      ##
+      # Returns a hash containing all custom fields and their values for a given
+      # revision. The keys of the has are the IDs of the custom fields, the
+      # values are hashes with two keys:
+      #
+      # * :name
+      # * :value
+      #
+      # @since  2012-04-30
+      # @param  [Fixnum] rev_id The ID of the revision for which to
+      #  retrieve the fields and values.
+      # @return [Array]
+      #
+      def custom_fields_and_values(rev_id = revision_id)
+        fields = {}
+        values = CustomFields::Model::CustomFieldValue \
+          .filter(:section_entry_id => id, :revision_id => rev_id) \
+          .eager(:custom_field) \
+          .all
+
+        values.each do |value|
+          field            = value.custom_field
+          fields[field.id] = {:name => field.name, :value => value.value}
+        end
+
+        return fields
+      end
+
       ##
       # Returns a string containing the name of the entry's status in the
       # currently used language.
       #
-      # @since  17-12-2011
+      # @since  2011-12-17
       # @return [String]
       #
       def status_name

data/lib/zen/package/sections/lib/sections/view/admin/revisions/index.xhtml

@@ -0,0 +1,89 @@
+<section>
+    <header>
+        <h1>#{get_breadcrumbs}</h1>
+    </header>
+
+    <div class="body">
+        <?r if @diff ?>
+
+        <h2>#{lang('revisions.titles.differences')}</h2>
+
+        <?r if !@diff.empty? ?>
+
+        <table class="no_sort no_background">
+            <tbody>
+                <?r @diff.each do |name, diff| ?>
+                <tr>
+                    <td>#{name}</td>
+                    <td>#{diff}</td>
+                </tr>
+                <?r end ?>
+            </tbody>
+        </table>
+
+        <?r else ?>
+
+        <p>#{lang('revisions.messages.no_differences')}</p>
+
+        <?r end ?>
+
+        <?r end ?>
+
+        <?r if @revisions and !@revisions.empty? ?>
+
+        <h2>#{lang('revisions.titles.revisions_for') % @entry_url}</h2>
+
+        <form method="post" action="#{Sections::Controller::Revisions.r(
+          :index,
+          @entry.section_id,
+          @entry.id
+        )}">
+
+            <table class="no_sort">
+                <thead>
+                    <tr>
+                        <th class="narrow">#{lang('revisions.labels.old')}</th>
+                        <th class="narrow">#{lang('revisions.labels.new')}</th>
+                        <th>#{lang('revisions.labels.id')}</th>
+                        <th>#{lang('revisions.labels.user')}</th>
+                        <th>#{lang('revisions.labels.created_at')}</th>
+                        <th></th>
+                    </tr>
+                </thead>
+                <tbody>
+                    <?r @revisions.each do |rev| ?>
+                    <tr>
+                        <td>
+                            #{old_revision_radio(rev.id, @old_rev_id)}
+                        </td>
+                        <td>
+                            #{new_revision_radio(rev.id, @new_rev_id)}
+                        </td>
+                        <td>#{rev.id}</td>
+                        <td>#{rev.user.name}</td>
+                        <td>#{format_date(rev.created_at)}</td>
+                        <td>
+                            <a href="#{Sections::Controller::Revisions.r(
+                              :restore,
+                              rev.id
+                            )}" class="icon undo">
+                                #{lang('revisions.labels.restore')}
+                            </a>
+                        </td>
+                    </tr>
+                    <?r end ?>
+                </tbody>
+            </table>
+
+            <input type="submit" class="button"
+            value="#{lang('revisions.buttons.compare')}" />
+
+        </form>
+
+        <?r else ?>
+
+        <p>#{lang('revisions.messages.no_revisions')}</p>
+
+        <?r end ?>
+    </div>
+</section>

data/lib/zen/package/sections/lib/sections/view/admin/section-entries/form.xhtml

@@ -72,7 +72,7 @@
             f.select(
               lang('section_entries.labels.author'),
               :user_id,
-              :values   => ::Users::Model::User.pk_hash(:name),
+              :values   => ::Users::Model::User.to_hash(:id, :name),
               :size     => 1,
               :required => :required,
               :selected => @entry.user_id

data/lib/zen/package/sections/lib/sections/view/admin/section-entries/index.xhtml

@@ -29,6 +29,7 @@
                         <th>#{lang('section_entries.labels.status')}</th>
                         <th>#{lang('section_entries.labels.created_at')}</th>
                         <th>#{lang('section_entries.labels.updated_at')}</th>
+                        <th></th>
                     </tr>
                 </thead>
                 <tbody>
@@ -62,6 +63,19 @@
                         <td>#{entry.status_name}</td>
                         <td>#{format_date(entry.created_at)}</td>
                         <td>#{format_date(entry.updated_at)}</td>
+
+                        <?r if user_authorized?(:show_revision) ?>
+                        <td>
+                            #{manage_link(
+                              Sections::Controller::Revisions.r(
+                                :index,
+                                entry.section_id,
+                                entry.id
+                              ),
+                              lang('revisions.titles.index')
+                            )}
+                        </td>
+                        <?r end ?>
                     </tr>
                     <?r end ?>
                 </tbody>

data/lib/zen/package/sections/migrations/1335711557_revisions.rb

@@ -0,0 +1,40 @@
+Sequel.migration do
+  up do
+    create_table :revisions do
+      primary_key :id
+
+      Time :created_at
+
+      foreign_key :user_id,
+        :users,
+        :on_delete => :cascade,
+        :on_update => :cascade,
+        :key       => :id
+
+      foreign_key :section_entry_id,
+        :section_entries,
+        :on_delete => :cascade,
+        :on_update => :cascade,
+        :key       => :id
+    end
+
+    alter_table :section_entries do
+      add_foreign_key :revision_id, :revisions,
+        :on_update => :cascade,
+        :on_delete => :set_null,
+        :key       => :id
+    end
+  end
+
+  down do
+    alter_table :section_entries do
+      if Zen.database.database_type.to_s.include?('mysql')
+        drop_constraint :custom_field_values_ibfk_4, :type => :foreign_key
+      end
+
+      drop_column :revision_id
+    end
+
+    drop_table :revisions
+  end
+end

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

@@ -90,6 +90,14 @@ module Settings
     #                 When set users are allowed to register user accounts.
     #             </td>
     #         </tr>
+    #         <tr>
+    #             <td>Revision amount</td>
+    #             <td>
+    #                 The maximum amount of revisions to keep for each section
+    #                 entry. After this limit has been exceeded the oldest
+    #                 revision will be removed.
+    #             </td>
+    #         </tr>
     #     </tbody>
     # </table>
     #
@@ -97,8 +105,8 @@ module Settings
     #
     # This controller uses the following permissions:
     #
-    # * show_setting
-    # * edit_setting
+    # * show\_setting
+    # * edit\_setting
     #
     # ## Events
     #
@@ -116,7 +124,7 @@ module Settings
     #
     # @since  0.1
     # @map    /admin/settings
-    # @event  after_edit_setting
+    # @event  after\_edit\_setting
     #
     class Settings < Zen::Controller::AdminController
       map   '/admin/settings'
@@ -156,7 +164,7 @@ module Settings
       #
       # @since      0.1
       # @permission edit_setting
-      # @event      after_edit_setting
+      # @event      after\_edit\_setting
       #
       def save
         authorize_user!(:edit_setting)

data/lib/zen/package/settings/lib/settings/setting.rb

@@ -46,7 +46,7 @@ module Settings
   # * checkbox
   # * date
   # * select
-  # * select_multiple
+  # * select\_multiple
   #
   # ## Migrating Settings
   #
@@ -158,7 +158,7 @@ module Settings
       # values of these settings will also be removed from the database.
       #
       # @since  0.2.5
-      # @param  [Array] namese An array with setting names to remove.
+      # @param  [Array] names An array with setting names to remove.
       #
       def remove(names)
         if names.class != Array
@@ -241,7 +241,7 @@ module Settings
     ##
     # Returns the description of the setting and translates it.
     #
-    # @since  13-11-2011
+    # @since  2011-11-13
     # @return [String]
     #
     def description
@@ -331,7 +331,7 @@ module Settings
     #
     #     get_setting(:allow_registration).true?
     #
-    # @since  12-11-2011
+    # @since  2011-11-12
     # @return [TrueClass|FalseClass]
     #
     def true?
@@ -344,7 +344,7 @@ module Settings
     # Serializes a value using Marshal and packs it so that it can be stored in
     # the database.
     #
-    # @since  13-11-2011
+    # @since  2011-11-13
     # @param  [Mixed] value The value to serialize.
     # @return [String]
     #
@@ -356,7 +356,7 @@ module Settings
     # Unserializes a value that was serialized using
     # {Settings::Setting#serialize}.
     #
-    # @since  13-11-2011
+    # @since  2011-11-13
     # @param  [String] value The value to unserialize.
     # @return [Mixed]
     #

data/lib/zen/package/users/lib/users/controller/user_groups.rb

@@ -75,10 +75,10 @@ module Users
     #
     # This controller uses the following permissions:
     #
-    # * show_user_group
-    # * edit_user_group
-    # * new_user_group
-    # * delete_user_group
+    # * show\_user\_group
+    # * edit\_user\_group
+    # * new\_user\_group
+    # * delete\_user\_group
     #
     # @since  0.1
     # @map    /admin/user-groups

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

@@ -135,16 +135,16 @@ module Users
     #
     # This controller uses the following permissions:
     #
-    # * show_user
-    # * new_user
-    # * edit_user
-    # * delete_user
+    # * show\_user
+    # * new\_user
+    # * edit\_user
+    # * delete\_user
     #
     # @since  0.1
     # @map    /admin/users
-    # @event  user_login
-    # @event  before_register_user
-    # @event  after_register_user
+    # @event  user\_login
+    # @event  before\_register\_user
+    # @event  after\_register\_user
     #
     class Users < Zen::Controller::AdminController
       helper :users, :layout
@@ -202,7 +202,7 @@ module Users
         @user = validate_user(id)
         @user.set(flash[:form_data]) if flash[:form_data]
 
-        @user_group_pks = Model::UserGroup.pk_hash(:name).invert
+        @user_group_pks = Model::UserGroup.to_hash(:id, :name).invert
         @permissions    = @user.permissions.map { |p| p.permission.to_sym }
 
         render_view(:form)
@@ -223,7 +223,7 @@ module Users
         )
 
         @user           = Model::User.new
-        @user_group_pks = Model::UserGroup.pk_hash(:name).invert
+        @user_group_pks = Model::UserGroup.to_hash(:id, :name).invert
 
         @user.set(flash[:form_data]) if flash[:form_data]
 
@@ -234,7 +234,7 @@ module Users
       # Show a form that allows a user to log in.
       #
       # @since  0.1
-      # @event  user_login
+      # @event  user\_login
       #
       def login
         if request.post?
@@ -277,8 +277,8 @@ module Users
       # specified by the user.
       #
       # @since 0.3
-      # @event before_register_user
-      # @event after_register_user
+      # @event before\_register\_user
+      # @event after\_register\_user
       #
       def register
         redirect(Dashboard::Controller::Dashboard.r(:index)) if logged_in?