the_role 2.3 → 2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77b00593bcd32d2fee50327a0c3fab22fbadf482
-  data.tar.gz: 269eb319746ed8f82864259c20ba46439ea59390
+  metadata.gz: 390002fab78f75cdae9b6aa2f354133640b21646
+  data.tar.gz: f7ef67983c17684310ec02f606454b58b921a58f
 SHA512:
-  metadata.gz: 88afca09c44fe32449d4d8ca1d7bdfa60d9ad13f2d02fdf43c3fbb29931ec99377c9e6e4bf0c632c739f40f0858ec58d55eb59bffde8cbcb1e114cba33a6f518
-  data.tar.gz: cf2b3f534ad0d7a949590a563d722e9048161a91560c3db73940b08cd5db4ba72691055fab7c86d1c596ed408fa99a22cf8a5c0389a53cb3a6905c0d796e2b0b
+  metadata.gz: e0512d3c687adf75d494cfee54b1fde431295bc0b59ccd677f3666b9949ea166f7b2a05c19f22192ff54f636de59835e58e3177db11403feee0f4a148339601c
+  data.tar.gz: 172dc91e2f26a1a1dd1f979302c59a7fe7186caff13c404472ed80ac387fa701160cd467a647133c2ba8474f37de8fdb01ab031a0f94935591bd5fc2d6cd1cd7

data/README.md

@@ -13,12 +13,16 @@
 </tr>
 <tr>
 <td><img src="https://github.com/the-teacher/the_role/raw/master/Bye_bye_CanCan_I_got_the_Role.png" alt="Bye bye CanCan, I got The Role!"></td>
-<td>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 <b>sections</b> and nested <b>rules</b>.<br><br><b>Section</b> may be associated with <b>controller</b> name.<br><br><b>Rule</b> may be associated with <b>action</b> name.<br><br>Section can have many rules.<br><br>Rule can have <b>true</b> or <b>false</b> value<br><br><b>Sections</b> and nested <b>Rules</b> provide <b>ACL</b> (<b>Access Control List</b>)<br><br>Role <b>stored in the database as JSON</b> string.<br><br>Using of hashes, makes role system extremely easy to configure and use.<br></td>
+<td>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 stored in the database as a JSON string.<br><br>TheRole - Semantic, lightweight role system with an administrative interface.<br><br>Role is a two-level hash, consisting of the <b>sections</b> and nested <b>rules</b>.<br><br>A <b>Section</b> may be associated with a <b>controller</b> name.<br><br>A <b>Rule</b> may be associated with an <b>action</b> name.<br><br>A Section can have many rules.<br><br>A Rule can be <b>true</b> or <b>false</b>.<br><br><b>Sections</b> and nested <b>Rules</b> provide an <b>ACL</b> (<b>Access Control List</b>)<br><br><br>Using hashes, makes role system extremely easy to configure and use.<br></td>
 </tr>
 </table>  
 
 ### GUI
 
+:warn: UI moved in **the_role_bootstrap3_ui** gem
+
+We are waiting for **foundation** version of UI
+
 <table>
 <tr>
   <td>TheRole management web interface => localhost:3000/admin/roles</td>
@@ -38,18 +42,21 @@ puts following yields into your layout:
 ### Rails 4 version
 
 ```
-gem 'the_role', '~> 2.0.0'
+gem 'the_role', '~> 2.4'
+
+gem 'the_role_bootstrap3_ui'
 ```
 
+Please read *the_role_bootstrap3_ui* docs to know more about assets
+
 ## If you have any questions
 
-Please before ask anything try to launch and play with **[Dummy App](spec/dummy_app)** in spec folder. Maybe example of integration will be better than any documentation. Thank you!
+Please, before asking anything try to launch and play with the **[Dummy App](spec/dummy_app)** in the spec folder. Maybe an example integration will be better than any documentation. Thank you!
 
 ### Instalation
 
 * [INSTALL](#install)
 * [INTEGRATION](#integration)
-* [Assets and Bootstrap](#assets-and-bootstrap)
 * [Configuration (optional)](#configuration)
 
 ### Understanding
@@ -88,7 +95,7 @@ bundle exec rails g the_role --help
 
 ### Change User migration
 
-Add **role_id:integer** field to your User Model
+Add a **role_id:integer** field to your User Model
 
 ```ruby
 def self.up
@@ -142,7 +149,7 @@ install TheRole migrations
 rake the_role_engine:install:migrations
 ```
 
-Invoke migration
+Invoke migrations
 
 ```ruby
 rake db:migrate
@@ -185,7 +192,7 @@ end
 create the_role config:
 
 ```
-bundle exec rails g the_role setup
+bundle exec rails g the_role config
 ```
 
 **config/initializers/the_role.rb**
@@ -202,7 +209,7 @@ TheRole.configure do |config|
 end
 ```
 
-#### Using with any controller
+#### Usage with any controller
 
 ```ruby
 class PagesController < ApplicationController
@@ -229,35 +236,26 @@ class PagesController < ApplicationController
 end
 ```
 
-### Assets and Bootstrap
+**integration with Inhirited Resource**
 
-**application.css**
-
-```
-//= require bootstrap
-```
-
-**application.js**
-
-```
-//= require jquery
-//= require jquery_ujs
-
-//= require bootstrap
-//= require the_role_editinplace
+```ruby
+  def owner_required
+    @owner_check_object = resource
+    super
+  end
 ```
 
 ## Understanding
 
 #### TheRole instead of CanCan?
 
-TheRole in contrast to CanCan has simple and predefined way to find access state of current role. If you don't want to create your own role scheme with CanCan Abilities - TheRole can be a great solution for your.
+TheRole, in contrast to CanCan, has a simple and predefined way to find the access state of the current role. If you don't want to create your own role scheme with CanCan Abilities - TheRole can be a great solution for you.
 
-You can manage roles with simple UI. TheRole's ACL structure is inspired by Rails controllers, that is why it's so great for Rails application.
+You can manage roles with a simple UI. TheRole's ACL structure is inspired by Rails' controllers, that's why it's so great for Rails applications.
 
-#### What does it mean semantic?
+#### What does semantic mean?
 
-Semantic - the science of meaning. Human should be able to understand fast what is happening in a role system.
+Semantic - the science of meaning. Humans should be able to quickly understand what is happening in a role system.
 
 Look at the next Role hash. If you can understand access rules - this authorization system is semantic.
 
@@ -299,7 +297,7 @@ But, also, you can use virtual names of sections, and virtual names of section's
 
 And you can use them as well as other access rules.
 
-#### Using with Views
+#### Usage within Views
 
 ```ruby
 <% if @user.has_role?(:twitter, :button) %>
@@ -311,11 +309,11 @@ And you can use them as well as other access rules.
 
 #### Who is Administrator?
 
-Administrator is the user who can access any section and the rules of your application.
+Administrator is the user who can access any section and rules of your application.
 
 Administrator is the owner of any objects in your application.
 
-Administrator is the user, which has virtual section **system** and rule **administrator** in the role-hash.
+Administrator is the user, who has a virtual section **system** and a rule **administrator** in the role-hash.
 
 
 ```ruby
@@ -328,13 +326,13 @@ admin_role_fragment = {
 
 #### Who is Moderator?
 
-Moderator is the user, which has access to any actions of some section(s).
+Moderator is the user, who has access to any actions of some section(s).
 
 Moderator is the owner of any objects of some class.
 
-Moderator is the user, which has a virtual section **moderator**, with **section name** as rule name.
+Moderator is the user, who has a virtual section **moderator**, with **section name** as rule name.
 
-There is Moderator of Pages (controller) and Twitter (virtual section)
+An example of a Moderator of Pages (controller) and Twitter (virtual section)
 
 ```ruby
 moderator_role_fragment = {
@@ -352,7 +350,7 @@ Administrator is owner of any object in system.
 
 Moderator of pages is owner of any page.
 
-User is owner of object, when **Object#user_id == User#id**.
+User is owner of objects, when **Object#user_id == User#id**.
 
 
 # API
@@ -364,13 +362,13 @@ User is owner of object, when **Object#user_id == User#id**.
 @user.role # => Role obj
 ```
 
-Is it Administrator?
+Is a user Administrator?
 
 ```ruby
 @user.admin?                       => true | false
 ```
 
-Is it Moderator?
+Is a user Moderator?
 
 ```ruby
 @user.moderator?(:pages)           => true | false
@@ -378,7 +376,7 @@ Is it Moderator?
 @user.moderator?(:articles)        => true | false
 ```
 
-Has user got an access to **rule** of **section** (action of controller)?
+Has user got access to **rule** of **section** (action of controller)?
 
 ```ruby
 @user.has_role?(:pages,    :show)  => true | false
@@ -451,7 +449,7 @@ Is user **Owner** of object?
 
 ```ruby
 # Incoming hash is true-mask-hash
-# All the rules of the Role will be reseted to false
+# All the rules of the Role will be reset to false
 # Only rules from true-mask-hash will be set true
 new_role_hash = {
   :pages => {
@@ -475,6 +473,7 @@ new_role_hash = {
 
 #### Changelog
 
+* 2.3.0 - Refactoring
 * 2.1.0 - User#any_role? & Role#any?
 * 2.0.3 - create role fix, cleanup
 * 2.0.2 - code cleanup, readme

data/config/locales/pl.yml

@@ -14,7 +14,8 @@ pl:
     section_not_deleted:      Sekcja nie skasowana
     section_rule_deleted:     "Reguła skasowana"
     section_rule_not_deleted: "Reguła nie skasowana"
-
+    access_denied: "Odmowa dostępu"
+    
   admin:
     roles:
       new:
@@ -39,4 +40,4 @@ pl:
       sidebar:
         roles_list: Lista ról
         new_role: Utwórz nową rolę
-        delete_role_confirm: 'Jesteś pewien? To może być niebezpieczne!'
+        delete_role_confirm: 'Czy jesteś pewien? To może być niebezpieczne!'

data/config/locales/pt_BR.yml

@@ -0,0 +1,43 @@
+pt-BR:
+  the_role:
+    role_created:             Papel criado
+    role_updated:             Papel atualizado
+    role_deleted:             Papel excluído
+    section_created:          Seção criada
+    section_not_created:      Sessão não foi criada
+    section_rule_created:     "Regra de sessão criada"
+    section_rule_not_created: "Regra de sessão não foi criada"
+    section_rule_on:          "Regra de sessão habilitada"
+    section_rule_off:         "Regra de sessão desabilitada"
+    state_not_changed:        "Regra de sessão não alterada"
+    section_deleted:          Sessão excluída
+    section_not_deleted:      Sessão não foi excluída
+    section_rule_deleted:     "Regra de sessão excluída"
+    section_rule_not_deleted: "Regra de sessão não foi excluída"
+    access_denied: "Acesso negado"
+
+  admin:
+    roles:
+      new:
+        create: Criar novo Papel
+        name: "Nome do Papel (caracteres latinos, com underscore)"
+        title: Título do papel (texto)
+        description: Descrição do papel (texto)
+      role:
+        role_name: 'Nome do papel:'
+        title:     'Título:'
+        role_description: 'Descrição do papel:'
+        delete_section: Excluir sessão
+        section_delete_confirm: 'Deseja excluir a sessão?'
+        rule_delete_confirm: 'Deseja excluir a regra?'
+        enable: Habilitar
+        disable: Desabilitar
+        delete_rule: Excluir regra
+        new_section_placeholder: Nome da nova sessão
+        create_section: Criar nova sessão
+        new_rule_placeholder: Nome da nova regra
+        create_rule: Criar nova regra
+      sidebar:
+        roles_list: Lista de Papéis
+        new_role: Criar novo papel
+        delete_role_confirm: 'Tem certeza? Isto pode ser perigiso!'

data/lib/generators/the_role/the_role_generator.rb

@@ -13,7 +13,7 @@ class TheRoleGenerator < Rails::Generators::NamedBase
     elsif gen_name == 'admin'
       create_admin_role
     else
-      puts 'TheComments Generator - wrong Name'
+      puts 'TheRole Generator - wrong Name'
       puts 'Try to use install'
     end
   end

data/lib/the_role/version.rb

@@ -1,3 +1,3 @@
 module TheRole
-  VERSION = "2.3"
+  VERSION = "2.4"
 end

data/lib/the_role.rb

@@ -1,5 +1,3 @@
-require 'haml'
-
 require 'the_role/hash'
 require 'the_role/config'
 require 'the_role/version'

data/spec/dummy_app/Gemfile

@@ -1,11 +1,10 @@
 source 'https://rubygems.org'
 
-gem 'rails', '~> 4.0.0'
-gem 'rake',  '~> 10.0.4'
+gem 'rails'
 
+gem 'devise'
 gem 'sqlite3'
 gem 'state_machine', '~> 1.2.0'
-gem 'devise', git: 'https://github.com/plataformatec/devise.git'
 
 gem 'sprockets-rails', github: 'rails/sprockets-rails'
 gem 'coffee-rails',    github: 'rails/coffee-rails'
@@ -19,8 +18,10 @@ gem 'uglifier'
 gem 'jquery-rails'
 gem 'jbuilder', '~> 1.0.1'
 
-gem 'the_role' , path: '../../'
-gem 'haml' ,     git: 'https://github.com/haml/haml.git', tag: '4.0.1'
+gem 'the_role', path: '../../'
+gem 'the_role_bootstrap3_ui',
+  github: 'the-teacher/the_role_bootstrap3_ui',
+  branch: 'master'
 
 group :test do
   gem 'factory_girl_rails', '~> 4.0'

data/spec/dummy_app/README.md

@@ -7,7 +7,7 @@ App for development and testing TheRole gem
 ```
 git clone git@github.com:the-teacher/the_role.git
 
-cd the_role/spec/the_role_on_devise/
+cd the_role/spec/dummy_app/
 
 bundle
 ```
@@ -15,7 +15,7 @@ bundle
 ### Start it!
 
 ```
-rake db:test_launch
+rake db:bootstrap_and_seed
 
 rails s
 ```
@@ -36,4 +36,4 @@ rake assets:build   RAILS_ENV=production
 rake db:test_launch RAILS_ENV=production
 
 rails s -e production
-```
+```

data/the_role.gemspec

@@ -19,5 +19,4 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency 'rails', ['>= 3', '< 5']
-  s.add_dependency 'haml'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: the_role
 version: !ruby/object:Gem::Version
-  version: '2.3'
+  version: '2.4'
 platform: ruby
 authors:
 - Ilya N. Zykin [the-teacher]
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-15 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,20 +30,6 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: '5'
-- !ruby/object:Gem::Dependency
-  name: haml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Authorization for Rails 4 with Web Interface
 email:
 - zykin-ilya@ya.ru
@@ -60,8 +46,6 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- app/assets/javascripts/.keep
-- app/assets/javascripts/the_role_editinplace.js.coffee
 - app/controllers/admin/role_sections_controller.rb
 - app/controllers/admin/roles_controller.rb
 - app/controllers/concerns/controller.rb
@@ -69,14 +53,10 @@ files:
 - app/models/concerns/base.rb
 - app/models/concerns/role.rb
 - app/models/concerns/user.rb
-- app/views/admin/roles/_role.html.haml
-- app/views/admin/roles/_sidebar.html.haml
-- app/views/admin/roles/edit.html.haml
-- app/views/admin/roles/index.haml
-- app/views/admin/roles/new.html.haml
 - config/locales/en.yml
 - config/locales/es.yml
 - config/locales/pl.yml
+- config/locales/pt_BR.yml
 - config/locales/ru.yml
 - config/locales/zh_CN.yml
 - config/routes.rb

data/app/assets/javascripts/the_role_editinplace.js.coffee

@@ -1,32 +0,0 @@
-showForm = (item) ->
-  holder = item.parents('.holder')
-  a_item = holder.children('span.a')
-  b_item = holder.children('span.b')
-
-  a_item.hide().off 'click'
-  b_item.css('visibility', 'visible')
-
-  holder.find('.btn-warning').click ->
-    item = $ @ 
-    hideForm item
-    item.parents('form')[0].reset()
-
-  holder.find('.btn-success').click ->
-    $(@).parents('form')[0].submit()
-  
-  b_item.find('input').keypress (event) ->
-    ENTER = 13
-    form  = $(event.target).parents('form')
-    form.submit() if event.which is ENTER
-
-hideForm = (item) ->
-  holder = item.parents('.holder')
-  a_item = holder.children('span.a')
-  b_item = holder.children('span.b')
-  
-  a_item.show()
-  b_item.css('visibility', 'hidden')
-  holder.find('.btn').off('click')
-  a_item.click -> showForm item
-
-$ -> $('span.a', 'h3, h5').click -> showForm $(@)

data/app/views/admin/roles/_role.html.haml

@@ -1,97 +0,0 @@
-- content_for :role_update_btn_set do
-  .btn-group
-    %a.btn.btn-warning
-      %i.icon-repeat.glyphicon.glyphicon-repeat
-    %a.btn.btn-success
-      %i.icon-ok.glyphicon.glyphicon-ok
-
-- content_for :role_main do
-  - hidden = 'visibility:hidden'
-  .panel.panel-primary
-    .panel-heading Role Info (edit in place)
-    .panel-body
-      = form_for(role, url: change_admin_role_path(role), html: { class: "form-inline" } ) do |f|
-        .row
-          .col-md-12
-            %h3.holder
-              = t '.role_name'
-              %span.a= role.name
-              %span.b{ style: hidden }
-                .form-group= f.text_field :name, class: "form-control"
-                = yield(:role_update_btn_set)
-
-        .row
-          .col-md-12
-            %h5.holder
-              = t '.title'
-              %span.a= role.title
-              %span.b{ style: hidden }
-                .form-group= f.text_field :title, class: "form-control"
-                = yield(:role_update_btn_set)
-
-        .row
-          .col-md-12
-            %h5.holder
-              = t '.role_description'
-              %span.a= role.description
-              %span.b{ style: hidden }
-                .form-group= f.text_field :description, class: "form-control"
-                = yield(:role_update_btn_set)
-
-  .panel.panel-primary
-    .panel-heading Role rules
-    .panel-body
-      - role.to_hash.each_pair do |section, rules|
-        .panel.panel-info
-          .panel-heading
-            .row
-              .col-md-9
-                %h5= section
-              .col-md-3
-                .delete
-                  .btn-group
-                    = button_to t('.delete_section'), admin_role_section_path(role, section), method: :delete, class: 'btn btn-danger', data: { confirm: t('.section_delete_confirm') }
-
-          .panel-body
-            .rules
-              - rules.each_pair do |rule, value|
-                .row
-                  .col-md-9
-                    %h4
-                      →
-                      = rule
-                  .col-md-3
-                    .controls
-                      .btn-group
-                        - klass = value ? :success : :info
-                        - state = value ? t('.enable') : t('.disable')
-                        %button{ class: "btn btn-#{klass}" }= state
-                        %button{ class: "btn btn-#{klass} dropdown-toggle", 'data-toggle' => :dropdown }
-                          %span.caret
-                        %ul.dropdown-menu
-                          %li.success= link_to t('.enable'),  rule_on_admin_role_section_path(role, section, :name => rule), :method => :put
-                          %li.info=    link_to t('.disable'), rule_off_admin_role_section_path(role, section, :name => rule), :method => :put
-                          %li.divider
-                          %li.error= link_to t('.delete_rule'), destroy_rule_admin_role_section_path(role, section, :name => rule), method: :delete, data: { confirm: t(".rule_delete_confirm") }
-
-  .panel.panel-success
-    .panel-heading
-      = t '.create_section'
-    .panel-body
-      = form_tag admin_role_sections_path(role), class: "form-inline"do |f|
-        .form-group
-          = text_field_tag :section_name, '', class: "form-control", placeholder: t('.new_section_placeholder')
-        = submit_tag t('.create_section'), class: "btn btn-success"
-
-  .panel.panel-success
-    .panel-heading
-      = t '.create_rule'
-    .panel-body
-      = form_tag create_rule_admin_role_sections_path(role), role: :form, class: "form-inline" do |f|
-        .form-group
-          %select.form-control{ name: :section_name }
-            - role.to_hash.each_pair do |section, rules|
-              %option{ value: section }= section
-        .form-group
-          = text_field_tag :rule_name, '', class: "form-control", placeholder: t('.new_rule_placeholder')
-        = submit_tag t('.create_rule'), class: "btn btn-success"

data/app/views/admin/roles/_sidebar.html.haml

@@ -1,18 +0,0 @@
-- content_for :role_sidebar do
-  .panel.panel-primary
-    .panel-heading Role Nav
-    .panel-body
-      %h4= link_to raw('← Home'), root_path
-
-  .panel.panel-primary
-    .panel-heading= t '.roles_list'
-    .panel-body
-  
-      - (@roles || Role.all).each do |role|
-        %p
-          = link_to role.title, edit_admin_role_url(role)
-          (#{role.users.count})
-          = link_to admin_role_url(role), method: :delete, title: role.title, confirm: t('.delete_role_confirm'), class: :delete do
-            %i.icon-remove.glyphicon.glyphicon-remove
-
-      %p.new= link_to t('.new_role'),  new_admin_role_path

data/app/views/admin/roles/edit.html.haml

@@ -1,2 +0,0 @@
-= render partial: 'sidebar'
-= render partial: 'role', locals: { role: @role }

data/app/views/admin/roles/index.haml

@@ -1,2 +0,0 @@
-= render partial: 'sidebar'
-= render partial: 'role', locals: { role: @roles.first }

data/app/views/admin/roles/new.html.haml

@@ -1,25 +0,0 @@
-= render partial: 'sidebar'
-
-- content_for :role_main do
-  - unless @role.errors.blank?
-    - @role.errors.each do |field, message|
-      .alert.alert-danger
-        %b= t(".#{field}")
-        \:
-        = message
-
-  .panel.panel-success
-    .panel-heading= raw t('.create')
-
-    .panel-body
-      = form_for(@role, url: admin_roles_path, role: :form) do |f|
-        %label= t('.name')
-        %p= f.text_field :name, class: "form-control"
-
-        %label= t('.title')
-        %p= f.text_field :title, class: "form-control"
-
-        %label= t('.description')
-        %p= f.text_field :description, class: "form-control"
-
-        = f.submit t('.create'), class: "btn btn-success"