zen 0.3 → 0.4

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

@@ -7,7 +7,9 @@ Zen::Package.add do |p|
   p.root       = __DIR__('sections')
   p.migrations = __DIR__('../migrations')
 
-  p.menu('sections.titles.index', '/admin', :permission => :show_section)
+  p.menu 'sections.titles.index',
+    '/admin/sections',
+    :permission => :show_section
 
   p.permission :show_section  , 'sections.permissions.show'
   p.permission :edit_section  , 'sections.permissions.edit'
@@ -20,13 +22,16 @@ Zen::Package.add do |p|
   p.permission :delete_section_entry, 'section_entries.permissions.delete'
 end
 
-Zen::Language.load('sections')
-Zen::Language.load('section_entries')
-
 require __DIR__('sections/model/section')
 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/widget/recent_entries')
 
 Zen::Controller::FrontendController.helper(:section_frontend)
+
+Zen::Event.listen :post_start do
+  Zen::Language.load('sections')
+  Zen::Language.load('section_entries')
+end

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

@@ -1,3 +1,5 @@
+require 'time'
+
 module Sections
   #:nodoc:
   module Controller
@@ -10,17 +12,17 @@ module Sections
     # "Manage entries". This will bring you to an overview of all existing
     # entries that looks like the one in the image below.
     #
-    # ![Section Entries](../../_static/sections/entries.png)
+    # ![Section Entries](../../images/sections/entries.png)
     #
     # Editing an entry can be done by clicking on it's name, creating a new one
     # can be done by clicking on the "Add section entry" button. In both cases
     # you'll see a form that looks similar to the one displayed in the images
     # below.
     #
-    # ![Edit Entry](../../_static/sections/edit_entry.png)
-    # ![Categories](../../_static/sections/edit_entry_categories.png)
-    # ![General](../../_static/sections/edit_entry_general.png)
-    # ![Meta](../../_static/sections/edit_entry_meta.png)
+    # ![Edit Entry](../../images/sections/edit_entry.png)
+    # ![Categories](../../images/sections/edit_entry_categories.png)
+    # ![General](../../images/sections/edit_entry_general.png)
+    # ![Meta](../../images/sections/edit_entry_meta.png)
     #
     # In the images above there are four tabs displayed. "Basic", "Categories",
     # "General" and "Meta". The first two are always available, the last two
@@ -54,21 +56,8 @@ module Sections
     # * edit_section_entry
     # * delete_section_entry
     #
-    # ## Events
-    #
-    # All events in this controller receive an instance of
-    # {Sections::Model::SectionEntry}. The event ``after_delete_section_entry``
-    # receives an instance of this model that has already been destroyed using
-    # ``#destroy()``.
-    #
     # @since  0.1
     # @map    /admin/section-entries
-    # @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 SectionEntries < Zen::Controller::AdminController
       map    '/admin/section-entries'
@@ -76,7 +65,7 @@ module Sections
       title  'section_entries.titles.%s'
 
       load_asset_group [:tabs, :editor, :datepicker], [:edit, :new]
-      csrf_protection  :save, :delete
+      csrf_protection  :save, :delete, :autosave
 
       ##
       # Show an overview of all entries for the current section.
@@ -130,15 +119,10 @@ module Sections
 
         validate_section(section_id)
 
-        @section_id  = section_id
+        @section_id = section_id
+        @entry      = Model::SectionEntry.new(:section_id => section_id)
 
-        if flash[:form_data]
-          @entry = flash[:form_data]
-        else
-          @entry = ::Sections::Model::SectionEntry.new(
-            :section_id => section_id
-          )
-        end
+        @entry.set(flash[:form_data]) if flash[:form_data]
 
         @possible_categories = @entry.possible_categories
         @custom_fields_hash  = @entry.custom_fields_hash
@@ -169,11 +153,8 @@ module Sections
 
         validate_section(section_id)
 
-        if flash[:form_data]
-          @entry = flash[:form_data]
-        else
-          @entry = validate_section_entry(entry_id, section_id)
-        end
+        @entry = validate_section_entry(entry_id, section_id)
+        @entry.set(flash[:form_data]) if flash[:form_data]
 
         @section_id          = section_id
         @possible_categories = @entry.possible_categories
@@ -187,141 +168,111 @@ module Sections
       # creates a new entry.
       #
       # @since      0.1
-      # @event      before_new_section_entry
-      # @event      after_new_section_entry
-      # @event      before_edit_section_entry
-      # @event      after_edit_section_entry
       # @permission edit_section_entry (when editing an entry)
       # @permission new_section_entry (when creating a new entry)
       #
       def save
+        post_data  = post_fields(*Model::SectionEntry::COLUMNS)
         section_id = request.params['section_id']
 
-        validate_section(section_id)
+        if post_data['created_at']
+          post_data['created_at'] = Time.strptime(
+            post_data['created_at'],
+            Model::SectionEntry::DATE_FORMAT
+          )
+        end
 
         if request.params['id'] and !request.params['id'].empty?
           authorize_user!(:edit_section_entry)
 
-          entry        = ::Sections::Model::SectionEntry[request.params['id']]
-          save_action  = :save
-          before_event = :before_edit_section_entry
-          after_event  = :after_edit_section_entry
-
-          # Section entries aren't considered to be updated whenever a custom
-          # field value is modified, this solves that problem
-          request.params['updated_at'] = Time.new
+          entry       = validate_section_entry(request.params['id'], section_id)
+          save_action = :save
         else
           authorize_user!(:new_section_entry)
 
-          entry = ::Sections::Model::SectionEntry.new(:section_id => section_id)
-          before_event = :before_new_section_entry
-          after_event  = :after_new_section_entry
-          save_action  = :new
+          entry       = Model::SectionEntry.new(:section_id => section_id)
+          save_action = :new
         end
 
-        request.params.delete('id')
-
-        success       = lang("section_entries.success.#{save_action}")
-        error         = lang("section_entries.errors.#{save_action}")
-        custom_fields = entry.custom_fields
-        field_errors  = {}
-        field_values  = {}
-
-        entry.custom_field_values.each do |value|
-          field_values[value.custom_field_id] = value
-        end
+        success      = lang("section_entries.success.#{save_action}")
+        error        = lang("section_entries.errors.#{save_action}")
+        field_errors = {}
+        field_values = {}
 
         begin
           Zen.database.transaction do
-            # Update the entry itself
-            post_data = request.subset(
-              :title,
-              :created_at,
-              :updated_at,
-              :section_id,
-              :user_id,
-              :slug,
-              :section_entry_status_id,
-              :category_pks
-            )
-
-            # Transform the dates properly
-            if post_data[:created_at]
-              post_data[:created_at] = Time.strptime(
-                post_data[:created_at],
-                date_format
-              )
-            end
-
-            if post_data[:updated_at]
-              post_data[:updated_at] = Time.strptime(
-                post_data[:updated_at],
-                date_format
-              )
-            end
-
-            post_data.each { |k, v| entry.send("#{k}=", v) }
-            Zen::Event.call(before_event, entry)
-
+            entry.set(post_data)
             entry.save
 
-            # Update/add all the custom field values
-            custom_fields.each do |field|
-              key = "custom_field_value_#{field.id}"
-
-              # The custom field has been submitted, let's see if we have to
-              # update it or add it.
-              if request.params.key?(key)
-                # Validate it
-                if field.required and request.params[key].empty?
-                  field_errors[:"custom_field_value_#{field.id}"] = \
-                    lang('zen_models.presence')
-
-                  raise
-                end
-
-                # Update it
-                if field_values.key?(field.id)
-                  field_values[field.id].update(:value => request.params[key])
-                # Add it
-                else
-                  entry.add_custom_field_value(
-                    :custom_field_id => field.id,
-                    :value           => request.params[key]
-                  )
-                end
-              end
-            end
+            field_errors = process_custom_fields(entry)
+
+            raise unless field_errors.empty?
           end
-        # The rescue statement is called whenever the following happens:
-        #
-        # 1. The fields for the section entry (title, slug, etc) are invalid
-        # 2. Any custom field marked as required didn't have a value
-        # 3. Something else went wrong, god knows what.
         rescue => e
-          Ramaze::Log.error(e.inspect)
+          Ramaze::Log.error(e)
           message(:error, error)
 
+          request.POST.delete('id')
+
           flash[:form_errors] = entry.errors.merge(field_errors)
-          flash[:form_data]   = entry
+          flash[:form_data]   = request.POST
 
           redirect_referrer
         end
 
-        Zen::Event.call(after_event, entry)
-
         message(:success, success)
         redirect(SectionEntries.r(:edit, section_id, entry.id))
       end
 
+      ##
+      # 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
+      #
+      def autosave
+        entry        = Model::SectionEntry[request.params['id']]
+        post_data    = post_fields(*Model::SectionEntry::COLUMNS)
+        field_errors = {}
+
+        if post_data['created_at']
+          post_data['created_at'] = Time.strptime(
+            post_data['created_at'],
+            Model::SectionEntry::DATE_FORMAT
+          )
+        end
+
+        if entry.nil? or !user_authorized?(:edit_section_entry)
+          respond_json(
+            {:error => lang('zen_general.errors.invalid_request')},
+            404
+          )
+        end
+
+        begin
+          Zen.database.transaction do
+            entry.set(post_data)
+            entry.save
+
+            field_errors = process_custom_fields(entry)
+
+            raise unless field_errors.empty?
+          end
+        rescue => e
+          Ramaze::Log.error(e)
+
+          respond_json({:errors => entry.errors.merge(field_errors)}, 400)
+        end
+
+        respond_json({:csrf_token => get_csrf_token})
+      end
+
       ##
       # Delete a set of section entries based on the supplied POST
       # field "section_entry_ids".
       #
       # @since      0.1
       # @permission delete_section_entry
-      # @event      before_delete_section_entry
-      # @event      after_delete_section_entry
       #
       def delete
         authorize_user!(:delete_section_entry)
@@ -336,18 +287,15 @@ module Sections
           entry = ::Sections::Model::SectionEntry[id]
 
           next if entry.nil?
-          Zen::Event.call(:before_delete_section_entry, entry)
 
           begin
             entry.destroy
           rescue => e
-            Ramaze::Log.error(e.inspect)
+            Ramaze::Log.error(e)
             message(:error,lang('section_entries.errors.delete') % id)
 
             redirect_referrer
           end
-
-          Zen::Event.call(:after_delete_section_entry, entry)
         end
 
         message(:success, lang('section_entries.success.delete'))

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

@@ -27,12 +27,12 @@ module Sections
     # the other data types (such as those mentioned earlier) together to form
     # the content displayed on your website.
     #
-    # Sections can be managed by going to ``/admin``. This page will show an
-    # overview of all existing sections as well as a few buttons and links that
-    # allow you to edit, create or delete sections as well as managing the
-    # entries for each existing section.
+    # Sections can be managed by going to ``/admin/sections``. This page will
+    # show an overview of all existing sections as well as a few buttons and
+    # links that allow you to edit, create or delete sections as well as
+    # managing the entries for each existing section.
     #
-    # ![Sections](../../_static/sections/sections.png)
+    # ![Sections](../../images/sections/sections.png)
     #
     # ## Creating/Editing Sections
     #
@@ -41,9 +41,9 @@ module Sections
     # both cases you'll end up with a form that looks like the one in the images
     # below.
     #
-    # ![General](../../_static/sections/edit_section_general.png)
-    # ![Comments](../../_static/sections/edit_section_comments.png)
-    # ![Groups](../../_static/sections/edit_section_groups.png)
+    # ![General](../../images/sections/edit_section_general.png)
+    # ![Comments](../../images/sections/edit_section_comments.png)
+    # ![Groups](../../images/sections/edit_section_groups.png)
     #
     # In this form you can specify the following fields:
     #
@@ -76,38 +76,19 @@ module Sections
     # * edit_section
     # * delete_section
     #
-    # ## Events
-    #
-    # All events in this controller receive an instance of
-    # {Sections::Model::Section}. The event ``after_delete_section`` receives an
-    # instance that has already been removed, thus you can't make any changes to
-    # it and save those in the database.
-    #
-    # Example of creating a dummy section entry:
-    #
-    #     Zen::Event.listen(:new_section) do |section|
-    #       section.add_section_entry(:title   => 'My Entry', :user_id => user.id)
-    #     end
-    #
     # @since  0.1
-    # @map    /admin
-    # @event  before_new_section
-    # @event  after_new_section
-    # @event  before_edit_section
-    # @event  after_edit_section
-    # @event  before_delete_section
-    # @event  after_delete_section
+    # @map    /admin/sections
     #
     class Sections < Zen::Controller::AdminController
-      map    '/admin'
+      map    '/admin/sections'
       helper :section
       title  'sections.titles.%s'
 
       csrf_protection  :save, :delete
       load_asset_group :tabs, [:edit, :new]
 
-      # Hook that is executed before Sections#index(), Sections#new() and
-      # Sections#edit().
+      autosave Model::Section, Model::Section::COLUMNS, :edit_section
+
       before(:index, :new, :edit) do
         @boolean_hash = {
           true  => lang('zen_general.special.boolean_hash.true'),
@@ -156,7 +137,8 @@ module Sections
           @page_title
         )
 
-        @section = flash[:form_data] || validate_section(id)
+        @section = validate_section(id)
+        @section.set(flash[:form_data]) if flash[:form_data]
 
         render_view(:form)
       end
@@ -175,7 +157,8 @@ module Sections
           @page_title
         )
 
-        @section = flash[:form_data] || ::Sections::Model::Section.new
+        @section = Model::Section.new
+        @section.set(flash[:form_data]) if flash[:form_data]
 
         render_view(:form)
       end
@@ -184,41 +167,23 @@ module Sections
       # Saves any changes made to an existing section or creates a new one.
       #
       # @since      0.1
-      # @event      before_new_section
-      # @event      after_new_section
-      # @event      before_edit_section
-      # @event      ater_edit_section
       # @permission new_section (when creating a section)
       # @permission edit_section (when editing a section)
       #
       def save
-        post = request.subset(
-          :id,
-          :name,
-          :slug,
-          :description,
-          :comment_allow,
-          :comment_require_account,
-          :comment_moderate,
-          :comment_format,
-          :custom_field_group_pks,
-          :category_group_pks
-        )
+        post = post_fields(*Model::Section::COLUMNS)
+        id   = request.params['id']
 
-        if post['id'] and !post['id'].empty?
+        if id and !id.empty?
           authorize_user!(:edit_section)
 
-          section      = validate_section(post['id'])
-          save_action  = :save
-          before_event = :before_edit_section
-          after_event  = :after_edit_section
+          section     = validate_section(id)
+          save_action = :save
         else
           authorize_user!(:new_section)
 
-          section      = ::Sections::Model::Section.new
-          save_action  = :new
-          before_event = :before_new_section
-          after_event  = :after_new_section
+          section     = ::Sections::Model::Section.new
+          save_action = :new
         end
 
         success = lang("sections.success.#{save_action}")
@@ -227,12 +192,8 @@ module Sections
         post['custom_field_group_pks'] ||= []
         post['category_group_pks']     ||= []
 
-        post.delete('id')
-
         begin
-          post.each { |k, v| section.send("#{k}=", v) }
-          Zen::Event.call(before_event, section)
-
+          section.set(post)
           section.save
 
           if save_action == :new
@@ -240,17 +201,15 @@ module Sections
             section.category_group_pks     = post['category_group_pks']
           end
         rescue => e
-          Ramaze::Log.error(e.inspect)
+          Ramaze::Log.error(e)
           message(:error, error)
 
-          flash[:form_data]   = section
+          flash[:form_data]   = post
           flash[:form_errors] = section.errors
 
           redirect_referrer
         end
 
-        Zen::Event.call(after_event, section)
-
         message(:success, success)
         redirect(Sections.r(:edit, section.id))
       end
@@ -260,8 +219,6 @@ module Sections
       # should be specified in the POST array "section_ids[]".
       #
       # @since      0.1
-      # @event      before_delete_section
-      # @event      after_delete_section
       # @permission delete_section
       #
       def delete
@@ -277,18 +234,15 @@ module Sections
           section = ::Sections::Model::Section[id]
 
           next if section.nil?
-          Zen::Event.call(:before_delete_section, section)
 
           begin
             section.destroy
           rescue => e
-            Ramaze::Log.error(e.inspect)
+            Ramaze::Log.error(e)
             message(:error, lang('sections.errors.delete') % id)
 
             redirect_referrer
           end
-
-          Zen::Event.call(:after_delete_section, section)
         end
 
         message(:success, lang('sections.success.delete'))