zen 0.1a → 0.2

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

@@ -0,0 +1,38 @@
+#:nodoc:
+module Menus
+  #:nodoc:
+  module Models
+    ##
+    # Model used for managing groups of menu items. This model uses the following
+    # Sequel plugins:
+    #
+    # * sluggable
+    #
+    # @author Yorick Peterse
+    # @since  0.2a
+    #
+    class Menu < Sequel::Model
+      plugin :sluggable, :source => :name, :freeze => false
+
+      # Define our relations
+      one_to_many :menu_items, :class => "Menus::Models::MenuItem"
+
+      ##
+      # Specifies all validates rules used when creating or updating a menu.
+      # A slug will be generated when a menu is first created but after that they are
+      # required to ensure that they don't collide with existing slugs.
+      #
+      # @author Yorick Peterse
+      # @since  0.2a
+      #
+      def validate
+        validates_presence :name
+        validates_presence :slug unless new? 
+        validates_unique   :slug
+      
+        # Prevent people from entering random crap for class and ID names
+        validates_format(/^[a-zA-Z\-_0-9]*/, [:css_class, :css_id])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+#:nodoc:
+module Menus
+  #:nodoc:
+  module Models
+    ##
+    # Model used for managing individual menu items in a group.
+    # This model uses the following plugins:
+    #
+    # * tree
+    #
+    # @author Yorick Peterse
+    # @since  0.2a
+    #
+    class MenuItem < Sequel::Model
+      plugin :tree, :order => :order
+
+      ##
+      # Specifies all validation rules that will be used when creating or updating a 
+      # menu item.
+      #
+      # @author Yorick Peterse
+      # @since  0.2a
+      #
+      def validate
+        validates_presence :name
+        validates_integer  [:order, :parent_id]
+        
+        # Prevent people from entering random crap for class and ID names
+        validates_format(/^[a-zA-Z\-_0-9]*/, [:css_class, :css_id])
+      end
+    end
+  end
+end

data/lib/zen/package/menus/lib/menus/view/admin/menu-items/edit.xhtml

@@ -0,0 +1,7 @@
+<article>
+    <header>
+        <h1>#{get_breadcrumbs}</h1>
+    </header>
+
+    #{render_partial :form}
+</article>

data/lib/zen/package/menus/lib/menus/view/admin/menu-items/form.xhtml

@@ -0,0 +1,64 @@
+#{
+form_for(
+  @menu_item, :method => :post, :action => @form_save_url, :id => :menu_item_form
+) do |f|
+
+  f.input_hidden(:csrf_token, get_csrf_token)
+  f.input_hidden(:id        , @menu_item.id)
+  f.input_hidden(:menu_id   , @menu_id)
+
+  f.input_text(
+    lang('menu_items.labels.name'), 
+    :name, 
+    :placeholder => lang('menu_items.placeholders.name')
+  )
+
+  f.input_text(
+    lang('menu_items.labels.url'),
+    :url, 
+    :placeholder => lang('menu_items.placeholders.url')
+  )
+
+  f.input_text(
+    lang('menu_items.labels.order'),
+    :order, 
+    :placeholder => lang('menu_items.placeholders.order')
+  )
+
+  # Generate the dropdown that contains all possible parent menu items    
+  parent_items = {}
+  Menus::Models::Menu[@menu_id.to_i].menu_items.each do |i|
+    if i.id != @menu_item.id
+      parent_items[i.id] = i.name
+    end
+  end
+
+  parent_items = menu_item_tree(@menu_id.to_i)
+
+  f.select(
+    lang('menu_items.labels.parent_id'),
+    :parent_id, 
+    :values   => parent_items, 
+    :selected => @menu_item.parent_id, 
+    :size     => 1
+  )
+
+  f.input_text(
+    lang('menu_items.labels.css_class'), 
+    :css_class, 
+    :placeholder => lang('menu_items.placeholders.css_class')
+  )
+
+  f.input_text(
+    lang('menu_items.labels.css_id'), 
+    :css_id, 
+    :placeholder => lang('menu_items.placeholders.css_id')
+  )
+
+  f.g.div(:class => :clearfix) do
+    f.g.div(:class => :button) do
+      f.g.input(:type => :submit, :value => lang('menu_items.buttons.save'))
+    end
+  end
+end
+}

data/lib/zen/package/menus/lib/menus/view/admin/menu-items/index.xhtml

@@ -0,0 +1,84 @@
+<article>
+    <header>
+        <h1>#{get_breadcrumbs}</h1>
+    </header>
+
+    <form method="post" action="#{@form_delete_url}">
+        <input name="csrf_token" type="hidden" value="#{get_csrf_token}" />
+
+        <?r if @menu_items and !@menu_items.empty? ?>
+        <table class="table">
+            <thead>
+                <tr>
+                    <?r if user_authorized?([:delete]) ?>
+                    <th>
+                        <input type="checkbox" />
+                    </th>
+                    <?r end ?>
+
+                    <th>#{lang('menu_items.labels.id')}</th>
+                    <th>#{lang('menu_items.labels.name')}</th>
+                    <th>#{lang('menu_items.labels.url')}</th>
+                    <th>#{lang('menu_items.labels.parent_id')}</th>
+                    <th>#{lang('menu_items.labels.order')}</th>
+                    <th>#{lang('menu_items.labels.css_class')}</th>
+                    <th>#{lang('menu_items.labels.css_id')}</th>
+                </tr>
+            </thead>
+            <tbody>
+
+                <?r @menu_items.each do |item| ?>
+                <tr>
+                    <?r if user_authorized?([:delete]) ?>
+                    <td>
+                        <input name="menu_item_ids[]" type="checkbox" value="#{item.id}" />
+                    </td>
+                    <?r end ?>
+
+                    <td>#{item.id}</td>
+
+                    <?r if user_authorized?([:edit]) ?>
+                    <td>
+                        #{anchor_to(
+                          item.name, 
+                          Menus::Controllers::MenuItems.r(:edit, @menu_id, item.id)
+                        )}
+                    </td>
+                    <?r else ?>
+                    <td>#{item.name}</td>
+                    <?r end ?>
+
+                    <td>#{anchor_to(item.url, item.url)}</td>
+                    <td>#{item.ancestors.map { |a| a.name }.join(', ')}</td>
+                    <td>#{item.order}</td>
+                    <td>#{item.css_class}</td>
+                    <td>#{item.css_id}</td>
+                </tr>
+                <?r end ?>
+
+            </tbody>
+        </table>
+
+        <?r else ?>
+        <p>#{lang('menu_items.messages.no_items')}</p>
+        <?r end ?>
+
+        <div class="clearfix">
+            <?r if user_authorized?([:create, :read]) ?>
+            <div class="button">
+                #{anchor_to(
+                  lang('menu_items.buttons.new'), 
+                  Menus::Controllers::MenuItems.r(:new, @menu_id)
+                )}
+            </div>
+            <?r end ?>
+
+            <?r if user_authorized?([:delete]) ?>
+            <div class="button">
+                <input type="submit" value="#{lang('menu_items.buttons.delete')}" />
+            </div>
+            <?r end ?>
+        </div>
+    </form> 
+
+</article>

data/lib/zen/package/menus/lib/menus/view/admin/menu-items/new.xhtml

@@ -0,0 +1,7 @@
+<article>
+    <header>
+        <h1>#{get_breadcrumbs}</h1>
+    </header>
+
+    #{render_partial :form}
+</article>

data/lib/zen/package/menus/lib/menus/view/admin/menus/edit.xhtml

@@ -0,0 +1,7 @@
+<article>
+    <header>
+        <h1>#{get_breadcrumbs}</h1>
+    </header>
+
+    #{render_partial :form}
+</article>

data/lib/zen/package/menus/lib/menus/view/admin/menus/form.xhtml

@@ -0,0 +1,42 @@
+#{
+form_for(@menu, :method => :post, :action => @form_save_url, :id => :menu_form) do |f| 
+  f.input_hidden(:csrf_token, get_csrf_token)
+  f.input_hidden(:id        , @menu.id)
+
+  f.input_text(
+    lang('menus.labels.name'), 
+    :name, 
+    :placeholder => lang('menus.placeholders.name') 
+  )
+
+  f.input_text(
+    lang('menus.labels.slug'), 
+    :slug, 
+    :placeholder => lang('menus.placeholders.slug')
+  )
+    
+  f.input_text(
+    lang('menus.labels.css_class'), 
+    :css_class, 
+    :placeholder => lang('menus.placeholders.css_class')
+  )
+
+  f.input_text(
+    lang('menus.labels.css_id'), 
+    :css_id, 
+    :placeholder => lang('menus.placeholders.css_id')
+  )
+
+  f.textarea(
+    lang('menus.labels.description'), 
+    :description, 
+    :rows => 8
+  )
+  
+  f.g.div(:class => "clearfix") do
+    f.g.div(:class => "button") do
+      f.g.input(:type => :submit, :value => lang('menus.buttons.save'))
+    end
+  end
+end
+}

data/lib/zen/package/menus/lib/menus/view/admin/menus/index.xhtml

@@ -0,0 +1,95 @@
+<article>
+    <header>
+        <h1>#{get_breadcrumbs}</h1>
+    </header>
+
+    <form action="#{@form_delete_url}" method="post">
+        <input name="csrf_token" type="hidden" value="#{get_csrf_token}" />
+
+        <?r if @menus and !@menus.empty? ?>
+
+        <table class="table">
+            <thead>
+                <tr>
+                    <?r if user_authorized?([:delete]) ?>
+                    <th>
+                        <input type="checkbox" />
+                    </th>
+                    <?r end ?>
+
+                    <th>#{lang('menus.labels.id')}</th>
+                    <th>#{lang('menus.labels.name')}</th>
+                    <th>#{lang('menus.labels.slug')}</th>
+                    <th>#{lang('menus.labels.css_class')}</th>
+                    <th>#{lang('menus.labels.css_id')}</th>
+
+                    <?r if user_authorized?([:create, :read]) ?>
+                    <th></th>
+                    <?r end ?>
+                </tr>
+            </thead>
+
+            <tbody>
+                <?r @menus.each do |menu| ?>
+                <tr>
+                    <?r if user_authorized?([:delete]) ?>
+                    <td>
+                        <input type="checkbox" name="menu_ids[]" value="#{menu.id}" />
+                    </td>
+                    <?r end ?>
+
+                    <td>#{menu.id}</td>
+
+                    <?r if user_authorized?([:edit]) ?>
+                    <td>
+                        #{anchor_to(
+                          menu.name, 
+                          Menus::Controllers::Menus.r(:edit, menu.id)
+                        )}
+                    </td>
+                    <?r else ?>
+                    <td>#{menu.name}</td>
+                    <?r end ?>
+
+                    <td>#{menu.slug}</td>
+                    <td>#{menu.css_class}</td>
+                    <td>#{menu.css_id}</td>
+
+                    <?r if user_authorized?([:create, :read]) ?>
+                    <td>
+                        #{anchor_to(
+                          lang('menus.labels.manage_items'), 
+                          Menus::Controllers::MenuItems.r(:index, menu.id)
+                        )}
+                    </td>
+                    <?r end ?>
+                </tr>
+                <?r end ?>
+            </tbody>
+        </table>
+
+        <?r else ?>
+        <p>#{lang('menus.messages.no_menus')}</p>
+        <?r end ?>
+
+        <div class="clearfix">
+
+            <?r if user_authorized?([:create, :read]) ?>
+            <div class="button">
+                #{anchor_to(
+                  lang('menus.buttons.new'), 
+                  Menus::Controllers::Menus.r(:new) 
+                )}
+            </div>
+            <?r end ?>
+
+            <?r if user_authorized?([:delete]) ?>
+            <div class="button">
+                <input type="submit" value="#{lang('menus.buttons.delete')}" />
+            </div>
+            <?r end ?>
+
+        </div>
+            
+    </form>    
+</article>

data/lib/zen/package/menus/lib/menus/view/admin/menus/new.xhtml

@@ -0,0 +1,7 @@
+<article>
+    <header>
+        <h1>#{get_breadcrumbs}</h1>
+    </header>
+
+    #{render_partial :form}
+</article>

data/lib/zen/package/menus/migrations/1297184342_create_schema.rb

@@ -0,0 +1,33 @@
+Sequel.migration do
+
+  up do
+    create_table :menus do
+      primary_key :id
+
+      String :name        , :null => false
+      String :slug        , :null => false, :index => true
+      String :description , :text => true
+      String :css_class
+      String :css_id
+    end
+
+    create_table :menu_items do
+      primary_key :id
+
+      Integer :parent_id, :index   => true
+      String :name      , :null    => false
+      String :url       , :null    => false
+      Integer :order    , :default => 0
+      String :css_class
+      String :css_id
+
+      foreign_key :menu_id, :menus, :update => :on_cascade, :on_delete => :cascade, :key => :id,
+    end
+  end
+  
+  down do
+    drop_table :menu_items
+    drop_table :menus
+  end
+
+end

data/lib/zen/{packages → package}/sections/lib/sections/controller/section_entries.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module Sections
+  #:nodoc:
   module Controllers
     ##
     # Section entries can be seen as blog entries, products, all sorts of things.
@@ -8,15 +10,14 @@ module Sections
     # @since  0.1
     #
     class SectionEntries < Zen::Controllers::AdminController
-      map '/admin/section_entries'
+      include ::Sections::Models 
       
+      map   '/admin/section-entries' 
       trait :extension_identifier => 'com.zen.sections'
       
-      include ::Sections::Models
-      
       before_all do
-        csrf_protection :save, :delete do
-          respond(@zen_general_lang.errors[:csrf], 401)
+        csrf_protection(:save, :delete) do
+          respond(lang('zen_general.errors.csrf'), 403)
         end
       end
       
@@ -24,44 +25,66 @@ module Sections
       # Constructor method, called upon initialization. It's used to set the
       # URL to which forms send their data and load the language pack.
       #
+      # This method loads the following language files:
+      #
+      # * sections
+      # * section_entries
+      # * zen_models
+      #
       # @author Yorick Peterse
       # @since  0.1
       #
       def initialize
         super
         
-        @form_save_url   = '/admin/section_entries/save'
-        @form_delete_url = '/admin/section_entries/delete'
-        @entries_lang    = Zen::Language.load 'section_entries'
-        @sections_lang   = Zen::Language.load 'sections'
-        @models_lang     = Zen::Language.load 'zen_models'
+        @form_save_url   = SectionEntries.r(:save)
+        @form_delete_url = SectionEntries.r(:delete)
+        
+        Zen::Language.load('section_entries')
+        Zen::Language.load('sections')
         
         # Set the page title
         if !action.method.nil?
-          method = action.method.to_sym
-        
-          if @entries_lang.titles.key? method
-            @page_title = @entries_lang.titles[method]
-          end
+          method      = action.method.to_sym
+          @page_title = lang("section_entries.titles.#{method}") rescue nil
         end
+
+        # Load our datepicker that ships with Zen itself
+        require_js(
+          'vendor/datepicker/Picker', 'vendor/datepicker/Picker.Attach', 
+          'vendor/datepicker/Picker.Date', 'vendor/datepicker/locale'
+        )
+
+        require_css('datepicker')
+
+        @status_hash = {
+          'draft'     => lang('section_entries.special.status_hash.draft'),
+          'published' => lang('section_entries.special.status_hash.published')
+        }
       end
       
       ##
-      # Show an overview of all entries for the current section
+      # Show an overview of all entries for the current section.
+      #
+      # This method requires the following permissions:
+      #
+      # * read
       # 
       # @author Yorick Peterse
       # @param  [Integer] section_id The ID of the current section.
       # @since  0.1
       #
-      def index section_id
+      def index(section_id)
         if !user_authorized?([:read])
-          respond(@zen_general_lang.errors[:not_authorized], 403)
+          respond(lang('zen_general.errors.not_authorized'), 403)
         end
         
-        set_breadcrumbs anchor_to(@sections_lang.titles[:index], "admin"),
-          @entries_lang.titles[:index]
+        set_breadcrumbs(
+          anchor_to(lang('sections.titles.index'), Sections.r(:index)),
+          lang('section_entries.titles.index')
+        )
         
-        section     = Section[section_id]
+        section     = Section[section_id.to_i]
         @section_id = section_id
         @entries    = section.section_entries
       end
@@ -69,52 +92,68 @@ module Sections
       ##
       # Show a form that lets the user edit an existing section entry.
       #
+      # This method requires the following permissions:
+      #
+      # * read
+      # * update
+      #
       # @author Yorick Peterse
       # @param  [Integer] section_id The ID of the current section.
       # @param  [Integer] entry_id The ID of the current section entry.
       # @since  0.1
       #
-      def edit section_id, entry_id
+      def edit(section_id, entry_id)
         if !user_authorized?([:read, :update])
-          respond(@zen_general_lang.errors[:not_authorized], 403)
+          respond(lang('zen_general.errors.not_authorized'), 403)
         end
         
-        set_breadcrumbs anchor_to(@sections_lang.titles[:index], "admin"),
-          anchor_to(@entries_lang.titles[:index], "admin/section_entries/index/#{section_id}"),
-          @entries_lang.titles[:edit]
+        set_breadcrumbs(
+          anchor_to(lang('sections.titles.index'), Sections.r(:index)),
+          anchor_to(lang('section_entries.titles.index'), SectionEntries.r(:index, section_id)),
+          lang('section_entries.titles.edit')
+        )
         
         @section_id = section_id
-        @entry      = SectionEntry[entry_id]
+
+        if flash[:form_data]
+          @entry = flash[:form_data]
+        else
+          @entry = SectionEntry[entry_id.to_i]
+        end
+
         @users_hash = {}
         
-        Users::Models::User.each do |u|
-          @users_hash[u.id] = u.name
-        end
+        Users::Models::User.each { |u| @users_hash[u.id] = u.name }
       end
       
       ##
       # Show a form that lets the user create a new section entry.
       #
+      # This method requires the following permissions:
+      #
+      # * read
+      # * create
+      #
       # @author Yorick Peterse
       # @param  [Integer] section_id The ID of the current section.
       # @since  0.1
       #
       def new section_id
         if !user_authorized?([:read, :create])
-          respond(@zen_general_lang.errors[:not_authorized], 403)
+          respond(lang('zen_general.errors.not_authorized'), 403)
         end
         
-        set_breadcrumbs anchor_to(@sections_lang.titles[:index], "admin"),
-          anchor_to(@entries_lang.titles[:index], "admin/section_entries/index/#{section_id}"),
-          @entries_lang.titles[:new]
+        set_breadcrumbs(
+          anchor_to(lang('sections.titles.index'), Sections.r(:index)),
+          anchor_to(lang('section_entries.titles.index'), SectionEntries.r(:index, section_id)),
+          lang('section_entries.titles.new')
+        )
           
         @section_id = section_id
-        @entry      = SectionEntry.new :section_id => @section_id
+        @entry      = SectionEntry.new(:section_id => @section_id)
         @users_hash = {}
         
-        Users::Models::User.each do |u|
-          @users_hash[u.id] = u.name
-        end
+        Users::Models::User.each { |u| @users_hash[u.id] = u.name }
       end
       
       ##
@@ -122,6 +161,11 @@ module Sections
       # 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 section or to update an existing one.
       #
+      # This method requires the following permissions:
+      #
+      # * create
+      # * save
+      #
       # @author Yorick Peterse
       # @since  0.1
       # @todo The way this method handles the creation of field values might require some
@@ -129,28 +173,25 @@ module Sections
       #
       def save
         if !user_authorized?([:create, :save])
-          respond(@zen_general_lang.errors[:not_authorized], 403)
+          respond(lang('zen_general.errors.not_authorized'), 403)
         end
         
         post                = request.params.dup
-        section_id          = post["section_id"]
-        field_values        = post["custom_field_values"]
+        section_id          = post['section_id']
+        field_values        = post['custom_field_values']
         custom_field_errors = {}
         
         post.delete("custom_field_values")
+        post.delete('slug') if post['slug'].empty?
         
-        post.each do |key, value|
-          post.delete(key) if value.empty?
-        end
-        
-        if !post["category_pks"].nil?
-          post["category_pks"].map! { |value| value.to_i }
+        if !post['category_pks'].nil?
+          post['category_pks'].map! { |value| value.to_i }
         else
-          post["category_pks"] = []
+          post['category_pks'] = []
         end
 
-        if post["id"] and !post["id"].empty?
-          @entry        = SectionEntry[post["id"]]
+        if post['id'] and !post['id'].empty?
+          @entry        = SectionEntry[post['id']]
           save_action   = :save
           
           # Section entries aren't considered to be updated whenever a custom field value
@@ -161,29 +202,35 @@ module Sections
           save_action   = :new
         end
         
-        flash_success = @entries_lang.success[save_action]
-        flash_error   = @entries_lang.errors[save_action]
+        flash_success = lang("section_entries.success.#{save_action}")
+        flash_error   = lang("section_entries.errors.#{save_action}")
         
         # Transactions ahoy!
         begin
           Zen::Database.handle.transaction do
             # Update the entry itself
             @entry.update(post)
-            notification(:success, @entries_lang.titles[:index], flash_success)
+            notification(:success, lang('section_entries.titles.index'), flash_success)
             
             # Update the field values
             field_values.each do |field_id, value|
-              field_value = CustomFields::Models::CustomFieldValue[:custom_field_id => field_id, :section_entry_id => @entry.id]
+              field_value = CustomFields::Models::CustomFieldValue[
+                :custom_field_id  => field_id, 
+                :section_entry_id => @entry.id
+              ]
               
               if field_value.nil?
-                field_value = @entry.add_custom_field_value(:section_entry_id => @entry.id, :custom_field_id => field_id)
+                field_value = @entry.add_custom_field_value(
+                  :section_entry_id => @entry.id, 
+                  :custom_field_id  => field_id
+                )
               end
               
               # Get the custom field for the current value
               custom_field = field_value.custom_field
               
               if custom_field.required and value.empty?
-                custom_field_errors[:"custom_field_values[#{field_id}]"] = @models_lang.presence
+                custom_field_errors[:"custom_field_values[#{field_id}]"] = lang('zen_models.presence')
               end
               
               # Validate the entry
@@ -203,14 +250,16 @@ module Sections
         # 2. Any custom field marked as required didn't have a value
         # 3. Something else went wrong, god knows what.
         rescue
-          notification(:error, @entries_lang.titles[:index], flash_error)
+          notification(:error, lang('section_entries.titles.index'), flash_error)
             
           flash[:form_errors] = @entry.errors.merge(custom_field_errors)
+          flash[:form_data]   = @entry
+
           redirect_referrer
         end
         
         if @entry.id
-          redirect "/admin/section_entries/edit/#{section_id}/#{@entry.id}"
+          redirect(SectionEntries.r(:edit, section_id, @entry.id))
         else
           redirect_referrer
         end
@@ -220,27 +269,42 @@ module Sections
       # Delete a set of section entries based on the supplied POST
       # field "section_entry_ids".
       #
+      # This method requires the following permissions:
+      #
+      # * delete
+      #
       # @author Yorick Peterse
       # @since  0.1
       #
       def delete
         if !user_authorized?([:delete])
-          respond(@zen_general_lang.errors[:not_authorized], 403)
+          respond(lang('zen_general.errors.not_authorized'), 403)
         end
         
-        if !request.params["section_entry_ids"] or request.params["section_entry_ids"].empty?
-          notification(:error, @entries_lang.titles[:index], @entries_lang.errors[:no_delete])
+        if !request.params['section_entry_ids'] or request.params['section_entry_ids'].empty?
+          notification(
+            :error, 
+            lang('section_entries.titles.index'), 
+            lang('section_entries.errors.no_delete')
+          )
+
           redirect_referrer
         end
         
-        request.params["section_entry_ids"].each do |id|
-          @entry = SectionEntry[id]
-          
+        request.params['section_entry_ids'].each do |id|
           begin
-            @entry.delete
-            notification(:success, @entries_lang.titles[:index], @entries_lang.success[:delete] % id)
+            SectionEntry[id.to_i].destroy
+            notification(
+              :success, 
+              lang('section_entries.titles.index'), 
+              lang('section_entries.success.delete')
+            )
           rescue
-            notification(:error, @entries_lang.titles[:index], @entries_lang.errors[:delete] % id)
+            notification(
+              :error, 
+              lang('section_entries.titles.index'), 
+              lang('section_entries.errors.delete') % id
+            )
           end
         end
         
@@ -248,4 +312,4 @@ module Sections
       end
     end 
   end
-end
+end