RubyGems - zen - Versions diffs - 0.4 → 0.4.1 - Mend

zen 0.4 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (92) hide show

data/.aspell.en.pws +31 -0
data/.gems +1 -1
data/.mailmap +1 -0
data/.travis.yml +13 -7
data/.yardopts +1 -1
data/Rakefile +2 -2
data/guide/changelog.md +23 -5
data/guide/css/common.css +48 -0
data/guide/javascript.md +1 -0
data/guide/javascript/zen_form.md +46 -0
data/guide/zen_compared.md +104 -0
data/lib/zen.rb +21 -12
data/lib/zen/helper/breadcrumb.rb +1 -1
data/lib/zen/helper/message.rb +4 -5
data/lib/zen/language.rb +75 -10
data/lib/zen/markup.rb +20 -8
data/lib/zen/model/init.rb +14 -9
data/lib/zen/model/plugin/events.rb +1 -1
data/lib/zen/package.rb +71 -14
data/lib/zen/package/categories/lib/categories/controller/categories.rb +39 -12
data/lib/zen/package/categories/lib/categories/controller/category_groups.rb +26 -5
data/lib/zen/package/categories/lib/categories/helper/category.rb +37 -6
data/lib/zen/package/categories/lib/categories/helper/category_frontend.rb +2 -2
data/lib/zen/package/categories/lib/categories/view/admin/categories/form.xhtml +26 -29
data/lib/zen/package/comments/lib/comments.rb +9 -1
data/lib/zen/package/comments/lib/comments/anti_spam.rb +1 -1
data/lib/zen/package/comments/lib/comments/controller/comments.rb +59 -14
data/lib/zen/package/comments/lib/comments/controller/comments_form.rb +49 -11
data/lib/zen/package/comments/lib/comments/helper/comment.rb +14 -2
data/lib/zen/package/comments/lib/comments/view/admin/comments/form.xhtml +3 -3
data/lib/zen/package/comments/migrations/1308774099_comment_status.rb +1 -1
data/lib/zen/package/custom_fields/lib/custom_fields/blue_form_parameters.rb +12 -0
data/lib/zen/package/custom_fields/lib/custom_fields/controller/custom_field_groups.rb +24 -6
data/lib/zen/package/custom_fields/lib/custom_fields/controller/custom_field_types.rb +68 -20
data/lib/zen/package/custom_fields/lib/custom_fields/controller/custom_fields.rb +106 -26
data/lib/zen/package/custom_fields/lib/custom_fields/helper/custom_field.rb +50 -11
data/lib/zen/package/custom_fields/lib/custom_fields/view/admin/custom-fields/form.xhtml +2 -2
data/lib/zen/package/dashboard/lib/dashboard/controller/dashboard.rb +1 -1
data/lib/zen/package/menu.rb +6 -1
data/lib/zen/package/menus/lib/menus/controller/menu_items.rb +44 -9
data/lib/zen/package/menus/lib/menus/controller/menus.rb +53 -13
data/lib/zen/package/menus/lib/menus/helper/menu.rb +30 -4
data/lib/zen/package/menus/lib/menus/model/menu.rb +4 -2
data/lib/zen/package/sections/lib/sections/controller/section_entries.rb +48 -9
data/lib/zen/package/sections/lib/sections/controller/sections.rb +77 -21
data/lib/zen/package/sections/lib/sections/helper/section.rb +32 -4
data/lib/zen/package/sections/lib/sections/model/section_entry.rb +1 -1
data/lib/zen/package/sections/lib/sections/view/admin/section-entries/form.xhtml +5 -4
data/lib/zen/package/sections/lib/sections/view/admin/sections/form.xhtml +3 -3
data/lib/zen/package/sections/migrations/1308813320_section_entry_statuses.rb +1 -1
data/lib/zen/package/settings/lib/settings/blue_form_parameters.rb +2 -2
data/lib/zen/package/settings/lib/settings/controller/settings.rb +60 -15
data/lib/zen/package/settings/lib/settings/view/admin/settings/index.xhtml +1 -1
data/lib/zen/package/users/lib/users/controller/user_groups.rb +42 -7
data/lib/zen/package/users/lib/users/controller/users.rb +78 -16
data/lib/zen/package/users/lib/users/helper/users.rb +29 -4
data/lib/zen/package/users/lib/users/view/admin/user-groups/form.xhtml +2 -2
data/lib/zen/package/users/lib/users/view/admin/users/form.xhtml +2 -2
data/lib/zen/public/admin/zen/css/general.css +5 -0
data/lib/zen/public/admin/zen/css/messages.css +1 -0
data/lib/zen/public/admin/zen/css/tables.css +33 -0
data/lib/zen/public/admin/zen/css/tabs.css +8 -0
data/lib/zen/public/admin/zen/js/index.js +21 -2
data/lib/zen/public/admin/zen/js/lib/events.js +45 -0
data/lib/zen/public/admin/zen/js/lib/form.js +229 -0
data/lib/zen/public/admin/zen/js/lib/hash.js +0 -27
data/lib/zen/task/spelling.rake +97 -0
data/lib/zen/task/test.rake +21 -0
data/lib/zen/theme.rb +80 -24
data/lib/zen/validation.rb +1 -1
data/lib/zen/version.rb +1 -1
data/proto/app/config/config.rb.erb +9 -4
data/proto/app/config/middlewares.rb +1 -2
data/spec/README.md +56 -0
data/spec/zen/controller/admin_controller.rb +0 -1
data/spec/zen/controller/preview.rb +0 -1
data/spec/zen/package.rb +32 -0
data/spec/zen/package/categories/controller/categories.rb +7 -0
data/spec/zen/package/categories/controller/category_groups.rb +7 -0
data/spec/zen/package/comments/controller/comments.rb +7 -0
data/spec/zen/package/custom_fields/controller/custom_field_groups.rb +7 -0
data/spec/zen/package/custom_fields/controller/custom_field_types.rb +7 -0
data/spec/zen/package/custom_fields/controller/custom_fields.rb +7 -0
data/spec/zen/package/menus/controller/menu_items.rb +7 -0
data/spec/zen/package/menus/controller/menus.rb +7 -0
data/spec/zen/package/menus/helper/menu_frontend.rb +1 -1
data/spec/zen/package/sections/controller/section_entries.rb +39 -0
data/spec/zen/package/sections/controller/sections.rb +14 -0
data/spec/zen/package/users/controller/user_groups.rb +7 -0
data/spec/zen/package/users/controller/users.rb +7 -0
data/zen.gemspec +6 -5
metadata +142 -40

data/lib/zen/helper/breadcrumb.rb CHANGED Viewed

@@ -38,7 +38,7 @@ module Ramaze
       end
       ##
-      # Retrieves all breacrumbs and separates them either by "&raquo;" or a
+      # Retrieves all breadcrumbs and separates them either by "&raquo;" or a
       # custom element set as the first argument of this method.
       #
       # @example

data/lib/zen/helper/message.rb CHANGED Viewed

@@ -5,10 +5,9 @@ module Ramaze
   #:nodoc:
   module Helper
     ##
-    # The Mesage helper is a Ruby implementation of the Codeigniter library
-    # "Message" (located here: https://github.com/isset/codeigniter-message).
-    # This helper was taken from another project of mine which can be found here:
-    # https://github.com/yorickpeterse/stumpert/
+    # Helper that wraps around Ramaze's flash helper and provides an easy way of
+    # setting messages (errors, informal messages, etc) as well as rendering the
+    # required HTML.
     #
     # ## Usage
     #
@@ -52,7 +51,7 @@ module Ramaze
         gestalt = ::Ramaze::Gestalt.new
         return if flash[:messages].nil?
         gestalt.div(:id => 'message_container', :class => 'container') do
           # Render each individual group
           types.each do |type|

data/lib/zen/language.rb CHANGED Viewed

@@ -20,18 +20,55 @@ module Zen
   #
   # When adding a language you **must** set the following items:
   #
-  # * **name**: the language code as defined in [ISO 639][iso 639]. Examples of
-  #   these codes are "en-GB", "nl", etc. At the moment Zen does not have
-  #   different language files for British English and American English.
-  # * **title**: the name of the language in a human friendly form. This name
-  #   should be set in the specific language. For example, for Dutch the title
-  #   would be "Nederlands".
+  # <table class="table full">
+  #     <thead>
+  #         <tr>
+  #             <th>Attribute</th>
+  #             <th>Description</th>
+  #         </tr>
+  #     </thead>
+  #     <tbody>
+  #         <tr>
+  #             <td>name</td>
+  #             <td>
+  #                 The language code as defined in
+  #                 <a href="https://en.wikipedia.org/wiki/ISO_639">ISO 369</a>.
+  #                 Examples of these codes are "en-GB", "nl", etc.
+  #             </td>
+  #         </tr>
+  #         <tr>
+  #             <td>title</td>
+  #             <td>
+  #                 A human friendly version of the name of the language. This
+  #                 name should be set in the specific language. For example,
+  #                 for Dutch the title should be "Nederlands" instead of
+  #                 "Dutch".
+  #             </td>
+  #         </tr>
+  #     </tbody>
+  # </table>
   #
   # Optionally you can also set the following attributes:
   #
-  # * **rtl**: indicates that the language reads from right to left. When set to
-  #   true the ``<html>`` tag will have an extra ``dir`` attribute so that
-  #   browsers can properly display the text from right to left.
+  # <table class="table full">
+  #     <thead>
+  #         <tr>
+  #             <th>Attribute</th>
+  #             <th>Description</th>
+  #         </tr>
+  #     </thead>
+  #     <tbody>
+  #         <tr>
+  #             <td>rtl</td>
+  #             <td>
+  #                 indicates that the language reads from right to left. When
+  #                 set to true the html tag will have an extra "dir" attribute
+  #                 so that browsers can properly display the text from right to
+  #                 left.
+  #             </td>
+  #         </tr>
+  #     </tbody>
+  # </table>
   #
   # ## Adding Translations
   #
@@ -118,7 +155,7 @@ module Zen
   #    namespace).
   #
   # In the last case missing language files will be loaded if possible. However,
-  # it is recommended that you pre-load your language files before starting the
+  # it is recommended that you load your language files before starting the
   # application. By doing this these translations don't have to be loaded during
   # an HTTP request which could potentially slow down the application.
   #
@@ -127,6 +164,25 @@ module Zen
   #
   #     Zen::Language.load('foobar')
   #
+  # Due to the way the language system works it's impossible to load these
+  # before {Zen.start} is called. The recommended way of loading a language file
+  # is by wrapping it in an event listener for the "post_start" event:
+  #
+  #     Zen::Event.listen :post_start do
+  #       Zen::Language.load('example')
+  #     end
+  #
+  # The reason for this requirement is that language files are stored in a cache
+  # (Ramaze::Cache::LRU by default) and this cache isn't set up until
+  # {Zen.start} is called.
+  #
+  # <div class="note todo">
+  #     <p>
+  #         This can't be stressed enough: always load language files using the
+  #         post_start event.
+  #     </p>
+  # </div>
+  #
   # ## Using Translations
   #
   # Once the entire process of adding and loading a language file has been
@@ -148,6 +204,15 @@ module Zen
   #     lang('foobar')
   #     lang('foo bar')
   #
+  # <div class="note todo">
+  #     <p>
+  #         Because language files aren't loaded until Zen.start is called you
+  #         should never use or rely on translations before the application has
+  #         started. Most of the core code works around this by loading
+  #         translations using blocks whenever they're needed.
+  #     </p>
+  # </div>
+  #
   # [iso 639]: https://en.wikipedia.org/wiki/ISO_639
   #
   # @since  0.2

data/lib/zen/markup.rb CHANGED Viewed

@@ -11,7 +11,7 @@ module Zen
   #     html = Zen::Markup.convert(:markdown, 'Hello **world**')
   #
   # When converting Markdown or Textile Zen will automatically install the
-  # required gems. For Markdown RDiscount is used, for Textile RedCloth is used.
+  # required gems. For Markdown Redcarpet is used, for Textile RedCloth is used.
   #
   # You may be tempted to call the various methods directly but it is not
   # recommended to do so. For example, you might have the following code:
@@ -36,12 +36,12 @@ module Zen
   # Adding a new engine is relatively easy and is done in two steps. First you
   # should add the name of your engine and it's label to
   # {Zen::Markup::REGISTERED}. The keys of this hash should be the methods to
-  # call, teh values will be displayed in various ``<select>`` elements in the
+  # call, the values will be displayed in various ``<select>`` elements in the
   # administration interface.
   #
   #     Zen::Markup::REGISTERED['my_markup'] = 'My Markup'
   #
-  # In this example the label is hardcoded but it's recommended to use
+  # In this example the label is hard coded but it's recommended to use
   # {Zen::Language.lang} instead.
   #
   # Once the engine has been added to the list you'll have to add a
@@ -83,6 +83,13 @@ module Zen
       'html'     => 'zen_general.markup.html'
     }
+    # Hash containing the configuration options to use for Redcarpet.
+    REDCARPET_OPTIONS = {
+      :tables             => true,
+      :fenced_code_blocks => true,
+      :strikethrough      => true
+    }
     class << self
       include ::Ramaze::Helper::CGI
@@ -123,23 +130,28 @@ module Zen
       private
       ##
-      # Converts the Markdown markup to HTML using RDiscount.
+      # Converts the Markdown markup to HTML using Redcarpet.
       #
       # @example
       #  Zen::Markup.markdown('Hello **world**')
       #
       # @since  0.2.5
       # @param  [String] markup The Markdown string to convert to HTML.
-      # @return [String] The HTML returned by RDiscount.
+      # @return [String] The HTML returned by Redcarpet.
       #
       def markdown(markup)
-        unless Kernel.const_defined?(:RDiscount)
+        unless Kernel.const_defined?(:Redcarpet)
           Ramaze.setup(:verbose => false) do
-            gem 'rdiscount'
+            gem 'redcarpet', ['>= 2.1.1']
           end
         end
-        return RDiscount.new(markup).to_html
+        @markdown ||= Redcarpet::Markdown.new(
+          Redcarpet::Render::HTML,
+          REDCARPET_OPTIONS,
+        )
+        return @markdown.render(markup)
       end
       ##

data/lib/zen/model/init.rb CHANGED Viewed

@@ -1,5 +1,3 @@
-Zen::Language.load('zen_models')
 Sequel::Model.strict_param_setting = false
 Sequel::Model.plugin(:validation_helpers)
@@ -9,6 +7,13 @@ Sequel.extension(:migration)
 Sequel.extension(:pagination)
 Sequel.extension(:inflector)
+Zen::Event.listen :post_start do
+  Zen::Language.load('zen_models')
+end
+# Note that the values for the :message keys should always be wrapped in
+# lambdas. Doing so means the call to lang() won't be executed until it is
+# actually needed.
 Sequel::Plugins::ValidationHelpers::DEFAULT_OPTIONS.merge!(
 {
   :exact_length => {
@@ -16,7 +21,7 @@ Sequel::Plugins::ValidationHelpers::DEFAULT_OPTIONS.merge!(
   },
   :format => {
-    :message => lang('zen_models.format')
+    :message => lambda { lang('zen_models.format') }
   },
   :includes  => {
@@ -25,12 +30,12 @@ Sequel::Plugins::ValidationHelpers::DEFAULT_OPTIONS.merge!(
   },
   :integer => {
-    :message   => lang('zen_models.integer'),
+    :message   => lambda { lang('zen_models.integer') },
     :allow_nil => true
   },
   :length_range => {
-    :message => lang('zen_models.length_range')
+    :message => lambda { lang('zen_models.length_range') }
   },
   :max_length => {
@@ -43,11 +48,11 @@ Sequel::Plugins::ValidationHelpers::DEFAULT_OPTIONS.merge!(
   },
   :not_string => {
-    :message  => lang('zen_models.not_string')
+    :message  => lambda { lang('zen_models.not_string') }
   },
   :numeric   => {
-    :message => lang('zen_models.numeric')
+    :message => lambda { lang('zen_models.numeric') }
   },
   :type      => {
@@ -55,10 +60,10 @@ Sequel::Plugins::ValidationHelpers::DEFAULT_OPTIONS.merge!(
   },
   :presence  => {
-    :message => lang('zen_models.presence')
+    :message => lambda { lang('zen_models.presence') }
   },
   :unique    => {
-    :message => lang('zen_models.unique')
+    :message => lambda { lang('zen_models.unique') }
   }
 })

data/lib/zen/model/plugin/events.rb CHANGED Viewed

@@ -70,7 +70,7 @@ module Sequel
       ##
       # Module containing the methods and attributes to make available on
-      # instance leve.
+      # instance level.
       #
       # @since 06-02-2012
       #

data/lib/zen/package.rb CHANGED Viewed

@@ -19,17 +19,55 @@ module Zen
   #
   # When adding a package you must **always** set the following attributes:
   #
-  # * name: the name of the package, should be a symbol
-  # * title: the title of the package. This should be a language key such as
-  #   "users.titles.index" as this allows users to view the package name in
-  #   their chosen language.
-  # * author: the name of the package's author.
-  # * about: a description of the package, just like the title attribute this
-  #   should be a language key, "users.description" is an example of such a key.
-  # * root: the root directory of the package, this path should point to the
-  #   directory containing your ``helper/`` and ``language/`` directories as
-  #   well as any ``public/`` directories.
-  # * An innstance of OpenStruct that can be used for storing custom data.
+  # <table class="table full">
+  #     <thead>
+  #         <tr>
+  #             <th>Attribute</th>
+  #             <th>Description</th>
+  #         </tr>
+  #     </thead>
+  #     <tbody>
+  #         <tr>
+  #             <td>name</td>
+  #             <td>The name of the package, should be a symbol.</td>
+  #         </tr>
+  #         <tr>
+  #             <td>title</td>
+  #             <td>
+  #                 The title of the package. This should be a language key such
+  #                 as "users.titles.index' as it allows users to view the
+  #                 package name in their chosen language.
+  #             </td>
+  #         </tr>
+  #         <tr>
+  #             <td>author</td>
+  #             <td>The name of the package's author.</td>
+  #         </tr>
+  #         <tr>
+  #             <td>about</td>
+  #             <td>
+  #                 A description of the package. Just like the title attribute
+  #                 this should be a language key.
+  #             </td>
+  #         </tr>
+  #         <tr>
+  #             <td>root</td>
+  #             <td>
+  #                 The root directory of the package. This path should point to
+  #                 the directory containing your helper, language and other
+  #                 directories.
+  #             </td>
+  #         </tr>
+  #         <tr>
+  #             <td>env</td>
+  #             <td>
+  #                 A special object (an instance of OpenStruct) that can be
+  #                 used for storing arbitrary data that might be needed by
+  #                 the package.
+  #             </td>
+  #         </tr>
+  #     </tbody>
+  # </table>
   #
   # Setting these (and other) attributes is very easy:
   #
@@ -43,8 +81,27 @@ module Zen
   # Besides the required attributes listed above you can also set the following
   # ones:
   #
-  # * url: a URL that points to the website of the package.
-  # * migrations: a directory containing all Sequel migrations.
+  # <table class="table full">
+  #     <thead>
+  #         <tr>
+  #             <th>Attribute</th>
+  #             <th>Description</th>
+  #         </tr>
+  #     </thead>
+  #     <tbody>
+  #         <tr>
+  #             <td>url</td>
+  #             <td>A URL that points to the website of the package author.</td>
+  #         </tr>
+  #         <tr>
+  #             <td>migrations</td>
+  #             <td>
+  #                 A directory containing the Sequel migrations for the
+  #                 package.
+  #             </td>
+  #         </tr>
+  #     </tbody>
+  # </table>
   #
   # ## Package Structure
   #
@@ -95,7 +152,7 @@ module Zen
   # Permissions allow you to restrict access to certain actions to specific
   # users/user groups. A permission can be added by calling ``permission()`` on
   # the object passed to the block. Again the title of the permission should be
-  # a langauge key so it can be displayed in a custom language:
+  # a language key so it can be displayed in a custom language:
   #
   #     Zen::Package.add do |p|
   #       p.permission(:show_some_package, 'packages.titles.index')

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

@@ -27,18 +27,45 @@ module Categories
     #
     # In this form you can specify the following fields:
     #
-    # * **Name** (required): the name of the category. This name can be anything
-    #   and there's no restriction to it's format. An example of such a name
-    #   would be "Code" or "Products".
-    # * **Slug**: a URL friendly version of a category name. If no slug is
-    #   specified one will be generated based on the category name.
-    # * **Parent**: the name of the parent category.
-    # * **Description**: a description of the category. While not required it
-    #   can help you remember what the category is meant for in case the name
-    #   doesn't already make this clear enough.
-    #
-    # Note that both the name of a category and it's slug can not be longer than
-    # 255 characters.
+    # <table class="table full">
+    #     <thead>
+    #         <tr>
+    #             <th class="field_name">Field</th>
+    #             <th>Required</th>
+    #             <th>Maximum Length</th>
+    #             <th>Description</th>
+    #         </tr>
+    #     </thead>
+    #     <tbody>
+    #         <tr>
+    #             <td>Name</td>
+    #             <td>Yes</td>
+    #             <td>255</td>
+    #             <td>The name of the category.</td>
+    #         </tr>
+    #         <tr>
+    #             <td>Slug</td>
+    #             <td>No</td>
+    #             <td>255</td>
+    #             <td>
+    #                 A URL friendly version of the name. If no custom slug is
+    #                 given one will be generated automatically.
+    #             </td>
+    #         </tr>
+    #         <tr>
+    #             <td>Parent</td>
+    #             <td>No</td>
+    #             <td></td>
+    #             <td>The parent category.</td>
+    #         </tr>
+    #         <tr>
+    #             <td>Description</td>
+    #             <td>No</td>
+    #             <td>Unlimited</td>
+    #             <td>A short description of the category.</td>
+    #         </tr>
+    #     </tbody>
+    # </table>
     #
     # ## Used Permissions
     #