zen 0.1a → 0.2

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

@@ -1,4 +1,6 @@
+#:nodoc:
 module Sections
+  #:nodoc:
   module Controllers
     ##
     # Sections can be seen as mini applications inside your website.
@@ -13,15 +15,14 @@ module Sections
     # @since   0.1
     #
     class Sections < Zen::Controllers::AdminController
-      map '/admin'
-      
-      trait :extension_identifier => 'com.zen.sections'
-      
       include ::Sections::Models
+
+      map   '/admin'
+      trait :extension_identifier => 'com.zen.sections'
       
       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
       
@@ -29,39 +30,45 @@ 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
+      #
       # @author Yorick Peterse
       # @since  0.1
       #
       def initialize
         super
         
-        @form_save_url   = '/admin/save'
-        @form_delete_url = '/admin/delete'
-        @sections_lang   = Zen::Language.load 'sections'
+        @form_save_url   = Sections.r(:save)
+        @form_delete_url = Sections.r(:delete)
+        
+        Zen::Language.load('sections')
         
         # Set the page title
         if !action.method.nil?
-          method = action.method.to_sym
-        
-          if @sections_lang.titles.key? method 
-            @page_title = @sections_lang.titles[method]
-          end
+          method      = action.method.to_sym
+          @page_title = lang("sections.titles.#{method}") rescue nil
         end
       end
     
       ##
       # Show an overview of all existing sections. Using this overview a user
       # can manage an existing section, delete it or create a new one.
+      #
+      # This method requires the following permissions:
+      #
+      # * read
       # 
       # @author Yorick Peterse
       # @since  0.1
       #
       def index
         if !user_authorized?([:read])
-          respond(@zen_general_lang.errors[:not_authorized], 403)
+          respond(lang('zen_general.errors.not_authorized'), 403)
         end
         
-        set_breadcrumbs @sections_lang.titles[:index]
+        set_breadcrumbs(lang('sections.titles.index'))
         
         @sections = Section.all
       end
@@ -69,34 +76,55 @@ module Sections
       ##
       # Show a form that lets the user edit an existing section.
       #
+      # This method requires the following permissions:
+      #
+      # * read
+      # * update
+      #
       # @author Yorick Peterse
       # @param  [Integer] id The ID of the section to retrieve so that we can edit it.
       # @since  0.1
       #
       def edit 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"), @page_title
+        set_breadcrumbs(
+          anchor_to(lang('sections.titles.index'), Sections.r(:index)), 
+          @page_title
+        )
         
         @custom_field_group_pk_hash = CustomFields::Models::CustomFieldGroup.pk_hash(:name)
         @category_group_pk_hash     = Categories::Models::CategoryGroup.pk_hash(:name)
-        @section                    = Section[id]
+
+        if flash[:form_data]
+          @section = flash[:form_data]
+        else
+          @section = Section[id.to_i]
+        end
       end
       
       ##
       # Show a form that lets the user create a new section.
       #
+      # This method requires the following permissions:
+      #
+      # * create
+      # * read
+      #
       # @author Yorick Peterse
       # @since  0.1
       #
       def new
         if !user_authorized?([:create, :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"), @page_title
+        set_breadcrumbs(
+          anchor_to(lang('sections.titles.index'), Sections.r(:index)), 
+          @page_title
+        )
         
         @custom_field_group_pk_hash = CustomFields::Models::CustomFieldGroup.pk_hash(:name)
         @category_group_pk_hash     = Categories::Models::CategoryGroup.pk_hash(:name)
@@ -108,43 +136,47 @@ 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
+      # * update
+      #
       # @author Yorick Peterse
       # @since  0.1
       #
       def save
         if !user_authorized?([:create, :update])
-          respond(@zen_general_lang.errors[:not_authorized], 403)
+          respond(lang('zen_general.errors.not_authorized'), 403)
         end
         
         post = request.params.dup
-       
-        post.each do |key, value|
-          post.delete(key) if value.empty?
-        end
 
-        if post["id"] and !post["id"].empty?
-          @section      = Section[post["id"]]
+        if post['id'] and !post['id'].empty?
+          @section      = Section[post['id']]
           save_action   = :save
         else
           @section      = Section.new
           save_action   = :new
         end
         
-        flash_success = @sections_lang.success[save_action]
-        flash_error   = @sections_lang.errors[save_action]
+        flash_success = lang("sections.success.#{save_action}")
+        flash_error   = lang("sections.errors.#{save_action}")
         
         # The primary keys have to be integers otherwise Sequel will soil it's pants
-        if !post["custom_field_group_pks"].nil?
-          post["custom_field_group_pks"].map! { |value| value.to_i }
+        if !post['custom_field_group_pks'].nil?
+          post['custom_field_group_pks'].map! { |value| value.to_i }
         else
-          post["custom_field_group_pks"] = []
+          post['custom_field_group_pks'] = []
         end
         
-        if !post["category_group_pks"].nil?
-          post["category_group_pks"].map! { |value| value.to_i }
+        if !post['category_group_pks'].nil?
+          post['category_group_pks'].map! { |value| value.to_i }
         else
-          post["category_group_pks"] = [] 
+          post['category_group_pks'] = [] 
         end
+
+        # Auto generate the slug if it's empty
+        post.delete('slug') if post['slug'].empty?
         
         begin
           @section.update(post)
@@ -154,15 +186,16 @@ module Sections
             @section.category_group_pks     = post['category_group_pks']
           end
           
-          notification(:success, @sections_lang.titles[:index], flash_success)
+          notification(:success, lang('sections.titles.index'), flash_success)
         rescue
-          notification(:error, @sections_lang.titles[:index], flash_error)
+          notification(:error, lang('sections.titles.index'), flash_error)
           
+          flash[:form_data]   = @section
           flash[:form_errors] = @section.errors
         end
         
         if @section.id
-          redirect "/admin/edit/#{@section.id}"
+          redirect(Sections.r(:edit, @section.id))
         else
           redirect_referrer
         end
@@ -174,27 +207,42 @@ module Sections
       # a field named "section_ids[]". This field should contain the primary values of
       # each section that has to be deleted.
       #
+      # 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_ids"] or request.params["section_ids"].empty?
-          notification(:error, @sections_lang.titles[:index], @sections_lang.errors[:no_delete])
+        if !request.params['section_ids'] or request.params['section_ids'].empty?
+          notification(
+            :error, 
+            lang('sections.titles.index'), 
+            lang('sections.errors.no_delete')
+          )
+
           redirect_referrer
         end
         
-        request.params["section_ids"].each do |id|
-          @section = Section[id]
-          
+        request.params['section_ids'].each do |id|
           begin
-            @section.delete
-            notification(:success, @sections_lang.titles[:index], @sections_lang.success[:delete] % id)
+            Section[id.to_i].destroy
+            notification(
+              :success, 
+              lang('sections.titles.index'), 
+              lang('sections.success.delete')
+            )
           rescue
-            notification(:error, @sections_lang.titles[:index], @sections_lang.errors[:delete] % id)
+            notification(
+              :error, 
+              lang('sections.titles.index'), 
+              lang('sections.errors.delete') % id
+            )
           end
         end
         

data/lib/zen/package/sections/lib/sections/language/en/section_entries.yml

@@ -0,0 +1,43 @@
+---
+titles:
+  index  : 'Entries'
+  edit   : 'EditEntry'
+  new    : 'AddEntry'
+
+labels:
+  id         : '#'
+  title      : 'Title'
+  slug       : 'Slug'
+  status     : 'Status'
+  created_at : 'Created at'
+  updated_at : 'Updated at'
+  author     : 'Author'
+
+special:
+  status_hash:
+    draft      : 'Draft'
+    published  : 'Published'
+
+tabs:
+  basic       : 'Basic'
+  categories  : 'Categories'
+
+messages:
+  no_entries     : 'No section entries have been created.'
+  no_categories  : 'No categories have been assigned to the current section.'
+
+errors:
+  new        : 'Failed to create a new section entry.'
+  save       : 'Failed to save the section entry.'
+  delete     : 'Failed to delete the section entry with ID#%s'
+  no_delete  : "You haven't specified any section entries to delete."
+
+success:
+  new     : 'The new section entry has been created.'
+  save    : 'The section entry has been modified.'
+  delete  : 'All selected entries have been deleted.'
+
+buttons:
+  new     : 'Add section entry'
+  delete  : 'Delete selected entries'
+  save    : 'Save entry'

data/lib/zen/package/sections/lib/sections/language/en/sections.yml

@@ -0,0 +1,48 @@
+---
+titles:
+  index  : 'Sections'
+  edit   : 'Edit Section'
+  new    : 'Add Secton'
+
+labels:
+  id                       : '#'
+  name                     : 'Name'
+  slug                     : 'Slug'
+  description              : 'Description'
+  comment_allow            : 'Allow comments'
+  comment_require_account  : 'Comments require an account'
+  comment_moderate         : 'Moderate comments'
+  comment_format           : 'Comment format'
+  custom_field_groups      : 'Custom field groups'
+  category_groups          : 'Category groups'
+  manage_entries           : 'Manage entries'
+
+special:
+  boolean_hash:
+    'true'  : 'Yes'
+    'false' : 'No'
+
+tabs:
+  general            : 'General'
+  comment_settings   : 'Comment Settings'
+  group_assignments  : 'Group Assignments'
+
+messages:
+  no_sections: "No sections have been created yet."
+
+errors:
+  new        : 'Failed to create a new section.'
+  save       : 'Failed to modify the section.'
+  delete     : 'Failed to delete the section with ID #%s.'
+  no_delete  : 'You need to specify at least one section to delete.'
+
+success:
+  new     : 'The new section has been created.'
+  save    : 'The section has been modified.'
+  delete  : 'The selected sections have been deleted.'
+
+buttons:
+  new     : 'Add section'
+  delete  : 'Delete selected sections'
+  save    : 'Save section'
+

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

@@ -1,12 +1,14 @@
+#:nodoc:
 module Sections
+  #:nodoc:
   module Liquid
     ##
     # The SectionEntries tag can be used to retrieve all section entries
     # for the given section. A basic example of this looks like the following:
     #
-    # bc. {% section_entries section="blog" %}
-    # Do something in here
-    # {% endsection_entries %}
+    #     {% section_entries section="blog" %}
+    #         Do something in here
+    #     {% endsection_entries %}
     #
     # When using this tag you can specify the following optionally arguments:
     #
@@ -16,20 +18,21 @@ module Sections
     # * section_entry: the slug of the section entry to select
     # * order: the sort order type
     # * order_by: the name of the column to sort on
+    # * category: retrieves all entries that are using the specified category
     #
     # These arguments can be specified as following:
     #
-    # bc. {% section_entries section="blog" limit="10" offset="20" %}
-    # Do something in here
-    # {% endsection_entries %}
+    #     {% section_entries section="blog" limit="10" offset="20" %}
+    #         Do something in here
+    #     {% endsection_entries %}
     #
     # Inside this block you can output the values of your custom fields by
     # calling the variable tag containing the name of the custom field. For example,
     # if you have a field called "body" you can output it for each entry as following:
     #
-    # bc. {% section_entries section="blog" limit="10" offset="20" %}
-    # {{body}}
-    # {% endsection_entries %}
+    #     {% section_entries section="blog" limit="10" offset="20" %}
+    #         {{body}}
+    #     {% endsection_entries %}
     #
     # The following variables are available by default:
     #
@@ -42,14 +45,13 @@ module Sections
     # * section_id: the ID of the section to which this entry belongs
     #
     # @example
-    #
     #  {% section_entries section="blog" limit="10" offset="20" %}
     #  <article>
-    #    <header>
-    #      <h1>{{title}}</h1>
-    #    </header>
+    #      <header>
+    #         <h1>{{title}}</h1>
+    #      </header>
     #
-    #    {{body}}
+    #      {{body}}
     #  </article>
     #  {% endsection_entries %}
     #
@@ -70,24 +72,25 @@ module Sections
       # @param  [String] arguments All additional arguments passed as a string.
       # @param  [String] html The HTML inside the block.
       #
-      def initialize tag_name, arguments, html
+      def initialize(tag_name ='section_entries', arguments = '', html = '')
         super
-        
+
         @arguments = {
-          'limit'   => nil,
-          'offset'  => nil,
-          'section' => Zen::Controllers::FrontendController.session[:settings][:default_section],
-          'order'   => 'desc',
-          'order_by'=> 'id'
+          'limit'    => 10,
+          'offset'   => 0,
+          'section'  => '',
+          'order'    => 'desc',
+          'order_by' => 'id',
+          'category' => ''
         }.merge(parse_key_values(arguments))
         
         @args_parsed = false
       end
       
       ##
-      # Processes that arguments, retrieves all data and renders the tag block.
-      # When outputting data inside the tag block you can always use the following
-      # variables:
+      # Processes the arguments set in the constructor, retrieves all data and renders 
+      # the tag block. When outputting data inside the tag block you can always use the 
+      # following variables regardless on whether there are any section entries:
       #
       # * total_rows: the amount of rows retrieved
       # * index: the current index
@@ -105,38 +108,48 @@ module Sections
       # @author Yorick Peterse
       # @since  0.1
       #
-      def render context
-        # Check if any of the given arguments in @arguments exist in our context.
-        if @args_parsed == false
-          @arguments.each do |k, v|
-            v = v.to_s
-            
-            if context.has_key?(v)
-              @arguments[k] = h(context[v])
-            end
-          end
-        end
-        
+      def render(context)
+        @arguments = merge_context(@arguments, context) if @args_parsed == false
+                
         @args_parsed = true
         result       = []
         entries      = []
         filter_hash  = {:status => 'published'}
         
+        # ------
+        # Filter by a section entry's slug
         if @arguments.key?('section_entry')
           if @arguments['section_entry'].empty?
-            raise ArgumentError, "You need to specify a section entry to retrieve"
+            raise(ArgumentError, "You need to specify a section entry to retrieve")
           end
           
           filter_hash[:slug] = @arguments['section_entry']
+
+        # ------
+        # Filter by a category's slug
+        elsif @arguments.key?('category') and !@arguments['category'].empty?
+          category = ::Categories::Models::Category[:slug => @arguments['category']]
+
+          # Bail out of the category doesn't exist
+          return result if category.nil?
+    
+          # Retrieve the category group
+          group = category.category_group
+
+          # Now it's time to retrieve all section IDs
+          filter_hash[:section_id] = group.sections.map { |s| s.id }
         
+        # ------
+        # Filter by a section's slug
         else
           if @arguments['section'].empty?
-            raise ArgumentError, "You need to specify a section for which to retrieve all entries"
+            @arguments['section'] = ::Settings::Model::Setting.get_settings[:default_section]
           end
           
           section = ::Sections::Models::Section[:slug => @arguments['section']]
           
           return result if section.nil?
+
           filter_hash[:section_id] = section.id
         end
         
@@ -149,9 +162,7 @@ module Sections
         context['total_rows'] = entries.count
         
         entries.each_with_index do |entry, index|
-          entry.values.each do |k, v|
-            context[k.to_s] = v
-          end
+          entry.values.each { |k, v| context[k.to_s] = v }
           
           context['index']      = index
           context['categories'] = []
@@ -198,10 +209,11 @@ module Sections
             context[name.to_s] = value
           end
           
-          result << render_all(@nodelist, context)
+          result.push(render_all(@nodelist, context))
         end
         
-        result << render_all(@nodelist, context) if result.empty?
+        result.push(render_all(@nodelist, context)) if result.empty?
+
         return result
       end
     end