zen 0.3 → 0.4

data/lib/zen/spec/simplecov.rb

@@ -17,6 +17,7 @@ SimpleCov.configure do
   add_filter 'lib/zen/model/settings'
   add_filter 'vendor'
   add_filter 'lib/zen/model/init'
+  add_filter 'lib/zen/migrator'
 end
 
 SimpleCov.start

data/lib/zen/task/build.rake

@@ -1,5 +1,5 @@
 namespace :build do
-  desc 'Builds the documentation using YARD'
+  desc 'Build the YARD docs'
   task :doc => ['clean:yard'] do
     root = File.expand_path('../../../../', __FILE__)
     Dir.chdir(root)
@@ -20,26 +20,7 @@ namespace :build do
     sh('gem', 'install', pkg)
   end
 
-  # 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
-
-  desc 'Builds a list of changes since a given Git tag and outputs it'
+  desc 'Build a list of changes'
   task :changes, [:tag] do |t, args|
     args.with_defaults(:tag => `git tag`.split(/\n/)[-1])
 

data/lib/zen/task/clean.rake

@@ -1,5 +1,5 @@
 namespace :clean do
-  desc 'Removes all the gems located in pkg/'
+  desc 'Removes all built gems'
   task :gem do
     glob_pattern = File.expand_path('../../../../pkg/*.gem', __FILE__)
 
@@ -17,13 +17,4 @@ namespace :clean do
     FileUtils.rm_rf("#{root}/doc")
     FileUtils.rm_rf("#{root}/.yardoc")
   end
-
-  desc 'Removes all the minified assets used for the specs'
-  task :assets do
-    path = File.expand_path('../../../../spec/public/minified/*', __FILE__)
-
-    Dir.glob(path).each do |file|
-      File.unlink(file)
-    end
-  end
 end

data/lib/zen/task/db.rake

@@ -1,5 +1,5 @@
 namespace :db do
-  desc 'Migrates the database to the newest version'
+  desc 'Migrates the entire database'
   task :migrate do
     require File.expand_path('../../../zen', __FILE__)
 
@@ -25,9 +25,7 @@ namespace :db do
 
       table = 'migrations_package_' + pkg.name.to_s
 
-      # Migration time
-      Sequel::Migrator.run(Zen.database, dir, :table => table)
-      Ramaze::Log.info("Successfully migrated \"#{pkg.name}\"")
+      Zen::Migrator.run(pkg.name, dir, table)
     end
   end
 
@@ -59,15 +57,11 @@ namespace :db do
 
       table = 'migrations_package_' + pkg.name.to_s
 
-      # Migration time
-      Sequel::Migrator.run(Zen.database, dir, :table => table, :target => 0)
-      Zen.database.drop_table(table)
-
-      Ramaze::Log.info("Successfully uninstalled \"#{pkg.name}\"")
+      Zen::Migrator.run(pkg.name, dir, table, 0)
     end
   end
 
-  desc 'Creates a default administrator with a random password'
+  desc 'Creates a default admin user'
   task :user do
     require File.expand_path('../../../zen', __FILE__)
 

data/lib/zen/task/package.rake

@@ -12,7 +12,7 @@ namespace :package do
     end
   end
 
-  desc 'Migrates a package to a certain version'
+  desc 'Migrates a specific package'
   task :migrate, :name, :version do |task, args|
     require File.expand_path('../../../zen', __FILE__)
 
@@ -49,9 +49,6 @@ namespace :package do
 
     table = 'migrations_package_' + package.name.to_s
 
-    Ramaze::Log.info('Migrating package...')
-
-    # Run all migrations
-    Sequel::Migrator.run(Zen.database, dir, :table => table, :target => version)
+    Zen::Migrator.run(package.name, dir, table, version)
   end
 end

data/lib/zen/task/setup.rake

@@ -1,4 +1,4 @@
-desc 'Installs all the required gems (requires RVM)'
+desc 'Installs all the required gems'
 task :setup do
   sh('rvm gemset import .gems')
 end

data/lib/zen/task/test.rake

@@ -3,15 +3,15 @@ namespace :test do
   command  = 'rake db:delete; rake db:migrate; rake db:test_user; ' \
     'ruby zen/all.rb'
 
-  desc 'Runs all specifications using SQLite3 or custom settings'
-  task :default => ['clean:assets'] do
+  desc 'Run specifications'
+  task :default do
     Dir.chdir(spec_dir)
 
     sh(command)
   end
 
-  desc 'Runs all specifications using MySQL'
-  task :mysql => ['clean:assets'] do
+  desc 'Runs specifications using MySQL'
+  task :mysql do
     Dir.chdir(spec_dir)
 
     ENV['DATABASE'] = 'zen_dev'
@@ -21,8 +21,8 @@ namespace :test do
     sh(command)
   end
 
-  desc 'Runs all specifications using PostgreSQL'
-  task :postgres => ['clean:assets'] do
+  desc 'Runs specifications using PostgreSQL'
+  task :postgres do
     Dir.chdir(spec_dir)
 
     ENV['DATABASE'] = 'zen_dev'

data/lib/zen/task/theme.rake

@@ -12,7 +12,7 @@ namespace :theme do
     end
   end
 
-  desc 'Migrates a theme to the given version'
+  desc 'Migrates a specific theme'
   task :migrate, :name, :version do |task, args|
     require File.expand_path('../../../zen', __FILE__)
 
@@ -47,9 +47,6 @@ namespace :theme do
       abort 'The theme\'s migration directory doesn\'t exist.'
     end
 
-    # Time to migrate the theme
-    Ramaze::Log.info('Migrating package...')
-
-    Sequel::Migrator.run(Zen.database, dir, :table => table, :target => version)
+    Zen::Migrator.run(theme.name, dir, table, version)
   end
 end

data/lib/zen/theme.rb

@@ -1,4 +1,5 @@
 require 'pathname'
+require 'ostruct'
 
 module Zen
   ##
@@ -39,7 +40,7 @@ module Zen
   #          |__ templates/
   #             |__ partials/
   #             |__ pages/
-  #             |__ foobar/
+  #             |__ example/
   #
   # Lets assume the theme is called "test" and is available on Rubygems (under
   # the same name). In that case you can install it as following:
@@ -68,8 +69,7 @@ module Zen
   #       |__ theme/
   #          |__ partials/
   #          |__ pages/
-  #          |__ foobar/
-  #          |__ partials/
+  #          |__ example/
   #          |__ test.rb
   #
   # Because the theme is located in the application root, which isn't added to
@@ -92,8 +92,7 @@ module Zen
   #          |__ test/
   #             |__ partials/
   #             |__ pages/
-  #             |__ foobar/
-  #             |__ partials/
+  #             |__ example/
   #             |__ test.rb
   #
   # <div class="note deprecated">
@@ -138,6 +137,8 @@ module Zen
   #   data into the database.
   # * default_template_group: the name of the default template group to use in
   #   case no custom one has been specified in the URI.
+  # * env: an instance of ``OpenStruct`` that can be used to store custom data
+  #   such as an instance of ``Ramaze::Asset::Environment``.
   #
   # An example call to ``Zen::Theme.add`` using these options:
   #
@@ -165,7 +166,7 @@ module Zen
   # Some examples:
   #
   #     GET /pages/entry/hello-world => /pages/entry.xhtml
-  #     GET /pages/foobar            => /404.xhtml (if "foobar" doesn't exist)
+  #     GET /pages/example            => /404.xhtml (if "example" doesn't exist)
   #     GET /pages                   => /pages/index.xhtml
   #
   # Templates have access to the special instance variable ``@request_uri``.
@@ -174,7 +175,7 @@ module Zen
   # with the following values for this array:
   #
   #     GET /pages/entry/hello-world => ['pages', 'entry', 'hello-world']
-  #     GET /pages/foobar            => ['pages', 'foobar']
+  #     GET /pages/example            => ['pages', 'example']
   #     GET /pages                   => ['pages', 'index']
   #
   # ## Retrieving Data
@@ -271,6 +272,10 @@ module Zen
     # The name of the default template group to use.
     attr_writer :default_template_group
 
+    # Instance of OpenStruct that can be used for storing custom data such as an
+    # instance of ``Ramaze::Asset::Environment``.
+    attr_reader :env
+
     ##
     # Hash containing all registered themes. The keys are the names of the
     # themes and the values instances of Zen::Theme::Base.
@@ -312,6 +317,15 @@ module Zen
       return REGISTERED[name]
     end
 
+    ##
+    # Creates a new instance of the theme.
+    #
+    # @since 12-02-2012
+    #
+    def initialize
+      @env = OpenStruct.new
+    end
+
     ##
     # Sets the name of the theme.
     #
@@ -331,7 +345,11 @@ module Zen
     #
     def formatted_name
       if url
-        return '<a href="%s" title="%s">%s</a>' % [url, name, name]
+        return '<a href="%s" title="%s" class="icon external">%s</a>' % [
+          url,
+          name,
+          name
+        ]
       else
         return name
       end
@@ -406,19 +424,5 @@ module Zen
         )
       end
     end
-
-    # Aliases to keep Zen backwards compatible. These aliases will be removed in
-    # Zen 0.3.
-    alias :template_dir  :templates
-    alias :template_dir= :templates=
-
-    alias :partial_dir   :partials
-    alias :partial_dir=  :partials=
-
-    alias :migration_dir  :migrations
-    alias :migration_dir= :migrations=
-
-    alias :public_dir  :public
-    alias :public_dir= :public=
   end # Theme
 end # Zen

data/lib/zen/version.rb

@@ -1,4 +1,4 @@
 module Zen
   # :nodoc:
-  VERSION = '0.3'
+  VERSION = '0.4'
 end

data/lib/zen/view/bottom.xhtml

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

data/lib/zen/view/search.xhtml

@@ -1,9 +1,7 @@
-<form action="#{@url}"
-method="get" id="search_form">
+<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>
+    <input type="submit" value="#{lang('zen_general.buttons.search')}"
+    class="button" />
 </form>

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

@@ -17,7 +17,7 @@ Ramaze.options.mode  = :dev
 # 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] %>
+Ramaze.options.app.name = <%= PROJECT_SETTINGS[:name].to_sym.inspect %>
 
 # The session identifier to use for cookies.
 Ramaze.options.session.key = '<%= PROJECT_SETTINGS[:name] %>.sid'

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

@@ -1,25 +1,121 @@
-<!DOCTYPE HTML>
-<html lang="#{get_setting(:frontend_language).value}">
+<!DOCTYPE html>
+<html lang="#{get_setting(:frontend_language).value}" id="admin"
+class="#{browser_name}">
     <head>
-        <meta charset="utf-8" />
-
-        <title>#{get_setting(:website_name).value}</title>
+        #{partial(:head)}
     </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>
+        #{partial(:sidebar)}
+
+        <div id="main" role="main">
+            <section>
+                <header>
+                    <h1>Welcome to Zen</h1>
+                </header>
+
+                <div class="body max_width">
+                    <p>
+                        Congratulations, You have successfully created a new
+                        project using Zen.
+                    </p>
+
+                    <p>
+                        For more information on getting
+                        started and other useful information see the
+
+                        <a href="http://zen-cms.com/documentation"
+                        title="Documentation">
+                            documentation
+                        </a>.
+                    </p>
+
+                    <h2>Common commands</h2>
+
+                    <p>Starting a Zen application using Thin as the server:</p>
+
+                    <pre><code>$ ramaze start -s thin</code></pre>
+
+                    <p>Opening the Ramaze console:</p>
+
+                    <pre><code>$ ramaze console</code></pre>
+
+                    <p>Migrating your database:</p>
+
+                    <pre><code>$ rake db:migrate</code></pre>
+
+                    <h2>Zen and Multi Processing</h2>
+
+                    <p>
+                        Keep in mind that the default configuration that comes
+                        with Zen does not work very well for multi process based
+                        servers such as Unicorn.
+                    </p>
+
+                    <p>
+                        Out of the box Zen will store
+                        session data as well as translations in the memory of
+                        the current process. This means that users may be logged
+                        out whenever their requests are handled by a process
+                        that doesn't contain the session data.
+                    </p>
+
+                    <p>
+                        Luckily this is very easy to fix by updating your
+                        config.rb file so that it contains the following line of
+                        code (make sure that you remove the existing one):
+                    </p>
+
+                    <pre><code>Ramaze::Cache.options.session = Ramaze::Cache::MemCache</code></pre>
+
+                    <p>
+                        Note that the use of Memcached is not enforced, you are
+                        free to use a different external cache such as
+                        <code>Ramaze::Cache::Redis</code>
+                    </p>
+
+                    <p>
+                        For more information see the documentation in the file
+                        config/config.rb.
+                    </p>
+
+                    <h2>System Information</h2>
+
+                    <table>
+                        <thead>
+                            <tr>
+                                <th></th>
+                                <th></th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                            <tr>
+                                <td>Ruby</td>
+                                <td>#{RUBY_DESCRIPTION}</td>
+                            </tr>
+                            <tr>
+                                <td>Database Adapter</td>
+                                <td>#{Zen.database.adapter_scheme}</td>
+                            </tr>
+                            <tr>
+                                <td>Sequel version</td>
+                                <td>#{Sequel::VERSION}</td>
+                            </tr>
+                            <tr>
+                                <td>Zen version</td>
+                                <td>#{Zen::VERSION}</td>
+                            </tr>
+                            <tr>
+                                <td>Ramaze version</td>
+                                <td>#{Ramaze::VERSION}</td>
+                            </tr>
+                            <tr>
+                                <td>Rack version</td>
+                                <td>#{Rack::VERSION.join('.')}</td>
+                            </tr>
+                        </tbody>
+                    </table>
+                </div>
+            </section>
+        </div>
     </body>
 </html>