zen 0.2.3 → 0.2.4

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

@@ -196,7 +196,12 @@ module Sections
               end
             end
             
-            values['comment'] = markup_to_html(values['comment'], entry.section.comment_format)
+            values['comment'] = Zen::Plugin.call(
+              'com.zen.plugin.markup', 
+              entry.section.comment_format.to_sym, 
+              values['comment']
+            )
+
             context['comments'].push(values)
           end
           
@@ -204,7 +209,9 @@ module Sections
           entry.custom_field_values.each do |field_value|
             field = field_value.custom_field
             name  = field.slug
-            value = markup_to_html(field_value.value, field.format.to_sym)
+            value = ::Zen::Plugin.call(
+              'com.zen.plugin.markup', field.format.to_sym, field_value.value
+            )
             
             context[name.to_s] = value
           end

data/lib/zen/package/settings/lib/settings.rb

@@ -6,14 +6,13 @@ require __DIR__ 'settings/liquid/setting'
 Liquid::Template.register_tag('setting', Settings::Liquid::Setting)
 
 Zen::Package.add do |p|
-  p.type        = 'extension'
-  p.name        = 'Settings'
-  p.author      = 'Yorick Peterse'
-  p.url         = 'http://yorickpeterse.com/'
-  p.version     = 1.0
-  p.about       = 'Module for managing settings such as the default module, whether or not to allow registration, etc.'
-  p.identifier  = 'com.zen.settings'
-  p.directory   = __DIR__('settings')
+  p.name          = 'Settings'
+  p.author        = 'Yorick Peterse'
+  p.url           = 'http://yorickpeterse.com/'
+  p.about         = 'Module for managing settings such as the default module, whether or not to allow registration, etc.'
+  p.identifier    = 'com.zen.settings'
+  p.directory     = __DIR__('settings')
+  p.migration_dir = __DIR__('../migrations')
   
   p.menu = [{
     :title => "Settings",

data/lib/zen/package/users/lib/users.rb

@@ -18,15 +18,14 @@ Liquid::Template.register_tag('user' , Users::Liquid::User)
 Zen::Controllers::BaseController.trait(:user_model => Users::Models::User)
 
 Zen::Package.add do |p|
-  p.type        = 'extension'
-  p.name        = 'Users'
-  p.author      = 'Yorick Peterse'
-  p.url         = 'http://yorickpeterse.com/'
-  p.version     = '1.0'
-  p.about       = "Module for managing users along with handling authentication and authorization."
+  p.name          = 'Users'
+  p.author        = 'Yorick Peterse'
+  p.url           = 'http://yorickpeterse.com/'
+  p.about         = "Module for managing users along with handling authentication and authorization."
   
-  p.identifier  = 'com.zen.users'
-  p.directory   = __DIR__('users')
+  p.identifier    = 'com.zen.users'
+  p.directory     = __DIR__('users')
+  p.migration_dir = __DIR__('../migrations')
   
   p.menu = [{
     :title    => "Users",

data/lib/zen/package/users/lib/users/view/admin/access-rules/form.xhtml

@@ -18,7 +18,7 @@
       users[user.id.to_s] = user.name
     end
     
-    Zen::Package.extensions.each do |ident, ext|
+    Zen::Package.packages.each do |ident, ext|
       extensions[ident] = ext.name
     end
     
@@ -74,28 +74,28 @@
       lang('access_rules.labels.create'), 
       :create_access, 
       @access_rule.create_access,
-      :values => @boolean_hash.invert
+      :values => @boolean_hash
     )
   
     f.input_radio(
       lang('access_rules.labels.read'), 
       :read_access, 
       @access_rule.read_access,
-      :values => @boolean_hash.invert
+      :values => @boolean_hash
     )
   
     f.input_radio(
       lang('access_rules.labels.update'), 
       :update_access, 
       @access_rule.update_access,
-      :values => @boolean_hash.invert
+      :values => @boolean_hash
     )
 
     f.input_radio(
       lang('access_rules.labels.delete'), 
       :delete_access, 
       @access_rule.delete_access,
-      :values => @boolean_hash.invert
+      :values => @boolean_hash
     )
     
     f.g.div(:class => 'clearfix') do

data/lib/zen/package/users/lib/users/view/admin/access-rules/index.xhtml

@@ -49,10 +49,10 @@
                     <td>#{rule.extension}</td>
                     <?r end ?>
                     
-                    <td>#{@boolean_hash[rule.create_access]}</td>
-                    <td>#{@boolean_hash[rule.read_access]}</td>
-                    <td>#{@boolean_hash[rule.update_access]}</td>
-                    <td>#{@boolean_hash[rule.delete_access]}</td>
+                    <td>#{@boolean_hash.invert[rule.create_access]}</td>
+                    <td>#{@boolean_hash.invert[rule.read_access]}</td>
+                    <td>#{@boolean_hash.invert[rule.update_access]}</td>
+                    <td>#{@boolean_hash.invert[rule.delete_access]}</td>
                     <td>
                         <?r if !rule.user_id.nil? ?>
                         #{rule.user.name}

data/lib/zen/plugin.rb

@@ -0,0 +1,172 @@
+require __DIR__('error/plugin_error')
+
+#:nodoc:
+module Zen
+  ##
+  # Plugins in Zen are quite similar to packages except for a few differences. The biggest
+  # difference is that plugins won't update any Ramaze root directories or language
+  # direactories. This means that they can't have controllers, models and so on. On top
+  # of that they're nothing more than lambda's. Plugins are useful for supporting multiple
+  # markup formats (Markdown, Textile, etc) and other small tasks such as replacing Email
+  # addresses and so on.
+  #
+  # ## Creating Plugins
+  #
+  # Creating plugins works in a similar way as creating packages. Plugins are added by
+  # calling Zen::Plugin#add and passing a block to it with details such as the name of
+  # the plugin, the author, the identifier and a list of actions. The last two are very
+  # important as the plugin won't work without them.
+  #
+  # ### Actions
+  #
+  # Each plugin has a getter/setter called "actions", this is just a simple key/value
+  # hash where the keys are the names of the actions and the values lambda's. The keys
+  # should always be symbols. Example:
+  #
+  #     actions = {
+  #       :downcase => lambda do |string|
+  #         string.downcase
+  #       end
+  #     }
+  #
+  # Note that you don't *have to* use lambda's, anything that responds to call() will do.
+  # 
+  # Because the actions method contains just a hash you can easily add functionality to
+  # existing plugins as following:
+  #
+  #     # First retrieve our plugin
+  #     plugin = Zen::Plugin['com.something.plugin.name']
+  #     plugin.actions[:my_action] = lamda do
+  #       # Do something....
+  #     end
+  #
+  # This can be very useful for extending plugins such as the markup plugin that's used to
+  # convert Markdown or Textile to HTML. By default this plugin only converts Markdown and
+  # Textile or HTML (it escapes all HTML) but by modifying the actions hash we can easily
+  # add new markup engines such as RDoc or even Latex.
+  #
+  # ## Calling Plugins
+  #
+  # Plugins can be called using Zen::Plugin#call, this method requires you to specify the
+  # plugin identifier, the action to call and optionally any data to send to the plugin.
+  # An example of calling a plugin would look like the following:
+  #
+  #     Zen::Plugin.call('com.zen.plugin.markup', :markdown, 'hello **world**')
+  #
+  # ## Identifiers
+  #
+  # Plugin identifiers should always have the following format:
+  #
+  #     com.VENDOR.plugin.NAME
+  #
+  # For example:
+  #
+  #     com.zen.plugin.markup
+  #
+  # @author Yorick Peterse
+  # @since  0.2.4
+  # @attr_reader [Hash] plugins Hash containing all plugins.
+  #
+  module Plugin
+    class << self
+      attr_reader :plugins
+    end
+
+    ##
+    # Adds a new plugin with the given details.
+    #
+    # @example
+    #  Zen::Plugin.add do |p|
+    #    p.name    = 'Markup'
+    #    p.author  = 'Yorick Peterse'
+    #    p.actions = {
+    #      :markdown => lambda do |markup|
+    #        RDiscount.new(markup).to_html
+    #      end 
+    #  end
+    #
+    # @author Yorick Peterse
+    # @since  0.2.4
+    # @yield  [plugin] Struct object containing all the details of a plugin.
+    # @raise  [Zen::PluginError] Error raised whenever the plugin already exists or is missing
+    # a certain setter.
+    #
+    def self.add
+      @plugins ||= {}
+      required   = [:name, :author, :about, :identifier, :actions]
+      plugin     = Zen::StrictStruct.new(
+        :name, :author, :about, :url, :identifier, :actions
+      ).new
+
+      yield plugin
+
+      # Check if all the required keys have been set
+      plugin.validate(required) do |k|
+        raise(Zen::PluginError, "The following plugin key is missing: #{k}")
+      end
+
+      # The actions getter should be a hash
+      if plugin.actions.class != Hash
+        raise(Zen::PluginError, "The actions setter/getter should be an instance of Hash.")
+      end
+
+      # Add our plugin
+      if !@plugins[plugin.identifier].nil?
+        raise(Zen::PluginError, "The plugin #{plugin.name} already exists.")
+      end
+
+      @plugins[plugin.identifier] = plugin
+    end
+
+    ##
+    # Returns a plugin for the given identifier.
+    #
+    # @example
+    #  Zen::Plugin['com.zen.plugin.markup']
+    #
+    # @author Yorick Peterse
+    # @since  0.2.4
+    # @param  [String] ident The plugin identifier.
+    # @raise  Zen::PluginError Error that's raised when no plugins have been added yet or
+    # the specified plugin doesn't exist.
+    # @return [Struct] Instance of the plugin.
+    #
+    def self.[](ident)
+      if @plugins.nil?
+        raise(Zen::PluginError, "No plugins have been added.")
+      end
+
+      if !@plugins[ident]
+        raise(Zen::PluginError, "The plugin #{ident} doesn't exist.")
+      end
+
+      return @plugins[ident]
+    end
+
+    ##
+    # Calls the plugin for the given identifier and executes the action.
+    #
+    # @example
+    #  Zen::Plugin.call('com.zen.foobar', :markdown, 'hello **world**')
+    #
+    # @author Yorick Peterse
+    # @since  0.2.4
+    # @param  [String] ident The plugin identifier.
+    # @param  [Symbol] action The plugin action to call.
+    # @param  [Array] data Any data to pass to the plugin's action (a lambda).
+    # @return [Mixed]
+    #
+    def self.call(ident, action, *data)
+      plugin = self[ident]
+      action = action.to_sym
+
+      if !plugin.actions[action]
+        raise(Zen::PluginError, "The action #{action} doesn't exist for #{ident}.")
+      end
+
+      # Call the plugin and return it's value
+      return plugin.actions[action].call(*data)
+    end
+
+  end
+end

data/lib/zen/plugin/markup.rb

@@ -0,0 +1,30 @@
+Zen::Plugin.add do |plugin|
+  plugin.name       = 'Markup'
+  plugin.author     = 'Yorick Peterse'
+  plugin.about      = 'Plugin used for converting various markup formats to HTML.'
+  plugin.identifier = 'com.zen.plugin.markup'
+  plugin.actions    = {
+
+    # Converts HTML to, well, HTML.
+    :html => lambda do |markup|
+      markup
+    end,
+
+    # Converts the given markup to plain text by escaping all HTML
+    :plain => lambda do |markup|
+      include Ramaze::Helper::CGI
+      h(markup)
+    end,
+
+    # Comvert Markdown documents to HTML
+    :markdown => lambda do |markup|
+      RDiscount.new(markup).to_html
+    end,
+
+    # Convert Textile documents to HTML
+    :textile => lambda do |markup|
+      RedCloth.new(markup).to_html
+    end
+
+  } 
+end

data/lib/zen/public/admin/css/layout.css

@@ -103,6 +103,7 @@
     margin: 20px auto;
     width:  500px;
 }
+
     #login #container
     {
         margin-top: 50px;
@@ -116,7 +117,23 @@
     margin-top: 20px;
     text-align: center;
 }
+
     #main_footer p
     {
       margin-bottom: 8px;
+      margin:        0 auto 8px auto;
+      width:         300px;
+    }
+    
+    #main_footer ul
+    {
+        list-style-type: none;
+        margin:          0 auto;
+        width:           300px;
     }
+        #main_footer ul li
+        {
+            float:      left;
+            margin:     0px 8px;
+            text-align: center;
+        }

data/lib/zen/strict_struct.rb

@@ -0,0 +1,36 @@
+#:nodoc:
+module Zen
+  ##
+  # StrictStruct is a simple extension of the Struct class, it provides a method that
+  # checks if all getters/setters have a value and if one doesn't it will call the
+  # appropriate block.
+  #
+  # @author Yorick Peterse
+  # @since  0.2.4
+  #
+  class StrictStruct < Struct
+
+    ##
+    # Validates all getter/setters in the current class to see if all values are set.
+    #
+    # @example
+    #  struct = Zen::StrictStruct.new(:name, :age).new
+    #  struct.validate([:name, :age]) do |k|
+    #    puts "The key #{k} is required!"
+    #  end
+    #  
+    # @author Yorick Peterse
+    # @since  0.2.4
+    # @param  [Array] required Array of getters that should return a value.
+    # @param  [Block] block The block to call whenever an item doesn't have a value.
+    #
+    def validate(required, &block)
+      required.each do |k|
+        if !self.respond_to?(k) or self.send(k).nil?
+          block.call(k)
+        end
+      end
+    end
+
+  end
+end

data/lib/zen/task/db.rb

@@ -22,12 +22,17 @@ module Zen
       # @since  0.2
       #
       def migrate(show_output = true)
-        exts = Zen::Package.extensions
+        exts = Zen::Package.packages
 
         puts "Migrating..." if show_output === true
 
         exts.each do |ident, ext|
-          dir   = ext.directory + '/../../migrations'
+          if ext.respond_to?(:migration_dir) and !ext.migration_dir.nil?
+            dir = ext.migration_dir
+          else
+            dir = ext.directory + '/../../migrations'
+          end
+          
           table = ext.identifier.gsub('.', '_').to_sym
             
           if File.directory?(dir)
@@ -49,10 +54,15 @@ module Zen
       # @since  0.2
       #
       def delete
-        exts = Zen::Package.extensions.map { |ident, ext| [ident, ext] }
+        exts = Zen::Package.packages.map { |ident, ext| [ident, ext] }
 
         exts.reverse.each do |ident, ext|
-          dir   = ext.directory + '/../../migrations'
+          if ext.respond_to?(:migration_dir) and !ext.migration_dir.nil?
+            dir = ext.migration_dir
+          else
+            dir = ext.directory + '/../../migrations'
+          end
+
           table = ext.identifier.gsub('.', '_').to_sym
             
           if File.directory?(dir)

data/lib/zen/task/package.rb

@@ -14,19 +14,18 @@ module Zen
       desc('list', 'Lists all installed packages')
 
       ##
-      # Lists all installed extensions.
+      # Lists all installed packages
       #
       # @author Yorick Peterse
       # @since  0.2
       #
       def list
         table = []
-        table.push(['Name', 'Author', 'Identifier', 'Version', 'Type', 'Directory'])
-        table.push(['------', '------', '------', '------', '------','------'])
-        packages = Zen::Package.extensions.merge(Zen::Package.themes)
+        table.push(['Name', 'Author', 'Identifier', 'Directory'])
+        table.push(['------', '------', '------', '------'])
 
-        packages.each do |ident, ext|
-          table.push([ext.name, ext.author, ext.identifier, ext.version.to_s, ext.type, ext.directory])
+        Zen::Package.packages.each do |ident, ext|
+          table.push([ext.name, ext.author, ext.identifier, ext.directory])
         end
 
         print_table(table)
@@ -47,7 +46,7 @@ module Zen
         version = options[:version]
         ident   = options[:identifier]
         
-        if Zen::Package.extensions.nil? or Zen::Package.extensions.empty?
+        if Zen::Package.packages.nil? or Zen::Package.extensions.empty?
           abort "No packages have been loaded. Be sure to add them to config/requires.rb."
         end
 
@@ -61,7 +60,13 @@ module Zen
           abort "You specified an invalid identifier."
         end
 
-        dir   = install_ext.directory + '/../../migrations'
+        # Get the directory from the migration_dir getter, generate it if it isn't there.
+        if install_ext.respond_to?(:migration_dir) and !install_ext.migration_dir.nil?
+          dir = install_ext.migration_dir
+        else
+          dir = install_ext.directory + '/../../migrations'
+        end
+
         table = install_ext.identifier.gsub('.', '_').to_sym
          
         puts "Migrating package..."