zen 0.1a → 0.2

data/lib/zen/{packages → package}/users/lib/users/controller/users.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module Users
+  #:nodoc:
   module Controllers
     ##
     # Controller for managing users. Users in this case are people
@@ -13,18 +15,18 @@ module Users
     # @since  0.1
     #
     class Users < Zen::Controllers::AdminController
-      map '/admin/users'
-      
-      trait :extension_identifier => 'com.zen.users'
       include ::Users::Models
+
+      map   '/admin/users'
+      trait :extension_identifier => 'com.zen.users'
       
       before_all do
-        csrf_protection :save, :delete do
-          respond(@zen_general_lang.errors[:csrf], 401)
+        csrf_protection(:save, :delete) do
+          respond(lang('zen_general.errors.csrf'), 403)
         end
       end
       
-      # Every action should use the admin layout except the "login" method,
+      # Every action should use the admin layout except the 'login' method,
       # that one will use a trimmed down version of the admin layout.
       layout do |path, format|
         if path == 'login'
@@ -37,40 +39,51 @@ module Users
       ##
       # Load our language packs, set the form URLs and define our page title.
       #
+      # This method loads the following language files:
+      #
+      # * users
+      #
       # @author Yorick Peterse
       # @since  0.1
       #
       def initialize
         super
         
-        @form_save_url   = '/admin/users/save'
-        @form_delete_url = '/admin/users/delete'
-        @form_login_url  = '/admin/users/login'
-        @users_lang      = Zen::Language.load 'users'
+        @form_save_url   = Users.r(:save)
+        @form_delete_url = Users.r(:delete)
+        @form_login_url  = Users.r(:login)
+
+        Zen::Language.load('users')
         
         # Set the page title
         if !action.method.nil?
-          method = action.method.to_sym
-        
-          if @users_lang.titles.key? method 
-            @page_title = @users_lang.titles[method]
-          end
+          method      = action.method.to_sym
+          @page_title = lang("users.titles.#{method}") rescue nil
         end
+
+        @status_hash = {
+          'open'   => lang('users.special.status_hash.open'),
+          'closed' => lang('users.special.status_hash.closed')
+        }
       end
       
       ##
       # Show an overview of all users and allow the current user
       # to manage these users.
       #
+      # This method requires the following permissions:
+      #
+      # * read
+      #
       # @author Yorick Peterse
       # @since  0.1
       #
       def index
         if !user_authorized?([:read])
-          respond(@zen_general_lang.errors[:not_authorized], 403)
+          respond(lang('zen_general.errors.not_authorized'), 403)
         end
         
-        set_breadcrumbs @users_lang.titles[:index]
+        set_breadcrumbs(lang('users.titles.index'))
         
         @users = User.all
       end
@@ -78,32 +91,54 @@ module Users
       ##
       # Edit an existing user based on the ID.
       #
+      # This method requires the following permissions:
+      #
+      # * read
+      # * update
+      #
       # @author Yorick Peterse
+      # @param  [Integer] id The ID of the user to edit.
       # @since  0.1
       #
-      def edit id
+      def edit(id)
         if !user_authorized?([:read, :update])
-          respond(@zen_general_lang.errors[:not_authorized], 403)
+          respond(lang('zen_general.errors.not_authorized'), 403)
         end
         
-        set_breadcrumbs anchor_to(@users_lang.titles[:index], "admin/users"), @users_lang.titles[:edit]
+        set_breadcrumbs(
+          anchor_to(lang('users.titles.index'), Users.r(:index)), 
+          lang('users.titles.edit')
+        )
         
-        @user           = User[id]
+        if flash[:form_data]
+          @user = flash[:form_data]
+        else
+          @user = User[id.to_i]
+        end
+
         @user_group_pks = UserGroup.pk_hash(:name)
       end
       
       ##
       # Create a new user.
       #
+      # This method requires the following permissions:
+      #
+      # * read
+      # * create
+      #
       # @author Yorick Peterse
       # @since  0.1
       #
       def new
         if !user_authorized?([:read, :create])
-          respond(@zen_general_lang.errors[:not_authorized], 403)
+          respond(lang('zen_general.errors.not_authorized'), 403)
         end
         
-        set_breadcrumbs anchor_to(@users_lang.titles[:index], "admin/users"), @users_lang.titles[:new]
+        set_breadcrumbs(
+          anchor_to(lang('users.titles.index'), Users.r(:index)), 
+          lang('users.titles.new')
+        )
         
         @user           = User.new
         @user_group_pks = UserGroup.pk_hash(:name)
@@ -122,10 +157,10 @@ module Users
             # Update the last time the user logged in
             User[:email => request.params['email']].update(:last_login => Time.new)
             
-            notification :success, @users_lang.titles[:index], @users_lang.success[:login]
-            redirect "admin"
+            notification(:success, lang('users.titles.index'), lang('users.success.login'))
+            redirect(::Sections::Controllers::Sections.r(:index))
           else
-            notification :error, @users_lang.titles[:index], @users_lang.errors[:login]
+            notification(:error, lang('users.titles.index'), lang('users.errors.login'))
           end
         end
       end
@@ -138,30 +173,32 @@ module Users
       #
       def logout
         user_logout
+        session.clear
         
-        notification :success, @users_lang.titles[:index], @users_lang.success[:logout]
-        redirect "admin/users/login"
+        notification(:success, lang('users.titles.index'), lang('users.success.logout'))
+        redirect(Users.r(:login))
       end
       
       ##
-      # Saves or creates a new user based on the POST data and a field named "id".
+      # Saves or creates a new user based on the POST data and a field named 'id'.
+      #
+      # This method requires the following permissions:
+      #
+      # * create
+      # * update
       #
       # @author Yorick Peterse
       # @since  0.1
       #
       def save
         if !user_authorized?([:update, :create])
-          respond(@zen_general_lang.errors[:not_authorized], 403)
+          respond(lang('zen_general.errors.not_authorized'), 403)
         end
         
         post = request.params.dup
        
-        post.each do |key, value|
-          post.delete(key) if value.empty?
-        end
-
-        if post["id"] and !post["id"].empty?
-          @user       = User[post["id"]]
+        if post['id'] and !post['id'].empty?
+          @user       = User[post['id']]
           save_action = :save
         else
           @user       = User.new
@@ -170,37 +207,43 @@ module Users
         
         if !post['new_password'].nil? and !post['new_password'].empty?
           if post['new_password'] != post['confirm_password']
-            notification :error, @users_lang.titles[:index], @users_lang.errors[:no_password_match]
+            notification(
+              :error, 
+              lang('users.titles.index'), 
+              lang('users.errors.no_password_match')
+            )
+
             redirect_referrer
           else
             post['password'] = post['new_password']
             
-            post.delete 'new_password'
-            post.delete 'confirm_password'
+            post.delete('new_password')
+            post.delete('confirm_password')
           end
         end
         
         # User group pks have to be integers
-        if !post["user_group_pks"].nil?
-          post["user_group_pks"].map! { |value| value.to_i }
+        if !post['user_group_pks'].nil?
+          post['user_group_pks'].map! { |value| value.to_i }
         else
-          post["user_group_pks"] = []
+          post['user_group_pks'] = []
         end
         
-        flash_success = @users_lang.success[save_action]
-        flash_error   = @users_lang.errors[save_action]
+        flash_success = lang("users.success.#{save_action}")
+        flash_error   = lang("users.errors.#{save_action}")
 
         begin
           @user.update(post)
-          notification(:success, @users_lang.titles[:index], flash_success)
+          notification(:success, lang('users.titles.index'), flash_success)
         rescue
-          notification(:error, @users_lang.titles[:index], flash_error)
+          notification(:error, lang('users.titles.index'), flash_error)
           
+          flash[:form_data]   = @user
           flash[:form_errors] = @user.errors
         end
         
         if @user.id
-          redirect "/admin/users/edit/#{@user.id}"
+          redirect(Users.r(:edit, @user.id))
         else
           redirect_referrer
         end
@@ -209,27 +252,42 @@ module Users
       ##
       # Delete all specified users.
       #
+      # This method requires the following permissions:
+      #
+      # * delete
+      #
       # @author Yorick Peterse
       # @since  0.1
       #
       def delete
         if !user_authorized?([:delete])
-          respond(@zen_general_lang.errors[:not_authorized], 403)
+          respond(lang('zen_general.errors.not_authorized'), 403)
         end
         
-        if !request.params["user_ids"] or request.params["user_ids"].empty?
-          notification(:error, @users_lang.titles[:index], @users_lang.errors[:no_delete])
+        if !request.params['user_ids'] or request.params['user_ids'].empty?
+          notification(
+            :error, 
+            lang('users.titles.index'), 
+            lang('users.errors.no_delete')
+          )
+
           redirect_referrer
         end
         
-        request.params["user_ids"].each do |id|
-          @user = User[id]
-          
+        request.params['user_ids'].each do |id|
           begin
-            @user.delete
-            notification(:success, @users_lang.titles[:index], @users_lang.success[:delete] % id)
+            User[id.to_i].destroy
+            notification(
+              :success, 
+              lang('users.titles.index'), 
+              lang('users.success.delete')
+            )
           rescue
-            notification(:error, @users_lang.titles[:index], @users_lang.errors[:delete] % id)
+            notification(
+              :error, 
+              lang('users.titles.index'), 
+              lang('users.errors.delete') % id
+            )
           end
         end
         
@@ -237,4 +295,4 @@ module Users
       end
     end
   end
-end
+end

data/lib/zen/package/users/lib/users/language/en/access_rules.yml

@@ -0,0 +1,35 @@
+---
+titles:
+  index : 'Access Rules'
+  edit  : 'Edit Access Rule'
+  new   : 'Add Access Rule'
+
+labels:
+  id           : '#'
+  extension    : 'Extension'
+  rule_applies : 'Rule applies to'
+  create       : 'Create'
+  read         : 'Read'
+  update       : 'Update'
+  delete       : 'Delete'
+  user         : 'User'
+  user_group   : 'User group'
+
+messages:
+  no_rules: 'No access rules have been added yet.'
+
+errors:
+  new       : 'Failed to create a new access rule.'
+  save      : 'Failed to save the access rule.'
+  delete    : 'Failed to delete the access rule with ID #%s.'
+  no_delete : 'You have to specify at least one rule to delete.'
+  
+success: 
+  new    : 'The access rule has been created.'
+  save   : 'The access rule has been modified.'
+  delete : 'The access rule with ID #%s has been deleted.'
+  
+buttons:
+  new    : 'New rule'
+  delete : 'Delete selected rules'
+  save   : 'Save rule'

data/lib/zen/package/users/lib/users/language/en/user_groups.yml

@@ -0,0 +1,31 @@
+---
+titles:
+  index : 'User Groups'
+  edit  : 'Edit User Group'
+  new   : 'Add User Group'
+
+labels:
+  id          : '#'
+  name        : 'Name'
+  slug        : 'Slug'
+  description : 'Description'
+  super_group : 'Super group'
+
+messages:
+  no_groups: 'No user groups have been added yet.'
+
+errors:
+  new       : 'Failed to create a new user group.'
+  save      : 'Failed to modify the user group.'
+  delete    : 'Failed to delete the user group with ID #%s.'
+  no_delete : 'You have to specify at least one group to delete.'
+  
+success:
+  new    : 'The new user group has been created.'
+  save   : 'The user group has been modified.'
+  delete : 'All selected user groups have been deleted.'
+
+buttons:
+  new    : 'New group'
+  delete : 'Delete selected groups'
+  save   : 'Save group'

data/lib/zen/package/users/lib/users/language/en/users.yml

@@ -0,0 +1,50 @@
+---
+titles:
+  index  : 'Users'
+  edit   : 'Edit User'
+  new    : 'Add User'
+  login  : 'Login'
+
+labels:
+  id               : '#'
+  email            : 'Email'
+  name             : 'Name'
+  website          : 'Website'
+  password         : 'Password'
+  new_password     : 'New password'
+  confirm_password : 'Confirm password'
+  status           : 'Status'
+  created_at       : 'Created'
+  updated_at       : 'Updated'
+  last_login       : 'Last login'
+  user_groups      : 'User groups'
+
+special:
+  status_hash:
+    open   : 'Open'
+    closed : 'Closed'
+
+messages:
+  no_users : 'No users have been added yet.'
+
+errors:
+  new               : 'Failed to create a new users.'
+  save              : 'Failed to save the user.'
+  delete            : 'Failed to delete the user with ID #%s.'
+  no_delete         : 'You have to specify at least one user to delete.'
+  no_password_match : 'The specified passwords did not match.'
+  login             : 'Failed to log in with the specified details.'
+  logout            : 'Failed to log out, perhaps you are already logged out.'
+
+success:
+  new    : 'The new user has been created.'
+  save   : 'The user has been modified.'
+  delete : 'All selected users have been deleted.'
+  login  : 'You have been successfully logged in.'
+  logout : 'You have been successfully logged out.'
+
+buttons:
+  login  : 'Login'
+  new    : 'Add user'
+  delete : 'Delete selected users'
+  save   : 'Save user'

data/lib/zen/{packages → package}/users/lib/users/liquid/user.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module Users
+  #:nodoc:
   module Liquid
     ##
     # Tag that can be used to retrieve details about a single user. When using this
@@ -6,15 +8,15 @@ module Users
     # will result in multiple WHERE/AND clauses. In order to retrieve a user with
     # the Email address "me@awesome.com" you'd do the following:
     #
-    # bc. {% user email="me@awesome.com" %}
-    #   {{name}}
-    # {% enduser %}
+    #     {% user email="me@awesome.com" %}
+    #         {{name}}
+    #     {% enduser %}
     #
     # If you want to add an extra condition simply do the following:
     #
-    # bc. {% user email="me@awesome.com" status="open" %}
-    #   {{name}}
-    # {% enduser %}
+    #     {% user email="me@awesome.com" status="open" %}
+    #         {{name}}
+    #     {% enduser %}
     #
     # Note that this class is a Liquid block, not a tag. This means that you'll have to
     # specify the closing tag. The reason for this is that there are multiple columns