the_role 1.4.1 → 1.5.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.rvmrc

data/.rvmrc.example

@@ -0,0 +1 @@
+rvm use ruby-1.8.7-p357@the_role --create

data/Gemfile

@@ -3,5 +3,3 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in the_role.gemspec
 gemspec
 
-gem 'haml', '~> 3.0'
-gem 'sass'

data/README.md

@@ -1,121 +1,83 @@
-## TheRole
+# gem 'the_role'
 
-Gem for providing simple, but powerful and flexible role system for ROR3 applications.
-Based on Hashes.
+## Bye bye CanCan, I got The Role!
 
-* Based on MVC semantik (easy to understand what's happening)
-* Realtime dynamically management with simple interface
-* Customizable
+Semantic, lightweight role system with an administrative interface
 
-##  Installation
+![TheSortableTree](https://github.com/the-teacher/the_role/raw/master/pic.png)
 
-Gemfile
+## What does it mean semantic?
 
-``` ruby
-  gem 'the_role'
-```
+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.
 
 ``` ruby
-  bundle install
+role = {
+  :pages => {
+    :index => true,
+    :show => true,
+    :new => false,
+    :edit => false,
+    :update => false,
+    :destroy => false
+  },
+  :articles => {
+    :index => true,
+    :show => true
+  }
+  :twitter => {
+    :button => true,
+    :follow => false
+  }
+}
 ```
 
-``` ruby
-rake the_role_engine:install:migrations
-  >> Copied migration 20111028145956_create_roles.rb from the_role_engine
+### How it  works 
 
-rails g model user role_id:integer
-rails g model role --migration=false
+Role - is a two-level hash, consisting of the sections and rules.
 
-rake db:create && rake db:migrate
-```
+**Section** may be associated with the name of a **controller**.
 
-Creating roles for test
+**Rule** may be associated with the name of **action** in the controller.
 
-``` ruby
-rake db:roles:test
-  >> Administrator, Moderator of pages, User, Demo
-```
+Section may contain a set of rules.
 
-Define aliases method for correctly work TheRole's controllers
+**Rule in Section** can be set to **true** and **false**, this provide **ACL** (**Access Control List**)
 
-**login_required** or any other method from your auth system
+Role hash **stored in the database as YAML** string.
+Using of hashes, makes it extremely easy to configure access rules in the role.
 
-**access_denied** or any other method for processing access denied situation
+### Virtual sections and rules
 
-``` ruby
-class ApplicationController < ActionController::Base
-  # You Auth system
-  include AuthenticatedSystem
-
-  # define aliases for correctly work of TheRole gem
-  alias_method :the_login_required, :login_required
-  alias_method :the_role_access_denied, :access_denied
-end
-```
+Usually, we use real names of controllers as names of sections, and we use names of real actions in controllers as names of section's rules.
 
-##  Using with controllers
+Like this:
 
 ``` ruby
-class ArticlesController < ApplicationController
-  # Auth system
-  before_filter :login_required, :except=>[:index, :show, :tag]
-  # Role system
-  before_filter :the_role_require,  :except => [:index, :show, :tag]
-  before_filter :the_role_object,   :only => [:edit, :update, :rebuild, :destroy]
-  before_filter :the_owner_require, :only => [:edit, :update, :rebuild, :destroy]
-
-  # actions
-  
-end
+current_user.has_role?(:pages, :show)
 ```
 
-##  Manage roles
+But you can also create virtual sections and rules:
+
 
 ``` ruby
-rails s
+current_user.has_role?(:twitter, :button)
+current_user.has_role?(:facebook, :like)
 ```
 
-**admin_roles_path** => **http://localhost:3000/admin/roles**
+These sections and the rules are not associated with real controllers and actions.
+And you can use them as well as other access rules.
+
+### Who is the administrator?
+
+Administrator - a user who can access any section and the rules of your application.
+The administrator is the owner of any objects in your application.
+Administrator - a user in the role-hash of which there is a section **system** and rule **administrator**.
+
+
+
 
-##  How it works
 
-``` ruby
-rails c
-
-user = User.first
-user.role = Role.where(:name => :demo).first
-user.save
-
-user.admin?
-  => false
-user.moderator? :pages
-  => false
-user.has_role? :pages, :index
-  => true 
- 
-
-user.role = Role.where(:name => :moderator).first
-user.save
-
-user.admin?
-  => false
-user.moderator? :pages
-  => true
-user.has_role? :pages, :any_crazy_name
-  => true
-
-user.role = Role.where(:name => :admin).first
-user.save
-
-user.admin?
-  => true
-user.moderator? :pages
-  => true
-user.moderator? :any_crazy_name
-  => true
-user.has_role? :any_crazy_name, :any_crazy_name
-  => true
 
-```
 
-Copyright (c) 2011 [Ilya N. Zykin Github.com/the-teacher], released under the MIT license

data/app/assets/stylesheets/the_role/form.css

@@ -1,55 +1,57 @@
-.form{
-  background:#EEE;
-  padding:5px;
-  margin:0 0 15px 0;
-  border:2px solid gray;
-  -moz-border-radius:5px;
-}
-.form label{
-  display:block;
-}
-.form .input{
-  border:1px solid #000;
-  padding:2px 0 2px 5px;
-  font-size:13pt;
-  color:DarkBlue;
-}
-.form .textarea{
-  font-size:13pt;
-  padding:2px;
-}
-.form .message_textarea{
-  font-size:13pt;
-  padding:2px;
-  border:1px solid black;
-  height: 200px;
-}
-.form .submit{
-  font-size:16pt;
-}
-.article_buttons{
-  margin:0 0 10px 0;
-  padding:0 0 5px 0;
-  border-bottom:1px dashed gray;
-}
-.article_buttons input{
-  margin-right:10px;
-}
-.submit_button{
-  margin-bottom:10px;
-}
-.moderation_buttons{
-  background:silver;
-  margin:3px 3px 10px 3px;
-  padding:5px;
-  border:2px solid blue;
-}
-.delete_button{
-  background: none repeat scroll 0 0 lightGrey;
-  border: 1px dashed gray;
-  padding: 5px 0;
-  text-align: right;
-}
-.delete_button input{
-  color:Crimson;
-}
+.the_role{
+  .the_form{
+    background:#EEE;
+    padding:5px;
+    margin:0 0 15px 0;
+    border:2px solid gray;
+    -moz-border-radius:5px;
+  }
+  .the_form label{
+    display:block;
+  }
+  .the_form .input{
+    border:1px solid #000;
+    padding:2px 0 2px 5px;
+    font-size:13pt;
+    color:DarkBlue;
+  }
+  .the_form .textarea{
+    font-size:13pt;
+    padding:2px;
+  }
+  .the_form .message_textarea{
+    font-size:13pt;
+    padding:2px;
+    border:1px solid black;
+    height: 200px;
+  }
+  .the_form .submit{
+    font-size:16pt;
+  }
+  .article_buttons{
+    margin:0 0 10px 0;
+    padding:0 0 5px 0;
+    border-bottom:1px dashed gray;
+  }
+  .article_buttons input{
+    margin-right:10px;
+  }
+  .submit_button{
+    margin-bottom:10px;
+  }
+  .moderation_buttons{
+    background:silver;
+    margin:3px 3px 10px 3px;
+    padding:5px;
+    border:2px solid blue;
+  }
+  .delete_button{
+    background: none repeat scroll 0 0 lightGrey;
+    border: 1px dashed gray;
+    padding: 5px 0;
+    text-align: right;
+  }
+  .delete_button input{
+    color:Crimson;
+  } 
+}

data/app/assets/stylesheets/the_role/headers.css.scss

@@ -1,13 +1,15 @@
-h1,h2,h3,h4,h5,h6{
-  font-family: Verdana, Arial;
-  color:#333;
-  font-weight:normal;
-  line-height:100%;
-  margin-bottom:15px;
+.the_role{
+  h1,h2,h3,h4,h5,h6{
+    font-family: Verdana, Arial;
+    color:#333;
+    font-weight:normal;
+    line-height:100%;
+    margin-bottom:15px;
+  }
+  h1{font-size:3em;}
+  h2{font-size:2.8em;}
+  h3{font-size:2.6em;}
+  h4{font-size:2.4em;}
+  h5{font-size:2.2em;}
+  h6{font-size:2em;}  
 }
-h1{font-size:3em;}
-h2{font-size:2.8em;}
-h3{font-size:2.6em;}
-h4{font-size:2.4em;}
-h5{font-size:2.2em;}
-h6{font-size:2em;}

data/app/assets/stylesheets/the_role/style.css.scss

@@ -1,76 +1,75 @@
-.body{
-  width: 900px;
-  margin:auto;
-  font:Tahoma;
-  font-family:Tahoma,Trebuchet MS,Times New Roman;
-}
-img, p, pre, blockquote, dd, dt, caption, legend, label{
-  font-size: 2em;
-}
-ul.index{
-  p{
-    padding: 5px;
-    &:hover{
-      background: #DDD;
-
+.the_role{
+  ul.index{
+    position: relative;
+    li{
+      position: relative;
+      p{
+        border-bottom: 1px solid Lavender;
+        font-size: 16px;
+        margin-bottom: 10px;
+        padding: 5px;
+        &:hover{ background: #EEE; }
+        a.delete{
+          position: absolute;
+          bottom: 5px; right: 0;
+          color: IndianRed;
+        }
+      }
     }
-    a.delete{
-      float: right;
+  }//ul.index
+
+  h4{
+    position: relative;
+    padding: 5px;
+    background: LightBlue;
+    .controls{
+      a{
+        color: blue;
+      }
     }
   }
-}//ul.index
 
-h4{
-  position: relative;
-  padding: 5px;
-  background: LightBlue;
   .controls{
-    a{
-      color: blue;
-    }
+    position:absolute;
+    right:10px;
+    top:10%;
+    zoom:1;
+    padding-bottom:6px;
+  }
+  .controls a{
+    margin:0 10px;
+    font-size:10pt;
+    color:#CCC;
+    border:1px solid transparent;
+    padding:3px;
+    text-decoration:none;
+  }
+  .controls a:hover{
+    color:#999;
+    border:1px solid #999;
+  }
+  ul.rights{
+    margin:0 0 20px;
+  }
+  ul.rights li{
+    margin:0 0 5px 20px;
+    position:relative;
+    zoom:1;
+    border-bottom:1px solid #EEE;
+    padding: 5px 0;
+    font-size:9pt;
+  }
+  ul.rights li .controls{
+    top:10%;
+    right:5px;
+    padding:5px;
+  }
+  form.new_action{
+    padding:15px;
+    background:#EEE;
+    margin:0 0 50px 0;
+  }
+  form{
+    margin:0 0 50px 0;
   }
 }
-
-.controls{
-  position:absolute;
-  right:10px;
-  top:10%;
-  zoom:1;
-  padding-bottom:6px;
-}
-.controls a{
-  margin:0 10px;
-  font-size:10pt;
-  color:#CCC;
-  border:1px solid transparent;
-  padding:3px;
-  text-decoration:none;
-}
-.controls a:hover{
-  color:#999;
-  border:1px solid #999;
-}
-ul.rights{
-  margin:0 0 20px;
-}
-ul.rights li{
-  margin:0 0 5px 20px;
-  position:relative;
-  zoom:1;
-  border-bottom:1px solid #EEE;
-  padding: 5px 0;
-  font-size:9pt;
-}
-ul.rights li .controls{
-  top:10%;
-  right:5px;
-  padding:5px;
-}
-form.new_action{
-  padding:15px;
-  background:#EEE;
-  margin:0 0 50px 0;
-}
-form{
-  margin:0 0 50px 0;
-}