zen 0.2.8 → 0.3b

data/lib/zen/validation.rb

@@ -1,16 +1,13 @@
-require __DIR__('error/validation_error')
-
-#:nodoc:
 module Zen
   ##
-  # The Validation module is a very basic validation framework that's used by 
+  # The Validation module is a very basic validation framework that's used by
   # various internal modules/classes such as Zen::Plugin and Zen::Package.
   #
   # ## Usage
   #
-  # Using the module is pretty simple. Include it, specify the validation rules 
-  # in a method and call it. All official modules and classes use a method 
-  # called "validate" but you're free to name it whatever you want. A basic 
+  # Using the module is pretty simple. Include it, specify the validation rules
+  # in a method and call it. All official modules and classes use a method
+  # called "validate" but you're free to name it whatever you want. A basic
   # example looks like the following:
   #
   #     class Something
@@ -23,7 +20,6 @@ module Zen
   #       end
   #     end
   #
-  # @author Yorick Peterse
   # @since  0.2.5
   #
   module Validation
@@ -33,12 +29,11 @@ module Zen
     # @example
     #  validates_presence(:name)
     #
-    # @author Yorick Peterse
     # @since  0.2.5
-    # @param  [Array/Symbol/String] attributes Either a single or multiple 
-    # attributes to validate.
-    # @raise  [ValidationError] Raised whenever a attribute is missing or is 
-    # set to nil.
+    # @param  [Array/Symbol/String] attributes Either a single or multiple
+    #  attributes to validate.
+    # @raise  [ValidationError] Raised whenever a attribute is missing or is
+    #  set to nil.
     #
     def validates_presence(attributes)
       if attributes.class != Array
@@ -53,21 +48,20 @@ module Zen
     end
 
     ##
-    # Checks if the length of a string matches the given length. You can specify 
+    # Checks if the length of a string matches the given length. You can specify
     # a minimum length, a maximum one as well as both.
     #
     # @example
     #  validates_length(:foobar, :min => 5, :max => 10)
     #
-    # @author Yorick Peterse
     # @since  0.2.5
     # @param  [String/Symbol] attribute The attribute to validate.
-    # @param  [Hash] options Hash containing the options to use for determining 
-    # how long the attribute's value should be.
+    # @param  [Hash] options Hash containing the options to use for determining
+    #  how long the attribute's value should be.
     # @option options [Fixnum] :min The minimum length of the attribute's value.
     # @option options [Fixnum] :max The maximum length of the value.
-    # @raise  [ValidationError] Raised then the value of the attribute isn't 
-    # long or short enough.
+    # @raise  [ValidationError] Raised then the value of the attribute isn't
+    #  long or short enough.
     #
     def validates_length(attribute, options)
       value = send(attribute)
@@ -94,21 +88,20 @@ module Zen
 
     ##
     # Checks if the given attributes match the specified regular expressions.
-    # When a hash is specified the keys should be the names of the attributes to 
+    # When a hash is specified the keys should be the names of the attributes to
     # validate and the values the regular expressions to use.
     #
     # @example
     #  validates_format(:name, /[\w\-]+/)
     #  validates_format(:name => /[\w\-]+/, :age => /[0-9]+/)
     #
-    # @author Yorick Peterse
     # @since  0.2.5
-    # @param  [Hash/Symbol] attribute The name of the attribute to validate or 
-    # a hash containing all the attributes and their regular expressions.
-    # @param  [Regexp] regexp The regular expression to use when validating a 
-    # single attribute.
-    # @raise [ValidationError] Raised when one of the attributes doesn't matches 
-    # the regular expression.
+    # @param  [Hash/Symbol] attribute The name of the attribute to validate or
+    #  a hash containing all the attributes and their regular expressions.
+    # @param  [Regexp] regexp The regular expression to use when validating a
+    #  single attribute.
+    # @raise [ValidationError] Raised when one of the attributes doesn't matches
+    #  the regular expression.
     #
     def validates_format(attribute, regexp = nil)
       if attribute.class != Hash
@@ -122,7 +115,7 @@ module Zen
 
         if !match
           raise(
-            ValidationError, 
+            ValidationError,
             "The attribute \"#{attr}\" doesn't match #{regexp}"
           )
         end
@@ -135,7 +128,6 @@ module Zen
     # @example
     #  validates_filepath(:directory)
     #
-    # @author Yorick Peterse
     # @since  0.2.5
     # @param [String/Symbol] attribute The attribute to validate.
     # @raise [ValidationError] Raised when one of the paths didn't exist.
@@ -145,7 +137,7 @@ module Zen
 
       if !File.exist?(path)
         raise(
-          ValidationError, 
+          ValidationError,
           "The path #{path} in \"#{attribute}\" doesn't exist."
         )
       end

data/lib/zen/version.rb

@@ -1,5 +1,4 @@
-#:nodoc:
 module Zen
   # :nodoc:
-  Version = '0.2.8'
+  VERSION = '0.3b'
 end

data/lib/zen/view/bottom.xhtml

@@ -1 +1,9 @@
-#{Zen::Asset.build(:javascript)}
+<script>
+var Zen = {
+    date_format: "#{date_format}",
+};
+</script>
+
+<script src="/admin/js/zen/lib/translations.js"></script>
+
+#{Zen.asset.build_html(:javascript)}

data/lib/zen/view/head.xhtml

@@ -2,6 +2,6 @@
 
 <link rel="shortcut icon" href="/admin/favicon.ico" />
 
-#{Zen::Asset.build(:stylesheet)}
+#{Zen.asset.build_html(:css)}
 
 <title>#{@page_title}</title>

data/lib/zen/view/main.xhtml

@@ -12,7 +12,7 @@
             #{lang('zen_general.labels.powered_by')}
 
             <a href="http://zen-cms.com/">
-                Zen #{Zen::Version}
+                Zen #{Zen::VERSION}
             </a>
         </p>
     </div>

data/lib/zen/view/search.xhtml

@@ -0,0 +1,9 @@
+<form action="#{@url}"
+method="get" id="search_form">
+    <input name="query" type="text" value="#{request.params['query']}"
+    placeholder="#{lang('zen_general.descriptions.search')}" />
+
+    <div class="button">
+        <input type="submit" value="#{lang('zen_general.buttons.search')}" />
+    </div>
+</form>

data/proto/app/Rakefile

@@ -9,4 +9,3 @@ if File.directory?(task_dir)
     import task
   end
 end
-

data/proto/app/app.rb

@@ -1,23 +1,28 @@
+# This is the main file of your application. It loads various configuration
+# files, your themes and starts your application.
 require 'zen'
-require 'ramaze/log/rotatinginformer'
 
-# Load the configuration files
-require __DIR__('config/config')
+# Depending on your database adapter you might need to install extra Gems.
+# Ramaze makes it easy to automatically install and require these using
+# Ramaze.setup(). For example, if you want to automatically load the mysql2 gem
+# you'd do this as following:
+#
+#     Ramaze.setup(:verbose => false) do
+#       gem 'mysql2'
+#     end
+#
 
-# Load all our custom Rack middlewares
+# Load all the configuration files.
+require __DIR__('config/config')
 require __DIR__('config/middlewares')
-
-# Load the database configuration file
 require __DIR__('config/database')
 
-# Make sure that Ramaze knows where you are
-Ramaze.options.roots.push(Zen.root)
-
-# Load the database
-Zen.init
-
-# Load all the packages
-require 'zen/package/all'
+# Load the default theme. You're free to change this or remove it.
+require __DIR__('theme/theme')
 
-# Almost done!
-Zen.post_init
+# Starts Zen. While you can still load custom files after calling this method it
+# is not recommended as it may lead to unexpected behavior. Zen itself tries not
+# to cache anything in memory unless required, however it could be that a
+# third-party extension does do this. Because of this it is recommended to just
+# put your require() calls before calling this method.
+Zen.start

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

@@ -0,0 +1,41 @@
+# Main configuration file for your project. This file should contain settings
+# such as the path to the root directory, the mode to use for Ramaze (dev, live,
+# etc) and various cache related settings.
+#
+# 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.
+Ramaze.options.mode  = :dev
+
+# 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
+# wrong data.
+Ramaze.options.app.name = :<%= PROJECT_SETTINGS[:name] %>
+
+# The session identifier to use for cookies.
+Ramaze.options.session.key = '<%= PROJECT_SETTINGS[:name] %>.sid'
+
+# Whether or not views should be cached after they've been read or pre-compiled.
+# It is recommended to turn this off when developing your application. By
+# default these settings are automatically set based on the mode specified in
+# Ramaze.options.mode.
+Ramaze::View.options.cache      = Ramaze.options.mode == :live
+Ramaze::View.options.read_cache = Ramaze.options.mode == :live
+
+# The cache driver to use for sessions. If you're running your application using
+# multiple processes (e.g. 3 Unicorn workers) you should use an external cache
+# such as Ramaze::Cache::MemCache. Not doing this will result in synchronization
+# problems between these processes.
+Ramaze::Cache.options.session  = Ramaze::Cache::LRU
+
+# The cache driver to use for storing settings. Similar to
+# Ramaze::Cache.options.session you should use an external cache in case you're
+# running a multi-process based setup.
+Ramaze::Cache.options.settings = Ramaze::Cache::LRU

data/proto/app/config/{database.rb → database.rb.erb}

@@ -1,6 +1,12 @@
-# It's recommended to create a separate database user for your Zen application
-# and prevent it from being able to access other databases. Zen is new and may
-# allow hackers to exploit the system.
+# Database configuration file for Zen.
+#
+# This configuration file should contain all the required details to make it
+# possible for Zen to connect to a SQL database.
+#
+# Keep in mind that it is recommended to add this file to your VCS' ignore list
+# and instead only keep track of a default configuration file (e.g.
+# database.default.rb). Doing this means your passwords and usernames don't end
+# up being tracked by your VCS.
 #
 # The following items can be set:
 #
@@ -16,21 +22,18 @@
 #
 # Fore more information see the Sequel documentation:
 # http://sequel.rubyforge.org/rdoc/files/doc/opening_databases_rdoc.html
+#
 Zen.database = Sequel.connect(
-  :adapter  => '',
-  :host     => 'localhost',
-  :username => '',
-  :password => '',
-  :database => '',
+  :adapter  => '<%= PROJECT_SETTINGS[:database][:adapter] %>',
+  :username => '<%= PROJECT_SETTINGS[:database][:username] %>',
+  :password => '<%= PROJECT_SETTINGS[:database][:password] %>',
+  :database => '<%= PROJECT_SETTINGS[:database][:database] %>',
   :test     => true,
-  :encoding => 'utf8',
-  :logger   => Ramaze::Logger::RotatingInformer.new(
-    __DIR__("../log/database/dev"), '%d-%m-%Y.log'
-  )
+  :encoding => 'utf8'
 )
 
-# IMPORTANT, when running MySQL the engine should be set to InnoDB in order for
-# foreign keys to work properly.
+# When running MySQL the engine should be set to InnoDB in order for foreign
+# keys to work properly.
 if Zen.database.adapter_scheme.to_s.include?('mysql')
   Sequel::MySQL.default_engine = 'InnoDB'
 end

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.

data/proto/app/theme/default/index.xhtml

@@ -0,0 +1,25 @@
+<!DOCTYPE HTML>
+<html lang="#{get_setting(:frontend_language).value}">
+    <head>
+        <meta charset="utf-8" />
+
+        <title>#{get_setting(:website_name).value}</title>
+    </head>
+    <body>
+        <h1>#{get_setting(:website_name).value}</h1>
+
+        <p>
+            Congratulations, you have successfully set up your Zen application.
+            For more information on how to create a website using Zen you should
+            take a look at the
+            <a href="http://zen-cms.com/documentation/index.html">
+                documentation
+            </a>.
+        </p>
+
+        <p>
+            If you want to log in instead you can do so by going to the
+            <a href="/admin/users/login">admin panel</a>.
+        </p>
+    </body>
+</html>

data/proto/app/theme/theme.rb

@@ -0,0 +1,19 @@
+# Registers a new theme to use for this project. See
+# http://zen-cms.com/documentation/Zen/Theme.html for more information on all
+# the available options and working with themes in general.
+Zen::Theme.add do |theme|
+  # The unique name of the theme specified as a symbol (required).
+  theme.name = :default
+
+  # The name of the author of the theme (required).
+  theme.author = 'Zen'
+
+  # A URL that points to a website/web page related to the theme.
+  theme.url = 'http://zen-cms.com/'
+
+  # A short description of the theme (required).
+  theme.about = 'The default theme for Zen.'
+
+  # The directory containing all the templates (required).
+  theme.templates = __DIR__
+end

data/proto/migration.rb

@@ -1,11 +1,9 @@
 Sequel.migration do
-  # Updates the database with the changes specified in the block.
   up do
-    
+
   end
-  
-  # Reverts the changes made in the up() block.
+
   down do
-    
+
   end
 end

data/proto/rack/thin.yml

@@ -0,0 +1,41 @@
+---
+# Configuration file for Thin. Thin can be installed by running the following
+# shell command:
+#
+#     $ gem install thin
+#
+# Once installed you can use the thin shell command to start/stop your
+# application.
+
+# Listen to 0.0.0.0:7000 by default.
+port: 7000
+
+# If you want to use a Unix socket instead uncomment the line below and make
+# sure that the path points to a valid Unix socket.
+#
+# socket: 'path/to/socket'
+
+# When set to true Thin will detach itself from the terminal and run as a
+# daemon.
+daemonize: false
+
+# Path to the PID file to use for each Thin worker.
+pid: tmp/thin.pid
+
+# The user and group to use for each Thin process. It is recommended that you
+# run your application using its own user and group.
+#
+# user: 'username'
+# group: 'groupname'
+
+# The amount of worker processes to start. It's very important to remember that
+# setting this option above 1 requires you to use a Ramaze cache that stores
+# it's data outside of each process' memory. An example of such a cache is
+# Ramaze::Cache::MemCache. When doing so you should set the following caches:
+#
+# * Ramaze::Cache.options.session
+# * Ramaze::Cache.options.settings
+#
+# Without this data will not be synced between Unicorn workers causing all kind
+# of weird things to happen.
+servers: 1

data/proto/rack/unicorn.rb

@@ -0,0 +1,38 @@
+# Configuration file for Unicorn. Unicorn can be installed by running the
+# following shell command:
+#
+#     $ gem install unicorn
+#
+# After it's installed you can use it by invoking the unicorn shell command.
+#
+# For more information on all the available options see the following page:
+# http://unicorn.bogomips.org/Unicorn/Configurator.html
+
+# The working_directory option contains the path to the directory of your
+# application.
+working_directory File.expand_path('../../', __FILE__)
+
+# The amount of worker processes to start. It's very important to remember that
+# setting this option above 1 requires you to use a Ramaze cache that stores
+# it's data outside of each process' memory. An example of such a cache is
+# Ramaze::Cache::MemCache. When doing so you should set the following caches:
+#
+# * Ramaze::Cache.options.session
+# * Ramaze::Cache.options.settings
+#
+# Without this data will not be synced between Unicorn workers causing all kind
+# of weird things to happen.
+worker_processes 1
+
+# Listen to localhost:7000 by default. You can specify either a port or a path
+# to a Unix socket.
+listen 7000
+
+# The user and user group to use for the application. It is recommended that you
+# run the application using a dedicated user.
+# user 'USER', 'GROUP'
+
+# Path to the file that will contain the PID of each unicorn worker. If you're
+# running multiple workers Unicorn will create multiple PIDs using the specified
+# name and suffix them with a number.
+pid File.expand_path('../../tmp/unicorn.pid', __FILE__)