zen 0.2.3 → 0.2.4

data/lib/zen/liquid/general.rb

@@ -48,7 +48,7 @@ module Zen
       # following:
       #
       #     context = {'username' => 'YorickPeterse'}
-      #     hash = {'selected_user' => 'username'}
+      #     hash    = {'selected_user' => 'username'}
       # 
       #     merge_context(hash, context) # => {'selected_user' => 'YorickPeterse'}
       #
@@ -89,32 +89,6 @@ module Zen
         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] The HTML generated by the markup engine.
-      #
-      def markup_to_html(markup, engine)
-        engine = engine.to_sym
-        
-        case engine
-          when :textile
-            markup = RedCloth.new(markup).to_html
-          when :markdown
-            markup = RDiscount.new(markup).to_html
-          when :plain
-            markup = h(markup)  
-        end
-        
-        return markup
-      end
     end
   end
 end

data/lib/zen/{base/package.rb → package.rb}

@@ -1,4 +1,7 @@
 require 'ramaze/gestalt'
+require __DIR__('helper/acl')
+require __DIR__('liquid/controller_behavior')
+require __DIR__('error/package_error')
 
 #:nodoc:
 module Zen
@@ -8,7 +11,8 @@ module Zen
   # actually be installed using either Rubygems or by storing them in a custom directory. 
   # As long as you require the correct file you're good to go.
   #
-  # Packages are added or "described" using a simple block and the add() method as following:
+  # Packages are added or "described" using a simple block and the add() method as 
+  # following:
   #
   #     Zen::Package.add do |ext|
   #       # ....
@@ -16,10 +20,8 @@ module Zen
   #
   # When using this block you're required to set the following attributes:
   #
-  # * type: the type of package, can either be "theme" or "extension"
   # * name: the name of the package
   # * author: the name of the person who made the package
-  # * version: the current version, either a string or a numeric value
   # * about: a small description of the package
   # * url: the URL to the package's website
   # * identifier: unique identifier for the package. The format is com.AUTHOR.NAME for
@@ -61,33 +63,29 @@ module Zen
   # directory of your extension. For example, if your extension is in "foobar" the migrations
   # should be located in "foobar/migrations", the lib directory in "foobar/lib", etc.
   #
-  # Migrations can be executed using the Rake task "extension:migrate" or "db:migrate",
-  # the latter will install all extensions while the first one will only install the 
-  # specified extension. Migration prototypes can be generated by the Rake task
-  # "proto:migration[DIRECTORY]" where DIRECTORY is the path to your migrations directory.
+  # Migrations can be executed using the Thor task "package:migrate" or "db:migrate",
+  # the latter will install all packages while the first one will only install the 
+  # specified packages. For more information on these tasks execute the following command:
   #
-  # ## Themes
+  #     $ thor -T
   #
-  # Themes are essentially packages like the sections or comments module except that they
-  # have a few limitations and work a bit different. First of all themes can't add 
-  # navigation items to the backend and second they should _always_ have the following 
-  # directories:
+  # ## Identifiers
   #
-  # * theme/lib/theme/templates
-  # * theme/lib/theme/public
+  # Package identifiers should always have the following format:
   #
-  # The templates directory is used to store all Liquid templates and template groups, 
-  # the public directory is used for CSS files, images and so on. Themes can have 
-  # migrations just like extensions which makes it relatively easy to share a theme 
-  # with somebody else.
+  #     com.VENDOR.NAME
+  #
+  # For example:
+  #
+  #     com.zen.sections
   #
   # @author Yorick Peterse
   # @since  0.1
+  # @attr_reader [Array] packages Array containing the instances of all packages.
   #
   module Package
     class << self
-      attr_reader :extensions
-      attr_reader :themes
+      attr_reader :packages
     end
     
     ##
@@ -102,7 +100,6 @@ module Zen
     #
     # When adding a new extension the following setters are required:
     #
-    # * type
     # * name
     # * author
     # * version
@@ -111,21 +108,24 @@ module Zen
     # * identifier
     # * directory
     #
+    # You can also set "migration_dir" to a directory with all migrations. By default
+    # Zen will assume that it's 2 levels above your root directory.
+    #
     # @author Yorick Peterse
     # @since  0.1
-    # @param  [Block] block Block containing information about the extension.
+    # @yield  [package] Object containing all setters and getters for each package.
     #
-    def self.add(&block)
-      package  = Struct.new(:type, :name, :author, :version, :about, :url,
-        :identifier, :directory, :menu).new
-      required = [:type, :name, :author, :version, :about, :url, :identifier, :directory]
+    def self.add
+      package = Zen::StrictStruct.new(
+        :name, :author, :about, :url, :identifier, :directory, :menu, :migration_dir
+      ).new
+
+      required = [:name, :author, :about, :identifier, :directory]
       
       yield package
       
-      required.each do |m|
-        if !package.respond_to?(m) or package.send(m).nil?
-          raise "A loaded package has no value set for the setter \"#{m}\""
-        end
+      package.validate(required) do |k|
+        raise(Zen::PackageError, "The following package key is missing: #{k}")
       end
 
       # Update the root but prevent duplicates
@@ -137,18 +137,18 @@ module Zen
       if !Zen::Language.options.paths.include?(package.directory)
         Zen::Language.options.paths.push(package.directory)
       end
-      
-      # Themes and extensions each have a different accessor
-      if package.type.to_s == 'theme'
-        # Remove the navigation menu
-        package.menu = nil if !package.menu.nil?
-        
-        @themes                          = {} if @themes.nil?
-        @themes[package.identifier.to_s] = package
-      else
-        @extensions                          = {} if @extensions.nil?
-        @extensions[package.identifier.to_s] = package
+
+      # Validate the directories
+      [:directory, :migration_dir].each do |k|
+        if package.respond_to?(k) and !package.send(k).nil?
+          if !File.exist?(package.send(k))
+            raise(PackageError, "The directory #{package.send(k)} does not exist.")
+          end
+        end
       end
+      
+      @packages                          = {} if @packages.nil?
+      @packages[package.identifier.to_s] = package 
     end
     
     ##
@@ -160,11 +160,7 @@ module Zen
     # @return [Object]
     #
     def self.[](ident)
-      if ident.include?('.themes.')
-        @themes[ident]
-      else
-        @extensions[ident]
-      end
+      @packages[ident.to_s]
     end
     
     ##
@@ -174,18 +170,32 @@ module Zen
     # of which each list item can contain N sub items.
     #
     # @author Yorick Peterse
-    # @param  [String] css_class A string of CSS classes to apply to the
-    # main UL element.
+    # @param  [String]  css_class A string of CSS classes to apply to the main UL element.
+    # @param  [Hash]    permissions Hash containing the permissions as returned by
+    # Ramaze::Helper::ACL#extension_permissions
+    # @param  [Boolean] all When set to true all elements will be displayed opposed to 
+    # only those the user is allowed to see.
     # @since  0.1
     #
-    def self.build_menu(css_class = '')
-      @g         = Ramaze::Gestalt.new
-      menu_items = []
+    def self.build_menu(css_class = '', permissions = {}, all = false)
+      @g          = Ramaze::Gestalt.new
+      menu_items  = []
+      identifiers = []
+
+      # Build a list of all allowed extensions
+      permissions.each do |ident, rules|
+        if rules.include?(:read)
+          identifiers.push(ident)
+        end
+      end
       
-      @extensions.each do |ident, ext|
+      @packages.each do |ident, ext|
+        # Got a menu for us?
         if !ext.menu.nil?
-          ext.menu.each do |m|
-            menu_items.push(m)
+          if identifiers.include?(ext.identifier) or all == true
+            ext.menu.each do |m|
+              menu_items.push(m)
+            end
           end
         end
       end
@@ -235,6 +245,6 @@ module Zen
         end
       end
     end
-    
+
   end
 end

data/lib/zen/package/all.rb

@@ -1,3 +1,8 @@
+##
+# Loads all core packages that ship with Zen. Note that it's important to load these
+# packages in the correct order as otherwise migrations that create foreign keys might
+# not work.
+#
 require __DIR__('users/lib/users')
 require __DIR__('sections/lib/sections')
 require __DIR__('settings/lib/settings')

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

@@ -8,14 +8,13 @@ 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     = '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.name          = 'Categories'
+  p.author        = 'Yorick Peterse'
+  p.url           = 'http://yorickpeterse.com/'
+  p.about         = "Module for managing categories. Categories can be used to organize section entries."
+  p.identifier    = 'com.zen.categories'
+  p.directory     = __DIR__('categories')
+  p.migration_dir = __DIR__('../migrations')
   
   p.menu = [{
     :title => "Categories",

data/lib/zen/package/comments/lib/comments.rb

@@ -10,14 +10,13 @@ Liquid::Template.register_tag('comments'    , Comments::Liquid::Comments)
 Liquid::Template.register_tag('comment_form', Comments::Liquid::CommentForm)
 
 Zen::Package.add do |p|
-  p.type        = 'extension'
-  p.name        = 'Comments'
-  p.author      = 'Yorick Peterse'
-  p.url         = 'http://yorickpeterse.com/'
-  p.version     = '1.0'
-  p.about       = "Allow users to post comments on any given section entry (as long as the section allows it)."
-  p.identifier  = 'com.zen.comments'
-  p.directory   = __DIR__('comments')
+  p.name          = 'Comments'
+  p.author        = 'Yorick Peterse'
+  p.url           = 'http://yorickpeterse.com/'
+  p.about         = "Allow users to post comments on any given section entry (as long as the section allows it)."
+  p.identifier    = 'com.zen.comments'
+  p.directory     = __DIR__('comments')
+  p.migration_dir = __DIR__('../migrations')
   
   p.menu = [{
     :title => "Comments",

data/lib/zen/package/comments/lib/comments/controller/comments_form.rb

@@ -127,7 +127,7 @@ module Comments
             flash[:success] = lang('comments.success.new')
           end
         rescue
-          flash[:error]     = lang('comments.errors.new')
+          flash[:error] = lang('comments.errors.new')
         end
         
         redirect_referrer

data/lib/zen/package/comments/lib/comments/liquid/comments.rb

@@ -94,7 +94,9 @@ module Comments
           comment.values.each { |k, v| context[k.to_s] = v }
           
           # Convert the comment body into HTML
-          context['comment'] = markup_to_html(context['comment'], format)
+          context['comment'] = Zen::Plugin.call(
+            'com.zen.plugin.markup', format.to_sym, context['comment']
+          )
           
           ['email', 'name', 'website'].each do |c|
             if context[c].nil? or context[c].empty?

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

@@ -8,14 +8,13 @@ require __DIR__ 'custom_fields/controller/custom_field_groups'
 require __DIR__ 'custom_fields/controller/custom_fields'
 
 Zen::Package.add do |p|
-  p.type        = 'extension'
-  p.name        = 'Custom Fields'
-  p.author      = 'Yorick Peterse'
-  p.url         = 'http://yorickpeterse.com/'
-  p.version     = 1.0
-  p.about       = "The Custom Fields module is used to manage, how original, custom fields and custom field groups."
-  p.identifier  = 'com.zen.custom_fields'
-  p.directory   = __DIR__('custom_fields')
+  p.name          = 'Custom Fields'
+  p.author        = 'Yorick Peterse'
+  p.url           = 'http://yorickpeterse.com/'
+  p.about         = "The Custom Fields module is used to manage, how original, custom fields and custom field groups."
+  p.identifier    = 'com.zen.custom_fields'
+  p.directory     = __DIR__('custom_fields')
+  p.migration_dir = __DIR__('../migrations')
   
   p.menu = [{
     :title => "Custom Fields",

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

@@ -17,6 +17,20 @@ module CustomFields
     class CustomFieldValue < Sequel::Model
       many_to_one(:custom_field , :class => "CustomFields::Models::CustomField")
       many_to_one(:section_entry, :class => "Sections::Models::SectionEntry")
+
+      ##
+      # Hook that is executed before saving a field's value. This hook is used to clean
+      # up all values making it easier to process them at a later stage.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.4
+      #
+      def before_save
+        # T-t-t-t-that's all folks!
+        if !self.value.nil?
+          self.value.gsub!(/\r\n/, "\n")
+        end
+      end
     end
   end
 end

data/lib/zen/package/custom_fields/migrations/1295255665_create_schema.rb

@@ -23,7 +23,7 @@ Sequel.migration do
       TrueClass :required,            :null => false, :default => false
       TrueClass :visual_editor,       :null => false, :default => true
       Integer   :textarea_rows,       :default => 10
-      Integer   :text_limit,          :default => 1
+      Integer   :text_limit
       
       foreign_key :custom_field_group_id, :custom_field_groups, :on_delete => :cascade,
         :on_update => :cascade, :key => :id

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

@@ -17,9 +17,6 @@ Liquid::Template.register_tag('menus', Menus::Liquid::Menus)
 
 # Describe the package
 Zen::Package.add do |p|
-  # The type of extension. Can either be "theme" or "extension".
-  p.type        = 'extension'
-
   # The name of the package
   p.name        = 'Menus' 
 
@@ -29,9 +26,6 @@ Zen::Package.add do |p|
   # A URL to a page about the package
   p.url         = 'http://zen-cms.com/userguide/menus'
 
-  # The version number of the package
-  p.version     = '1.0'
-
   # Describe what your theme or extension does.
   p.about       = 'The Menus extension allows you to easily create navigation menus 
 for the frontend.'
@@ -50,6 +44,11 @@ for the frontend.'
   # Path to the directory containing the controllers, models, etc.
   #
   p.directory   = __DIR__('menus')
+
+  ##
+  # Path to the directory containing all migrations for this package.
+  #
+  p.migration_dir = __DIR__('../migrations')
   
   # Note that themes can not have menu items (they'll be ignored).
   p.menu = [{

data/lib/zen/package/sections/lib/sections.rb

@@ -14,20 +14,19 @@ Liquid::Template.register_tag('section_entries', Sections::Liquid::SectionEntrie
 
 # Describe what this extension is all about
 Zen::Package.add do |p|
-  p.type        = 'extension'
   p.name        = 'Sections'
   p.author      = 'Yorick Peterse'
   p.url         = 'http://yorickpeterse.com/'
-  p.version     = 1.0
   p.about       = "The sections module allows users to create and manage sections. 
 Sections can be seen as small web applications that live inside the CMS. 
 For example, you could have a section for your blog and for your pages."
   
-  p.identifier  = 'com.zen.sections'
-  p.directory   = __DIR__('sections')
+  p.identifier    = 'com.zen.sections'
+  p.directory     = __DIR__('sections')
+  p.migration_dir = __DIR__('../migrations')
   
   p.menu = [{
     :title => "Sections",
     :url   => "admin"
   }]
-end
+end

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

@@ -1,8 +1,8 @@
 ---
 titles:
   index  : 'Entries'
-  edit   : 'EditEntry'
-  new    : 'AddEntry'
+  edit   : 'Edit Entry'
+  new    : 'Add Entry'
 
 labels:
   id         : '#'