zen 0.3 → 0.4

data/lib/vendor/sequel_sluggable.rb

@@ -121,7 +121,7 @@ module Sequel
         # @param [String] String to be slugged
         # @return [String]
         def to_slug(value)
-          value.chomp.downcase.gsub(/[^a-z0-9]+/,'-')
+          value.chomp.downcase.gsub(/[^a-z0-9_]+/, '-')
         end
 
         # Sets target column with source column which

data/lib/zen.rb

@@ -1,15 +1,14 @@
 require 'ramaze'
+require 'json'
 
 Ramaze.setup(:verbose => false) do
-  gem 'sequel'      , ['~> 3.28.0']
+  gem 'sequel'      , ['~> 3.33.0']
   gem 'bcrypt-ruby' , ['~> 3.0.1'], :lib => 'bcrypt'
   gem 'loofah'      , ['~> 1.2.0']
   gem 'ramaze-asset', ['~> 0.2.3'], :lib => 'ramaze/asset'
 end
 
-unless $LOAD_PATH.include?(__DIR__)
-  $LOAD_PATH.unshift(__DIR__)
-end
+$:.unshift(__DIR__) unless $:.include?(__DIR__)
 
 ##
 # Main module for Zen, all other modules and classes will be placed inside this
@@ -18,6 +17,28 @@ end
 # @since  0.1
 #
 module Zen
+  ##
+  # Array containing all the translations that should be made available to the
+  # Javascript code.
+  #
+  # @since 19-02-2012
+  #
+  JAVASCRIPT_TRANSLATIONS = [
+    'zen_general.buttons.bold',
+    'zen_general.buttons.italic',
+    'zen_general.buttons.link',
+    'zen_general.buttons.ul',
+    'zen_general.buttons.ol',
+    'zen_general.buttons.preview',
+    'zen_general.buttons.close',
+    'zen_general.datepicker.select_a_time',
+    'zen_general.datepicker.use_mouse_wheel',
+    'zen_general.datepicker.time_confirm_button',
+    'zen_general.datepicker.apply_range',
+    'zen_general.datepicker.cancel',
+    'zen_general.datepicker.week'
+  ]
+
   class << self
     # The database connection to use for Sequel.
     attr_accessor :database
@@ -29,29 +50,40 @@ module Zen
     attr_reader :root
 
     ##
-    # Sets the root directory and adds the path to Ramaze.options.roots.
+    # Sets the root directory and adds the path to Ramaze.options.roots. Once
+    # set this method sets up the global assets and loads all asset groups that
+    # ship with Zen.
     #
     # @since  0.3
     #
     def root=(path)
+      raise('You can only set Zen.root once') unless root.nil?
+
       @root = path
 
       if !Ramaze.options.roots.include?(@root)
         Ramaze.options.roots.push(@root)
       end
+
+      setup_assets
+      load_global_assets
     end
 
     ##
     # Prepares Zen for the party of it's life.
     #
-    # @since  0.3
+    # @since 0.3
+    # @event pre_start Event that is fired before starting Zen.
+    # @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.
     #
     def start
-      if root.nil?
-        raise('You need to specify a valid root directory in Zen.root')
-      end
+      raise('No valid root directory specified in Zen.root') if root.nil?
+
+      Zen::Event.call(:pre_start)
 
-      # Set up Ramaze::Cache manually. This makes it possible for the langauge
+      # Set up Ramaze::Cache manually. This makes it possible for the language
       # files to cache their data in the custom cache without having to wait for
       # Ramaze to set it up.
       Ramaze::Cache.setup
@@ -59,27 +91,12 @@ module Zen
 
       require 'zen/model/init'
       require 'zen/model/methods'
-
-      setup_assets
-
       require 'zen/package/all'
 
-      # Load the global stylesheet and Javascript file if they're located in
-      # ROOT/public/css/admin/global.css and ROOT/public/js/admin/global.js
-      load_global_assets
-
-      # Migrate all settings
-      begin
-        Settings::Setting.migrate
-      rescue => e
-        Ramaze::Log.warn(
-          'Failed to migrate the settings, make sure the database ' \
-            'table is up to date and that you executed rake db:migrate.'
-        )
-      end
-
       Zen.asset.build(:javascript)
       Zen.asset.build(:css)
+
+      Zen::Event.call(:post_start)
     end
 
     private
@@ -104,14 +121,13 @@ module Zen
       Zen.asset.serve(
         :css,
         [
-          'admin/css/zen/reset',
-          'admin/css/zen/grid',
-          'admin/css/zen/layout',
-          'admin/css/zen/general',
-          'admin/css/zen/forms',
-          'admin/css/zen/tables',
-          'admin/css/zen/buttons',
-          'admin/css/zen/messages'
+          'admin/zen/css/reset',
+          'admin/zen/css/layout',
+          'admin/zen/css/general',
+          'admin/zen/css/forms',
+          'admin/zen/css/tables',
+          'admin/zen/css/buttons',
+          'admin/zen/css/messages'
         ],
         :name => 'zen_core'
       )
@@ -119,10 +135,12 @@ module Zen
       Zen.asset.serve(
         :javascript,
         [
-          'admin/js/vendor/mootools/core',
-          'admin/js/vendor/mootools/more',
-          'admin/js/zen/lib/html_table',
-          'admin/js/zen/index'
+          'admin/mootools/js/core',
+          'admin/mootools/js/more',
+          'admin/zen/js/lib/base',
+          'admin/zen/js/lib/html_table',
+          'admin/zen/js/lib/autosave',
+          'admin/zen/js/index'
         ],
         :name => 'zen_core'
       )
@@ -142,16 +160,16 @@ module Zen
 
       publics.each do |p|
         p   = File.join(Zen.root, p)
-        css = File.join(p, 'admin', 'css', 'global.css')
-        js  = File.join(p, 'admin', 'js', 'global.js')
+        css = File.join(p, 'admin/zen/css/global.css')
+        js  = File.join(p, 'admin/zen/js/global.js')
 
         if File.exist?(css) and css_loaded == false
-          Zen.asset.serve(:css, ['admin/css/global'])
+          Zen.asset.serve(:css, ['admin/zen/css/global'])
           css_loaded = true
         end
 
         if File.exist?(js) and js_loaded == false
-          Zen.asset.serve(:javascript, ['admin/js/global'])
+          Zen.asset.serve(:javascript, ['admin/zen/js/global'])
           js_loaded = true
         end
       end
@@ -172,6 +190,7 @@ require 'zen/validation'
 require 'zen/language'
 require 'zen/event'
 require 'zen/model/helper'
+require 'zen/model/plugin/events'
 require 'zen/languages'
 
 Ramaze::HelpersHelper.options.paths.push(__DIR__('zen'))
@@ -183,6 +202,8 @@ include Zen::Language::SingletonMethods
 require 'zen/markup'
 require 'zen/package'
 require 'zen/theme'
+require 'zen/security'
+require 'zen/migrator'
 
 # Load all the base controllers
 require 'zen/controller/base_controller'
@@ -190,4 +211,3 @@ require 'zen/controller/frontend_controller'
 require 'zen/controller/admin_controller'
 require 'zen/controller/main_controller'
 require 'zen/controller/preview'
-require 'zen/controller/translations'

data/lib/zen/asset_groups.rb

@@ -1,7 +1,7 @@
 Zen.asset.register_asset_group(:tabs) do |asset, controller, methods|
   asset.serve(
     :javascript,
-    ['admin/js/zen/lib/tabs'],
+    ['admin/zen/js/lib/tabs', 'admin/zen/js/lib/hash'],
     :name       => 'zen_tabs',
     :controller => controller,
     :minify     => true,
@@ -10,7 +10,7 @@ Zen.asset.register_asset_group(:tabs) do |asset, controller, methods|
 
   asset.serve(
     :css,
-    ['admin/css/zen/tabs'],
+    ['admin/zen/css/tabs'],
     :name       => 'zen_tabs',
     :controller => controller,
     :minify     => true,
@@ -21,7 +21,7 @@ end
 Zen.asset.register_asset_group(:datepicker) do |asset, controller, methods|
   asset.serve(
     :javascript,
-    ['admin/js/vendor/datepicker'],
+    ['admin/zen/js/lib/datepicker'],
     :name       => 'vendor_datepicker',
     :controller => controller,
     :minify     => true,
@@ -30,7 +30,7 @@ Zen.asset.register_asset_group(:datepicker) do |asset, controller, methods|
 
   asset.serve(
     :css,
-    ['admin/css/zen/datepicker'],
+    ['admin/zen/css/datepicker'],
     :name       => 'vendor_datepicker',
     :controller => controller,
     :minify     => true,
@@ -41,7 +41,7 @@ end
 Zen.asset.register_asset_group(:window) do |asset, controller, methods|
   asset.serve(
     :javascript,
-    ['admin/js/zen/lib/window'],
+    ['admin/zen/js/lib/window'],
     :name       => 'zen_window',
     :controller => controller,
     :minify     => true,
@@ -50,7 +50,7 @@ Zen.asset.register_asset_group(:window) do |asset, controller, methods|
 
   asset.serve(
     :css,
-    ['admin/css/zen/window'],
+    ['admin/zen/css/window'],
     :name       => 'zen_window',
     :controller => controller,
     :minify     => true,
@@ -64,9 +64,9 @@ Zen.asset.register_asset_group(:editor) do |asset, controller, methods|
   asset.serve(
     :javascript,
     [
-      'admin/js/zen/lib/editor',
-      'admin/js/zen/lib/editor/markdown',
-      'admin/js/zen/lib/editor/textile'
+      'admin/zen/js/lib/editor',
+      'admin/zen/js/lib/editor/markdown',
+      'admin/zen/js/lib/editor/textile'
     ],
     :name       => 'zen_editor',
     :controller => controller,
@@ -76,7 +76,7 @@ Zen.asset.register_asset_group(:editor) do |asset, controller, methods|
 
   asset.serve(
     :css,
-    ['admin/css/zen/editor'],
+    ['admin/zen/css/editor'],
     :name       => 'zen_editor',
     :controller => controller,
     :minify     => true,

data/lib/zen/bin/create.rb

@@ -218,9 +218,16 @@ module Zen
           )
         end
 
+        puts
         puts wrap_string(
-          "Your project has been created, you can find it in #{destination}"
+          "Your project has been created. Don't forget to migrate your " \
+            "database before starting Zen, this can be done using the " \
+            "following command:"
         )
+
+        puts
+        puts '    $ rake db:migrate'
+        puts
       end
 
       ##

data/lib/zen/helper/breadcrumb.rb

@@ -21,8 +21,6 @@ module Ramaze
     # @since  0.1
     #
     module Breadcrumb
-      @breadcrumbs = []
-
       ##
       # Appends each element to the list of breadcrumb segments.
       #
@@ -53,21 +51,15 @@ module Ramaze
       #  segment.
       # @return [String]
       #
-      def get_breadcrumbs(separator = "»")
+      def get_breadcrumbs(separator = '/')
         if !@breadcrumbs or @breadcrumbs.empty?
           return
         end
 
-        html      = ''
-        separator = " #{separator} "
-
-        @breadcrumbs.each do |segment|
-          html += segment + separator
-        end
-
-        @breadcrumbs = nil
+        items     = @breadcrumbs.dup
+        items[-1] = '<span class="current">%s</span>' % items[-1]
 
-        return html.chomp(separator)
+        return items.join(' %s ' % separator)
       end
     end # Breadcrumb
   end # Helper

data/lib/zen/helper/controller.rb

@@ -1,8 +1,7 @@
 module Ramaze
   module Helper
     ##
-    # Helper that provides a few methods for commonly used code inside a
-    # controller.
+    # General helper for methods that don't really belong into separate helpers.
     #
     # @since  0.3
     #
@@ -18,6 +17,152 @@ module Ramaze
         into.extend(Ramaze::Helper::Controller::ClassMethods)
       end
 
+      ##
+      # Returns an anchor tag that points towards the URL that allows users to
+      # manage collections of data.
+      #
+      # @since  17-12-2011
+      # @see    Ramaze::Helper::Controller#edit_link
+      # @return [String]
+      #
+      def manage_link(url, text)
+        return '<a href="%s" class="icon pages">%s</a>' % [url, text]
+      end
+
+      ##
+      # Returns an anchor tag that should point to a form that allows users to
+      # edit certain resources.
+      #
+      # @since  17-12-2011
+      # @param  [#to_s] url The URL for the link.
+      # @param  [#to_s] text The text to display in the link tag.
+      # @return [String]
+      #
+      def edit_link(url, text)
+        return '<a href="%s" class="icon edit">%s</a>' % [url, text]
+      end
+
+      ##
+      # Returns a button that should point to a form that allows users to create
+      # new resources.
+      #
+      # @since 17-12-2011
+      # @see   Ramaze::Helper::Controller#edit_link
+      #
+      def new_button(url, text)
+        return '<a href="%s" class="button">%s</a>' % [url, text]
+      end
+
+      ##
+      # Returns a button that when clicked should delete a set of resources.
+      #
+      # @since  17-12-2011
+      # @param  [String] text The text to display on the button.
+      # @return [String]
+      #
+      def delete_button(text)
+        return '<input type="submit" value="%s" class="button danger" />' \
+          % text
+      end
+
+      ##
+      # 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
+      # @param  [Mixed] object
+      # @return [String]
+      #
+      def render_pagination(object)
+        if object.respond_to?(:navigation) and object.page_count > 1
+          return object.navigation
+        end
+      end
+
+      ##
+      # Returns a string containing the name of the browser. The following
+      # values can be returned:
+      #
+      # * firefox
+      # * internet_explorer
+      # * chrome
+      # * safari
+      # * other
+      #
+      # Note that this method does a very simple check and thus should not be
+      # relied on for anything mission critical.
+      #
+      # @since  23-12-2011
+      # @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]
+      #
+      def browser_name(agent = nil)
+        agent ||= request.env['HTTP_USER_AGENT']
+
+        if agent.nil? or agent.empty?
+          return 'other'
+        end
+
+        case agent.downcase
+        when /chrome/
+          return 'chrome'
+
+        when /safari/
+          return 'safari'
+
+        when /msie/
+          return 'internet_explorer'
+
+        when /firefox/
+          return 'firefox'
+        end
+
+        return 'other'
+      end
+
+      ##
+      # Writes a JSON response.
+      #
+      # @since 13-02-2012
+      # @param [Mixed] data The response data.
+      # @param [Fixnum] status The HTTP status code.
+      #
+      def respond_json(data, status = 200)
+        respond(JSON.dump(data), status, 'Content-Type' => 'application/json')
+      end
+
+      ##
+      # 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.
+      # @return [Hash]
+      #
+      def post_fields(*keys)
+        keys = keys.map { |k| k.to_s }
+
+        request.POST.reject { |k, v| not keys.include?(k) }
+      end
+
+      ##
+      # Returns a JSON string containing all the translations for the Javascript
+      # code.
+      #
+      # @since  19-02-2012
+      # @return [String]
+      #
+      def javascript_translations
+        hash = {}
+
+        Zen::JAVASCRIPT_TRANSLATIONS.each do |key|
+          hash[key] = lang(key)
+        end
+
+        return JSON.dump(hash)
+      end
+
       ##
       # Methods that become available as class methods.
       #
@@ -58,12 +203,70 @@ module Ramaze
         #  CSRF attacks.
         #
         def csrf_protection(*actions)
-          # before_all() calls don't stack. Because CSRF protected methods are
-          # usually used for POST calls (and are separate methods) this works
-          # around it.
           stacked_before_all(:validate_csrf_token) do
             csrf_protection(*actions) do
-              respond(lang('zen_general.errors.csrf'), 403)
+              message(:error, lang('zen_general.errors.csrf'))
+
+              unless request.POST.empty?
+                request.POST.delete('id')
+                request.POST.delete('csrf_token')
+
+                flash[:form_data] = request.POST
+              end
+
+              redirect_referrer(::Dashboard::Controller::Dashboard.r(:index))
+            end
+          end
+        end
+
+        ##
+        # Creates a method that can be used for automatically saving an existing
+        # object. This method requires you to supply the following:
+        #
+        # * A model that extends ``Sequel::Model``
+        # * An array of columns that can be specified
+        #
+        # @example
+        #  autosave Model::CategoryGroup,
+        #  [:name, :description],
+        #  :edit_category_group
+        #
+        # @since 13-02-2012
+        # @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
+        #  objects.
+        #
+        def autosave(model, columns, permission)
+          self.instance_eval do
+            define_method :autosave do
+              csrf_protection(:autosave) do
+                respond(lang('zen_general.errors.csrf'), 403)
+              end
+
+              post   = post_fields(*columns)
+              object = model[request.params['id']]
+
+              if object.nil? or !user_authorized?(permission)
+                respond_json(
+                  {:error => lang('zen_general.errors.invalid_request')},
+                  404
+                )
+              else
+                begin
+                  post.each do |k, v|
+                    object.send("#{k}=", v) if object.respond_to?("#{k}=")
+                  end
+
+                  object.save
+
+                  respond_json({:csrf_token => get_csrf_token}, 200)
+                rescue => e
+                  Ramaze::Log.error(e)
+
+                  respond_json({:errors  => object.errors}, 400)
+                end
+              end
             end
           end
         end