zen 0.4 → 0.4.1

data/.aspell.en.pws

@@ -0,0 +1,31 @@
+personal_ws-1.1 en 28 utf-8
+stylesheet
+getter
+erb
+timestamp
+checkboxes
+Capybara's
+isset
+xhtml
+csrf
+https
+strftime
+nodoc
+todo
+procs
+readline
+namespace
+backend
+rb
+frontend
+rtl
+textarea
+mutex
+github
+boolean
+reloader
+regex
+checkbox
+login
+ramaze
+ramaze's

data/.gems

@@ -8,7 +8,7 @@ ramaze-asset
 rake
 
 # Development.
-rdiscount
+redcarpet
 bacon
 yard
 capybara

data/.mailmap

@@ -1,3 +1,4 @@
 Yorick Peterse <yorickpeterse@gmail.com> YorickPeterse <info@yorickpeterse.com>
 Yorick Peterse <yorickpeterse@gmail.com> Yorick Peterse <info@yorickpeterse.com>
 Yorick Peterse <yorickpeterse@gmail.com> YorickPeterse <yorickpeterse@gmail.com>
+Yorick Peterse <yorickpeterse@gmail.com> Yorick Peterse <yorick@isset.nl>

data/.travis.yml

@@ -1,4 +1,4 @@
-script: "rake setup; rake test:default"
+script: "rake setup; rake test:travis"
 rvm:
   - 1.9.2
   - 1.9.3
@@ -13,15 +13,21 @@ branches:
     - master
 
 env:
-  - 'ADAPTER=sqlite'
+  - 'ADAPTER=sqlite DATABASE=database.db'
   - 'ADAPTER=mysql2 DATABASE=zen_dev'
   - 'ADAPTER=postgres DATABASE=zen_dev USERNAME=postgres'
-  - 'LRU=1 ADAPTER=sqlite'
-  - 'LRU=1 ADAPTER=mysql2 DATABASE=zen_dev'
-  - 'LRU=1 ADAPTER=postgres DATABASE=zen_dev USERNAME=postgres'
+  - 'LRU=1 ADAPTER=sqlite DATABASE=database_lru.db'
+  - 'LRU=1 ADAPTER=mysql2 DATABASE=zen_dev_lru'
+  - 'LRU=1 ADAPTER=postgres DATABASE=zen_dev_lru USERNAME=postgres'
 
 before_script:
-  - "mysql -e 'CREATE DATABASE zen_dev;'"
-  - "psql -c  'CREATE DATABASE zen_dev;' -U postgres"
+  - "mysql -e 'CREATE DATABASE zen_dev_1_9_2;'"
+  - "mysql -e 'CREATE DATABASE zen_dev_1_9_3;'"
+  - "mysql -e 'CREATE DATABASE zen_dev_lru_1_9_2;'"
+  - "mysql -e 'CREATE DATABASE zen_dev_lru_1_9_3;'"
+  - "psql -c 'CREATE DATABASE zen_dev_1_9_2;' -U postgres"
+  - "psql -c 'CREATE DATABASE zen_dev_lru_1_9_2;' -U postgres"
+  - "psql -c 'CREATE DATABASE zen_dev_1_9_3;' -U postgres"
+  - "psql -c 'CREATE DATABASE zen_dev_lru_1_9_3;' -U postgres"
   - "export DISPLAY=:99.0"
   - "sh -e /etc/init.d/xvfb start"

data/.yardopts

@@ -1,6 +1,6 @@
 ./lib/zen/**/*.rb ./lib/zen.rb
 -m markdown
--M rdiscount
+-M redcarpet
 -o ./doc
 -r ./README.md
 -e ./lib/yard/tags.rb

data/Rakefile

@@ -1,11 +1,11 @@
 require 'rubygems'
 
-Zen::Gemspec = Gem::Specification::load(
+Zen::Gemspec = Gem::Specification.load(
   File.expand_path('../zen.gemspec', __FILE__)
 )
 
 task_path = File.expand_path('../lib/zen/task', __FILE__)
-tasks     = ['build', 'clean', 'proto', 'setup', 'test']
+tasks     = ['build', 'clean', 'proto', 'setup', 'test', 'spelling']
 
 tasks.each do |task|
   import File.join(task_path, "#{task}.rake")

data/guide/changelog.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 0.4.1 - April 16th, 2012
+
+* Updated various version requirements.
+* Menu items are sorted properly, in some cases the sort order would be broken
+  due to the dataset being sorted after it was retrieved.
+* Replaced RDiscount with Redcarpet.
+* Show menu items without permissions.
+* Documentation improvements and fixed various spelling errors.
+* Removed the `post_start` event.
+* Load core packages when connecting to a DB.
+* Call `:post_start` before building assets.
+* Hide messages by clicking on them.
+* Basic set of styles for the pagination buttons.
+* Preserve author IDs for section entries
+* Handle forms using the Mootools class Zen.Form.
+* Moved Mootools events into their own file.
+* Set Ramaze.options.mode before Zen.root.
+
 ## 0.4 - March 7th, 2012
 
 * Packages can contain multiple menus.
@@ -20,7 +38,7 @@
 * Fixed an issue that would incorrectly generate application names when creating
   a new application using ``zen create``.
 * Full stack traces are logged in case of errors rather than just the message.
-* Model related events (e.g. before_new_section_entry) have been moved into
+* Model related events (e.g. `before_new_section_entry`) have been moved into
   their corresponding models.
 * Menu item manager has been re-written so that menu items can be organized
   using a drop and drag interface.
@@ -63,7 +81,7 @@
 * Core packages no longer include certain modules just to so that they don't
   have to specify the full namespace to a class.
 * Added an event system (Zen::Event) and a bucket load of events.
-* Merged Zen.init and Zen.post_init into Zen.start.
+* Merged Zen.init and `Zen.post_init` into Zen.start.
 * Fixed various YARD formatting issues.
 * Localized all of the Javascript.
 * All specs now pass on Ruby 1.9.3.
@@ -103,7 +121,7 @@
   section entries plugin.
 * Statuses of comments and section entries are now stored in a separate table.
 * Plugins can be called as a singleton using Zen::Plugin.plugin.
-* The column menu_items.order has been renamed to menu_items.sort_order.
+* The column `menu_items.order` has been renamed to menu_items.sort_order.
 * The accessor method for settings that defines the possible values now accepts
   a Proc, this makes it possible for conditional possible values and such.
 * Various performance tweaks.
@@ -116,8 +134,8 @@
 * Users can now create their own custom field types.
 * Overview pages now paginate their results so they display a maximum of 20 rows
   per page.
-* All references to "css_class" and "css_id" have been replaced with
-  "html_class" and "html_id".
+* All references to "css\_class" and "css\_id" have been replaced with
+  "html\_class" and "html\_id".
 * Ramaze::Helper::Common has been removed.
 * Tables can now be sorted by clicking on the headers.
 * The required permissions for the #save() methods of all controllers have been

data/guide/css/common.css

@@ -18,3 +18,51 @@ pre.code
     font-size:   13px;
     line-height: 1.4;
 }
+
+/**
+ * YARD uses generic table styles, using a special class means those tables
+ * don't get messed up.
+ */
+.table
+{
+    border:          1px solid #ccc;
+    border-right:    none;
+    border-collapse: separate;
+    border-spacing:  0;
+    text-align:      left;
+}
+
+.table.full
+{
+    width: 100%;
+}
+
+    .table .field_name
+    {
+        min-width: 160px;
+    }
+
+    .table thead tr th.no_sort:first-child
+    {
+        width: 25px;
+    }
+
+    .table thead tr th, .table tbody tr td
+    {
+        border-bottom:  1px solid #ccc;
+        border-right:   1px solid #ccc;
+        min-width:      20px;
+        padding:        8px 5px;
+        text-align:     left;
+        vertical-align: top;
+    }
+
+    .table tbody tr:last-child td
+    {
+        border-bottom: none;
+    }
+
+    .table tr:nth-child(odd) td
+    {
+        background: #f9f9f9;
+    }

data/guide/javascript.md

@@ -62,6 +62,7 @@ Out of the box the following classes are available:
 * {file:javascript/zen_editor Zen.Editor}
 * {file:javascript/zen_htmltable Zen.HtmlTable}
 * {file:javascript/zen_autosave Zen.Autosave}
+* {file:javascript/zen_form Zen.Form}
 
 The following third-party classes are also provided:
 

data/guide/javascript/zen_form.md

@@ -0,0 +1,46 @@
+# Zen.Form
+
+Zen.Form is a class used for adding various dynamic features to HTML forms
+such as automatically saving the data and handling validation errors using
+the HTML5 constraints API.
+
+For the features related to the HTML5 constraints API to work properly users
+should be using a modern browser. If this API is not implemented it will be
+silently ignored. Automatically saving data is supported regardless of the
+existence of this API and is handled by Zen.Autosave.
+
+## Usage
+
+In order to use this class you'll have to create a new instance of it and
+pass an instance of Element to it (an instance for a ``<form>`` element):
+
+    new Zen.Form($('my_form'));
+
+By passing and object to the second parameter you can customize various parts
+of this class. The following options are available:
+
+* autosave_attribute: name of the attribute that contains the URL to send
+  requests to when automatically saving form data. This option is set to
+  "data-autosave-url" by default.
+* tabs_selector: a CSS selector used to determine the tabs for the form, set
+  to "div.tabs ul" by default.
+* error_class: the primary class to use for error indicators in a tab, set to
+  "tab_error" by default.
+
+An example of setting one of these options is the following:
+
+    new Zen.Form($('my_form'), {error_class: 'custom_tab_error'});
+
+Keep in mind that out of the box there's no need to manually use this class,
+Zen already does this for you.
+
+## Tabs and Errors
+
+This class makes it easier for users to nice form errors. This is achieved by
+showing a small error icon in a tab of which the corresponding tab field
+contains a number of invalid form elements. For this to work properly you
+should add the class "tab_field" to each tab field:
+
+    <div id="general" class="tab_field">
+        <!-- Tab field's content -->
+    </div>

data/guide/zen_compared.md

@@ -7,6 +7,110 @@ things up a bit.
 
 Do note that since I wrote Zen my opinion is more than likely biased.
 
+## Quick Overview
+
+<table class="table">
+    <thead>
+        <tr>
+            <th></th>
+            <th>Zen</th>
+            <th>Wordpress</th>
+            <th>Expression Engine</th>
+            <th>Radiant</th>
+            <th>Refinery</th>
+            <th>Locomotive</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>
+                <strong>Language</strong>
+            </td>
+            <td>Ruby</td>
+            <td>PHP</td>
+            <td>PHP</td>
+            <td>Ruby</td>
+            <td>Ruby</td>
+            <td>Ruby</td>
+        </tr>
+        <tr>
+            <td>
+                <strong>Framework</strong>
+            </td>
+            <td>Ramaze</td>
+            <td>None</td>
+            <td>Codeigniter</td>
+            <td>Rails</td>
+            <td>Rails</td>
+            <td>Rails</td>
+        </tr>
+        <tr>
+            <td>
+                <strong>Storage Engines</strong>
+            </td>
+            <td>MySQL, PostgreSQL, SQLite3 <sup>1</sup></td>
+            <td>MySQL</td>
+            <td>MySQL</td>
+            <td>MySQL, SQLite3 and probably PostgreSQL</td>
+            <td>MySQL, PostgreSQL, SQLite3</td>
+            <td>MongoDB</td>
+        </tr>
+        <tr>
+            <td>
+                <strong>License</strong>
+            </td>
+            <td>MIT</td>
+            <td>GPLv2</td>
+            <td>Proprietary</td>
+            <td>MIT</td>
+            <td>MIT</td>
+            <td>MIT</td>
+        </tr>
+        <tr>
+            <td>
+                <strong>Flexible content management <sup>2</sup></strong>
+            </td>
+            <td>Yes</td>
+            <td>No</td>
+            <td>Yes</td>
+            <td>No</td>
+            <td>No</td>
+            <td>Limited</td>
+        </tr>
+        <tr>
+            <td>
+                <strong>Easy to install <sup>3</sup></strong>
+            </td>
+            <td>Yes</td>
+            <td>No</td>
+            <td>No</td>
+            <td>Yes</td>
+            <td>Yes</td>
+            <td>No</td>
+        </tr>
+        <tr>
+            <td>
+                <strong>Markup <sup>4</sup></strong>
+            </td>
+            <td>plain text, Markdown, Textile, HTML</td>
+            <td>plain text, HTML</td>
+            <td>plain text, HTML</td>
+            <td>plain text, Markdown, Textile, SmartyPants</td>
+            <td>plain text, HTML</td>
+            <td>Unknown, probably plain text and HTML</td>
+        </tr>
+    </tbody>
+</table>
+
+1. Zen in theory supports all databases supported by Sequel but only the ones
+   listed above have been officially tested.
+2. Flexible content management without having to install various third-party
+   plugins.
+3. Easy to install without the need of having to execute multiple shell commands
+   or manually extracting archives.
+4. Support for different markup formats without installing third-party plugins
+   or writing them yourself.
+
 ## Zen vs Wordpress
 
 There are quite a few differences between Zen and Wordpress besides the language

data/lib/zen.rb

@@ -2,9 +2,9 @@ require 'ramaze'
 require 'json'
 
 Ramaze.setup(:verbose => false) do
-  gem 'sequel'      , ['~> 3.33.0']
+  gem 'sequel'      , ['~> 3.34.1']
   gem 'bcrypt-ruby' , ['~> 3.0.1'], :lib => 'bcrypt'
-  gem 'loofah'      , ['~> 1.2.0']
+  gem 'loofah'      , ['~> 1.2.1']
   gem 'ramaze-asset', ['~> 0.2.3'], :lib => 'ramaze/asset'
 end
 
@@ -41,7 +41,7 @@ module Zen
 
   class << self
     # The database connection to use for Sequel.
-    attr_accessor :database
+    attr_reader :database
 
     # Instance of Ramaze::Asset::Environment to use for all backend assets.
     attr_accessor :asset
@@ -70,10 +70,23 @@ module Zen
     end
 
     ##
-    # Prepares Zen for the party of it's life.
+    # Sets the database connection to use and loads the core packages provided
+    # by Zen.
+    #
+    # @since 27-03-2012
+    #
+    def database=(database)
+      @database = database
+
+      require 'zen/model/init'
+      require 'zen/model/methods'
+      require 'zen/package/all'
+    end
+
+    ##
+    # Prepares Zen for the party of its life.
     #
     # @since 0.3
-    # @event pre_start Event that is fired before starting Zen.
     # @event post_start Event that is fired after all packages have been loaded,
     #  the cache has been set up, etc. This event is called at the very end of
     #  the method.
@@ -81,22 +94,16 @@ module Zen
     def start
       raise('No valid root directory specified in Zen.root') if root.nil?
 
-      Zen::Event.call(:pre_start)
-
       # Set up Ramaze::Cache manually. This makes it possible for the language
       # files to cache their data in the custom cache without having to wait for
       # Ramaze to set it up.
       Ramaze::Cache.setup
       Ramaze.options.setup.delete(Ramaze::Cache)
 
-      require 'zen/model/init'
-      require 'zen/model/methods'
-      require 'zen/package/all'
+      Zen::Event.call(:post_start)
 
       Zen.asset.build(:javascript)
       Zen.asset.build(:css)
-
-      Zen::Event.call(:post_start)
     end
 
     private
@@ -138,8 +145,10 @@ module Zen
           'admin/mootools/js/core',
           'admin/mootools/js/more',
           'admin/zen/js/lib/base',
+          'admin/zen/js/lib/events',
           'admin/zen/js/lib/html_table',
           'admin/zen/js/lib/autosave',
+          'admin/zen/js/lib/form',
           'admin/zen/js/index'
         ],
         :name => 'zen_core'