zen 0.2.8 → 0.3b

data/lib/zen/package/comments/migrations/1308774099_comment_status.rb

@@ -28,7 +28,7 @@ Sequel.migration do
       status_id = Zen.database[:comment_statuses].insert({:name => status})
 
       comments.each do |comment|
-        if comment[:status] === status
+        if comment[:status] == status
           Zen.database[:comments].filter(:id => comment[:id]) \
             .update(:comment_status_id => status_id)
         end
@@ -45,9 +45,17 @@ Sequel.migration do
       statuses[status[:id]] = status[:name]
     end
 
-    # Put the old columns back in place
-    drop_column(:comments, :comment_status_id)
-    add_column(:comments, :status, String, :default => 'closed')
+    alter_table(:comments) do
+      # MySQL doesn't automatically drop foreign keys, because of this the one
+      # for the comment status ID has to be removed manually. Luckily the name
+      # of the foreign key is rather easy to figure out.
+      if Zen.database.adapter_scheme.to_s.include?('mysql')
+        drop_constraint(:comments_ibfk_2, :type => :foreign_key)
+      end
+
+      drop_column(:comment_status_id)
+      add_column(:status, String, :default => 'closed')
+    end
 
     # Put the old statuses back in place
     comments.each do |comment|

data/lib/zen/package/comments/migrations/1313851786_remove_defensio_signature.rb

@@ -0,0 +1,11 @@
+Sequel.migration do
+  # Updates the database with the changes specified in the block.
+  up do
+    drop_column(:comments, :defensio_signature)
+  end
+
+  # Reverts the changes made in the up() block.
+  down do
+    add_column(:comments, :defensio_signature, String)
+  end
+end

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

@@ -1,56 +1,53 @@
-# Update the helpers path for the controllers
-Ramaze::HelpersHelper.options.paths.push(__DIR__('custom_fields'))
+Zen::Package.add do |p|
+  p.name       = :custom_fields
+  p.title      = 'custom_fields.titles.index'
+  p.author     = 'Yorick Peterse'
+  p.url        = 'http://zen-cms.com/'
+  p.about      = 'custom_fields.description'
+  p.root       = __DIR__('custom_fields')
+  p.migrations = __DIR__('../migrations')
+
+  p.menu(
+    'custom_fields.titles.index',
+    '/admin/custom-field-groups',
+    :permission => :show_custom_field_group
+  ) do |sub|
+    sub.menu(
+      'custom_field_types.titles.index',
+      '/admin/custom-field-types',
+      :permission => :show_custom_field
+    )
+  end
+
+  p.permission :show_custom_field_group, 'custom_field_groups.permissions.show'
+  p.permission :edit_custom_field_group, 'custom_field_groups.permissions.edit'
+  p.permission :new_custom_field_group , 'custom_field_groups.permissions.new'
+  p.permission :delete_custom_field_group,
+    'custom_field_groups.permissions.delete'
+
+  p.permission :show_custom_field_type  , 'custom_field_types.permissions.show'
+  p.permission :edit_custom_field_type  , 'custom_field_types.permissions.edit'
+  p.permission :new_custom_field_type   , 'custom_field_types.permissions.new'
+  p.permission :delete_custom_field_type, 'custom_field_types.permissions.delete'
+
+  p.permission :show_custom_field  , 'custom_fields.permissions.show'
+  p.permission :edit_custom_field  , 'custom_fields.permissions.edit'
+  p.permission :new_custom_field   , 'custom_fields.permissions.new'
+  p.permission :delete_custom_field, 'custom_fields.permissions.delete'
+end
 
-# Update the language path
-Zen::Language.options.paths.push(__DIR__('custom_fields'))
+Zen::Language.load('custom_fields')
+Zen::Language.load('custom_field_groups')
+Zen::Language.load('custom_field_types')
 
-# Load all models
 require __DIR__('custom_fields/model/custom_field_method')
 require __DIR__('custom_fields/model/custom_field_type')
 require __DIR__('custom_fields/model/custom_field')
 require __DIR__('custom_fields/model/custom_field_group')
 require __DIR__('custom_fields/model/custom_field_value')
 
-# Load all controllers
 require __DIR__('custom_fields/controller/custom_field_groups')
 require __DIR__('custom_fields/controller/custom_fields')
 require __DIR__('custom_fields/controller/custom_field_types')
 
 require __DIR__('custom_fields/blue_form_parameters')
-
-# Load all the language files
-Zen::Language.load('custom_fields')
-Zen::Language.load('custom_field_groups')
-Zen::Language.load('custom_field_types')
-
-# Define the package
-Zen::Package.add do |p|
-  p.name          = 'custom_fields'
-  p.author        = 'Yorick Peterse'
-  p.url           = 'http://yorickpeterse.com/'
-  p.about         = "The Custom Fields module is used to manage custom fields 
-and custom field groups."
-
-  p.directory     = __DIR__('custom_fields')
-  p.migration_dir = __DIR__('../migrations')
-  
-  p.menu = [{
-    :title    => lang('custom_fields.titles.index'),
-    :url      => "admin/custom-field-groups",
-    :children => [
-      {
-        :title => lang('custom_field_types.titles.index'),
-        :url   => 'admin/custom-field-types'
-      }
-    ]
-  }]
-
-  p.controllers = {
-    lang('custom_fields.titles.index') \
-      => CustomFields::Controller::CustomFields, 
-    lang('custom_field_groups.titles.index') \
-      => CustomFields::Controller::CustomFieldGroups,
-    lang('custom_field_types.titles.index') \
-      => CustomFields::Controller::CustomFieldTypes
-  }
-end

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

@@ -1,10 +1,74 @@
-#:nodoc:
 module CustomFields
   ##
   # The BlueFormParameters module is used to build an array of parameters for
-  # various BlueForm methods based on the type and method of a custom field.
+  # various BlueForm methods based on the type and method of a custom field. Out
+  # of the box this module provides a set of methods that can be used to
+  # generate the parameters for most methods in the BlueForm helper that ships
+  # with Ramaze. However, there may be a time when you want to add your own
+  # method. Don't worry, this is quite easy.
+  #
+  # Each method (they should be class methods) in this module takes two
+  # parameters, the first one is an instance of
+  # {CustomFields::Model::CustomField} and the second one an instance of
+  # {CustomFields::Model::CustomFieldValue}. The return value should be an
+  # array containing all the parameters that will be passed to BlueForm.
+  #
+  # Lets start with the basic skeleton of such a method:
+  #
+  #     module CustomFields
+  #       module BlueFormParameters
+  #         def self.my_method(field, field_value)
+  #           params = [:input_text]
+  #
+  #           return params
+  #         end
+  #       end
+  #     end
+  #
+  # So far the only thing this method does is telling BlueForm that we want to
+  # invoke the ``input_text()`` method. Let's add some extra parameters to it
+  # such as the label and name:
+  #
+  #     module CustomFields
+  #       module BlueFormParameters
+  #         def self.my_method(field, field_value)
+  #           params = [
+  #             :input_text,
+  #             field.label,
+  #             "custom_field_value_#{field.id}"
+  #           ]
+  #
+  #           return params
+  #         end
+  #       end
+  #     end
+  #
+  # The second parameter in this array is the label of the field, the third the
+  # name. The names of these fields should be specified in the format of
+  # ``custom_field_value_N`` where ``N`` is the ID of the custom field.
+  #
+  # Let's add our value to the list. BlueForm allows you to specify a hash
+  # containing additional parameters (including the value). Adding this hash to
+  # the array is as easy as, well, just adding it:
+  #
+  #     module CustomFields
+  #       module BlueFormParameters
+  #         def self.my_method(field, field_value)
+  #           params = [
+  #             :input_text,
+  #             field.label,
+  #             "custom_field_value_#{field.id}",
+  #             {:value => field_value.value}
+  #           ]
+  #
+  #           return params
+  #         end
+  #       end
+  #     end
+  #
+  # And there you have it, a very basic example of how to add custom parameters
+  # allowing you to build your own HTML markup for your fields.
   #
-  # @author Yorick Peterse
   # @since  0.2.8
   #
   module BlueFormParameters
@@ -13,12 +77,11 @@ module CustomFields
       # Generates the required parameters for
       # Ramaze::Helper::BlueForm::Form#input_text.
       #
-      # @author Yorick Peterse
       # @since  0.2.8
       # @param  [CustomFields::Model::CustomField] field The custom field to use
-      # for filling in classes, values, etc.
+      #  for filling in classes, values, etc.
       # @param  [CustomFields::Model::CustomFieldValue] field_value The
-      # value of the custom field for a given entry.
+      #  value of the custom field for a given entry.
       # @return [Array]
       #
       def input_text(field, field_value)
@@ -36,11 +99,11 @@ module CustomFields
         end
 
         if !field.description.nil?
-          params.last[:placeholder] = field.description
+          params.last[:title] = field.description
         end
 
         if !field.format.nil? and !field.format.empty? \
-        and type.allow_markup === true
+        and type.allow_markup == true
           params.last[:'data-format'] = field.format
         end
 
@@ -55,7 +118,6 @@ module CustomFields
       # Generates the required parameters for
       # Ramaze::Helper::BlueForm::Form#input_password.
       #
-      # @author Yorick Peterse
       # @since  0.2.8
       # @see    CustomFields::BlueFormParameters.input_text
       #
@@ -72,7 +134,6 @@ module CustomFields
       # Generates the required parameters for
       # Ramaze::Helper::BlueForm::Form#textarea.
       #
-      # @author Yorick Peterse
       # @since  0.2.8
       # @see    CustomFields::BlueFormParameters.input_text
       #
@@ -86,7 +147,7 @@ module CustomFields
 
         # Remove the class "text]editor" if the field does not allow the text
         # editor to be used.
-        if field.text_editor === false
+        if field.text_editor == false
           params.last[:class].gsub!('text_editor', '')
         end
 
@@ -97,7 +158,6 @@ module CustomFields
       # Generates the required parameters for
       # Ramaze::Helper::BlueForm::Form#input_radio.
       #
-      # @author Yorick Peterse
       # @since  0.2.8
       # @see    CustomFields::BlueFormParameters.input_text
       #
@@ -135,7 +195,6 @@ module CustomFields
       # Generates the required parameters for
       # Ramaze::Helper::BlueForm::Form#input_checkbox.
       #
-      # @author Yorick Peterse
       # @since  0.2.8
       # @see    CustomFields::BlueFormParameters.input_radio
       #
@@ -150,7 +209,6 @@ module CustomFields
       # Generates the required parameters for
       # Ramaze::Helper::BlueForm::Form#select.
       #
-      # @author Yorick Peterse
       # @since  0.2.8
       # @see    CustomFields::BlueFormParameters.input_text
       #
@@ -188,7 +246,6 @@ module CustomFields
       # Ramaze::Helper::BlueForm::Form#select but allows multiple values to be
       # selected.
       #
-      # @author Yorick Peterse
       # @since  0.2.8
       # @see    CustomFields::BlueFormParameters.select
       #
@@ -202,8 +259,6 @@ module CustomFields
 
         return params
       end
-
-      private
     end # class << self
   end # BlueFormParameters
 end # CustomFields

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

@@ -1,196 +1,225 @@
-#:nodoc:
+##
+# Package for managing custom field groups, custom fields and custom field
+# types.
+#
+# ## Controllers
+#
+# * {CustomFields::Controller::CustomFieldGroups}
+# * {CustomFields::Controller::CustomFields}
+# * {CustomFields::Controller::CustomFieldTypes}
+#
+# ## Helpers
+#
+# * {Ramaze::Helper::CustomField}
+#
+# ## Models
+#
+# * {CustomFields::Model::CustomFieldGroup}
+# * {CustomFields::Model::CustomField}
+# * {CustomFields::Model::CustomFieldType}
+# * {CustomFields::Model::CustomFieldMethod}
+# * {CustomFields::Model::CustomFieldValue}
+#
+# ## Generic Modules & Classes
+#
+# * {CustomFields::BlueFormParameters}
+#
 module CustomFields
   #:nodoc:
   module Controller
     ##
-    # Controller for managing custom field groups. These groups are used to
-    # organize individual fields into a larger group which in turn will be
-    # assigned to a section.
+    # Custom field groups allow you to group various fields into groups which in
+    # turn can be assigned to a number of sections. Managing your groups can be
+    # done by navigating to ``/admin/custom-field-groups``. If you have any
+    # existing groups these will be displayed, otherwise a message telling you
+    # that do don't have any groups will be displayed instead.
     #
-    # @author  Yorick Peterse
-    # @since   0.1
+    # ![Groups](../../_static/custom_fields/custom_field_groups.png)
+    #
+    # Just like with other packages you can delete records by clicking the
+    # checkboxes followed by the "Delete selected groups" button. Groups can be
+    # edited by clicking on the name of a group. If you want to manage the
+    # fields of a group you should click on the "Manage custom fields" link.
+    #
+    # ## Adding/Editing Groups
+    #
+    # ![Edit Group](../../_static/custom_fields/edit_custom_field_group.png)
+    #
+    # When creating a new group or editing an existing group you can fill in the
+    # following two fields:
+    #
+    # * **Name** (required): the name of the group, an example of such a name is
+    #   "General group" or "Meta fields".
+    # * **Description**: a description of the group.
+    #
+    # Note that the length of the group name can not be longer than 255
+    # characters.
+    #
+    # ## Used Permissions
+    #
+    # * show_custom_field_group
+    # * new_custom_field_group
+    # * edit_custom_field_group
+    # * delete_custom_field_group
+    #
+    # ## Events
+    #
+    # All events in this controller receive an instance of
+    # {CustomFields::Model::CustomFieldGroup}. The
+    # ``after_delete_custom_field_group`` event will receive an instance of this
+    # model that has already been destroyed.
+    #
+    # @since  0.1
+    # @map    /admin/custom-field-groups
+    # @event  before_new_custom_field_group
+    # @event  after_new_custom_field_group
+    # @event  before_edit_custom_field_group
+    # @event  after_edit_custom_field_group
+    # @event  before_delete_custom_field_group
+    # @event  after_delete_custom_field_group
     #
     class CustomFieldGroups < Zen::Controller::AdminController
-      include ::CustomFields::Model
-
       helper :custom_field
       map    '/admin/custom-field-groups'
+      title  'custom_field_groups.titles.%s'
 
-      before_all do
-        csrf_protection(:save, :delete) do
-          respond(lang('zen_general.errors.csrf'), 403)
-        end
-      end
+      csrf_protection :save, :delete
 
       ##
-      # Constructor method, called upon initialization. It's used to set the URL
-      # to which forms send their data and load the language pack.
+      # Shows an overview that allows the user to manage existing field groups
+      # and create new ones.
       #
-      # This method loads the following language files:
-      #
-      # * custom_field_groups
-      #
-      # @author Yorick Peterse
-      # @since  0.1
-      #
-      def initialize
-        super
-
-        Zen::Language.load('custom_field_groups')
-
-        # Set the page title
-        if !action.method.nil?
-          method      = action.method.to_sym
-          @page_title = lang("custom_field_groups.titles.#{method}") rescue nil
-        end
-      end
-
-      ##
-      # Show an overview of all existing custom field groups. Using this
-      # overview a user can manage an existing field group, delete it or create
-      # a new one.
-      #
-      # This method requires the following permissions:
-      #
-      # * read
-      #
-      # @author Yorick Peterse
-      # @since  0.1
+      # @since      0.1
+      # @permission show_custom_field_group
       #
       def index
-        require_permissions(:read)
+        authorize_user!(:show_custom_field_group)
 
         set_breadcrumbs(lang('custom_field_groups.titles.index'))
 
-        @field_groups = paginate(CustomFieldGroup)
+        @field_groups = search do |query|
+          ::CustomFields::Model::CustomFieldGroup \
+            .search(query) \
+            .order(:id.asc)
+        end
+
+        @field_groups ||= ::CustomFields::Model::CustomFieldGroup.order(:id.asc)
+        @field_groups   = paginate(@field_groups)
       end
 
       ##
       # Show a form that lets the user edit an existing custom field group.
       #
-      # This method requires the following permissions:
-      #
-      # * read
-      # * update
-      #
-      # @author Yorick Peterse
-      # @param  [Integer] id The ID of the custom field group to retrieve so
-      # that we can edit it.
-      # @since  0.1
+      # @param  [Fixnum] id The ID of the custom field group to retrieve so
+      #  that we can edit it.
+      # @since      0.1
+      # @permission edit_custom_field_group
       #
       def edit(id)
-        require_permissions(:read, :update)
+        authorize_user!(:edit_custom_field_group)
 
         set_breadcrumbs(
           CustomFieldGroups.a(lang('custom_field_groups.titles.index'), :index),
           @page_title
         )
 
-        if flash[:form_data]
-          @field_group = flash[:form_data]
-        else
-          @field_group = validate_custom_field_group(id)
-        end
+        @field_group = flash[:form_data] || validate_custom_field_group(id)
 
         render_view(:form)
       end
 
       ##
-      # Show a form that lets the user create a new custom field group.
+      # Allows a user to create a new custom field group.
       #
-      # This method requires the following permissions:
-      #
-      # * read
-      # * create
-      #
-      # @author Yorick Peterse
-      # @since  0.1
+      # @since      0.1
+      # @permission new_custom_field_group
       #
       def new
-        require_permissions(:read, :create)
+        authorize_user!(:new_custom_field_group)
 
         set_breadcrumbs(
           CustomFieldGroups.a(lang('custom_field_groups.titles.index'), :index),
           @page_title
         )
 
-        @field_group = CustomFieldGroup.new
+        if flash[:form_data]
+          @field_group = flash[:form_data]
+        else
+          @field_group = ::CustomFields::Model::CustomFieldGroup.new
+        end
 
         render_view(:form)
       end
 
       ##
-      # Method used for processing the form data and redirecting the user back
-      # to the proper URL. Based on the value of a hidden field named 'id' we'll
-      # determine if the data will be used to create a new group or to update an
-      # existing one.
-      #
-      # This method requires the following permissions:
-      #
-      # * create
-      # * update
-      #
-      # @author Yorick Peterse
-      # @since  0.1
+      # Saves or creates a new custom field group. If a valid ID is specified in
+      # the POST key "id" an existing row will be updated instead of creating a
+      # new one.
+      #
+      # @since      0.1
+      # @permission edit_custom_field_group (when editing a group)
+      # @permission new_custom_field_group (when creating a group)
+      # @event      before_edit_custom_field_group
+      # @event      after_edit_custom_field_group
+      # @event      before_new_custom_field_group
+      # @event      after_new_custom_field_group
       #
       def save
         post = request.subset(:id, :name, :description)
 
         if post['id'] and !post['id'].empty?
-          require_permissions(:update)
+          authorize_user!(:edit_custom_field_group)
 
-          @field_group  = validate_custom_field_group(post['id'])
-          save_action   = :save
+          field_group  = validate_custom_field_group(post['id'])
+          save_action  = :save
+          before_event = :before_edit_custom_field_group
+          after_event  = :after_edit_custom_field_group
         else
-          require_permissions(:create)
+          authorize_user!(:new_custom_field_group)
 
-          @field_group  = CustomFieldGroup.new
-          save_action   = :new
+          field_group  = ::CustomFields::Model::CustomFieldGroup.new
+          save_action  = :new
+          before_event = :before_new_custom_field_group
+          after_event  = :after_new_custom_field_group
         end
 
         post.delete('id')
 
-        # Set the messages
-        flash_success = lang("custom_field_groups.success.#{save_action}")
-        flash_error   = lang("custom_field_groups.errors.#{save_action}")
+        success = lang("custom_field_groups.success.#{save_action}")
+        error   = lang("custom_field_groups.errors.#{save_action}")
 
         begin
-          @field_group.update(post)
-          message(:success, flash_success)
+          post.each { |k, v| field_group.send("#{k}=", v) }
+          Zen::Event.call(before_event, field_group)
+
+          field_group.save
         rescue => e
           Ramaze::Log.error(e.inspect)
-          message(:error, flash_error)
+          message(:error, error)
 
-          flash[:form_errors] = @field_group.errors
-          flash[:form_data]   = @field_group
+          flash[:form_errors] = field_group.errors
+          flash[:form_data]   = field_group
 
           redirect_referrer
         end
 
-        if !@field_group.nil? and @field_group.id
-          redirect(CustomFieldGroups.r(:edit, @field_group.id))
-        else
-          redirect_referrer
-        end
+        Zen::Event.call(after_event, field_group)
+
+        message(:success, success)
+        redirect(CustomFieldGroups.r(:edit, field_group.id))
       end
 
       ##
-      # Delete an existing custom field group.
+      # Delete an existing custom field group. The IDs of the groups to remove
+      # should be specified in a POST array called "custom_field_group_ids".
       #
-      # In order to delete a custom field group you'll need to send a POST
-      # request that contains a field named 'custom_field_group_ids[]'. This
-      # field should contain the primary values of each field group that has to
-      # be deleted.
-      #
-      # This method requires the following permissions:
-      #
-      # * delete
-      #
-      # @author Yorick Peterse
-      # @since  0.1
+      # @since      0.1
+      # @permission delete_custom_field_group
+      # @event      before_delete_custom_field_group
+      # @event      after_delete_custom_field_group
       #
       def delete
-        require_permissions(:delete)
+        authorize_user!(:delete_custom_field_group)
 
         if !request.params['custom_field_group_ids'] \
         or request.params['custom_field_group_ids'].empty?
@@ -199,17 +228,24 @@ module CustomFields
         end
 
         request.params['custom_field_group_ids'].each do |id|
+          group = ::CustomFields::Model::CustomFieldGroup[id]
+
+          next if group.nil?
+          Zen::Event.call(:before_delete_custom_field_group, group)
+
           begin
-            CustomFieldGroup[id].destroy
-            message(:success, lang('custom_field_groups.success.delete'))
+            group.destroy
           rescue => e
             Ramaze::Log.error(e.inspect)
             message(:error, lang('custom_field_groups.errors.delete') % id)
 
             redirect_referrer
           end
+
+          Zen::Event.call(:after_delete_custom_field_group, group)
         end
 
+        message(:success, lang('custom_field_groups.success.delete'))
         redirect_referrer
       end
     end # CustomFieldGroups