zen 0.2.5 → 0.2.6

data/lib/zen/task/build.rake

@@ -10,9 +10,7 @@ namespace :build do
   task :doc do
     zen_path = File.expand_path('../../../../', __FILE__)
     command  = "yard doc #{zen_path}/lib -m markdown -M rdiscount -o #{zen_path}/doc "
-    command += "-r #{zen_path}/README.md --private --protected "
-    command += "--files #{zen_path}/license.txt,#{zen_path}/CHANGELOG.md,"
-    command += "#{zen_path}/ROADMAP.md"
+    command += "-r #{zen_path}/README.md --private --protected"
 
     sh(command)
   end
@@ -30,8 +28,8 @@ namespace :build do
   desc 'Builds the MANIFEST file'
   task :manifest do
     zen_path     = File.expand_path('../../../../', __FILE__)
-    ignore_exts  = ['.gem', '.gemspec']
-    ignore_files = ['.DS_Store', '.gitignore']
+    ignore_exts  = ['.gem', '.gemspec', '.swp']
+    ignore_files = ['.DS_Store', '.gitignore', '.rvmrc']
     ignore_dirs  = ['.git', '.yardoc', 'spec', 'pkg', 'doc']
     files        = ''
     
@@ -40,7 +38,8 @@ namespace :build do
       f.gsub!(/^\//, '')
 
       # Ignore directories
-      if !File.directory?(f) and !ignore_exts.include?(File.extname(f)) and !ignore_files.include?(File.basename(f))
+      if !File.directory?(f) and !ignore_exts.include?(File.extname(f)) \
+      and !ignore_files.include?(File.basename(f))
         files += "#{f}\n"
       else
         Find.prune if ignore_dirs.include?(f)
@@ -57,4 +56,22 @@ namespace :build do
     end
   end
 
+  # Shamelessly stolen from Ramaze
+  desc 'Builds a list of all the people that have contributed to Zen'
+  task :authors do
+    authors = Hash.new(0)
+
+    `git shortlog -nse`.scan(/(\d+)\s(.+)\s<(.*)>$/) do |count, name, email|
+      authors[[name, email]] += count.to_i
+    end
+
+    File.open('AUTHORS', 'w+') do |io|
+      io.puts "Following persons have contributed to Zen."
+      io.puts '(Sorted by number of submitted patches, then alphabetically)'
+      io.puts ''
+      authors.sort_by{|(n,e),c| [-c, n.downcase] }.each do |(name, email), count|
+        io.puts("%6d %s <%s>" % [count, name, email])
+      end
+    end
+  end
 end

data/lib/zen/task/clean.rake

@@ -7,13 +7,13 @@ require 'fileutils'
 # @since  0.2.5
 #
 namespace :clean do
+  desc 'Removes all the gems located in pkg/'
+  task :gem do
+    glob_pattern = File.expand_path('../../../../pkg/*.gem', __FILE__)
 
-  desc 'Removes all log files'
-  task :log do
-    zen_path = File.expand_path('../../../../', __FILE__)
-
-    log_files = Dir.glob("#{zen_path}/spec/log/**/*.log")
-    log_files.each { |file| File.unlink(file) }
+    Dir.glob(glob_pattern).each do |gem|
+      File.unlink(gem)
+    end
   end
 
   desc 'Removes all YARD files'
@@ -23,5 +23,4 @@ namespace :clean do
     FileUtils.rm_rf("#{zen_path}/doc")
     FileUtils.rm_rf("#{zen_path}/.yardoc")
   end
-
 end

data/lib/zen/task/db.rake

@@ -1,5 +1,3 @@
-Sequel.extension(:migration)
-
 ##
 # Task group for database related tasks such as migrating and removing the database.
 #
@@ -30,9 +28,9 @@ namespace :db do
       table = 'migrations_package_' + pkg.name.to_s
 
       # Migration time
-      Zen::Database.handle.transaction do
-        Sequel::Migrator.run(Zen::Database.handle, dir, :table => table)
-        puts "Successfully migrated \"#{pkg.name}\""
+      Zen.database.transaction do
+        Sequel::Migrator.run(Zen.database, dir, :table => table)
+        Ramaze::Log.info("Successfully migrated \"#{pkg.name}\"")
       end
     end
   end
@@ -61,11 +59,11 @@ namespace :db do
       table = 'migrations_package_' + pkg.name.to_s
 
       # Migration time
-      Zen::Database.handle.transaction do
-        Sequel::Migrator.run(Zen::Database.handle, dir, :table => table, :target => 0)
-        Zen::Database.handle.drop_table(table)
+      Zen.database.transaction do
+        Sequel::Migrator.run(Zen.database, dir, :table => table, :target => 0)
+        Zen.database.drop_table(table)
 
-        puts "Successfully uninstalled \"#{pkg.name}\""
+        Ramaze::Log.info("Successfully uninstalled \"#{pkg.name}\"")
       end
     end
   end

data/lib/zen/task/package.rake

@@ -34,11 +34,11 @@ MSG
     end
 
     # Validate the package name
-    if !Zen::Packages::Registered[args[:name].to_sym]
+    if !Zen::Package::Registered[args[:name].to_sym]
       abort "The package name \"#{args[:name]}\" is invalid."
     end
 
-    package = Zen::Packages::Registered[args[:name].to_sym]
+    package = Zen::Package::Registered[args[:name].to_sym]
 
     # Get the migrations directory
     if package.respond_to?(:migration_dir) and !package.migration_dir.nil?
@@ -54,12 +54,12 @@ MSG
 
     table = 'migrations_package_' + package.name.to_s
 
-    puts "Migrating package..."
+    Ramaze::Log.info('Migrating package...')
 
     # Run all migrations
-    Zen::Database.handle.transaction do
-      Sequel.migrator.run(
-        Zen::Database.handle, dir, :table => table, :target => version
+    Zen.database.transaction do
+      Sequel::Migrator.run(
+        Zen.database, dir, :table => table, :target => version
       )
     end
   end

data/lib/zen/task/test.rake

@@ -0,0 +1,6 @@
+desc 'Runs all the RSpec specifications'
+task :test do
+  spec_dir = __DIR__('../../../spec')
+  sh("cd #{spec_dir}; rake db:delete; rm resources/database.db; rake db:migrate; \
+rake db:test_user; rspec zen/all.rb")
+end

data/lib/zen/task/theme.rake

@@ -56,11 +56,11 @@ MSG
     end
 
     # Time to migrate the theme
-    puts 'Migrating...'
+    Ramaze::Log.info('Migrating package...')
 
-    Zen::Database.handle.transaction do
+    Zen.database.transaction do
       Sequel::Migrator.run(
-        Zen::Database.handle, dir, :table => table, :target => version
+        Zen.database, dir, :table => table, :target => version
       )
     end
   end

data/lib/zen/theme.rb

@@ -64,7 +64,7 @@ module Zen
         if !Ramaze.options.publics.include?(theme.public_dir)
           # Generate a relative path from ROOT to the theme
           to   = Pathname.new(theme.public_dir)
-          from = Pathname.new(Zen.options.root)
+          from = Pathname.new(Zen.root)
           dir  = to.relative_path_from(from.realpath).to_s
 
           Ramaze.options.publics.push(dir)
@@ -97,6 +97,5 @@ module Zen
 
       return Registered[name]
     end
-
-  end
-end
+  end # Theme
+end # Zen

data/lib/zen/validation.rb

@@ -8,9 +8,9 @@ module Zen
   #
   # ## Usage
   #
-  # Using the module is pretty simple. Include it, specify the validation rules in a 
+  # 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 
+  # but you're free to name it whatever you want. A basic example looks like the
   # following:
   #
   #     class Something
@@ -27,7 +27,6 @@ module Zen
   # @since  0.2.5
   #
   module Validation
-    
     ##
     # Checks if the specified attributes exist and aren't set to nil.
     #
@@ -74,7 +73,7 @@ module Zen
 
       if !value.respond_to?(:length)
         raise(
-          ValidationError, 
+          ValidationError,
           "The length of \"#{attribute}\" can't be checked as the method \"length\" " +
           "doesn't exist."
         )
@@ -107,7 +106,7 @@ module Zen
     # 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 
+    # @raise [ValidationError] Raised when one of the attributes doesn't matches the
     # regular expression.
     #
     def validates_format(attribute, regexp = nil)
@@ -139,11 +138,10 @@ module Zen
     #
     def validates_filepath(attribute)
       path = send(attribute)
-      
+
       if !File.exist?(path)
         raise(ValidationError, "The path #{path} in \"#{attribute}\" doesn't exist.")
       end
     end
-
-  end
-end
+  end # Validation
+end # Zen

data/lib/zen/version.rb

@@ -1,12 +1,11 @@
 #:nodoc:
 module Zen
   ##
-  # Defines the current version of Zen as a string. This constant
-  # is used to set the Gem version when generating a new Rubygems
-  # package.
+  # Defines the current version of Zen as a string. This constant is used to set the Gem 
+  # version when generating a new Rubygems package.
   #
   # @author Yorick Peterse
   # @since  0.1
   #
-  Version = '0.2.5'
+  Version = '0.2.6'
 end

data/lib/zen/view/bottom.xhtml

@@ -1,6 +1 @@
-<script>
-Zen       = {};
-Zen.Flash = #{flash.combined.to_json};
-</script>
-
 #{Zen::Asset.build(:javascript)}

data/lib/zen/view/main.xhtml

@@ -1,3 +1,5 @@
+#{display_messages}
+
 <!--
 Main area of the admin panel. The content stretches across the entire screen and there
 are no silly sidebars.

data/proto/app/app.rb

@@ -1,4 +1,3 @@
-# Load the Zen gem
 require 'zen'
 
 # Load the configuration files
@@ -11,10 +10,13 @@ require __DIR__('config/middlewares')
 require __DIR__('config/database')
 
 # Make sure that Ramaze knows where you are
-Ramaze.options.roots.push(Zen.options.root)
+Ramaze.options.roots.push(Zen.root)
 
 # Load the database
 Zen.init
 
-# Require all the custom gems/modules we need
-require __DIR__('config/requires')
+# Load all the packages
+require 'zen/package/all'
+
+# Almost done!
+Zen.post_init

data/proto/app/config/config.rb

@@ -1,12 +1,6 @@
 # Specify the root directory. This is required since there are multiple directories
 # to load resources from. This directory will be used for the database logger, modes, etc.
-Zen.options.root     = __DIR__('../')
-
-# UTF-8 bitches.
-Zen.options.encoding = 'utf8'
-
-# Sets the language to use in the event of the database settings not being set correctly.
-Zen.options.language = 'en'
+Zen.root = __DIR__('../')
 
 # Set the application's mode. Available modes are "dev" and "live"
 Ramaze.options.mode  = :dev

data/proto/app/config/database.rb

@@ -1,54 +1,58 @@
 ##
 # Database group to use for developing the website.
 #
-# The following options can be set:
+# IMPORTANT: 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.
 #
-# * adapter: the SQL adapter used by Sequel to connect to the database. Examples of these
-# are mysql2, postgres, sqlite, etc.
-# * host: the hostname of the database server.
-# * username: the name of the user used for connecting to the database
-# * password: the password of the user used for connecting to the database.
+# The following items can be set:
+#
+# * adapter: the adapter to use. When using MySQL it's best to use the mysql2 gem as it's 
+#   a lot faster than the mysql gem.
+# * host: the hostname where the database is located.
+# * username: the username to use for connecting to the database.
+# * password: the password to use for connecting to the database.
 # * database: the name of the database to use.
+# * test: whether or not the connection should be verified.
+# * encoding: the encoding type to use.
+# * logger: the logger used for logging queries and such.
 #
-# IMPORTANT: it's recommended to create a 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. Using an isolated user would prevent hackers from destroying
-# all databases.
+# Fore more information see the Sequel documentation: 
+# http://sequel.rubyforge.org/rdoc/files/doc/opening_databases_rdoc.html
 #
-Zen::Database.mode :dev do |db|
-  # Example: mysql2
-  db.adapter  = ''
-
-  # Example: localhost
-  db.host     = ''
+# Sets the connection for the development mode
+if Ramaze.options.mode === :dev
+  Zen.database = Sequel.connect(
+    :adapter  => '',
+    :host     => 'localhost',
+    :username => '',
+    :password => '',
+    :database => '',
+    :test     => true,
+    :encoding => 'utf8',
+    :logger   => Ramaze::Logger::RotatingInformer.new(
+      __DIR__("../log/database/dev"), '%d-%m-%Y.log'
+    )
+  )
 
-  # Example: zen-app
-  db.username = ''
-  
-  # Example: 23x190jj38123x
-  db.password = ''
-
-  # Example: blog
-  db.database = ''
+# Does the same but for the live mode
+elsif Ramaze.options.mode === :live
+  Zen.database = Sequel.connect(
+    :adapter  => 'mysql2',
+    :host     => '',
+    :username => '',
+    :password => '',
+    :database => '',
+    :test     => true,
+    :encoding => 'utf8',
+    :logger   => Ramaze::Logger::RotatingInformer.new(
+      __DIR__("../log/database/live"), '%d-%m-%Y.log'
+    )
+  )
 end
 
-##
-# Database group to use for your production server.
-# This group accepts the same settings as the block above.
-#
-Zen::Database.mode :live do |db|
-  # Example: mysql2
-  db.adapter  = ''
-
-  # Example: localhost
-  db.host     = ''
-
-  # Example: zen-app
-  db.username = ''
-  
-  # Example: 23x190jj38123x
-  db.password = ''
-
-  # Example: blog
-  db.database = ''
+# IMPORTANT, 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

@@ -1,4 +1,3 @@
-##
 # All Rack middlewares should go in a block like the one below. Different combinations
 # can be used for different versions by setting the first argument of the middleware!
 # method to a symbol containing the name of the environment (e.g. :live).
@@ -7,82 +6,43 @@
 # detect errors, reloading the code and so on.
 #
 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.
-  #
   m.use Rack::Lint
 
-  ##
-  # Rack::CommonLogger is used to log requests in an Apache like format. Zen ships with
-  # a small extension of Ramaze::Log::RotatingInformer that automatically creates the
-  # required directories for each mode and group (database, server, etc) but any Rack
-  # compatible logger will do.
-  #
-  m.use Rack::CommonLogger, Zen::Logger.new("#{Zen.options.root}/log/server")
-
-  ##
   # Shows an error page whenever an exception was raised. It's not recommended to use
   # this middleware on a production server as it may reveal sensitive 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 such.
-  #
   # m.use Rack::RouteExceptions
   
-  ##
   # Middleware that enables conditional GET using If-None-Match and If-Modified-Since.
   # Currently Zen doesn't respond to conditional GET requests so it's fairly useless
   # out of the box, it can be useful for custom extensions and such.
-  #
   # m.use Rack::ConditionalGet
   
-  ##
   # Automatically sets the ETag header on all string bodies. Etags can be useful for
   # checking if a certain page has been modified or not.
   #
   # IMPORTANT: Prior to Rack 1.2.2 Rack::ETag required the second argument of use() to
   # be set to 'public'. Newer versions no longer require this.
-  #
   m.use Rack::ETag
   
-  ##
   # Allows HEAD requests. HEAD requests are identical to GET requests but shouldn't
   # return the body.
-  #
   m.use Rack::Head
   
-  ##
   # Automatically reloads your application whenever it detects changes. Note that this
   # middleware isn't always as accurate so there may be times when you have to manually
   # restart your server.
-  #
   m.use Ramaze::Reloader
   
-  ##
   # Runs Ramaze based on all mappings and such.
-  #
-  m.run Ramaze::AppMap
-end
-
-##
-# Middlewares to use for a production environment.
-#
-Ramaze.middleware! :live do |m|
-  m.use Rack::CommonLogger, Zen::Logger.new("#{Zen.options.root}/log/server")
-  m.use Rack::RouteExceptions
-  m.use Rack::ShowStatus
-  m.use Rack::ConditionalGet
-  m.use Rack::ETag
-  m.use Rack::Head
   m.run Ramaze::AppMap
 end