zen 0.2.3 → 0.2.4

data/CHANGELOG.md

@@ -1,13 +1,23 @@
 # Changelog
 
-## 0.2 - March 18th, 2011
+## 0.2.4 - March 27th, 2011
+
+* Fix an issue that would prevent migrations from being executed in the correct order.
+* Fixed a small translation bug in the section entries translation file.
+* Restyled the footer in the admin panel.
+* Removed the requirement of having to specify the type of package/extension.
+* Navigation items will now be hidden according to the user's permissions.
+* Split packages into packages, themes and plugins. This makes it much easier to extend
+small features such as the markup generator and the comment validation system
+
+## 0.2 - March 20th, 2011
 
 * Added a package for managing navigation items.
 * Introduced a new language system using YAML files instead of Ruby files.
 * Added a datepicker for date fields.
 * Improved several existing Liquid tags.
 * Form data is no longer lost in case of an error. 
-* Converted all markup from Textile to Markdown
+* Converted all markup from Textile to Markdown.
 * Replaced Bacon by RSpec 2 and Webrat.
 * Replaced Rake by Thor.
 * Cleaned up a lot of code.

data/MANIFEST

@@ -4,28 +4,30 @@ README.md
 ROADMAP.md
 Thorfile
 bin/zen
-lib/zen/base/database.rb
-lib/zen/base/language.rb
-lib/zen/base/logger.rb
-lib/zen/base/package.rb
-lib/zen/base/version.rb
-lib/zen/bin/zen_binary.rb
+lib/zen/bin/base.rb
 lib/zen/controller/admin_controller.rb
 lib/zen/controller/base_controller.rb
 lib/zen/controller/frontend_controller.rb
 lib/zen/controller/main_controller.rb
+lib/zen/database.rb
+lib/zen/error/language_error.rb
+lib/zen/error/package_error.rb
+lib/zen/error/plugin_error.rb
+lib/zen/error/theme_error.rb
 lib/zen/helper/acl.rb
 lib/zen/helper/asset.rb
 lib/zen/helper/breadcrumb.rb
 lib/zen/helper/common.rb
 lib/zen/language/en/zen_general.yml
 lib/zen/language/en/zen_models.yml
+lib/zen/language.rb
 lib/zen/layout/admin.xhtml
 lib/zen/layout/login.xhtml
 lib/zen/liquid/controller_behavior.rb
 lib/zen/liquid/general.rb
 lib/zen/liquid/redirect.rb
 lib/zen/liquid/strip.rb
+lib/zen/logger.rb
 lib/zen/model/methods.rb
 lib/zen/model/settings.rb
 lib/zen/package/all.rb
@@ -152,6 +154,9 @@ lib/zen/package/users/lib/users/view/admin/users/new.xhtml
 lib/zen/package/users/lib/users.rb
 lib/zen/package/users/migrations/.gitkeep
 lib/zen/package/users/migrations/1295281013_create_schema.rb
+lib/zen/package.rb
+lib/zen/plugin/markup.rb
+lib/zen/plugin.rb
 lib/zen/public/admin/css/boilerplate.css
 lib/zen/public/admin/css/buttons.css
 lib/zen/public/admin/css/datepicker.css
@@ -201,11 +206,15 @@ lib/zen/public/admin/js/zen/init.js
 lib/zen/public/admin/js/zen/modal.js
 lib/zen/public/admin/js/zen/notification.js
 lib/zen/public/admin/js/zen/tabs.js
+lib/zen/strict_struct.rb
 lib/zen/task/build.rb
 lib/zen/task/clean.rb
 lib/zen/task/db.rb
 lib/zen/task/package.rb
 lib/zen/task/proto.rb
+lib/zen/task/theme.rb
+lib/zen/theme.rb
+lib/zen/version.rb
 lib/zen.rb
 license.txt
 proto/app/Thorfile
@@ -215,16 +224,14 @@ proto/app/config/database.rb
 proto/app/config/middlewares.rb
 proto/app/config/requires.rb
 proto/app/config.ru
-proto/app/logs/.gitkeep
+proto/app/log/.gitkeep
 proto/app/public/.gitkeep
 proto/app/start.rb
 proto/app/vendor/.gitkeep
 proto/app/vendor/themes/.gitkeep
 proto/migration.rb
-proto/package/LICENSE
-proto/package/README.textile
 proto/package/lib/package/controller/controllers.rb
-proto/package/lib/package/language/en/languages.rb
+proto/package/lib/package/language/en/languages.yml
 proto/package/lib/package/model/model.rb
 proto/package/lib/package/view/admin/package/edit.xhtml
 proto/package/lib/package/view/admin/package/form.xhtml

data/ROADMAP.md

@@ -9,14 +9,18 @@ to be unverified/undecided and might not be added/completed at all.
 
 ### 0.3 - June 2011
 
-* Most parts of the core covered by specs. (!)
-* A working (although probably rough) plugin system to extend the inner parts of Zen. 
-An example of a plugin would be something that allows the use of Akismet for comments
-rather than Defensio.
 * Website completely up and running. (!)
 * Translation system for the Javascript used in the backend
 * Documentation/Userguide online
 
+### 0.2.4 - March 2011
+
+* Liquid tags work when caching is enabled.
+* Compatibility with 1.9 and 1.9.1. (?)
+* A working (although probably rough) plugin system to extend the inner parts of Zen. 
+An example of a plugin would be something that allows the use of Akismet for comments
+rather than Defensio.
+
 ### 0.2 - March 2011
 
 * General code improvements.

data/bin/zen

@@ -2,8 +2,7 @@
 zen_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'zen'))
 
 require 'thor'
-
 require zen_path
-require zen_path + "/bin/zen_binary"
+require zen_path + "/bin/base"
 
-Zen::Bin::Base.start
+Zen::Bin::Base.start

data/lib/zen.rb

@@ -4,6 +4,8 @@
 #
 # @author Yorick Peterse
 # @since  0.1
+# @attr_reader [Array] languages An array containing all the currently loaded language
+# files stored as hashes.
 #
 module Zen
   require 'sequel'
@@ -12,29 +14,37 @@ module Zen
   require 'liquid'
   require 'json'
   require 'defensio'
-  require 'thor'
   require 'sequel_sluggable'
   require 'yaml'
-  require __DIR__('zen/base/version')
+  require __DIR__('zen/version')
   
   include Innate::Optioned
+
+  class << self
+    attr_reader :languages
+  end
   
   # Update several paths so we can load helpers/layouts from the Zen gem
   Innate::HelpersHelper.options.paths.push(__DIR__('zen'))
   Ramaze.options.roots.push(__DIR__('zen'))
   
   options.dsl do
-    # General configuration options
-    o 'The character encoding to use when dealing with data',   :encoding,       'utf8'
-    o 'The date format to use for log files and such.',         :date_format,    '%d-%m-%Y'
-    o 'The base directory of Zen.',                             :root,           ''
+    o 'The character encoding to use when dealing with data', :encoding,     'utf8'
+    o 'The date format to use for log files and such.',       :date_format,  '%d-%m-%Y'
+    o 'The base directory of Zen.',                           :root,         ''
   end
   
   # Load all classes/modules provided by Zen itself.
-  require __DIR__ 'zen/base/logger'
-  require __DIR__ 'zen/base/database'
-  require __DIR__ 'zen/base/package'
-  require __DIR__ 'zen/base/language'
+  require __DIR__ 'zen/strict_struct'
+  require __DIR__ 'zen/logger'
+  require __DIR__ 'zen/database'
+  require __DIR__ 'zen/package'
+  require __DIR__ 'zen/language'
+  require __DIR__ 'zen/plugin'
+  require __DIR__ 'zen/theme'
+
+  # Load all required plugins
+  require __DIR__ 'zen/plugin/markup'
   
   # Load all the base controllers
   require __DIR__ 'zen/controller/base_controller'
@@ -48,10 +58,6 @@ module Zen
   require __DIR__ 'zen/liquid/redirect'
   require __DIR__ 'zen/liquid/strip'
   
-  class << self
-    attr_reader :languages
-  end
-  
   # Update the language paths
   Zen::Language.options.paths.push(__DIR__('zen'))
   

data/lib/zen/controller/main_controller.rb

@@ -43,7 +43,7 @@ module Zen
           respond(lang('zen_general.errors.no_theme'))
         end
 
-        theme    = ::Zen::Package[@settings[:theme]]
+        theme    = ::Zen::Theme[@settings[:theme]]
         group    = @uri[0]
         template = @uri[1]
         
@@ -57,13 +57,16 @@ module Zen
         end
         
         # Create the group, template and partial paths
-        theme_path    = theme.directory + '/templates'
+        theme_path    = theme.template_dir
         group_path    = theme_path + "/#{group}"
         template_path = theme_path + "/#{group}/#{template}.liquid"
         
         # Register our partial path
-        partial_path                   = theme_path + "/partials"
-        ::Liquid::Template.file_system = ::Liquid::LocalFileSystem.new(partial_path)
+        if theme.respond_to?(:partial_dir) and !theme.partial_dir.nil?
+          ::Liquid::Template.file_system = ::Liquid::LocalFileSystem.new(
+            theme.partial_dir
+          )
+        end
         
         # Is the website down?
         if @settings[:website_enabled] == '0'

data/lib/zen/{base/database.rb → database.rb}

@@ -43,6 +43,7 @@ module Zen
   #
   # @author Yorick Peterse
   # @since  0.1
+  # @attr_reader [Object] handle The Sequel database handle to use for all models.
   #
   module Database
     include Innate::Optioned
@@ -98,9 +99,9 @@ module Zen
     # @author Yorick Peterse
     # @since  0.1
     # @param  [Symbol] mode The development mode for which the database settings should be used.
-    # @param  [Block] &block Block containing all database settings.
+    # @yield  [config] Object containing all the options to set for the current mode.
     #
-    def self.mode mode, &block
+    def self.mode(mode)
       mode = mode.to_sym
       
       if mode == Ramaze.options.mode

data/lib/zen/error/language_error.rb

@@ -0,0 +1,10 @@
+#:nodoc:
+module Zen
+  ##
+  # Error class used by Zen::Language.
+  #
+  # @author Yorick Peterse
+  # @since  0.2.4
+  #
+  class LanguageError < StandardError; end
+end

data/lib/zen/error/package_error.rb

@@ -0,0 +1,10 @@
+#:nodoc:
+module Zen
+  ##
+  # Error class used by Zen::Package.
+  #
+  # @author Yorick Peterse
+  # @since  0.2.4
+  #
+  class PackageError < StandardError; end
+end

data/lib/zen/error/plugin_error.rb

@@ -0,0 +1,10 @@
+#:nodoc:
+module Zen
+  ##
+  # Error class used by Zen::Plugin.
+  #
+  # @author Yorick Peterse
+  # @since  0.2.4
+  #
+  class PluginError < StandardError; end
+end

data/lib/zen/error/theme_error.rb

@@ -0,0 +1,10 @@
+#:nodoc:
+module Zen
+  ##
+  # Error class used by Zen::Theme.
+  #
+  # @author Yorick Peterse
+  # @since  0.2.4
+  #
+  class ThemeError < StandardError; end
+end

data/lib/zen/helper/acl.rb

@@ -84,12 +84,18 @@ module Ramaze
       # should have ALL specified permissios. Setting this to false causes
       # this method to return true if any of the permissions are set for the
       # current user.
+      # @param  [String] identifier A custom identifier to use for validating the user's 
+      # permissions instead of using a class trait.
       # @return [Boolean]
       #
-      def user_authorized?(reqs, require_all = true)
-        identifier = ancestral_trait.values_at(:extension_identifier)
-        identifier = identifier[0]
-        
+      def user_authorized?(reqs, require_all = true, identifier = nil)
+        # Retrieve the identifier from the class trait if we didn't already have one
+        if identifier.nil?
+          identifier = ancestral_trait.values_at(:extension_identifier)
+          identifier = identifier[0]
+        end
+
+        # Still don't have an identifier?
         if identifier.nil?
           raise "You need to specify an extension identifier"
         end
@@ -122,6 +128,7 @@ module Ramaze
         
         return true
       end
+
     end
   end
 end

data/lib/zen/{base/language.rb → language.rb}

@@ -1,3 +1,5 @@
+require __DIR__('error/language_error')
+
 #:nodoc:
 module Zen
   ##
@@ -107,7 +109,7 @@ module Zen
         end        
       end
 
-      raise "No language file could be found for \"#{lang_name}\""
+      raise(Zen::LanguageError, "No language file could be found for \"#{lang_name}\"")
     end
 
     ##
@@ -140,14 +142,20 @@ module Zen
       translations  = ::Zen::Language.translations
 
       if !translations or !translations.key?(lang)
-        raise "No translation files have been added for the language code \"#{lang}\""
+        raise(
+          Zen::LanguageError, 
+          "No translation files have been added for the language code \"#{lang}\""
+        )
       end
 
       if translations[lang][key]
         return translations[lang][key]
       end
       
-      raise "The specified language item \"#{key}\" does not exist"
+      raise(
+        Zen::LanguageError,
+        "The specified language item \"#{key}\" does not exist"
+      )
     end
 
     private

data/lib/zen/layout/admin.xhtml

@@ -17,7 +17,10 @@
                 doesn't have the required permissions for the extension that created it.
                 -->
                 <nav id="main_nav" class="grid_12">
-                    #{Zen::Package.build_menu("left")}
+                    #{
+                        perms = extension_permissions
+                        Zen::Package.build_menu("left", perms[0], perms[1])
+                    }
                     
                     <ul class="right clearfix">
                         <li>
@@ -53,17 +56,23 @@
         <footer id="main_footer" class="container">
             <div class="grid_12">
                 <p>#{lang('zen_general.labels.zen_version') % Zen::Version}</p>
-                <p>
-                    <a href="http://zen-cms.com/">
-                        #{lang('zen_general.labels.zen_website')}
-                    </a> |
-                    <a href="http://zen-cms.com/documentation">
-                        #{lang('zen_general.labels.zen_docs')}
-                    </a> |
-                    <a href="https://github.com/zen-cms/">
-                        #{lang('zen_general.labels.zen_github')}
-                    </a>
-                </p>
+                <ul class="clearfix">
+                    <li>
+                        <a href="http://zen-cms.com/">
+                            #{lang('zen_general.labels.zen_website')}
+                        </a>
+                    </li>
+                    <li>
+                        <a href="http://zen-cms.com/documentation">
+                            #{lang('zen_general.labels.zen_docs')}
+                        </a>
+                    </li>
+                    <li>
+                        <a href="https://github.com/zen-cms/">
+                            #{lang('zen_general.labels.zen_github')}
+                        </a>
+                    </li>
+                </ul>
             </div>
         </footer>
         

data/lib/zen/layout/login.xhtml

@@ -23,17 +23,23 @@
         <footer id="main_footer" class="container">
             <div class="grid_12">
                 <p>#{lang('zen_general.labels.zen_version') % Zen::Version}</p>
-                <p>
-                    <a href="http://zen-cms.com/">
-                        #{lang('zen_general.labels.zen_website')}
-                    </a> |
-                    <a href="http://zen-cms.com/documentation">
-                        #{lang('zen_general.labels.zen_docs')}
-                    </a> |
-                    <a href="https://github.com/zen-cms/">
-                        #{lang('zen_general.labels.zen_github')}
-                    </a>
-                </p>
+                <ul class="clearfix">
+                    <li>
+                        <a href="http://zen-cms.com/">
+                            #{lang('zen_general.labels.zen_website')}
+                        </a>
+                    </li>
+                    <li>
+                        <a href="http://zen-cms.com/documentation">
+                            #{lang('zen_general.labels.zen_docs')}
+                        </a>
+                    </li>
+                    <li>
+                        <a href="https://github.com/zen-cms/">
+                            #{lang('zen_general.labels.zen_github')}
+                        </a>
+                    </li>
+                </ul>
             </div>
         </footer>