zen 0.3 → 0.4

data/lib/zen/package/custom_fields/lib/custom_fields/controller/custom_field_types.rb

@@ -15,7 +15,7 @@ module CustomFields
     # URL called "Custom field types". Clicking this URL will take you to an
     # overview of all existing field types.
     #
-    # ![Types](../../_static/custom_fields/custom_field_types.png)
+    # ![Types](../../images/custom_fields/custom_field_types.png)
     #
     # ## Adding/Editing Field Types
     #
@@ -24,7 +24,7 @@ module CustomFields
     # button. In both cases you'll end up at a form that looks like the image
     # below.
     #
-    # ![Edit Type](../../_static/custom_fields/edit_custom_field_type.png)
+    # ![Edit Type](../../images/custom_fields/edit_custom_field_type.png)
     #
     # In this form you can specify the following fields:
     #
@@ -56,22 +56,8 @@ module CustomFields
     # * new_custom_field_type
     # * delete_custom_field_type
     #
-    # ## Events
-    #
-    # All events in this controller will receive an instance of
-    # {CustomFields::Model::CustomFieldType}. Just like other packages the event
-    # ``after_delete_custom_field_type`` receives an instance that has already
-    # been destroyed. This means that this event can not be used to make changes
-    # to the object and save them.
-    #
     # @since  0.2.8
     # @map    /admin/custom-field-types
-    # @event  before_new_custom_field_type
-    # @event  after_new_custom_field_type
-    # @event  before_edit_custom_field_type
-    # @event  after_edit_custom_field_type
-    # @event  before_delete_custom_field_type
-    # @event  after_delete_custom_field_type
     #
     class CustomFieldTypes < Zen::Controller::AdminController
       map    '/admin/custom-field-types'
@@ -80,8 +66,10 @@ module CustomFields
 
       csrf_protection :save, :delete
 
-      # Blck that's executed before CustomFieldTypes#edit() and
-      # CustomFieldTypes#new().
+      autosave Model::CustomFieldType,
+        Model::CustomFieldType::COLUMNS,
+        :edit_custom_field_type
+
       before(:index, :edit, :new) do
         @boolean_hash = {
           true  => lang('zen_general.special.boolean_hash.true'),
@@ -103,10 +91,10 @@ module CustomFields
         set_breadcrumbs(lang('custom_field_types.titles.index'))
 
         @field_types = search do |query|
-          ::CustomFields::Model::CustomFieldType.search(query).order(:id.asc)
+          Model::CustomFieldType.search(query).order(:id.asc)
         end
 
-        @field_types ||= ::CustomFields::Model::CustomFieldType \
+        @field_types ||= Model::CustomFieldType \
           .eager(:custom_field_method) \
           .order(:id.asc)
 
@@ -128,9 +116,10 @@ module CustomFields
           lang('custom_field_types.titles.edit')
         )
 
-        @custom_field_type = flash[:form_data] || validate_custom_field_type(id)
-        @custom_field_methods = ::CustomFields::Model::CustomFieldMethod \
-          .pk_hash(:name)
+        @custom_field_type    = validate_custom_field_type(id)
+        @custom_field_methods = Model::CustomFieldMethod.pk_hash(:name)
+
+        @custom_field_type.set(flash[:form_data]) if flash[:form_data]
 
         render_view(:form)
       end
@@ -149,14 +138,10 @@ module CustomFields
           lang('custom_field_types.titles.new')
         )
 
-        @custom_field_methods = ::CustomFields::Model::CustomFieldMethod \
-          .pk_hash(:name)
+        @custom_field_methods = Model::CustomFieldMethod.pk_hash(:name)
+        @custom_field_type    = Model::CustomFieldType.new
 
-        if flash[:form_data]
-          @custom_field_type = flash[:form_data]
-        else
-          @custom_field_type = ::CustomFields::Model::CustomFieldType.new
-        end
+        @custom_field_type.set(flash[:form_data]) if flash[:form_data]
 
         render_view(:form)
       end
@@ -164,66 +149,42 @@ module CustomFields
       ##
       # Creates a new custom field type or edits an existing one.
       #
-      # This method requires either create or update permissions based on the
-      # supplied data.
-      #
       # @since      0.2.8
-      # @event      before_edit_custom_field_type
-      # @event      after_edit_custom_field_type
-      # @event      before_new_custom_field_type
-      # @event      after_new_custom_field_type
       # @permission edit_custom_field_type (when editing a field type)
       # @permission new_custom_field_type (when creating a field type)
       #
       def save
-        post = request.subset(
-          :id,
-          :name,
-          :language_string,
-          :html_class,
-          :serialize,
-          :allow_markup,
-          :custom_field_method_id
-        )
+        post = post_fields(*Model::CustomFieldType::COLUMNS)
+        id   = request.params['id']
 
-        if post['id'] and !post['id'].empty?
+        if id and !id.empty?
           authorize_user!(:edit_custom_field_type)
 
-          field_type   = validate_custom_field_type(post['id'])
-          save_action  = :save
-          before_event = :before_edit_custom_field_type
-          after_event  = :after_edit_custom_field_type
+          field_type  = validate_custom_field_type(id)
+          save_action = :save
         else
           authorize_user!(:new_custom_field_type)
 
-          field_type   = ::CustomFields::Model::CustomFieldType.new
-          save_action  = :new
-          before_event = :before_new_custom_field_type
-          after_event  = :after_new_custom_field_type
+          field_type  = Model::CustomFieldType.new
+          save_action = :new
         end
 
-        post.delete('id')
-
         success = lang("custom_field_types.success.#{save_action}")
         error   = lang("custom_field_types.errors.#{save_action}")
 
         begin
-          post.each { |k, v| field_type.send("#{k}=", v) }
-          Zen::Event.call(before_event, field_type)
-
+          field_type.set(post)
           field_type.save
         rescue => e
-          Ramaze::Log.error(e.inspect)
+          Ramaze::Log.error(e)
           message(:error, error)
 
-          flash[:form_data]   = field_type
+          flash[:form_data]   = post
           flash[:form_errors] = field_type.errors
 
           redirect_referrer
         end
 
-        Zen::Event.call(after_event, field_type)
-
         message(:success, success)
         redirect(CustomFieldTypes.r(:edit, field_type.id))
       end
@@ -233,8 +194,6 @@ module CustomFields
       # in the POST array "custom_field_type_ids".
       #
       # @since      0.2.8
-      # @event      before_delete_custom_field_type
-      # @event      after_delete_custom_field_type
       # @permission delete_custom_field_type
       #
       def delete
@@ -247,21 +206,18 @@ module CustomFields
         end
 
         request.params['custom_field_type_ids'].each do |id|
-          type = ::CustomFields::Model::CustomFieldType[id]
+          type = Model::CustomFieldType[id]
 
           next if type.nil?
-          Zen::Event.call(:before_delete_custom_field_type, type)
 
           begin
             type.destroy
           rescue => e
-            Ramaze::Log.error(e.inspect)
+            Ramaze::Log.error(e)
             message(:error, lang('custom_field_types.errors.delete') % id)
 
             redirect_referrer
           end
-
-          Zen::Event.call(:after_delete_custom_field_type, type)
         end
 
         message(:success, lang('custom_field_types.success.delete'))

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

@@ -12,15 +12,15 @@ module CustomFields
     # you've reached this page you'll see an overview of all your custom fields
     # or a message saying no fields were found (if this is the case).
     #
-    # ![Custom Fields](../../_static/custom_fields/custom_fields.png)
+    # ![Custom Fields](../../images/custom_fields/custom_fields.png)
     #
     # Editing a custom field can be done by clicking on the name of the field,
     # creating a new one can be done by clicking on the button "Add custom
     # field". In both cases you'll be shown a form that looks like the one in
     # the image below.
     #
-    # ![General](../../_static/custom_fields/edit_custom_field_general.png)
-    # ![Settings](../../_static/custom_fields/edit_custom_field_settings.png)
+    # ![General](../../images/custom_fields/edit_custom_field_general.png)
+    # ![Settings](../../images/custom_fields/edit_custom_field_settings.png)
     #
     # In this form you can specify the following fields:
     #
@@ -58,33 +58,23 @@ module CustomFields
     # * edit_custom_field
     # * delete_custom_field
     #
-    # ## Events
-    #
-    # All events in this controller receive an instance of
-    # {CustomFields::Model::CustomField}. Just like other packages the event
-    # ``after_delete_custom_field`` receives an instance that has already been
-    # destroyed, thus you won't be able to make any changes to the object and
-    # save them in the database.
-    #
     # @since  0.1
     # @map    /admin/custom-fields
-    # @event  before_new_custom_field
-    # @event  after_new_custom_field
-    # @event  before_edit_custom_field
-    # @event  after_edit_custom_field
-    # @event  before_delete_custom_field
-    # @event  after_delete_custom_field
     #
     class CustomFields < Zen::Controller::AdminController
       helper :custom_field
       map    '/admin/custom-fields'
       title  'custom_fields.titles.%s'
 
+      autosave Model::CustomField,
+        Model::CustomField::COLUMNS,
+        :edit_custom_field
+
       csrf_protection  :save; :delete
       load_asset_group :tabs, [:edit, :new]
 
       before(:index, :edit, :new) do
-        @custom_field_types = ::CustomFields::Model::CustomFieldType.type_hash
+        @custom_field_types = Model::CustomFieldType.type_hash
         @boolean_hash       = {
           true  => lang('zen_general.special.boolean_hash.true'),
           false => lang('zen_general.special.boolean_hash.false')
@@ -111,13 +101,13 @@ module CustomFields
         field_group = validate_custom_field_group(custom_field_group_id)
         @custom_field_group_id = custom_field_group_id
         @custom_fields         = search do |query|
-          ::CustomFields::Model::CustomField \
+          Model::CustomField \
             .search(query) \
             .filter(:custom_field_group_id => custom_field_group_id) \
             .order(:id.asc)
         end
 
-        @custom_fields ||= ::CustomFields::Model::CustomField \
+        @custom_fields ||= Model::CustomField \
           .filter(:custom_field_group_id => custom_field_group_id) \
           .order(:id.asc)
 
@@ -153,12 +143,9 @@ module CustomFields
         )
 
         @custom_field_group_id = custom_field_group_id
+        @custom_field          = validate_custom_field(id, custom_field_group_id)
 
-        if flash[:form_data]
-          @custom_field = flash[:form_data]
-        else
-          @custom_field = validate_custom_field(id, custom_field_group_id)
-        end
+        @custom_field.set(flash[:form_data]) if flash[:form_data]
 
         render_view(:form)
       end
@@ -190,12 +177,9 @@ module CustomFields
         )
 
         @custom_field_group_id = custom_field_group_id
+        @custom_field          = Model::CustomField.new
 
-        if flash[:form_data]
-          @custom_field = flash[:form_data]
-        else
-          @custom_field = ::CustomFields::Model::CustomField.new
-        end
+        @custom_field.set(flash[:form_data]) if flash[:form_data]
 
         render_view(:form)
       end
@@ -204,75 +188,43 @@ module CustomFields
       # Saves the changes made by {#edit} and {#new}.
       #
       # @since      0.1
-      # @event      before_new_custom_field
-      # @event      after_new_custom_field
-      # @event      before_edit_custom_field
-      # @event      after_edit_custom_field
       # @permission edit_custom_field (when editing a field)
       # @permission new_custom_field (when creating a new field)
       #
       def save
-        post = request.subset(
-          :id,
-          :name,
-          :slug,
-          :description,
-          :sort_order,
-          :format,
-          :possible_values,
-          :required,
-          :text_editor,
-          :textarea_rows,
-          :text_limit,
-          :custom_field_group_id,
-          :custom_field_type_id
-        )
+        post = post_fields(*Model::CustomField::COLUMNS)
+        id   = request.params['id']
 
         validate_custom_field_group(post['custom_field_group_id'])
 
-        # Get or create a custom field group based on the ID from the hidden
-        # field.
-        if post['id'] and !post['id'].empty?
+        if id and !id.empty?
           authorize_user!(:edit_custom_field)
 
-          custom_field = validate_custom_field(
-            post['id'], post['custom_field_group_id']
-          )
-
+          custom_field = validate_custom_field(id, post['custom_field_group_id'])
           save_action  = :save
-          before_event = :before_edit_custom_field
-          after_event  = :after_edit_custom_field
         else
           authorize_user!(:new_custom_field)
 
-          custom_field = ::CustomFields::Model::CustomField.new
+          custom_field = Model::CustomField.new
           save_action  = :new
-          before_event = :before_new_custom_field
-          after_event  = :after_new_custom_field
         end
 
-        post.delete('id')
-
         success = lang("custom_fields.success.#{save_action}")
         error   = lang("custom_fields.errors.#{save_action}")
 
         begin
-          post.each { |k, v| custom_field.send("#{k}=", v) }
-          Zen::Event.call(before_event, custom_field)
-
+          custom_field.set(post)
           custom_field.save
         rescue => e
-          Ramaze::Log.error(e.inspect)
+          Ramaze::Log.error(e)
           message(:error, error)
 
-          flash[:form_data]   = custom_field
+          flash[:form_data]   = post
           flash[:form_errors] = custom_field.errors
 
           redirect_referrer
         end
 
-        Zen::Event.call(after_event, custom_field)
-
         message(:success, success)
         redirect(
           CustomFields.r(:edit, post['custom_field_group_id'], custom_field.id)
@@ -287,14 +239,12 @@ module CustomFields
       # should contain the primary values of each field that has to be deleted.
       #
       # @since      0.1
-      # @event      before_delete_custom_field
-      # @event      after_delete_custom_field
       # @permission delete_custom_field
       #
       def delete
         authorize_user!(:delete_custom_field)
 
-        post = request.subset(:custom_field_ids)
+        post = post_fields(:custom_field_ids)
 
         if post['custom_field_ids'].nil? or post['custom_field_ids'].empty?
           message(:error, lang('custom_fields.errors.no_delete'))
@@ -302,21 +252,18 @@ module CustomFields
         end
 
         request.params['custom_field_ids'].each do |id|
-          custom_field = ::CustomFields::Model::CustomField[id]
+          custom_field = Model::CustomField[id]
 
           next if custom_field.nil?
-          Zen::Event.call(:before_delete_custom_field, custom_field)
 
           begin
             custom_field.destroy
           rescue => e
-            Ramaze::Log.error(e.inspect)
+            Ramaze::Log.error(e)
             message(:error, lang('custom_fields.errors.delete') % id)
 
             redirect_referrer
           end
-
-          Zen::Event.call(:after_delete_custom_field, custom_field)
         end
 
         message(:success, lang('custom_fields.success.delete'))

data/lib/zen/package/custom_fields/lib/custom_fields/model/custom_field.rb

@@ -4,11 +4,37 @@ module CustomFields
     ##
     # Model for managing retrieving custom fields.
     #
-    # @since  0.1
+    # @since 0.1
+    # @event before_new_custom_field
+    # @event after_new_custom_field
+    # @event before_edit_custom_field
+    # @event after_edit_custom_field
+    # @event before_delete_custom_field
+    # @event after_delete_custom_field
     #
     class CustomField < Sequel::Model
       include Zen::Model::Helper
 
+      ##
+      # Array containing all the columns the user can set.
+      #
+      # @since 17-02-2012
+      #
+      COLUMNS = [
+        :name,
+        :slug,
+        :description,
+        :sort_order,
+        :format,
+        :possible_values,
+        :required,
+        :text_editor,
+        :textarea_rows,
+        :text_limit,
+        :custom_field_group_id,
+        :custom_field_type_id
+      ]
+
       one_to_many :custom_field_values,
         :class => "CustomFields::Model::CustomFieldValue"
 
@@ -16,8 +42,18 @@ module CustomFields
         :class => 'CustomFields::Model::CustomFieldType',
         :eager => [:custom_field_method]
 
+      plugin :association_dependencies, :custom_field_values => :delete
+
       plugin :sluggable, :source => :name, :freeze => false
 
+      plugin :events,
+        :before_create  => :before_new_custom_field,
+        :after_create   => :after_new_custom_field,
+        :before_update  => :before_edit_custom_field,
+        :after_update   => :after_edit_custom_field,
+        :before_destroy => :before_delete_custom_field,
+        :after_destroy  => :after_delete_custom_field
+
       ##
       # Searches for a set of custom fields.
       #
@@ -56,6 +92,17 @@ module CustomFields
         validates_presence(:slug) unless new?
         validates_unique(:slug)
       end
+
+      ##
+      # Hook that is executed before creating or saving an object.
+      #
+      # @since 03-01-2012
+      #
+      def before_save
+        sanitize_fields([:name, :slug, :description, :format])
+
+        super
+      end
     end # CustomField
   end # Model
 end # CustomFields