the_role 1.6.2 → 1.6.3

data/README.md

@@ -4,21 +4,40 @@
 |:------------- |:-------------|
 | ![Bye bye CanCan, I got The Role!](https://github.com/the-teacher/the_role/raw/master/Bye_bye_CanCan_I_got_the_Role.png) | TheRole is an authorization library for Ruby on Rails which restricts what resources a given user is allowed to access. All permissions are defined in with 2-level-hash, and store in database with JSON.<br><br>TheRole - Semantic, lightweight role system with an administrative interface.<br><br>Role is a two-level hash, consisting of the **sections** and nested **rules**.<br><br>**Section** may be associated with **controller** name.<br><br>**Rule** may be associated with **action** name.<br><br>Section can have many rules.<br><br>Rule can have **true** or **false** value<br><br>**Sections** and nested **Rules** provide **ACL** (**Access Control List**)<br><br>Role **stored in the database as JSON** string.<br><br>Using of hashes, makes role system extremely easy to configure and use.<br> |
 
-### rubygems page
-
-http://rubygems.org/gems/the_role
-
 ### GUI
 
 | TheRole management web interface |
 |:-------------:|
 |![TheRole](https://github.com/the-teacher/the_role/raw/master/pic.png)|
 
+### rubygems page
+
+http://rubygems.org/gems/the_role
+
+### TheRole and Devise 2
+
+[Integration with Devise2](https://github.com/the-teacher/the_role/wiki/Integration-with-Devise2)
+
+### TheRole and Sorcery
+
+[Integration with Sorcery](https://github.com/the-teacher/the_role/wiki/Integration-with-Sorcery)
+
+### Want to improve this gem?
+
+* I need for your feedback and issues
+* [How to start development process](https://github.com/the-teacher/the_role/wiki/Want-to-improve-this-gem%3F)
+
+### Rspec for TheRole
+
+[Specs with Devise 2](https://github.com/the-teacher/devise2_on_the_role/tree/master/spec)
+
+Read **How to start development process** manual for running specs
+
 ## What does it mean semantic?
 
 Semantic - the science of meaning. Human should fast to understand what is happening in a role system.
 
-Look at hash. If you can understand access rules - this role system is semantically.
+Look at next Role hash. If you can understand access rules - this authorization system is semantically.
 
 ``` ruby
 role = {
@@ -68,38 +87,57 @@ And you can use them as well as other access rules.
   bundle
 ```
 
-### Migrate
+### User Model migration
 
-Add **role_id:integer** to User Model Migration
+Add **role_id:integer** field to your User Model
 
-``` ruby
-rake the_role_engine:install:migrations
-  >> Copied migration 20111028145956_create_roles.rb from the_role_engine
+```ruby
+def self.up
+  create_table :users do |t|
+    t.string :login,            :null    => false
+    t.string :email,            :default => nil
+    t.string :crypted_password, :default => nil
+    t.string :salt,             :default => nil
+
+    t.integer :role_id,         :default => nil
+
+    t.timestamps
+  end
+end
 ```
 
+#### Generate Role Model without migration
+
 ``` ruby
 rails g model role --migration=false
 ```
 
+#### Generate Role migration
+
 ``` ruby
-rake db:create && rake db:migrate
+rake the_role_engine:install:migrations
 ```
 
-### Fake roles for test (not required)
+#### Create database and migrate
+
+``` ruby
+rake db:create && rake db:migrate
+```
 
-Creating roles for test 
+#### Create fake roles for test (not required)
 
 ``` ruby
 rake db:roles:test
-  >> Administrator, Moderator of pages, User, Demo
 ```
 
-### Change your ApplicationController
+#### Change your ApplicationController
 
 **Example for Devise2**
 
 ``` ruby
 class ApplicationController < ActionController::Base
+  include TheRole::Requires
+
   protect_from_forgery
 
   def access_denied
@@ -108,7 +146,6 @@ class ApplicationController < ActionController::Base
 
   alias_method :login_required,     :authenticate_user!
   alias_method :role_access_denied, :access_denied
-
 end
 ```
 
@@ -119,7 +156,7 @@ Define aliases method for correctly work TheRole's controllers
 **access_denied** or any other method for processing access denied situation
 
 
-### Using with any controller
+#### Using with any controller
 
 ``` ruby
 class PagesController < ApplicationController
@@ -139,8 +176,37 @@ class PagesController < ApplicationController
 end
 ```
 
+### Ownership checking
+
 **owner_required** method require **@ownership_checking_object** variable, with cheked object.
 
+You should to define **@ownership_checking_object** before invoke of **owner_required** method.
+
+### Using with Views
+
+```ruby
+<% if @user.has_role?(:twitter, :button) %>
+  Twitter Button is Here
+<% else %>
+  Access Denied
+<% end %>
+```
+
+### Way to set default role for new User
+
+```ruby
+class User
+  after_create :set_default_role
+
+  private
+
+  def set_default_role
+    self.role = Role.where(:name => :user).first
+    self.save
+  end
+end
+```
+
 ### Who is Administrator?
 
 Administrator it's a user who can access any section and the rules of your application.

data/app/assets/javascripts/admin_the_role.js

@@ -1,3 +1,4 @@
 //= require jquery
 //= require jquery_ujs
+//= require bootstrap-alert
 //= require bootstrap-dropdown

data/app/assets/javascripts/bootstrap-alert.js

@@ -0,0 +1,90 @@
+/* ==========================================================
+ * bootstrap-alert.js v2.0.4
+ * http://twitter.github.com/bootstrap/javascript.html#alerts
+ * ==========================================================
+ * Copyright 2012 Twitter, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ========================================================== */
+
+
+!function ($) {
+
+  "use strict"; // jshint ;_;
+
+
+ /* ALERT CLASS DEFINITION
+  * ====================== */
+
+  var dismiss = '[data-dismiss="alert"]'
+    , Alert = function (el) {
+        $(el).on('click', dismiss, this.close)
+      }
+
+  Alert.prototype.close = function (e) {
+    var $this = $(this)
+      , selector = $this.attr('data-target')
+      , $parent
+
+    if (!selector) {
+      selector = $this.attr('href')
+      selector = selector && selector.replace(/.*(?=#[^\s]*$)/, '') //strip for ie7
+    }
+
+    $parent = $(selector)
+
+    e && e.preventDefault()
+
+    $parent.length || ($parent = $this.hasClass('alert') ? $this : $this.parent())
+
+    $parent.trigger(e = $.Event('close'))
+
+    if (e.isDefaultPrevented()) return
+
+    $parent.removeClass('in')
+
+    function removeElement() {
+      $parent
+        .trigger('closed')
+        .remove()
+    }
+
+    $.support.transition && $parent.hasClass('fade') ?
+      $parent.on($.support.transition.end, removeElement) :
+      removeElement()
+  }
+
+
+ /* ALERT PLUGIN DEFINITION
+  * ======================= */
+
+  $.fn.alert = function (option) {
+    return this.each(function () {
+      var $this = $(this)
+        , data = $this.data('alert')
+      if (!data) $this.data('alert', (data = new Alert(this)))
+      if (typeof option == 'string') data[option].call($this)
+    })
+  }
+
+  $.fn.alert.Constructor = Alert
+
+
+ /* ALERT DATA-API
+  * ============== */
+
+  $(function () {
+    $('body').on('click.alert.data-api', dismiss, Alert.prototype.close)
+  })
+
+}(window.jQuery);

data/app/assets/stylesheets/close.less

@@ -0,0 +1,29 @@
+// CLOSE ICONS
+// -----------
+
+.close {
+  float: right;
+  font-size: 20px;
+  font-weight: bold;
+  line-height: @baseLineHeight;
+  color: @black;
+  text-shadow: 0 1px 0 rgba(255,255,255,1);
+  .opacity(20);
+  &:hover {
+    color: @black;
+    text-decoration: none;
+    cursor: pointer;
+    .opacity(40);
+  }
+}
+
+// Additional properties for button version
+// iOS requires the button element instead of an anchor tag.
+// If you want the anchor version, it requires `href="#"`.
+button.close {
+  padding: 0;
+  cursor: pointer;
+  background: transparent;
+  border: 0;
+  -webkit-appearance: none;
+}

data/app/assets/stylesheets/role_set.less

@@ -11,6 +11,8 @@
 
 @import "forms.less";
 @import "wells.less";
+@import "alerts.less";
+@import "close.less";
 
 .well{
   input{

data/app/controllers/admin/role_sections_controller.rb

@@ -11,19 +11,19 @@ class Admin::RoleSectionsController < ApplicationController
   def create
     if @role.create_section params[:section_name]
       flash[:notice] = t 'the_role.section_created'
-      redirect_to edit_admin_role_path @role
     else
-      render :action => :edit
+      flash[:error]  = t 'the_role.section_not_created'
     end
+    redirect_to_edit
   end
   
   def create_rule
     if @role.create_rule params[:section_name], params[:rule_name]
-      flash[:notice] = t 'the_role.section_created'
-      redirect_to edit_admin_role_path @role
+      flash[:notice] = t 'the_role.section_rule_created'
     else
-      render :action => :edit
+      flash[:error]  = t 'the_role.section_rule_not_created'
     end
+    redirect_to_edit
   end
 
   def rule_on
@@ -31,10 +31,10 @@ class Admin::RoleSectionsController < ApplicationController
     rule_name    = params[:name]
     if @role.rule_on section_name, rule_name
       flash[:notice] = t 'the_role.section_rule_on'
-      redirect_to edit_admin_role_path @role
     else
-      render :action => :edit
+      flash[:error]  = t 'the_role.section_rule_state_not_changed'
     end
+    redirect_to_edit
   end
 
   def rule_off
@@ -42,20 +42,20 @@ class Admin::RoleSectionsController < ApplicationController
     rule_name    = params[:name]
     if @role.rule_off section_name, rule_name
       flash[:notice] = t 'the_role.section_rule_off'
-      redirect_to edit_admin_role_path @role
     else
-      render :action => :edit
+      flash[:error]  = t 'the_role.section_rule_state_not_changed'
     end
+    redirect_to_edit
   end
   
   def destroy
     section_name = params[:id]
     if @role.delete_section section_name
       flash[:notice] = t 'the_role.section_deleted'
-      redirect_to edit_admin_role_path @role
     else
-      render :action => :edit
-    end   
+      flash[:error]  = t 'the_role.section_not_deleted'
+    end
+    redirect_to_edit
   end
   
   def destroy_rule
@@ -63,10 +63,10 @@ class Admin::RoleSectionsController < ApplicationController
     rule_name    = params[:name]
     if @role.delete_rule section_name, rule_name
       flash[:notice] = t 'the_role.section_rule_deleted'
-      redirect_to edit_admin_role_path @role
     else
-      render :action => :edit
+      flash[:error]  = t 'the_role.section_rule_not_deleted'
     end
+    redirect_to_edit
   end
 
   protected
@@ -75,4 +75,8 @@ class Admin::RoleSectionsController < ApplicationController
     @role = Role.find params[:role_id]
     @ownership_checking_object = @role
   end
+
+  def redirect_to_edit
+    redirect_to edit_admin_role_path @role
+  end
 end

data/app/views/layouts/the_role.html.haml

@@ -16,9 +16,18 @@
         User: #{current_user.try(:name) || current_user.id}
     .crusty
       .container
+
+        - if flash[:notice]
+          .alert.alert-block
+            %a.close{:href => '#', 'data-dismiss' => :alert } ×
+            = flash[:notice]
+
+        - if flash[:error]
+          .alert.alert-error
+            %a.close{:href => '#', 'data-dismiss' => :alert } ×
+            = flash[:error]
         .row
           .span3
             .sidebar= yield :sidebar
           .span9
-            .content= yield
-    
+            .content= yield

data/config/locales/en.yml

@@ -5,6 +5,7 @@ en:
     name_presence: Set the role name
     title_presence: Set title of role
     section_created: Section is successfully created
+    section_not_created: Section is not created
     section_rule_created: In a given group is successfully created an access rule
     section_deleted: access rule is removed
     section_rule_deleted: access rule is removed

data/config/locales/es.yml

@@ -0,0 +1,41 @@
+es:
+  the_role:
+    name_presence: Define el nombre del rol
+    title_presence: Definir el titulo del rol
+    section_created: "Sección creada exitosamente"
+    section_rule_created: En un grupo determinado se ha creado un rol de acceso exitosamente
+    section_deleted: regla de acceso eliminada
+    section_rule_deleted: regla de acceso eliminada
+    section_name_is_wrong: Nombre de rol erroneo
+    section_rule_wrong_name: Nombre de regla erroneo
+    section_name_is_blank: "El nombre del equipo de roles esta vacía"
+    section_exists: "La sección ya existe"
+    role_created: El Rol ha sido establecido exitosamente
+    role_updated: Rol actualizado exitosamente
+    delete_role: Esto puede ser un gran problema. ¿Eliminar este rol?
+  admin:
+    roles:
+      index:
+        list: lista de roles
+        delete: 'Borrar Rol'
+        new: Crear un nuevo rol
+      edit:
+        title: Editar rol
+        back: '← A la lista de roles'
+        name: 'Nombre del rol -'
+        create_section: "Crear una Sección"
+        create_access_rule: Crear una regla de acceso
+        create_rule: Nueva Regla
+        section_needs: "Crear al menos una sección"
+        update: Actualizar
+      form:
+        destroy_section_confirm: "¿Eliminar una sección de roles?"
+        empty: "No hay una sección de roles"
+        delete_rule_confirm: ¿Eliminar la regla de acceso?
+        delete: Eliminar
+      new:
+        back: '← A la lista de roles'
+        create: Crear un nuevo rol
+        name: Nombre del rol (Latin)
+        title: Titulo del rol
+        new: Crear

data/lib/the_role/version.rb

@@ -1,3 +1,3 @@
 module TheRole
-  VERSION = "1.6.2"
+  VERSION = "1.6.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_role
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-19 00:00:00.000000000 Z
+date: 2012-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &15241260 !ruby/object:Gem::Requirement
+  requirement: &11730300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15241260
+  version_requirements: *11730300
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &15240720 !ruby/object:Gem::Requirement
+  requirement: &11729380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15240720
+  version_requirements: *11729380
 - !ruby/object:Gem::Dependency
   name: sass-rails
-  requirement: &15239980 !ruby/object:Gem::Requirement
+  requirement: &11822780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15239980
+  version_requirements: *11822780
 - !ruby/object:Gem::Dependency
   name: coffee-rails
-  requirement: &15255560 !ruby/object:Gem::Requirement
+  requirement: &11821140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15255560
+  version_requirements: *11821140
 - !ruby/object:Gem::Dependency
   name: therubyracer
-  requirement: &15254860 !ruby/object:Gem::Requirement
+  requirement: &11819800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15254860
+  version_requirements: *11819800
 - !ruby/object:Gem::Dependency
   name: less-rails
-  requirement: &15254180 !ruby/object:Gem::Requirement
+  requirement: &11818680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15254180
+  version_requirements: *11818680
 description: Authorization lib for Rails 3 with Web Interface, aka CanCan killer
 email:
 - zykin-ilya@ya.ru
@@ -92,11 +92,13 @@ files:
 - README.md
 - Rakefile
 - app/assets/javascripts/admin_the_role.js
+- app/assets/javascripts/bootstrap-alert.js
 - app/assets/javascripts/bootstrap-dropdown.js
 - app/assets/stylesheets/admin_the_role.css
 - app/assets/stylesheets/alerts.less
 - app/assets/stylesheets/button-groups.less
 - app/assets/stylesheets/buttons.less
+- app/assets/stylesheets/close.less
 - app/assets/stylesheets/custom.scss
 - app/assets/stylesheets/dropdowns.less
 - app/assets/stylesheets/forms.less
@@ -120,6 +122,7 @@ files:
 - app/views/admin/roles/new.html.haml
 - app/views/layouts/the_role.html.haml
 - config/locales/en.yml
+- config/locales/es.yml
 - config/locales/ru.yml
 - config/routes.rb
 - db/migrate/20111025025129_create_roles.rb