zen 0.2.4.1 → 0.2.5

data/lib/zen/plugin/helper.rb

@@ -0,0 +1,47 @@
+#:nodoc:
+module Zen
+  #:nodoc:
+  module Plugin
+    ##
+    # Module containing various methods that can be used for developing plugins.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    module Helper
+
+      ##
+      # Method that can be used to validate the class of a given variable. If the class
+      # isn't included in the whitelist an error will be triggered explaining the error.
+      #
+      # @example
+      #  username = 10
+      #  validate_type(username, :username, [String]) # => TypeError: "\"username\" can only
+      #  be an instance of String but got Integer."
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @param  [Mixed] variable The variable to validate.
+      # @param  [Symbol/String] name The name of the variable to validate.
+      # @param  [Array] whitelist Whitelist of the allowed classes.
+      # @raise  TypeError Raised whenever the variable's class wasn't allowed.
+      #
+      def validate_type(variable, name, whitelist)
+        if whitelist.class != Array
+          whitelist = [whitelist]
+        end
+
+        name    = name.to_s
+        classes = whitelist.join(' or ').to_s
+
+        if !whitelist.include?(variable.class)
+          raise(
+            TypeError, 
+            "\"#{name}\" can only be an instance of #{classes} but got #{variable.class}"
+          )
+        end
+      end
+
+    end
+  end
+end

data/lib/zen/plugin/markup/lib/markup.rb

@@ -0,0 +1,14 @@
+# Load our language packs
+Zen::Language.options.paths.push(__DIR__('markup'))
+Zen::Language.load('markup')
+
+# Load the actual plugin
+require __DIR__('markup/markup')
+
+# Describe the plugin
+Zen::Plugin.add do |plugin|
+  plugin.name    = 'markup'
+  plugin.author  = 'Yorick Peterse'
+  plugin.about   = 'Plugin used for converting various markup formats to HTML.'
+  plugin.plugin  = Zen::Plugin::Markup
+end

data/lib/zen/plugin/markup/lib/markup/language/en/markup.yml

@@ -0,0 +1,6 @@
+---
+engines:
+  html     : 'HTML'
+  markdown : 'Markdown'
+  textile  : 'Textile'
+  plain    : 'Plain text'

data/lib/zen/plugin/markup/lib/markup/markup.rb

@@ -0,0 +1,154 @@
+#:nodoc
+module Zen
+  #:nodoc
+  module Plugin
+    ##
+    # The Markup plugin is used to convert the given markup using the specified engine.
+    # Out of the box this plugin is capable of doing the following:
+    #
+    # * Markdown -> HTML
+    # * Textile -> HTML
+    # * HTML -> Plain text (escapes HTML)
+    # * Regular HTML
+    #
+    # When using Markdown you'll have to make sure RDiscount is loaded, for Textile this
+    # should be RedCloth.
+    #
+    # ## Usage
+    #
+    # Using this plugin can be done as following::
+    #
+    #     plugin(:markup, :markdown, "hello **world**")
+    #
+    # ## Adding Engines
+    #
+    # In order to add a custom markdown engine (e.g. RDoc) you'll have to update 
+    # Zen::Plugin::Markup::Engines so that it includes the name and human readable name
+    # of the engine you wish to use. This can be done as following:
+    #
+    #     Zen::Plugin::Markup::Engines[:rdoc] => 'RDoc'
+    #
+    # Once this is done you'll need to define a method that matches the key you've just
+    # added. In this case it will be named "rdoc":
+    #
+    #     module Zen
+    #       module Plugin
+    #         class Markup
+    #           def rdoc(markup)
+    #             # Do something with the markup in the variable "markup"
+    #           end
+    #         end
+    #       end
+    #     end
+    #
+    # Once this has been done you're able to convert RDoc markup to HTML using this plugin.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    class Markup
+      include Ramaze::Helper::CGI
+      
+      # Load the language pack in the class method scope rather than the instance's scope
+      class << self
+        include Zen::Language
+      end
+
+      ##
+      # Hash containing the keys of the engines to use and their human friendly names
+      # (used in the backend). Note that the keys of this hash should be strings.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      #
+      Engines = {
+        'markdown' => lang('markup.engines.markdown'),
+        'textile'  => lang('markup.engines.textile'),
+        'plain'    => lang('markup.engines.plain'),
+        'html'     => lang('markup.engines.html')
+      } 
+    
+      ##
+      # Creates a new instance of the markup plugin and validates all the given parameters.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @param  [Symbol] engine The markup engine to use (e.g. :markdown).
+      # @param  [String] markup The markup to convert to HTML or something else.
+      #
+      def initialize(engine = 'markdown', markup = '')
+        @engine, @markup = engine.to_s, markup
+
+        # Validate the given engine
+        if !Engines.keys.include?(@engine)
+          raise(ArgumentError, "The markup engine \"#{@engine}\" is invalid.")
+        end
+
+        # Does the engine have a matching method?
+        if !respond_to?(@engine)
+          raise(NoMethodError, "The engine \"#{@engine}\" has no matching method.")
+        end
+      end
+
+      ##
+      # Converts the markup into HTML or plain text. 
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @return [String] The converted markup.
+      #
+      def call
+        return send(@engine, @markup)
+      end
+
+      ##
+      # Converts the Markdown markup to HTML using RDiscount.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @param  [String] markup The Markdown string to convert to HTML.
+      # @return [String] The HTML returned by RDiscount.
+      #
+      def markdown(markup)
+        return RDiscount.new(markup).to_html
+      end
+
+      ##
+      # Converts Textile to HTML using RedCloth.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @param  [String] markup The Textile markup to convert to HTML.
+      # @return [String] The HTML returned by RedCloth.
+      #
+      def textile(markup)
+        return RedCloth.new(markup).to_html
+      end
+
+      ##
+      # Escapes all HTML using Ramaze::Helper::CGI.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @param  [String] markup The markup in which all HTML tags should be escaped.
+      # @return [String] String containing the escaped HTML.
+      #
+      def plain(markup)
+        return h(markup)
+      end
+
+      ##
+      # Ignores the markup and just returns it.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @param  [String] markup The markup to return.
+      # @return [String] String containing our markup.
+      #
+      def html(markup)
+        return markup
+      end
+
+    end
+  end
+end

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

@@ -66,3 +66,7 @@ select
     margin-right: 10px;
 }
 
+*[disabled], *[disabled="disabled"]
+{
+    cursor: not-allowed;
+}

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

@@ -11,6 +11,7 @@ body
 {
     background:  #eee;
     font-family: 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Arial, sans-serif;
+    font-size:   13px;
 }
 
 /* Headings */
@@ -49,34 +50,33 @@ h1, h2, h3, h4, h5, h6
     margin-bottom: 15px;
 }
 
-/* List elements */
-ol 
+/* General */
+p,dl,hr,ol,ul,pre,table,address,fieldset 
 {
-    list-style:decimal;
+    margin-bottom: 20px;
 }
 
-ul 
+hr
 {
-    list-style:disc;
+    border:           0 #ccc solid;
+    border-top-width: 1px;
+    clear:            both;
+    height:           0;
 }
 
-li 
+.hidden
 {
-    margin-left:30px;
+    display: none;
 }
 
-/* General */
-p,dl,hr,ol,ul,pre,table,address,fieldset 
+a, a:active, a:visited
 {
-    margin-bottom: 20px;
+    color:#607890;
 }
 
-hr
+a:hover
 {
-    border:           0 #ccc solid;
-    border-top-width: 1px;
-    clear:            both;
-    height:           0;
+    color:#036;
 }
 
 /**

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

@@ -18,7 +18,7 @@
   width:         100%;
 }
 
-    #top #main_nav .left li
+    #top #main_nav .left, #top #main_nav .left li
     {
         float:   left;
     }
@@ -28,15 +28,15 @@
         float:   right;
     }
 
-        #top #main_nav ul li a
-        {
-            color:            #fff;
-            display:          block;
-            margin:           3px 10px;
-            padding:          3px 3px 5px 3px;
-            text-decoration:  none;
-            text-align:       center;
-        }
+    #top #main_nav ul li a
+    {
+        color:            #fff;
+        display:          block;
+        margin:           3px 10px;
+        padding:          3px 3px 5px 3px;
+        text-decoration:  none;
+        text-align:       center;
+    }
 
     #top #main_nav ul li:hover, #top #main_nav ul li a:hover
     {

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

@@ -0,0 +1,123 @@
+@charset "UTF-8";
+
+/** 
+ * http://meyerweb.com/eric/tools/css/reset/ 
+ * v2.0 | 20110126
+ * License: none (public domain)
+ */
+html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, 
+strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, 
+form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, 
+canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, 
+ruby, section, summary, time, mark, audio, video 
+{
+    border:         0;
+    font-size:      100%;
+    font:           inherit;
+    margin:         0;
+    padding:        0;
+    vertical-align: baseline;
+}
+
+/* HTML5 display-role reset for older browsers */
+article, aside, details, figcaption, figure, footer, header, hgroup, menu, nav, section 
+{
+    display: block;
+}
+
+body 
+{
+    line-height: 1.3;
+}
+
+ol, ul, ol li, ul li
+{
+    list-style-type: none;
+    margin:          0px;
+    padding:         0px;
+}
+
+blockquote, q 
+{
+    quotes: none;
+}
+
+blockquote:before, blockquote:after, q:before, q:after 
+{
+    content: '';
+    content: none;
+}
+
+table 
+{
+    /**
+     * Instead of "collapse" I'm using "separate" as that allows me to give table cells
+     * a border without having to go through a lot of trouble
+     */
+    border-collapse: separate;
+    border-spacing:  0;
+    width:           100%;
+}
+
+    table th
+    {
+        font-weight: bold;
+    }
+
+pre, code
+{
+    font-size:   13px;
+    font-family: monospace;
+}
+
+/**
+ * These form elements usually don't trigger any special cursor and thus can confuse
+ * users when these elements have custom styles (e.g. a background image). 
+ */
+input[type="submit"], input[type="button"], input[type="checkbox"], input[type="radio"],
+button, select
+{
+    cursor: pointer;
+}
+
+*[disabled], *[disabled="disabled"]
+{
+    cursor: not-allowed;
+}
+
+textarea
+{
+    overflow: auto;
+}
+
+acronym, abbr
+{
+    cursor: help;
+}
+
+/* Some typography related styles */
+body
+{
+    font-size: 16px;
+}
+
+h1, h2, h3, h4, h5, h6
+{
+    font-weight: bold;
+}
+
+a:hover, a:active
+{
+    outline: none;
+}
+
+strong
+{
+    font-weight: bold;
+}
+
+small
+{
+    font-size: 11px;
+}