zen 0.1a → 0.2

data/lib/zen/liquid/controller_behavior.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module Zen
+  #:nodoc:
   module Liquid
     ##
     # Module that can be used to allow Liquid tags to use data that would otherwise

data/lib/zen/liquid/general.rb

@@ -1,6 +1,6 @@
-require 'enumerator'
-
+#:nodoc:
 module Zen
+  #:nodoc:
   module Liquid
     ##
     # Module that provides several methods that can be used to ease the process of
@@ -17,14 +17,14 @@ module Zen
       # and turns it into a key/value hash. This makes it easier to
       # use tags with key/value variables such as the following:
       #
-      # bc. {% my_tag name="yorick" %}
+      #     {% my_tag name="yorick" %}
       #
       # @author Yorick Peterse
       # @since  0.1
       # @param  [String] string the raw string specified after the tag name.
-      # @return [Hash]
+      # @return [Hash] A key/value hash of all specified arguments.
       #
-      def parse_key_values string
+      def parse_key_values(string)
         key_values = {}
         
         # Thanks to Michael Trommer (https://github.com/entropie) for coming up with
@@ -36,21 +36,72 @@ module Zen
         # Returns the data in the format of {'key' => 'value'}
         return key_values
       end
-      
+
+      ##
+      # Merges the values in the given context with the hash. This means that if the
+      # Liquid context has a key that matches a value in the hash that key's value
+      # will become the value of the key in the hash. Confused? Assume our context has
+      # a key of "username" which is set to "YorickPeterse". If our hash had a key
+      # who's value is "username" that value would be replaced with "YorickPeterse".
+      #
+      # If context was a hash (it's an object) this would result in something like the
+      # following:
+      #
+      #     context = {'username' => 'YorickPeterse'}
+      #     hash = {'selected_user' => 'username'}
+      # 
+      #     merge_context(hash, context) # => {'selected_user' => 'YorickPeterse'}
+      #
+      # This method will also automatically escape all variables using the h() method
+      # so you don't have to worry about nasty input.
+      #
+      # @author Yorick Peterse
+      # @since  0.2a
+      # @param  [Hash] hash The input hash that may contain Liquid variables
+      # @param  [Liquid::Context] context The Liquid context from which to extract any
+      # variables set in the hash.
+      # @return [Hash] The merged hash.
+      #
+      def merge_context(hash, context)
+        if hash.class != Hash
+          raise(
+            TypeError, 
+            "The first argument of this method should be a hash instead of \"#{hash.class}\""
+          )
+        end
+
+        hash.each do |k, v|
+          v = v.to_s
+
+          # Check if the Liquid context has a matching key and extract the value of that key
+          # if this is the case.
+          if context.respond_to?('key?')
+            if context.key?(v)
+              hash[k] = h(context[v])
+            end
+          else
+            if context.has_key?(v)
+              hash[k] = h(context[v])
+            end
+          end
+        end
+
+        return hash
+      end
+       
       ##
       # Converts the given input data to HTML using the specified markup engine.
       #
       # @example
-      #
       #  markup_to_html("h2. Hello world!", :textile)
       #
       # @author Yorick Peterse
       # @since  0.1
       # @param  [String] markup The raw markup that has to be converted to HTML.
       # @param  [Symbol] engine The markup engine to use such as Textile.
-      # @return [String] 
+      # @return [String] The HTML generated by the markup engine.
       #
-      def markup_to_html markup, engine
+      def markup_to_html(markup, engine)
         engine = engine.to_sym
         
         case engine

data/lib/zen/liquid/redirect.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module Zen
+  #:nodoc:
   module Liquid
     ##
     # The Redirect tag can be used to redirect a user from one URL to another. 
@@ -6,13 +8,20 @@ module Zen
     # @example
     #  {% redirect "blog/index" %}
     #
+    # Optionally you can redirect a user to a 404 page by doing the following:
+    #
+    #     {% redirect "404" %}
+    #
+    # This will render the 404 template but without changing the current URL.
+    #
     # @author Yorick Peterse
     # @since  0.1
     #
     class Redirect < ::Liquid::Tag
       include ::Ramaze::Helper::Redirect
       include ::Zen::Liquid::ControllerBehavior
-     
+      include ::Ramaze::Helper::Render
+      
       ##
       # Creates a new instance of this tag by passing the tag name, arguments and HTML
       # tokens to the construct.
@@ -23,8 +32,10 @@ module Zen
       # @param  [String] arguments All additional arguments passed as a string.
       # @param  [String] tokens All tokens (HTML mostly) inside the tag block.
       #
-      def initialize tag_name, arguments, tokens
-        @url = arguments.gsub('"', '').gsub("'", '')
+      def initialize(tag_name = 'redirect', arguments = '', tokens = '')
+        super
+
+        @url = arguments.gsub('"', '').gsub("'", '').strip
       end
       
       ##
@@ -35,12 +46,24 @@ module Zen
       # @since  0.1
       # @param  [Object] context The current Liquid context
       # 
-      def render context
+      def render(context)
         if @url.nil? or @url.empty?
-          raise ArgumentError, "You need to specify a URL in order to redirect a user"
+          raise(ArgumentError, "You need to specify a URL in order to redirect a user")
         end
         
-        redirect(@url)
+        # 404 URLs are treated differently than other URLs
+        if @url == '404'
+          theme      = ::Zen::Package[session[:settings][:theme]]
+          not_found  = theme.directory + "/templates/404.liquid"
+
+          if File.exist?(not_found)
+            respond(action.instance.render_file(not_found), 404)
+          else
+            respond("The requested page could not be found", 404)
+          end
+        else
+          redirect(@url)
+        end
       end
     end
   end

data/lib/zen/liquid/strip.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module Zen
+  #:nodoc:
   module Liquid
     ##
     # Tag block that can be used to strip leading and trailing characters from
@@ -31,7 +33,7 @@ module Zen
       # @param  [String] html The HTML inside the block.
       # @since  0.1
       #
-      def initialize tag_name, arguments, html
+      def initialize(tag_name = 'strip', arguments = '', html = '')
         super
         
         @arguments = {'start' => '', 'end' => ''}

data/lib/zen/model/methods.rb

@@ -1,12 +1,14 @@
+#:nodoc:
 module Sequel
+  #:nodoc:
   class Model
     ##
-    # Retrieves all primary values and an optional column and returns the results as an array of hashes in
-    # which the keys of these hashes are the IDs and the values the values of the specified column.
-    # This array can be used when creating <select> elements using the BlueForm helper.
+    # Retrieves all primary values and an optional column and returns the results as 
+    # an array of hashes in which the keys of these hashes are the IDs and the values 
+    # the values of the specified column. This array can be used when creating <select> 
+    # elements using the BlueForm helper.
     #
     # @example
-    #
     #  Sections::Models::Section.pk_hash(:name) # => {1 => 'Blog', 2 => 'General'}
     #
     # @author Yorick Peterse
@@ -23,4 +25,4 @@ module Sequel
       return hash
     end
   end
-end
+end

data/lib/zen/model/settings.rb

@@ -1,9 +1,10 @@
-# Load the language pack and configure Sequel to use that pack
-lang = Zen::Language.load 'zen_models'
+include Zen::Language
 
-# When passing a hash to update() or create() we'll ignore any keys that don't belong in the table.
-# This allows you to directly pass request.params to these methods without having to filter the hash
-# yourself.
+Zen::Language.load('zen_models')
+
+# When passing a hash to update() or create() we'll ignore any keys that don't belong 
+# in the table. This allows you to directly pass request.params to these methods 
+# without having to filter the hash yourself.
 Sequel::Model.strict_param_setting = false
 
 # Load all the required plugins
@@ -12,16 +13,66 @@ Sequel::Model.plugin :association_pks
 Sequel::Model.plugin :schema
 
 Sequel::Plugins::ValidationHelpers::DEFAULT_OPTIONS.merge!(
-  :exact_length => {:message => lang.exact_length},
-  :format       => {:message => lang.format},
-  :includes     => {:message => lang.includes, :allow_nil => false},
-  :integer      => {:message => lang.integer,  :allow_nil => true},
-  :length_range => {:message => lang.length_range},
-  :max_length   => {:message => lang.max_length, :allow_nil => true},
-  :min_length   => {:message => lang.min_length, :allow_nil => true},
-  :not_string   => {:message => lang.not_string},
-  :numeric      => {:message => lang.numeric},
-  :type         => {:message => lang.type},
-  :presence     => {:message => lang.presence},
-  :unique       => {:message => lang.unique}
-)
+{
+  :exact_length => {
+    :message    => lambda do |length|
+      lang('zen_models.exact_length') & length
+    end
+  },
+
+  :format    => {
+    :message => lang('zen_models.format')
+  },
+
+  :includes  => {
+    :message => lambda do |arg|
+      lang('zen_models.includes') % arg.inspect
+    end,
+    :allow_nil => false
+  },
+
+  :integer     => {
+    :message   => lang('zen_models.integer'),
+    :allow_nil => true
+  },
+
+  :length_range =>
+  {
+    :message => lang('zen_models.length_range')
+  },
+
+  :max_length => {
+    :message  => lambda do |length|
+      lang('zen_models.max_length') % length
+    end,
+    :allow_nil => true
+  },
+
+  :min_length => {
+    :message  => lambda do |length|
+      lang('zen_models.min_length') % length
+    end
+  },
+
+  :not_string => {
+    :message  => lang('zen_models.not_string')
+  },
+
+  :numeric   => {
+    :message => lang('zen_models.numeric')
+  },
+
+  :type      => {
+    :message => lambda do |type|
+      lang('zen_models.type') % type
+    end
+  },
+
+  :presence  => {
+    :message => lang('zen_models.presence')
+  },
+
+  :unique    => {
+    :message => lang('zen_models.unique')
+  }
+})

data/lib/zen/package/all.rb

@@ -0,0 +1,7 @@
+require __DIR__('categories/lib/categories')
+require __DIR__('comments/lib/comments')
+require __DIR__('custom_fields/lib/custom_fields')
+require __DIR__('menus/lib/menus')
+require __DIR__('sections/lib/sections')
+require __DIR__('settings/lib/settings')
+require __DIR__('users/lib/users')

data/lib/zen/{packages → package}/categories/lib/categories.rb

@@ -12,13 +12,13 @@ Zen::Package.add do |p|
   p.name        = 'Categories'
   p.author      = 'Yorick Peterse'
   p.url         = 'http://yorickpeterse.com/'
-  p.version     = '0.1'
+  p.version     = '1.0'
   p.about       = "Module for managing categories. Categories can be used to organize section entries."
   p.identifier  = 'com.zen.categories'
   p.directory   = __DIR__('categories')
   
   p.menu = [{
     :title => "Categories",
-    :url   => "admin/category_groups"
+    :url   => "admin/category-groups"
   }]
-end
+end

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

@@ -0,0 +1,250 @@
+#:nodoc:
+module Categories 
+  #:nodoc:
+  module Controllers
+    ##
+    # Categories can be seen as "tags" for your section entries. They describe the
+    # type of entry just like tags except that categories generally cover larger elements.
+    # When adding a new entry categories aren't required so you're free to ignore 
+    # them if you don't need them.
+    #
+    # @author Yorick Peterse
+    # @since  0.1
+    #
+    class Categories < Zen::Controllers::AdminController
+      include ::Categories::Models
+      
+      map '/admin/categories'
+      trait :extension_identifier => 'com.zen.categories'
+      
+      before_all do
+        csrf_protection(:save, :delete) do
+          respond(lang('zen_general.errors.csrf'), 403)
+        end
+      end
+      
+      ##
+      # The constructor is used to set various options such as the form URLs and load
+      # the language pack for the categories module.
+      #
+      # The following language files are loaded:
+      #
+      # * categories
+      # * category_groups
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def initialize
+        super
+        
+        @form_save_url   = Categories.r(:save)
+        @form_delete_url = Categories.r(:delete)
+
+        Zen::Language.load('categories')
+        Zen::Language.load('category_groups')
+        
+        # Set the page title
+        if !action.method.nil?
+          method      = action.method.to_s
+          @page_title = lang("categories.titles.#{method}") rescue nil
+        end
+      end
+      
+      ##
+      # Show an overview of all existing categories and allow the user
+      # to create and manage these categories.
+      #
+      # This method requires the following permissions:
+      #
+      # * read
+      #
+      # @author Yorick Peterse
+      # @param  [Integer] category_group_id The ID of the category group that's currently
+      # being managed by the user.
+      # @since  0.1
+      #
+      def index category_group_id
+        if !user_authorized?([:read])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+        
+        set_breadcrumbs(
+          anchor_to(lang('category_groups.titles.index'), CategoryGroups.r(:index)),
+          lang('categories.titles.index')
+        )
+        
+        @category_group_id = category_group_id.to_i
+        @categories        = CategoryGroup[@category_group_id].categories
+      end
+      
+      ##
+      # Edit an existing category based on the ID specified in the URL.
+      #
+      # This method requires the following permissions:
+      #
+      # * read
+      # * update
+      #
+      # @author Yorick Peterse
+      # @param  [Integer] category_group_id The category group ID.
+      # @param  [Integer] id The ID of the category to edit.
+      # @since  0.1
+      #
+      def edit category_group_id, id
+        if !user_authorized?([:read, :update])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+        
+        set_breadcrumbs(
+          anchor_to(lang('category_groups.titles.index'), CategoryGroups.r(:index)),
+          anchor_to(lang('categories.titles.index'), Categories.r(:index, category_group_id)),
+          lang('categories.titles.edit')
+        )
+          
+        @category_group_id = category_group_id.to_i
+
+        if flash[:form_data]
+          @category = flash[:form_data]
+        else
+          @category = Category[id.to_i]
+        end
+      end
+      
+      ##
+      # Create a new category.
+      #
+      # This method requires the following permissions:
+      #
+      # * read
+      # * create
+      #
+      # @author Yorick Peterse
+      # @param  [Integer] category_group_id The ID of the category group.
+      # @since  0.1
+      #
+      def new category_group_id
+        if !user_authorized?([:read, :create])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+        
+        set_breadcrumbs(
+          anchor_to(lang('category_groups.titles.index'), CategoryGroups.r(:index)),
+          anchor_to(lang('categories.titles.index'), Categories.r(:index, category_group_id)),
+          lang('categories.titles.new')
+        )
+          
+        @category_group_id = category_group_id.to_i
+        @category          = Category.new
+      end
+
+      ##
+      # Save the changes made to an existing category or create a new one based
+      # on the current POST data.
+      #
+      # This method requires the following permissions:
+      #
+      # * create
+      # * update
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #    
+      def save
+        if !user_authorized?([:create, :update])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+        
+        post              = request.params.dup
+        category_group_id = post['category_group_id']
+        
+        post.delete('slug') if post['slug'].empty?
+
+        # Retrieve the category and set the notifications based on if the ID has
+        # been specified or not.
+        if post['id'] and !post['id'].empty?
+          @category   = Category[post['id'].to_i]
+          save_action = :save
+        else
+          @category   = Category.new
+          save_action = :new
+        end
+        
+        flash_success = lang("categories.success.#{save_action}")
+        flash_error   = lang("categories.errors.#{save_action}")
+        
+        # Try to update the category
+        begin
+          @category.update(post)
+          notification(:success, lang('categories.titles.index'), flash_success)
+        rescue
+          notification(:error, lang('categories.titles.index'), flash_error)
+ 
+          flash[:form_errors] = @category.errors
+          flash[:form_data]   = @category
+        end
+        
+        if @category.id
+          redirect(Categories.r(:edit, category_group_id, @category.id))
+        else  
+          redirect(Categories.r(:new, category_group_id))
+        end
+      end
+      
+      ##
+      # Delete all specified category groups and their categories. In
+      # order to delete a number of groups an array of fields, named "category_group_ids"
+      # is required. This array will contain all the primary values of each group 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(lang('zen_general.errors.not_authorized'), 403)
+        end
+        
+        post              = request.params.dup
+        category_group_id = post['category_group_id'].to_i
+        
+        # Obviously we'll require some IDs
+        if !request.params['category_ids'] or request.params['category_ids'].empty?
+          notification(
+            :error, 
+            lang('categories.titles.index'), 
+            lang('categorieserrors.no_delete')
+          )
+
+          redirect(Categories.r(:index, category_group_id))
+        end
+        
+        # Delete each section
+        request.params['category_ids'].each do |id|
+          begin
+            Category[id.to_i].destroy
+            notification(
+              :success, 
+              lang('categories.titles.index'), 
+              lang('categories.success.delete')
+            )
+
+          rescue
+            notification(
+              :error, 
+              lang('categories.titles.index'), 
+              lang('categories.errors.delete') % id
+            )
+
+          end
+        end
+        
+        redirect(Categories.r(:index, category_group_id))
+      end
+    end
+  end
+end