zen 0.4 → 0.4.1

data/lib/zen/theme.rb

@@ -120,25 +120,81 @@ module Zen
   # theme using Rubygems. For example, if the theme is called "test" then the
   # file would be called "test.rb".
   #
-  # When registering a theme you can set the following setters:
-  #
-  # * name (required): the name of the theme (should be a symbol)
-  # * author (required): the name of the person who developed the theme.
-  # * about (required): a short description of the theme.
-  # * templates (required): a path to the directory containing the templates for
-  #   all sections.
-  # * partials: a path to the directory containing all the partials that should
-  #   be rendered when calling ``partial()``.
-  # * public: a path to an extra public directory to use, useful when you're
-  #   distributing your theme using Rubygems and want to ship it with a few CSS
-  #   files.
-  # * migrations: path to a directory containing all Sequel migrations for the
-  #   theme. While not always needed this can be useful to automatically insert
-  #   data into the database.
-  # * default_template_group: the name of the default template group to use in
-  #   case no custom one has been specified in the URI.
-  # * env: an instance of ``OpenStruct`` that can be used to store custom data
-  #   such as an instance of ``Ramaze::Asset::Environment``.
+  # When registering a new theme you're required to set the following
+  # attributes:
+  #
+  # <table class="table full">
+  #     <thead>
+  #         <tr>
+  #             <th>Attribute</th>
+  #             <th>Description</th>
+  #         </tr>
+  #     </thead>
+  #     <tbody>
+  #         <tr>
+  #             <td>name</td>
+  #             <td>The name of the theme as a symbol.</td>
+  #         </tr>
+  #         <tr>
+  #             <td>auhtor</td>
+  #             <td>The name of the author of the theme.</td>
+  #         </tr>
+  #         <tr>
+  #             <td>about</td>
+  #             <td>A short description of the theme.</td>
+  #         </tr>
+  #         <tr>
+  #             <td>templates</td>
+  #             <td>
+  #                 Path to the directory containing the templates of the
+  #                 theme.
+  #             </td>
+  #         </tr>
+  #     </tbody>
+  # </table>
+  #
+  # Optionally you can also specify the following attributes:
+  #
+  # <table class="table full">
+  #     <thead>
+  #         <tr>
+  #             <th>Attribute</th>
+  #             <th>Description</th>
+  #         </tr>
+  #     </thead>
+  #     <tbody>
+  #         <tr>
+  #             <td>partials</td>
+  #             <td>Path to a directory containing template partials.</td>
+  #         </tr>
+  #         <tr>
+  #             <td>public</td>
+  #             <td>
+  #                 Path to the public directory of the theme. This attribute is
+  #                 useful when you're distributing CSS and Javascript files (or
+  #                 other static files) with your theme.
+  #             </td>
+  #         </tr>
+  #         <tr>
+  #             <td>migrations</td>
+  #             <td>Directory containing Sequel migrations for the theme.</td>
+  #         </tr>
+  #         <tr>
+  #             <td>default_template_group</td>
+  #             <td>
+  #                 The name of the default template group to use, set to
+  #                 "default" by default.
+  #             </td>
+  #         </tr>
+  #         <tr>
+  #             <td>env</td>
+  #             <td>
+  #                 An instance of OpenStruct that can be used for storing
+  #                 arbitrary data (such as an asset manager).
+  #             </td>
+  #         </tr>
+  #     </tbody>
+  # </table>
   #
   # An example call to ``Zen::Theme.add`` using these options:
   #
@@ -166,7 +222,7 @@ module Zen
   # Some examples:
   #
   #     GET /pages/entry/hello-world => /pages/entry.xhtml
-  #     GET /pages/example            => /404.xhtml (if "example" doesn't exist)
+  #     GET /pages/example           => /404.xhtml (if "example" doesn't exist)
   #     GET /pages                   => /pages/index.xhtml
   #
   # Templates have access to the special instance variable ``@request_uri``.
@@ -175,7 +231,7 @@ module Zen
   # with the following values for this array:
   #
   #     GET /pages/entry/hello-world => ['pages', 'entry', 'hello-world']
-  #     GET /pages/example            => ['pages', 'example']
+  #     GET /pages/example           => ['pages', 'example']
   #     GET /pages                   => ['pages', 'index']
   #
   # ## Retrieving Data
@@ -209,7 +265,7 @@ module Zen
   #
   # ## Template Partials
   #
-  # Often you'll need to re-use an existing template multiple times. For
+  # Often you'll need to reuse an existing template multiple times. For
   # example, almost all templates will have some data inside the ``<head>`` tag
   # that will have pretty much the same markup and/or content in different
   # templates. Zen makes it possible this easy by using "partials". Partials are
@@ -301,7 +357,7 @@ module Zen
     end
 
     ##
-    # Retrieves a single theme for hte given identifier.
+    # Retrieves a single theme for the given identifier.
     #
     # @since  0.2.4
     # @param  [String/Symbol] name The name of the theme to retrieve.
@@ -338,7 +394,7 @@ module Zen
 
     ##
     # Returns the name of the theme as either plain text or an anchor tag if the
-    # url attribute is set.
+    # URL attribute is set.
     #
     # @since  19-11-2011
     # @return [String]

data/lib/zen/validation.rb

@@ -123,7 +123,7 @@ module Zen
     end
 
     ##
-    # Checks if the specified attribute contains a valid filepath.
+    # Checks if the specified attribute contains a valid file path.
     #
     # @example
     #  validates_filepath(:directory)

data/lib/zen/version.rb

@@ -1,4 +1,4 @@
 module Zen
   # :nodoc:
-  VERSION = '0.4'
+  VERSION = '0.4.1'
 end

data/proto/app/config/config.rb.erb

@@ -5,14 +5,19 @@
 # Because this file is loaded using require() like any other file you're free to
 # add statements and custom code in this configuration file.
 
-# The root directory of your application. This directory will be used for
-# various settings by Zen and is therefor required.
-Zen.root = __DIR__('../')
-
 # The application mode to use. Based on different modes your application might
 # behave differently. For example, when set to :dev assets will not be minified.
+#
+# One thing to keep in mind is that the Ramaze mode **must** be set before
+# defining Zen's root directory. Defining the mode after setting the root
+# directory will prevent the various assets being used for the backend from
+# being minified.
 Ramaze.options.mode  = :dev
 
+# The root directory of your application. This directory will be used for
+# various settings by Zen and is therefor required.
+Zen.root = __DIR__('../')
+
 # The name of your application. Its very important that this name is unique,
 # especially when a cache is shared among different Ramaze applications. If
 # these applications were to use the same name they might end up retrieving the

data/proto/app/config/middlewares.rb

@@ -6,7 +6,7 @@
 # For development purposes we'll be loading various middlewares to make it
 # easier to detect errors, reloading the code and so on.
 #
-Ramaze.middleware!(:dev) do |m|
+Ramaze.middleware! :dev do |m|
   # Rack::Lint is used to validate all code according to the Rack specification.
   # It's not recommended to use this middleware in a production environment as
   # it will slow your application down a bit.
@@ -17,7 +17,6 @@ Ramaze.middleware!(:dev) do |m|
   # details to the visitor.
   m.use Rack::ShowExceptions
 
-  # Pretty much the same as Rack::ShowExceptions.
   m.use Rack::ShowStatus
 
   # Routes exceptions to different actions, can be useful for catching 404's and

data/spec/README.md

@@ -0,0 +1,56 @@
+# Testing Zen
+
+Zen comes with a wide variety of tests to ensure that the various parts of Zen
+work as expected. These tests can be configured to use different databases
+and/or features. Regardless of the configuration you should first migrate the
+database and set up a test user, this can be done by running the following
+commands:
+
+    $ cd spec
+    $ rake db:migrate
+    $ rake db:test_user
+
+Once migrated you can run the tests as following:
+
+    $ ruby zen/all.rb
+
+## Requirements
+
+* Ruby 1.9.2 or newer
+* Firefox
+* Selenium
+
+Based on your configuration you may also need extra gems such as the sqlite3 gem
+or the mysql2 gem.
+
+## Environment Variables
+
+* ADAPTER: the database adapter to use. For SQLite3 this should be set to
+  "sqlite", for MySQL to "mysql2" and for PostgreSQL to "postgres".
+* DATABASE: the name or file (in case of SQLite3) of the database.
+* USERNAME: the username to use for connecting to a PostgreSQL or MySQL
+  database.
+* PASSWORD: the password to use for connecting to a PostgreSQL or MySQL
+  database.
+* LRU: when set to a non empty value the cache for sessions is set to
+  Ramaze::Cache::LRU.
+* COVERAGE: when set to a non empty value code coverage will be generated using
+  SimpleCov.
+
+## Examples
+
+Testing MySQL:
+
+    $ cd spec
+    $ export ADAPTER=mysql2 DATABASE=zen_dev USERNAME=root
+    $ rake db:migrate
+    $ rake db:test_user
+    $ ruby zen/all.rb
+
+Testing PostgreSQL:
+
+    $ cd spec
+    $ export ADAPTER=postgres DATABASE=zen_dev USERNAME=postgres
+    $ rake db:migrate
+    $ rake db:test_user
+    $ ruby zen/all.rb

data/spec/zen/controller/admin_controller.rb

@@ -1,5 +1,4 @@
 require File.expand_path('../../../helper', __FILE__)
-require 'rdiscount'
 
 describe 'Zen::Controller::AdminController' do
   behaves_like :capybara

data/spec/zen/controller/preview.rb

@@ -1,5 +1,4 @@
 require File.expand_path('../../../helper', __FILE__)
-require 'rdiscount'
 
 describe "Zen::Controller::Preview" do
   behaves_like :capybara

data/spec/zen/package.rb

@@ -4,6 +4,12 @@ require File.join(Zen::FIXTURES, 'package')
 describe 'Zen::Package' do
   behaves_like :capybara
 
+  after do
+    admins = Users::Model::UserGroup[:slug => 'administrators']
+
+    admins.update(:super_group => true) unless admins.super_group
+  end
+
   it 'Add a new package' do
     Zen::Package.add do |p|
       p.name       = :spec
@@ -59,4 +65,30 @@ describe 'Zen::Package' do
     menu.include?('<ul class="navigation">').should == true
     menu.include?(html).should                      == true
   end
+
+  # https://github.com/zen-cms/Zen-Core/issues/65
+  it 'Menu items that do not need permissions should be displayed' do
+    permission = Zen::Package[:spec].menu[0].options[:permission]
+    admins     = Users::Model::UserGroup[:slug => 'administrators']
+    logout     = Users::Controller::Users.r(:logout).to_s
+
+    Zen::Package[:spec].menu[0].options[:permission] = nil
+
+    # Change the user to a regular user for this test.
+    visit(logout)
+
+    admins.update(:super_group => false)
+
+    capybara_login
+
+    visit(Dashboard::Controller::Dashboard.r(:index).to_s)
+
+    within '#admin_navigation' do
+      page.has_content?('Spec').should == true
+    end
+
+    visit(logout)
+
+    Zen::Package[:spec].menu[0].options[:permission] = permission
+  end
 end

data/spec/zen/package/categories/controller/categories.rb

@@ -145,6 +145,13 @@ describe "Categories::Controller::Categories" do
     page.has_selector?('span.error').should == true
   end
 
+  it 'Non numeric category IDs should be handled gracefully' do
+    visit(Categories::Controller::Categories.r(:edit, group.id, 'a').to_s)
+
+    page.current_path.should                    == index_url
+    page.has_selector?('.message.error').should == true
+  end
+
   enable_javascript
 
   it 'Automatically save a category' do

data/spec/zen/package/categories/controller/category_groups.rb

@@ -152,6 +152,13 @@ describe "Categories::Controller::CategoryGroups" do
     page.has_selector?('span.error').should == true
   end
 
+  it 'Non numeric category group IDs should be handled gracefully' do
+    visit(Categories::Controller::CategoryGroups.r(:edit, 'a').to_s)
+
+    page.current_path.should                    == index_url
+    page.has_selector?('.message.error').should == true
+  end
+
   enable_javascript
 
   it 'Automatically save a category group' do

data/spec/zen/package/comments/controller/comments.rb

@@ -159,6 +159,13 @@ describe 'Comments::Controller::Comments' do
     page.has_selector?('span.error').should == true
   end
 
+  it 'Gracefully handle non numeric comment IDs' do
+    visit(Comments::Controller::Comments.r(:edit, 'a').to_s)
+
+    page.current_path.should                    == index_url
+    page.has_selector?('.message.error').should == true
+  end
+
   enable_javascript
 
   it 'Automatically save a comment' do

data/spec/zen/package/custom_fields/controller/custom_field_groups.rb

@@ -91,6 +91,13 @@ describe 'CustomFields::Controller::CustomFieldGroups' do
     page.find('input[name="name"]').value.should == 'Spec field group modified'
   end
 
+  it 'Gracefully handle non numeric custom field group IDs' do
+    visit(CustomFields::Controller::CustomFieldGroups.r(:edit, 'a').to_s)
+
+    page.current_path.should                    == index_url
+    page.has_selector?('.message.error').should == true
+  end
+
   enable_javascript
 
   it 'Automatically save a custom field group' do

data/spec/zen/package/custom_fields/controller/custom_field_types.rb

@@ -139,6 +139,13 @@ describe 'CustomFields::Controller::CustomFieldTypes' do
     page.find_field('custom_field_method_id').value.should == method_id
   end
 
+  it 'Gracefully handle non numeric custom field type IDs' do
+    visit(CustomFields::Controller::CustomFieldTypes.r(:edit, 'a').to_s)
+
+    page.current_path.should                    == index_url
+    page.has_selector?('.message.error').should == true
+  end
+
   enable_javascript
 
   it 'Automatically save a custom field type' do

data/spec/zen/package/custom_fields/controller/custom_fields.rb

@@ -129,6 +129,13 @@ describe 'CustomFields::Controller::CustomFields' do
       .value.should == textarea_field.id.to_s
   end
 
+  it 'Gracefully handle non numeric custom field IDs' do
+    visit(CustomFields::Controller::CustomFields.r(:edit, group.id, 'a').to_s)
+
+    page.current_path.should                    == index_url
+    page.has_selector?('.message.error').should == true
+  end
+
   enable_javascript
 
   it 'Automatically save a custom field' do

data/spec/zen/package/menus/controller/menu_items.rb

@@ -57,6 +57,13 @@ describe "Menus::Controller::MenuItems" do
     page.find('input[name="name"]').value.should == 'Spec menu item modified'
   end
 
+  it 'Gracefully handle non numeric menu item IDs' do
+    visit(Menus::Controller::MenuItems.r(:edit, menu.id, 'a').to_s)
+
+    page.current_path.should                    == index_url
+    page.has_selector?('.message.error').should == true
+  end
+
   enable_javascript
 
   it 'Automatically save a menu item' do

data/spec/zen/package/menus/controller/menus.rb

@@ -89,6 +89,13 @@ describe "Menus::Controller::Menus" do
     page.find('input[name="name"]').value.should == 'Spec menu modified'
   end
 
+  it 'Gracefully handle non numeric menu IDs' do
+    visit(Menus::Controller::Menus.r(:edit, 'a').to_s)
+
+    page.current_path.should                    == index_url
+    page.has_selector?('.message.error').should == true
+  end
+
   enable_javascript
 
   it 'Automatically save a menu' do

data/spec/zen/package/menus/helper/menu_frontend.rb

@@ -52,7 +52,7 @@ describe 'Menus::Plugin::Menus' do
   end
 
   it "Retrieve a menu with only 1 item" do
-    menu = render_menu(nav_menu.slug, :limit => 1).strip
+    menu = render_menu(nav_menu.slug, :limit => 1, :order => :asc).strip
 
     menu.include?('Spec').should                  == true
     menu.include?('Spec 2').should                == false