zen 0.1a

data/lib/zen/liquid/redirect.rb

@@ -0,0 +1,47 @@
+module Zen
+  module Liquid
+    ##
+    # The Redirect tag can be used to redirect a user from one URL to another. 
+    #
+    # @example
+    #  {% redirect "blog/index" %}
+    #
+    # @author Yorick Peterse
+    # @since  0.1
+    #
+    class Redirect < ::Liquid::Tag
+      include ::Ramaze::Helper::Redirect
+      include ::Zen::Liquid::ControllerBehavior
+     
+      ##
+      # Creates a new instance of this tag by passing the tag name, arguments and HTML
+      # tokens to the construct.
+      # 
+      # @author Yorick Peterse
+      # @since  0.1
+      # @param  [String] tag_name The name of the tag that was called.
+      # @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("'", '')
+      end
+      
+      ##
+      # Redirects the user to a certain page based on the arguments specified in the
+      # constructor method.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      # @param  [Object] context The current Liquid context
+      # 
+      def render context
+        if @url.nil? or @url.empty?
+          raise ArgumentError, "You need to specify a URL in order to redirect a user"
+        end
+        
+        redirect(@url)
+      end
+    end
+  end
+end

data/lib/zen/liquid/strip.rb

@@ -0,0 +1,58 @@
+module Zen
+  module Liquid
+    ##
+    # Tag block that can be used to strip leading and trailing characters from
+    # the text inside of the block. This tag can be extremely useful when you're
+    # displaying elements seperated by a comma and want to remove the last comma.
+    #
+    # @example
+    #  {% strip end=", " %}
+    #    Hello, world, 
+    #  {% endstrip %}
+    #
+    # This tag has the following options:
+    #
+    # * start
+    # * end
+    #
+    # @author Yorick Peterse
+    # @since  0.1
+    #
+    class Strip < ::Liquid::Block
+      include ::Zen::Liquid::General
+      
+      ##
+      # Creates a new instance of the block and passes the tag name,
+      # all additional arguments and the HTML to the constructor method.
+      #
+      # @author Yorick Peterse
+      # @param  [String] tag_name The name of the tag that was called.
+      # @param  [String] arguments All additional arguments passed as a string.
+      # @param  [String] html The HTML inside the block.
+      # @since  0.1
+      #
+      def initialize tag_name, arguments, html
+        super
+        
+        @arguments = {'start' => '', 'end' => ''}
+        @arguments = @arguments.merge(parse_key_values(arguments))
+      end
+      
+      ##
+      # Renders the tag block. We'll retrieve the content inside the block,
+      # trim it and return it.
+      # 
+      # @author Yorick Peterse
+      # @since  0.1
+      # @param  [Object] context The Liquid context for the current tag
+      #
+      def render context
+        html = super
+        html = html.join
+        html = html.gsub(/^#{@arguments['start']}/, '').gsub(/#{@arguments['end']}$/, '')
+        
+        return html
+      end
+    end
+  end
+end

data/lib/zen/model/methods.rb

@@ -0,0 +1,26 @@
+module Sequel
+  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.
+    #
+    # @example
+    #
+    #  Sections::Models::Section.pk_hash(:name) # => {1 => 'Blog', 2 => 'General'}
+    #
+    # @author Yorick Peterse
+    # @param  [Symbol] column The name of the optional column to select.
+    # @return [Hash]
+    #
+    def self.pk_hash column
+      hash = {}
+      
+      self.select(:id, column.to_sym).each do |row|
+        hash[row.id] = row.send(column)
+      end
+      
+      return hash
+    end
+  end
+end

data/lib/zen/model/settings.rb

@@ -0,0 +1,27 @@
+# Load the language pack and configure Sequel to use that pack
+lang = 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
+Sequel::Model.plugin :validation_helpers
+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}
+)

data/lib/zen/packages/categories/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011, Yorick Peterse
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/zen/packages/categories/lib/categories.rb

@@ -0,0 +1,24 @@
+
+# Load all the classes such as controllers, models and so on.
+require __DIR__ 'categories/model/category_group'
+require __DIR__ 'categories/model/category'
+
+require __DIR__ 'categories/controller/category_groups'
+require __DIR__ 'categories/controller/categories'
+
+# Describe what this package is all about
+Zen::Package.add do |p|
+  p.type        = 'extension'
+  p.name        = 'Categories'
+  p.author      = 'Yorick Peterse'
+  p.url         = 'http://yorickpeterse.com/'
+  p.version     = '0.1'
+  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"
+  }]
+end

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

@@ -0,0 +1,202 @@
+module Categories
+  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
+      map '/admin/categories'
+      
+      trait :extension_identifier => 'com.zen.categories'
+      
+      include ::Categories::Models
+      
+      before_all do
+        csrf_protection :save, :delete do
+          respond(@zen_general_lang.errors[:csrf], 401)
+        end
+      end
+      
+      ##
+      # The constructor is used to set various options such as the form URLs and load
+      # the language pack for the categories module.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def initialize
+        super
+        
+        @form_save_url   = '/admin/categories/save'
+        @form_delete_url = '/admin/categories/delete'
+        @categories_lang = Zen::Language.load 'categories'
+        @groups_lang     = Zen::Language.load 'category_groups'
+        
+        # Set the page title
+        if !action.method.nil?
+          method = action.method.to_sym
+        
+          if @categories_lang.titles.key? method
+            @page_title = @categories_lang.titles[method]
+          end
+        end
+      end
+      
+      ##
+      # Show an overview of all existing categories and allow the user
+      # to create and manage these categories.
+      #
+      # @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(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        set_breadcrumbs anchor_to(@groups_lang.titles[:index], "admin/category_groups/"),
+          @categories_lang.titles[:index]
+                              
+        @category_group_id = category_group_id
+        @categories        = CategoryGroup[category_group_id].categories
+      end
+      
+      ##
+      # Edit an existing category based on the ID specified in the URL.
+      #
+      # @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(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        set_breadcrumbs anchor_to(@groups_lang.titles[:index], "admin/category_groups/"),
+          anchor_to(@categories_lang.titles[:index], "admin/categories/index/#{category_group_id}"),
+          @categories_lang.titles[:edit]
+          
+        @category_group_id = category_group_id
+        @category          = Category[id]
+      end
+      
+      ##
+      # Create a new category.
+      #
+      # @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(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        set_breadcrumbs anchor_to(@groups_lang.titles[:index], "admin/category_groups/"),
+          anchor_to(@categories_lang.titles[:index], "admin/categories/index/#{category_group_id}"),
+          @categories_lang.titles[:new]
+          
+        @category_group_id = category_group_id
+        @category          = Category.new
+      end
+
+      ##
+      # Save the changes made to an existing category or create a new one based
+      # on the current POST data.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #    
+      def save
+        if !user_authorized?([:create, :update])
+          respond(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        post              = request.params.dup
+        category_group_id = post["category_group_id"]
+        
+        # Remove all empty values
+        post.each do |key, value|
+          post.delete(key) if value.empty?
+        end
+        
+        post.delete("parent_id") if post["parent_id"] == '--'
+        
+        # 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"]]
+          save_action = :save
+        else
+          @category   = Category.new
+          save_action = :new
+        end
+        
+        flash_success = @categories_lang.success[save_action]
+        flash_error   = @categories_lang.errors[save_action]
+        
+        # Try to update the category
+        begin
+          @category.update(post)
+          notification(:success, @categories_lang.titles[:index], flash_success)
+        rescue
+          notification(:error, @categories_lang.titles[:index], flash_error)
+          flash[:form_errors] = @categories_lang.errors
+        end
+        
+        if @category.id
+          redirect "/admin/categories/edit/#{category_group_id}/#{@category.id}"
+        else  
+          redirect "/admin/categories/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.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def delete
+        if !user_authorized?([:delete])
+          respond(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        post              = request.params.dup
+        category_group_id = post["category_group_id"]
+        
+        # Obviously we'll require some IDs
+        if !request.params["category_ids"] or request.params["category_ids"].empty?
+          notification(:error, @categories_lang.titles[:index], @categories_lang.errors[:no_delete])
+          redirect "/admin/categories/index/#{category_group_id}"
+        end
+        
+        # Delete each section
+        request.params["category_ids"].each do |id|
+          @category = Category[id]
+          
+          begin
+            @category.delete
+            notification(:success, @categories_lang.titles[:index], @categories_lang.success[:delete] % id)
+          rescue
+            notification(:error, @categories_lang.titles[:index], @categories_lang.errors[:delete] % id)
+          end
+        end
+        
+        redirect "/admin/categories/index/#{category_group_id}"
+      end
+    end
+  end
+end

data/lib/zen/packages/categories/lib/categories/controller/category_groups.rb

@@ -0,0 +1,173 @@
+module Categories
+  module Controllers
+    ##
+    # Category groups can be used to group a number of categories into a single container.
+    # These groups are assigned to a section (rather than individual categories). It's
+    # important to remember that a section entry can't use a category group until it has
+    # been added to a section.
+    #
+    # @author Yorick Peterse
+    # @since  0.1
+    #
+    class CategoryGroups < Zen::Controllers::AdminController
+      map '/admin/category_groups'
+      
+      trait :extension_identifier => 'com.zen.categories'
+      
+      include ::Categories::Models
+      
+      before_all do
+        csrf_protection :save, :delete do
+          respond(@zen_general_lang.errors[:csrf], 401)
+        end
+      end
+      
+      ##
+      # The constructor is used to set various options such as the form URLs and load
+      # the language pack for the categories module.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def initialize
+        super
+        
+        @form_save_url   = '/admin/category_groups/save'
+        @form_delete_url = '/admin/category_groups/delete'
+        @groups_lang     = Zen::Language.load 'category_groups'
+        
+        # Set the page title
+        if !action.method.nil?
+          method = action.method.to_sym
+        
+          if @groups_lang.titles.key? method
+            @page_title = @groups_lang.titles[method]
+          end
+        end
+      end
+      
+      ##
+      # Show an overview of all existing category groups and allow the user
+      # to create new category groups or manage individual categories.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def index
+        if !user_authorized?([:read])
+          respond(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        set_breadcrumbs @groups_lang.titles[:index]
+        
+        @category_groups = CategoryGroup.all
+      end
+      
+      ##
+      # Edit an existing category group based on the ID specified in the URL.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def edit id
+        if !user_authorized?([:read, :update])
+          respond(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        set_breadcrumbs anchor_to(@groups_lang.titles[:index], "admin/category_groups"),
+          @groups_lang.titles[:edit]
+        
+        @category_group = CategoryGroup[id]
+      end
+      
+      ##
+      # Create a new category group.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def new
+        if !user_authorized?([:create, :read])
+          respond(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        set_breadcrumbs anchor_to(@groups_lang.titles[:index], "admin/category_groups"),
+          @groups_lang.titles[:new ]
+        
+        @category_group = CategoryGroup.new
+      end
+
+      ##
+      # Save or create a new category group based on the current POST data.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #    
+      def save
+        if !user_authorized?([:create, :update])
+          respond(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        post = request.params.dup
+        
+        if post["id"] and !post["id"].empty?
+          @category_group = CategoryGroup[post["id"]]
+          save_action     = :save
+        else
+          @category_group = CategoryGroup.new
+          save_action     = :new
+        end
+        
+        flash_success = @groups_lang.success[save_action]
+        flash_error   = @groups_lang.errors[save_action]
+        
+        begin
+          @category_group.update(post)
+          notification(:success, @groups_lang.titles[:index], flash_success)
+        rescue
+          notification(:error, @groups_lang.titles[:index], flash_error)
+          flash[:form_errors] = @groups_lang.errors
+        end
+        
+        if @category_group.id
+          redirect "/admin/category_groups/edit/#{@category_group.id}"
+        else  
+          redirect "/admin/cateogry_groups/new"
+        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.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def delete
+        if !user_authorized?([:delete])
+          respond(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        if !request.params["category_group_ids"] or request.params["category_group_ids"].empty?
+          notification(:error, @groups_lang.titles[:index], @groups_lang.errors[:no_delete])
+          redirect "/admin/category_groups"
+        end
+        
+        request.params["category_group_ids"].each do |id|
+          @category_group = CategoryGroup[id]
+          
+          begin
+            @cateogry_group.delete
+            notification(:success, @groups_lang.titles[:index], @groups_lang.success[:delete] % id)
+          rescue
+            notification(:error, @groups_lang.titles[:index], @groups_lang.errors[:delete] % id)
+          end
+        end
+        
+        redirect "/admin/category_groups"
+      end
+    end
+  end
+end