zen 0.2.8 → 0.3b

data/lib/zen/package/settings/lib/settings/setting_groups.rb

@@ -0,0 +1,11 @@
+# Settings group for various settings that don't belong in any other group.
+Settings::SettingsGroup.add do |group|
+  group.title = 'settings.tabs.general'
+  group.name  = :general
+end
+
+# Settings group for security related settings such as the Defensio API key.
+Settings::SettingsGroup.add do |group|
+  group.title = 'settings.tabs.security'
+  group.name  = :security
+end

data/lib/zen/package/settings/lib/settings/settings.rb

@@ -0,0 +1,83 @@
+Settings::Setting.add do |setting|
+  setting.title       = 'settings.labels.website_name'
+  setting.description = 'settings.descriptions.website_name'
+  setting.name        = :website_name
+  setting.group       = :general
+  setting.default     = 'Zen'
+  setting.type        = 'textbox'
+end
+
+Settings::Setting.add do |setting|
+  setting.title       = 'settings.labels.website_description'
+  setting.description = 'settings.descriptions.website_description'
+  setting.name        = :website_description
+  setting.group       = :general
+  setting.type        = 'textarea'
+end
+
+Settings::Setting.add do |setting|
+  setting.title       = 'settings.labels.language'
+  setting.description = 'settings.descriptions.language'
+  setting.name        = :language
+  setting.group       = :general
+  setting.default     = 'en'
+  setting.type        = 'select'
+  setting.values      = Zen::Language.to_hash
+end
+
+Settings::Setting.add do |setting|
+  setting.title       = 'settings.labels.frontend_language'
+  setting.description = 'settings.descriptions.frontend_language'
+  setting.name        = :frontend_language
+  setting.group       = :general
+  setting.default     = 'en'
+  setting.type        = 'select'
+  setting.values      = Zen::Language.to_hash
+end
+
+Settings::Setting.add do |setting|
+  setting.title       = 'settings.labels.theme'
+  setting.description = 'settings.descriptions.theme'
+  setting.name        = :theme
+  setting.group       = :general
+  setting.type        = 'select'
+  setting.default     = 'default'
+  setting.values      = lambda do
+    theme_hash = {}
+
+    Zen::Theme::REGISTERED.each do |name, theme|
+      name             = name.to_s
+      theme_hash[name] = name
+    end
+
+    return theme_hash
+  end
+end
+
+Settings::Setting.add do |setting|
+  setting.title       = 'settings.labels.date_format'
+  setting.description = 'settings.descriptions.date_format'
+  setting.name        = :date_format
+  setting.group       = :general
+  setting.type        = 'select'
+  setting.default     = '%Y-%m-%d %H:%M:%S'
+  setting.values      = {
+    '%Y-%m-%d %H:%M:%S' => '2011-05-10 13:30:12',
+    '%d-%m-%Y %H:%M:%S' => '10-05-2011 13:30:12',
+    '%A, %B %d, %Y'     => 'Tuesday, May 10, 2011'
+  }
+end
+
+Settings::Setting.add do |setting|
+  setting.title       = 'settings.labels.enable_antispam'
+  setting.description = 'settings.descriptions.enable_antispam'
+  setting.name        = :enable_antispam
+  setting.group       = :security
+  setting.type        = 'radio'
+  setting.values      = lambda do
+    return {
+      lang('zen_general.special.boolean_hash.true')  => '1',
+      lang('zen_general.special.boolean_hash.false') => '0'
+    }
+  end
+end

data/lib/zen/package/settings/lib/settings/settings_group.rb

@@ -0,0 +1,84 @@
+module Settings
+  ##
+  # Base class used for setting groups.
+  #
+  # @since  0.2.5
+  #
+  class SettingsGroup
+    include ::Zen::Validation
+
+    ##
+    # Hash containing all registered setting groups.
+    #
+    # @since  0.3
+    #
+    REGISTERED = {}
+
+    # The name of the group
+    attr_reader :name
+
+    # The title of the group, displayed in the GUI
+    attr_writer :title
+
+    ##
+    # Registers a new setting group using the specified block.
+    #
+    # @example
+    #  Settings::SettingsGroup.add do |group|
+    #    group.name  = 'example'
+    #    group.title = 'Example group'
+    #  end
+    #
+    # @since  0.2.5
+    #
+    def self.add
+      group = self.new
+
+      yield group
+
+      group.validate
+
+      REGISTERED[group.name] = group
+    end
+
+    ##
+    # Sets the name of the group and converts it to a symbol.
+    #
+    # @since  0.3
+    # @param  [#to_sym] name The name of the settings group.
+    #
+    def name=(name)
+      @name = name.to_sym
+    end
+
+    ##
+    # Returns the title of the setting and tries to translate it.
+    #
+    # @since  0.3
+    # @return [String]
+    #
+    def title
+      begin
+        return lang(@title)
+      rescue
+        return @title
+      end
+    end
+
+    ##
+    # Validates all attributes of this class.
+    #
+    # @since  0.2.5
+    #
+    def validate
+      validates_presence([:name, :title])
+
+      if REGISTERED.key?(name)
+        raise(
+          ::Zen::ValidationError,
+          "The setting group \"#{name}\" has already been registered."
+        )
+      end
+    end
+  end # SettingsGroup
+end # Settings

data/lib/zen/package/settings/lib/settings/singleton_methods.rb

@@ -0,0 +1,35 @@
+module Settings
+  ##
+  # Module that's injected into the global namespace allowing developers to
+  # retrieve settings without having to use the full namespace of
+  # {Settings::Setting::REGISTERED}.
+  #
+  # @since  0.3
+  #
+  module SingletonMethods
+    ##
+    # Retrieves the setting for the given name. This method returns an instance
+    # of {Settings::Setting}, this means that in order to retrieve the actual
+    # value you'll have to invoke ``#value()`` on the return value.
+    #
+    # @example
+    #  get_setting(:website_name) # => #<Settings::Setting>
+    #
+    # @example Retrieving the value
+    #  get_setting(:website_name) # => "Example"
+    #
+    # @since  0.3
+    # @param  [#to_sym] name The name of the setting to retrieve.
+    # @return [Settings::Setting]
+    #
+    def get_setting(name)
+      name = name.to_sym
+
+      if !Settings::Setting::REGISTERED.key?(name)
+        raise(ArgumentError, "The setting \"#{name}\" doesn't exist.")
+      end
+
+      return Settings::Setting::REGISTERED[name]
+    end
+  end # SingletonMethods
+end # Settings

data/lib/zen/package/settings/lib/settings/view/admin/settings/index.xhtml

@@ -1,8 +1,8 @@
-<article>
+<section>
     <header>
         <h1>#{get_breadcrumbs}</h1>
     </header>
-  
+
     <div class="tabs">
         <ul>
             <?r @groups.each do |name, group| ?>
@@ -12,67 +12,25 @@
             <?r end ?>
         </ul>
     </div>
- 
-    #{
-    form_for(@settings_ordered, :method => :post, :action => @form_save_url, 
-    :id => :setting_form) do |f|
+
+    #{form_for(
+      @settings_ordered,
+      :method => :post,
+      :action => ::Settings::Controller::Settings.r(:save),
+      :id     => :setting_form
+    ) do |f|
       f.input_hidden(:csrf_token, get_csrf_token)
 
       @settings_ordered.each do |group, items|
         f.g.div(:id => "group_#{group}") do
           items.each do |s|
-            value = plugin(:settings, :get, s.name).value
-            
-            case s.type
-              when 'textbox'
-                f.input_text(
-                  s.title, 
-                  s.name, 
-                  :value => value
-                )
-
-              when 'textarea'
-                f.textarea(
-                  s.title, 
-                  s.name, 
-                  :value => value, 
-                  :rows  => 8
-                )
-
-              when 'radio'
-                f.input_radio(
-                  s.title, 
-                  s.name, 
-                  value, 
-                  :values => s.values
-                )
-
-              when 'checkbox'
-                f.input_checkbox(
-                  s.title, 
-                  s.name, 
-                  value, 
-                  :values => s.values
-                )
-
-              when 'select'
-                f.select(
-                  s.title, 
-                  s.name, 
-                  :values   => s.values, 
-                  :size     => 1, 
-                  :selected => value
-                )
-            end
+            f.send(*get_setting(s.name).form_parameters)
           end
         end
       end
-    
-      f.g.div(:class => 'clearfix') do
-        f.g.div(:class => 'button') do
-          f.g.input(:type => 'submit', :value => lang('settings.buttons.save'))
-        end
+
+      f.g.div(:class => 'button') do
+        f.g.input(:type => 'submit', :value => lang('settings.buttons.save'))
       end
-    end
-    }
-</article>
+    end}
+</section>

data/lib/zen/package/settings/migrations/1321197919_remove_unused_columns.rb

@@ -0,0 +1,17 @@
+Sequel.migration do
+  up do
+    alter_table(:settings) do
+      drop_column(:group)
+      drop_column(:default)
+      drop_column(:type)
+    end
+  end
+
+  down do
+    alter_table(:settings) do
+      add_column(:group, String)
+      add_column(:default, String)
+      add_column(:type, String)
+    end
+  end
+end

data/lib/zen/package/users/lib/users.rb

@@ -1,43 +1,58 @@
-Ramaze::HelpersHelper.options.paths.push(__DIR__('users'))
+Zen::Package.add do |p|
+  p.name       = :users
+  p.title      = 'users.titles.index'
+  p.author     = 'Yorick Peterse'
+  p.url        = 'http://zen-cms.com/'
+  p.about      = 'users.description'
+  p.root       = __DIR__('users')
+  p.migrations = __DIR__('../migrations')
 
-require __DIR__('users/model/user')
-require __DIR__('users/model/user_group')
-require __DIR__('users/model/access_rule')
-require __DIR__('users/controller/users')
-require __DIR__('users/controller/user_groups')
-require __DIR__('users/controller/access_rules')
+  p.menu(
+    'users.titles.index',
+    '/admin/users',
+    :permission => :show_user
+  ) do |sub|
+    sub.menu(
+      'user_groups.titles.index',
+      '/admin/user-groups',
+      :permission => :show_user_group
+    )
+  end
+
+  p.permission :show_user_group  , 'user_groups.permissions.show'
+  p.permission :edit_user_group  , 'user_groups.permissions.edit'
+  p.permission :new_user_group   , 'user_groups.permissions.new'
+  p.permission :delete_user_group, 'user_groups.permissions.delete'
+
+  p.permission :show_user  , 'users.permissions.show'
+  p.permission :edit_user  , 'users.permissions.edit'
+  p.permission :new_user   , 'users.permissions.new'
+  p.permission :delete_user, 'users.permissions.delete'
+
+  p.permission :show_permission, 'permissions.permissions.show'
+  p.permission :edit_permission, 'permissions.permissions.edit'
+end
 
-Zen::Language.options.paths.push(__DIR__('users'))
 Zen::Language.load('users')
 Zen::Language.load('user_groups')
-Zen::Language.load('access_rules')
+Zen::Language.load('permissions')
 
-# The trait for the User helper has to be specified in the constructor as
-# our user model is loaded after this class is loaded (but before it's initialized)
+require __DIR__('users/settings')
+require __DIR__('users/model/user')
+require __DIR__('users/model/user_group')
+require __DIR__('users/model/permission')
+require __DIR__('users/model/user_status')
+
+# The trait for the User helper has to be specified in the constructor as our
+# user model is loaded after this class is loaded (but before it's
+# initialized)
 Zen::Controller::BaseController.trait(:user_model => Users::Model::User)
+Zen::Controller::AdminController.helper(:acl, :access)
 
-Zen::Package.add do |p|
-  p.name          = 'users'
-  p.author        = 'Yorick Peterse'
-  p.url           = 'http://yorickpeterse.com/'
-  p.about         = "Module for managing users along with handling authentication and 
-authorization."
-  
-  p.directory     = __DIR__('users')
-  p.migration_dir = __DIR__('../migrations')
-  
-  p.menu = [{
-    :title    => lang('users.titles.index'),
-    :url      => 'admin/users',
-    :children => [
-      {:title => lang('user_groups.titles.index') , :url => 'admin/user-groups'},
-      {:title => lang('access_rules.titles.index'), :url => 'admin/access-rules'}
-    ]
-  }]
-
-  p.controllers = {
-    lang('users.titles.index')        => Users::Controller::Users, 
-    lang('user_groups.titles.index')  => Users::Controller::UserGroups, 
-    lang('access_rules.titles.index') => Users::Controller::AccessRules
-  }
-end
+# The settings controller is already loaded so that one has to be updated as
+# well.
+Ramaze::Helper::Access.add_block(Settings::Controller::Settings)
+
+# Load the controllers after the helpers have been loaded.
+require __DIR__('users/controller/users')
+require __DIR__('users/controller/user_groups')

data/lib/zen/package/users/lib/users/controller/user_groups.rb

@@ -1,48 +1,78 @@
-#:nodoc:
 module Users
   #:nodoc:
   module Controller
     ##
-    # Controller for managing all user groups. It's not required to add a user
-    # to a group but it can certainly make it easier when adding custom
-    # permissions or granting a user full access to the backend.
+    # User groups allow you to group types of users together and assign
+    # permissions to the entire group of users without having to modify each
+    # individual user.
+    #
+    # User groups can be managed by going to ``/admin/user-groups``. This page
+    # will show an overview of all existing groups or a message saying no groups
+    # have been added yet.
+    #
+    # ![User Groups](../../_static/users/user_groups_overview.png)
+    #
+    # Editing a user group can be done by clicking on the name of the group,
+    # creating a new one can be done by clicking the button "New group". When
+    # creating or editing a group you'll be presented with the form shown in the
+    # images below.
+    #
+    # ![Edit Group](../../_static/users/edit_user_group.png)
+    # ![Group Permissions](../../_static/users/edit_user_group_permissions.png)
+    #
+    # In this form you can fill in the following fields:
+    #
+    # * **Name** (required): the name of the user group.
+    # * **Slug**: a URL friendly version of the name. If no name is specified
+    #   one will be generated automatically.
+    # * **Super group** (required): when set to "Yes" all users that are
+    #   assigned to this group will have access to *everything* regardless of
+    #   their individual settings.
+    # * **Description**: a description of the user group.
+    #
+    # Besides these fields you can also specify all the permissions o the user
+    # group similar to how they're managed for individual users. Note that user
+    # specific rules will only overwrite group based rules if a group blocks
+    # something while a user specific rules allows something. Simply said, rules
+    # are added to the list but aren't removed based on their source.
+    #
+    # ## Used Permissions
+    #
+    # This controller uses the following permissions:
+    #
+    # * show_user_group
+    # * edit_user_group
+    # * new_user_group
+    # * delete_user_group
+    #
+    # ## Events
+    #
+    # All events in this controller receive an instance of
+    # {Users::Model::UserGroup}. Just like other controllers the event
+    # ``after_delete_user_group`` will receive a user group that has already
+    # been destroyed using ``#destroy()``.
     #
-    # @author Yorick Peterse
     # @since  0.1
+    # @map    /admin/user-groups
+    # @event  before_new_user_group
+    # @event  after_new_user_user
+    # @event  before_edit_user_group
+    # @event  after_edit_user_group
+    # @event  before_delete_user_group
+    # @event  after_delete_user_group
     #
     class UserGroups < Zen::Controller::AdminController
-      include ::Users::Model
-
       helper :users
-      map '/admin/user-groups'
+      map    '/admin/user-groups'
+      title  'user_groups.titles.%s'
 
-      before_all do
-        csrf_protection(:save, :delete) do
-          respond(lang('zen_general.errors.csrf'), 403)
-        end
-      end
+      csrf_protection  :save, :delete
+      load_asset_group :tabs
 
-      ##
-      # Load our language packs, set the form URLs and define our page title.
-      #
-      # This method loads the following language files:
-      #
-      # * user_groups
-      #
-      # @author Yorick Peterse
-      # @since  0.1
-      #
-      def initialize
-        super
-
-        Zen::Language.load('user_groups')
-
-        # Set the page title
-        if !action.method.nil?
-          method      = action.method.to_sym
-          @page_title = lang("user_groups.titles.#{method}") rescue nil
-        end
+      serve :javascript, ['/admin/js/users/permissions'], :minify => false
+      serve :css, ['/admin/css/users/permissions.css'], :minify => false
 
+      before(:index, :edit, :new) do
         @boolean_hash = {
           true  => lang('zen_general.special.boolean_hash.true'),
           false => lang('zen_general.special.boolean_hash.false')
@@ -53,46 +83,39 @@ module Users
       # Show an overview of all user groups and allow the current user
       # to manage these groups
       #
-      # This method requires the following permissions:
-      #
-      # * read
-      #
-      # @author Yorick Peterse
-      # @since  0.1
+      # @since      0.1
+      # @permission show_user_group
       #
       def index
-        require_permissions(:read)
+        authorize_user!(:show_user_group)
 
         set_breadcrumbs(lang('user_groups.titles.index'))
 
-        @user_groups = paginate(UserGroup)
+        @user_groups = search do |query|
+          ::Users::Model::UserGroup.search(query).order(:id.asc)
+        end
+
+        @user_groups ||= ::Users::Model::UserGroup.order(:id.asc)
+        @user_groups   = paginate(@user_groups)
       end
 
       ##
       # Edit an existing user group.
       #
-      # This method requires the following permissions:
-      #
-      # * read
-      # * update
-      #
-      # @author Yorick Peterse
-      # @param  [Integer] id The ID of the user group to edit.
-      # @since  0.1
+      # @param      [Fixnum] id The ID of the user group to edit.
+      # @since      0.1
+      # @permission edit_user_group
       #
       def edit(id)
-        require_permissions(:read, :update)
+        authorize_user!(:edit_user_group)
 
         set_breadcrumbs(
           UserGroups.a(lang('user_groups.titles.index'), :index),
           lang('user_groups.titles.edit')
         )
 
-        if flash[:form_data]
-          @user_group = flash[:form_data]
-        else
-          @user_group = validate_user_group(id)
-        end
+        @user_group  = flash[:form_data] || validate_user_group(id)
+        @permissions = @user_group.permissions.map { |p| p.permission.to_sym }
 
         render_view(:form)
       end
@@ -100,23 +123,18 @@ module Users
       ##
       # Create a new user group.
       #
-      # This method requires the following permissions:
-      #
-      # * read
-      # * create
-      #
-      # @author Yorick Peterse
-      # @since  0.1
+      # @since      0.1
+      # @permission new_user_group
       #
       def new
-        require_permissions(:read, :create)
+        authorize_user!(:new_user_group)
 
         set_breadcrumbs(
           UserGroups.a(lang('user_groups.titles.index'), :index),
           lang('user_groups.titles.new')
         )
 
-        @user_group = UserGroup.new
+        @user_group = flash[:form_data] || ::Users::Model::UserGroup.new
 
         render_view(:form)
       end
@@ -125,42 +143,46 @@ module Users
       # Saves or creates a new user group based on the POST data and a field
       # named 'id'.
       #
-      # This method requires the following permissions:
-      #
-      # * create
-      # * read
-      #
-      # @author Yorick Peterse
-      # @since  0.1
+      # @since      0.1
+      # @permission new_user_group (when creating a new group)
+      # @permission edit_user_group (when editing a group)
+      # @event      before_new_user_group
+      # @event      after_new_user_group
+      # @event      before_edit_user_group
+      # @event      after_edit_user_group
       #
       def save
         post = request.subset(:id, :name, :slug, :description, :super_group)
 
         if post['id'] and !post['id'].empty?
-          require_permissions(:update)
+          authorize_user!(:edit_user_group)
 
-          user_group  = validate_user_group(post['id'])
-          save_action = :save
+          user_group   = validate_user_group(post['id'])
+          save_action  = :save
+          before_event = :before_edit_user_group
+          after_event  = :after_edit_user_group
         else
-          require_permissions(:create)
+          authorize_user!(:new_user_group)
 
-          user_group  = UserGroup.new
-          save_action = :new
-
-          post.delete('slug') if post['slug'].empty?
+          user_group   = ::Users::Model::UserGroup.new
+          save_action  = :new
+          before_event = :before_new_user_group
+          after_event  = :after_new_user_group
         end
 
         post.delete('id')
 
-        flash_success = lang("user_groups.success.#{save_action}")
-        flash_error   = lang("user_groups.errors.#{save_action}")
+        success = lang("user_groups.success.#{save_action}")
+        error   = lang("user_groups.errors.#{save_action}")
 
         begin
-          user_group.update(post)
-          message(:success, flash_success)
+          post.each { |k, v| user_group.send("#{k}=", v) }
+          Zen::Event.call(before_event, user_group)
+
+          user_group.save
         rescue => e
           Ramaze::Log.error(e.inspect)
-          message(:error, flash_error)
+          message(:error, error)
 
           flash[:form_data]   = user_group
           flash[:form_errors] = user_group.errors
@@ -168,25 +190,31 @@ module Users
           redirect_referrer
         end
 
-        if user_group.id
-          redirect(UserGroups.r(:edit, user_group.id))
-        else
-          redirect_referrer
+        if user_authorized?(:edit_permission)
+          update_permissions(
+            :user_group_id,
+            user_group.id,
+            request.params['permissions'] || [],
+            user_group.permissions.map { |p| p.permission }
+          )
         end
+
+        Zen::Event.call(after_event, user_group)
+
+        message(:success, success)
+        redirect(UserGroups.r(:edit, user_group.id))
       end
 
       ##
-      # Delete all specified user groups.
+      # Deletes all specified user groups.
       #
-      # This method requires the following permissions:
-      #
-      # * delete
-      #
-      # @author Yorick Peterse
-      # @since  0.1
+      # @since      0.1
+      # @permission delete_user_group
+      # @event      before_delete_user_group
+      # @event      after_delete_user_group
       #
       def delete
-        require_permissions(:delete)
+        authorize_user!(:delete_user_group)
 
         if !request.params['user_group_ids'] \
         or request.params['user_group_ids'].empty?
@@ -195,17 +223,24 @@ module Users
         end
 
         request.params['user_group_ids'].each do |id|
+          group = ::Users::Model::UserGroup[id]
+
+          next if group.nil?
+          Zen::Event.call(:before_delete_user_group, group)
+
           begin
-            UserGroup[id].destroy
-            message(:success,  lang('user_groups.success.delete'))
+            group.destroy
           rescue => e
             Ramaze::Log.error(e.inspect)
             message(:error, lang('user_groups.errors.delete') % id)
 
             redirect_referrer
           end
+
+          Zen::Event.call(:after_delete_user_group, group)
         end
 
+        message(:success,  lang('user_groups.success.delete'))
         redirect_referrer
       end
     end # UserGroups