zen 0.4.2 → 0.4.3

data/README.md

@@ -78,6 +78,7 @@ small portion of what it can do.
 * {Sections Sections & Section Entries}
   * {Sections::Controller::Sections Managing Sections}
   * {Sections::Controller::SectionEntries Managing Section Entries}
+  * {Sections::Controller::Revisions Managing And Restoring Revisions}
   * {Ramaze::Helper::SectionFrontend#get_entries Section Entries & Templates}
 * {Settings}
   * {Settings::Controller::Settings Managing Settings}
@@ -96,17 +97,18 @@ small portion of what it can do.
 * {Zen::Event Events}
 * {Zen::Validation Validating Objects}
 * {Zen::Security.sanitize Sanitizing User Input}
-* {file:autosaving_forms Automatically Saving Form Data}
 * {Ramaze::Helper::Locale Working With Dates}
-* {file:asset_management Asset Management}
 * {Zen::Markup Converting Markup}
+* {Zen::HTMLDiff Generating Diffs}
+* {file:autosaving_forms Automatically Saving Form Data}
+* {file:asset_management Asset Management}
 * {file:javascript Javascript API}
 
 ## Community
 
 * [Website][zen website]
 * [Mailing list][mailing list]
-* IRC channel: \#zen-cms on Freenode
+* IRC channel: \#zen on Freenode
 
 ## Websites Using Zen
 

data/Rakefile

@@ -1,12 +1,14 @@
-require 'rubygems'
-
-Zen::Gemspec = Gem::Specification.load(
-  File.expand_path('../zen.gemspec', __FILE__)
-)
+require 'rubygems/package_task'
 
 task_path = File.expand_path('../lib/zen/task', __FILE__)
-tasks     = ['build', 'clean', 'proto', 'setup', 'test', 'spelling']
+tasks     = ['build', 'proto', 'test', 'spelling']
+GEMSPEC   = Gem::Specification.load('zen.gemspec')
 
 tasks.each do |task|
   import File.join(task_path, "#{task}.rake")
 end
+
+Gem::PackageTask.new(GEMSPEC) do |pkg|
+  pkg.need_tar = false
+  pkg.need_zip = false
+end

data/bin/zen

@@ -1,13 +1,8 @@
 #!/usr/bin/env ruby
 require 'ramaze'
+require 'shebang'
 
-Ramaze.setup(:verbose => false) do
-  gem 'shebang', ['~> 0.1']
-end
-
-unless $LOAD_PATH.include?(__DIR__('../lib'))
-  $LOAD_PATH.unshift(__DIR__('../lib'))
-end
+$:.unshift(__DIR__('../lib')) unless $:.include?(__DIR__('../lib'))
 
 require 'zen/version'
 require 'zen/bin/create'

data/guide/asset_management.md

@@ -1,3 +1,4 @@
+# @title Asset Management
 # Asset Management
 
 Zen comes with an asset manager powered by [Ramaze::Asset][ramaze-asset]. Before

data/guide/autosaving_forms.md

@@ -1,3 +1,4 @@
+# @title Automatically Saving Form Data
 # Automatically Saving Form Data
 
 To make it easier for users to work with their data Zen allows developers to

data/guide/changelog.md

@@ -1,5 +1,27 @@
+# @title Changelog
 # Changelog
 
+## 0.4.3 - June 10th, 2012
+
+* Fixed various YARD warnings.
+* Updated the version requirement of Rake.
+* Simplified the loading of Gems.
+* Added pg and mysql2 to the gemspec.
+* Fixed the task for building Gems.
+* Load specific Ramaze versions.
+* Updated various version requirements.
+* Expanded the documentation of `get_entries()`.
+* Changed `@since` date formats to Y-m-d.
+* Fixed a minor formatting issue for `get_entries()`.
+* `:field_values` was renamed to `:custom_field_values`.
+* Small style changes for messages.
+* Removed `Sequel::Model.pk_hash`.
+* Redirect to the dashboard for invalid searches.
+* Re-organized some parts of the developer guide.
+* Replaced Raspell with `FFI::Aspell`.
+* Ability to compare section entry revisions and restore specific revisions.
+* Escape underscores in Markdown text.
+
 ## 0.4.2 - April 16th, 2012
 
 * Bugfix for rendering menu items in the backend. Due to a typo the menu items

data/guide/faq.md

@@ -1,3 +1,4 @@
+# @title Frequently Asked Questions
 # Frequently Asked Questions
 
 ## When starting I get the warning "Failed to migrate the settings..."

data/guide/getting_started.md

@@ -1,3 +1,4 @@
+# @title Getting Started
 # Getting Started
 
 Once installed (see {file:installation Installation}) you can use the ``zen``

data/guide/hacking.md

@@ -1,3 +1,4 @@
+# @title Hacking & Contributing
 # Hacking & Contributing
 
 Everybody is free to contribute to Zen. However, to ensure that the quality of

data/guide/installation.md

@@ -1,3 +1,4 @@
+# @title Installation
 # Installation
 
 Zen can be installed in two different ways, either by using Rubygems or Git. The
@@ -11,7 +12,7 @@ your terminal:
 
     $ gem install zen
 
-If you want to install a specific version of Zen you can provide the ``-v``
+If you want to install a specific version of Zen you can provide the `-v`
 option:
 
     $ gem install zen -v [VERSION]
@@ -28,8 +29,8 @@ be done by a simply cloning the repository:
 
     $ git clone git://github.com/zen-cms/Zen-Core.git zen_core
 
-This command saves a local copy of Zen in the directory ./zen_core. Now that you
-have a local copy there are two ways of using it:
+This command saves a local copy of Zen in the directory `./zen_core`. Now that
+you have a local copy there are two ways of using it:
 
 1. Manually build the Gem each time you've made a change.
 2. Directly load the Zen installation from your application.

data/guide/javascript.md

@@ -1,3 +1,4 @@
+# @title Javascript API
 # Javascript API
 
 Zen comes with a pretty good Javascript API that's based on the

data/guide/javascript/zen_autosave.md

@@ -1,3 +1,4 @@
+# @title Zen.Autosave
 # Zen.Autosave
 
 Zen.Autosave automatically saves form data at a given interval. Automatically

data/guide/javascript/zen_editor.md

@@ -1,3 +1,4 @@
+# @title Zen.Editor
 # Zen.Editor
 
 Zen.Editor is the main class used for the markup editor that can be used to more

data/guide/javascript/zen_form.md

@@ -1,3 +1,4 @@
+# @title Zen.Form
 # Zen.Form
 
 Zen.Form is a class used for adding various dynamic features to HTML forms

data/guide/javascript/zen_hash.md

@@ -1,3 +1,4 @@
+# @title Zen.Hash
 # Zen.Hash
 
 Zen.Hash is a class that can be used to parse and generate shebang/hash bang

data/guide/javascript/zen_htmltable.md

@@ -1,3 +1,4 @@
+# @title Zen.HtmlTable
 # Zen.HtmlTable
 
 The class Zen.HtmlTable was introduced in Zen 0.2.8 and makes it possible to

data/guide/javascript/zen_tabs.md

@@ -1,3 +1,4 @@
+# @title Zen.Tabs
 # Zen.Tabs
 
 Zen.Tabs can be used to create a tab based navigation menu. Because Zen already

data/guide/javascript/zen_window.md

@@ -1,3 +1,4 @@
+# @title Zen.Window
 # Zen.Window
 
 The Window class can be used to display modal windows with (or without) a set of

data/guide/zen_compared.md

@@ -1,3 +1,4 @@
+# @title Comparing Zen With Others
 # Comparing Zen With Others
 
 A common question people ask when looking into specific software is "How is this

data/lib/zen.rb

@@ -1,12 +1,10 @@
-require 'ramaze'
 require 'json'
-
-Ramaze.setup(:verbose => false) do
-  gem 'sequel'      , ['~> 3.34.1']
-  gem 'bcrypt-ruby' , ['~> 3.0.1'], :lib => 'bcrypt'
-  gem 'loofah'      , ['~> 1.2.1']
-  gem 'ramaze-asset', ['~> 0.2.3'], :lib => 'ramaze/asset'
-end
+require 'ramaze'
+require 'sequel'
+require 'bcrypt'
+require 'loofah'
+require 'ramaze/asset'
+require 'diff-lcs'
 
 $:.unshift(__DIR__) unless $:.include?(__DIR__)
 
@@ -21,7 +19,7 @@ module Zen
   # Array containing all the translations that should be made available to the
   # Javascript code.
   #
-  # @since 19-02-2012
+  # @since 2012-02-19
   #
   JAVASCRIPT_TRANSLATIONS = [
     'zen_general.buttons.bold',
@@ -73,13 +71,12 @@ module Zen
     # Sets the database connection to use and loads the core packages provided
     # by Zen.
     #
-    # @since 27-03-2012
+    # @since 2012-03-27
     #
     def database=(database)
       @database = database
 
       require 'zen/model/init'
-      require 'zen/model/methods'
       require 'zen/package/all'
     end
 
@@ -87,7 +84,7 @@ module Zen
     # Prepares Zen for the party of its life.
     #
     # @since 0.3
-    # @event post_start Event that is fired after all packages have been loaded,
+    # @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.
     #
@@ -213,6 +210,7 @@ require 'zen/package'
 require 'zen/theme'
 require 'zen/security'
 require 'zen/migrator'
+require 'zen/html_diff'
 
 # Load all the base controllers
 require 'zen/controller/base_controller'

data/lib/zen/event.rb

@@ -66,7 +66,7 @@ module Zen
       #
       # @since  0.3
       # @param  [#to_sym] event The name of the event to invoke.
-      # @param  [Array] *args An array of arguments to pass to each event.
+      # @param  [Array] args An array of arguments to pass to each event.
       #
       def call(event, *args)
         event = event.to_sym
@@ -105,7 +105,7 @@ module Zen
       #  Zen::Event.delete(:before_new_user, :after_new_user)
       #
       # @since  0.3
-      # @param  [Array] *names The names of the events to remove. Each name
+      # @param  [Array] names The names of the events to remove. Each name
       #  should be a symbol or something that responds to #to_sym().
       #
       def delete(*names)

data/lib/zen/helper/controller.rb

@@ -21,7 +21,7 @@ module Ramaze
       # Returns an anchor tag that points towards the URL that allows users to
       # manage collections of data.
       #
-      # @since  17-12-2011
+      # @since  2011-12-17
       # @see    Ramaze::Helper::Controller#edit_link
       # @return [String]
       #
@@ -33,7 +33,7 @@ module Ramaze
       # Returns an anchor tag that should point to a form that allows users to
       # edit certain resources.
       #
-      # @since  17-12-2011
+      # @since  2011-12-17
       # @param  [#to_s] url The URL for the link.
       # @param  [#to_s] text The text to display in the link tag.
       # @return [String]
@@ -46,7 +46,7 @@ module Ramaze
       # Returns a button that should point to a form that allows users to create
       # new resources.
       #
-      # @since 17-12-2011
+      # @since 2011-12-17
       # @see   Ramaze::Helper::Controller#edit_link
       #
       def new_button(url, text)
@@ -56,7 +56,7 @@ module Ramaze
       ##
       # Returns a button that when clicked should delete a set of resources.
       #
-      # @since  17-12-2011
+      # @since  2011-12-17
       # @param  [String] text The text to display on the button.
       # @return [String]
       #
@@ -69,7 +69,7 @@ module Ramaze
       # Checks if a given object can be paginated and the page count is greater
       # than 1. If this is the case then the pagination links are displayed.
       #
-      # @since  17-12-2011
+      # @since  2011-12-17
       # @param  [Mixed] object
       # @return [String]
       #
@@ -84,7 +84,7 @@ module Ramaze
       # values can be returned:
       #
       # * firefox
-      # * internet_explorer
+      # * internet\_explorer
       # * chrome
       # * safari
       # * other
@@ -92,7 +92,7 @@ module Ramaze
       # Note that this method does a very simple check and thus should not be
       # relied on for anything mission critical.
       #
-      # @since  23-12-2011
+      # @since  2011-12-23
       # @param  [String] agent String containing the user agent to check, set to
       #  ``request.env['HTTP_USER_AGENT']`` if no custom agent is specified.
       # @return [String]
@@ -124,7 +124,7 @@ module Ramaze
       ##
       # Writes a JSON response.
       #
-      # @since 13-02-2012
+      # @since 2012-02-13
       # @param [Mixed] data The response data.
       # @param [Fixnum] status The HTTP status code.
       #
@@ -136,8 +136,8 @@ module Ramaze
       # Returns a hash containing all the given POST fields, similar to
       # ``Innate::Request#subset``.
       #
-      # @since  19-02-2012
-      # @param  [Array] *keys The POST keys to retrieve.
+      # @since  2012-02-19
+      # @param  [Array] keys The POST keys to retrieve.
       # @return [Hash]
       #
       def post_fields(*keys)
@@ -150,7 +150,7 @@ module Ramaze
       # Returns a JSON string containing all the translations for the Javascript
       # code.
       #
-      # @since  19-02-2012
+      # @since  2012-02-19
       # @return [String]
       #
       def javascript_translations
@@ -199,7 +199,7 @@ module Ramaze
         #  end
         #
         # @since  0.3
-        # @param  [Array] *actions An array of action names to protect against
+        # @param  [Array] actions An array of action names to protect against
         #  CSRF attacks.
         #
         def csrf_protection(*actions)
@@ -231,7 +231,7 @@ module Ramaze
         #  [:name, :description],
         #  :edit_category_group
         #
-        # @since 13-02-2012
+        # @since 2012-02-13
         # @param [Class] model The model to use for saving data.
         # @param [Array] columns The columns that can be saved.
         # @param [#to_sym] permission The permission required for saving

data/lib/zen/helper/message.rb

@@ -21,13 +21,13 @@ module Ramaze
     #
     # This will create and return the HTML for all the messages.
     #
-    # @since  26-05-2011
+    # @since  2011-05-26
     #
     module Message
       ##
       # Adds a new message to the list for the given type.
       #
-      # @since  26-05-2011
+      # @since  2011-05-26
       # @param  [Symbol/String] type The type of message to store (e.g. "error").
       # @param  [String] message The message to display.
       #
@@ -44,7 +44,7 @@ module Ramaze
       ##
       # Renders all the messages for the specified types.
       #
-      # @since  26-05-2011
+      # @since  2011-05-26
       # @param  [Array] types Array containing all the messages to render.
       #
       def display_messages(types = [:info, :error, :success])

data/lib/zen/helper/search.rb

@@ -4,13 +4,13 @@ module Ramaze
     # The Search helper is a helper that can be used in controllers allowing the
     # user to search the content of those controllers and models.
     #
-    # @since  16-10-2011
+    # @since  2011-10-16
     #
     module Search
       ##
       # Renders a search form that points to the given URL.
       #
-      # @since  16-10-2011
+      # @since  2011-10-16
       # @param  [#to_s] url The URL to point the search form to.
       # @return [String]
       #
@@ -33,7 +33,7 @@ module Ramaze
       #    Sections::Model::Section.search(query)
       #  end
       #
-      # @since  16-10-2011
+      # @since  2011-10-16
       # @return [NilClass|Mixed]
       #
       def search
@@ -46,7 +46,7 @@ module Ramaze
         rescue => e
           Ramaze::Log.error(e)
           message(:error, lang('zen_general.errors.invalid_search'))
-          redirect_referrer(::Sections::Controller::Sections.r(:index))
+          redirect_referrer(Dashboard::Controller::Dashboard.r(:index))
         end
       end
     end # Search