burlesque 1.0.0 → 2.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -9,7 +9,7 @@ Installation
 Before you can use the generator, add the gem to your project's Gemfile as follows:
 
 ```
-gem 'burlesque', :git => 'git@gitlab.acid.cl:burlesque.git'
+gem 'burlesque'
 ```
 
 Then install it by running:
@@ -18,13 +18,27 @@ Then install it by running:
 bundle install
 ```
 
-Finally, bootstrap your Rails app, for example:
+After, bootstrap your Rails app, for example:
 
 ```
-rails generate burlesque:install
+rake burlesque:install:migrations
 rake db:migrate
 ```
 
+If you would like to run migrations only from Burlesque engine, you can do it by specifying SCOPE:
+
+```
+rake db:migrate SCOPE=burlesque
+```
+
+Finally, in model that you need burlesque:
+
+```
+include Burlesque::Admin
+```
+
+
+
 CanCan
 ------
 
@@ -47,3 +61,8 @@ end
 ```
 
   [cancan]: https://github.com/ryanb/cancan
+
+Todo
+----
+
+Rake task for burlesque admin module inclusion.

data/Rakefile

@@ -1 +1,40 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Burlesque'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/burlesque/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/burlesque/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/burlesque/application_controller.rb

@@ -0,0 +1,4 @@
+module Burlesque
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/burlesque/application_helper.rb

@@ -0,0 +1,4 @@
+module Burlesque
+  module ApplicationHelper
+  end
+end

data/app/models/burlesque/admin_group.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+# Public: Modelo intermedio, permite que un Grupo pueda ser asignado a un 'Administrador',
+#         Este administrador puede ser cualquier modelo que incluya el modulo 'Burlesque::Admin'
+#
+module Burlesque
+  class AdminGroup < ActiveRecord::Base
+    belongs_to :group
+    belongs_to :adminable, polymorphic: true
+
+    validates_uniqueness_of :group_id, scope: [:adminable_id, :adminable_type], message: I18n.t('errors.messages.group_taken')
+
+    after_create :add_new_roles_to_admin
+
+    private
+    def add_new_roles_to_admin
+      group.roles.each do |role|
+        adminable.roles << role unless adminable.roles.include? role
+      end
+    end
+  end
+end

data/app/models/burlesque/admin_role.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+# Public: Modelo intermedio, permite que un Role pueda ser asignado a un 'Administrador',
+#         Este administrador puede ser cualquier modelo que incluya el modulo 'Burlesque::Admin'
+#
+module Burlesque
+  class AdminRole < ActiveRecord::Base
+    belongs_to :role
+    belongs_to :authorizable, polymorphic: true
+
+    validates_uniqueness_of :role_id, scope: [:authorizable_id, :authorizable_type], message: I18n.t('errors.messages.role_taken')
+  end
+end

data/app/models/burlesque/group.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+
+# Public: Modelo que maneja Grupos
+#
+module Burlesque
+  class Group < ActiveRecord::Base
+    has_many :role_groups
+    has_many :roles, through: :role_groups, dependent: :destroy, after_remove: :remove_roles_from_admin
+
+    has_many :admin_groups, dependent: :destroy
+    # for has_many :admins relations see admins function
+
+    attr_accessible :name, :role_ids
+
+    validates :name, presence: true, uniqueness: true
+
+    # Public: Relacion a muchos usuarios
+    #
+    # Se usa esta funcion dado que la tabla de administrador es polimorfica.
+    #
+    # Returns los administradores que tienen el rol en cuestion.
+    def admins
+      admin_groups.map &:adminable
+    end
+
+    # Public: Indica si el grupo tiene un rol en particular.
+    #
+    # role -  el rol que se quiere consultar, puede ser un Role o Role.name
+    #
+    # Returns Boolean.
+    def role? role
+      role_name = role.respond_to?(:name) ? role.name : role
+      self.roles.map(&:name).include?(role_name.to_s)
+    end
+
+    # Public: Setea los roles que se indican al grupo.
+    # Eliminando los roles que no esten en la lista.
+    #
+    # ids - id's de los Roles que se desean asignar destructivamente.
+    #
+    # Returns nothing.
+    def role_ids=(ids)
+      ids.each do |ri|
+        if ri.presence
+          role = ::Role.find(ri)
+          self.roles << role unless self.roles.include? role
+        end
+      end
+
+      to_deletes = []
+      role_groups.each do |rg|
+        role = rg.role
+        to_deletes << role unless ids.include?(role.id.to_s) or ids.include?(role.id)
+      end
+
+      to_deletes.each do |role|
+        self.roles.delete(role) if self.roles.include?(role)
+      end
+    end
+
+    # Public: Permite agregar un grupo de Roles al Grupo
+    # No elimina los roles que no esten en la lista, solo agrega los que no estan.
+    #
+    # new_roles - el arreglo de roles que se quiere agregar al grupo
+    #
+    # Returns nothing.
+    def push_roles new_roles
+      new_roles.each do |role|
+        self.roles << role unless self.roles.include? role
+      end
+    end
+
+    private
+    # Public: Permite que al eliminar un rol de un grupo, tambien se modifiquen los roles de los administradores asociados a ese grupo.
+    #
+    # role -  el rol que se elimino del grupo.
+    #
+    # Returns nothing.
+    def remove_roles_from_admin role
+      admins.each do |admin|
+        if admin.admin_roles.map(&:role_id).include?(role.id) and not admin.role_in_groups?(role.name)
+          admin.admin_roles.find_by_role_id(role.id).destroy
+        end
+      end
+    end
+  end
+end

data/app/models/burlesque/role.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+
+# Public: Modulo que maneja Roles.
+#         Un Role es un permiso que permite a un usuario a realizar una determinada acción sobre un modelo
+#
+module Burlesque
+  class Role < ActiveRecord::Base
+    attr_accessible :name
+
+    has_many :role_groups
+    has_many :groups, through: :role_groups, dependent: :destroy
+
+    has_many :admin_roles, dependent: :destroy
+    # for has_many :admins relations see admins function
+
+    attr_accessible :name
+    validates :name, presence: true, uniqueness: true
+
+    SPLITER = '#'
+
+    scope :action,        lambda { |action| where('name LIKE ?',     "%#{SPLITER}#{action}")     }
+    scope :not_action,    lambda { |action| where('name NOT LIKE ?', "%#{SPLITER}#{action}")     }
+    scope :resource,      lambda { |model|  where('name LIKE ?',     "#{model.to_s}#{SPLITER}%") }
+    scope :not_resource,  lambda { |model|  where('name NOT LIKE ?', "#{model.to_s}#{SPLITER}%") }
+
+    # Public: Relacion a muchos usuarios
+    #
+    # Se usa esta funcion dado que la tabla de administrador es polimorfica.
+    #
+    # Returns los administradores que tienen el rol en cuestion.
+    def admins
+      admin_roles.map &:authorizable
+    end
+
+    # Public: Traduce el nombre de un rol.
+    #
+    # Primero revisa si existe una traducción para el rol bajo el scope de autorizaciones,
+    # luego si el no existe una traducción intenta traducir el nombre del rol usando la
+    # traduccion de Burleque, que traduce la acción por defecto e intenta usar las traducciones
+    # definidas para cada modelo
+    #
+    # Returns el nombre del rol ya traducido.
+    def translate_name
+      translate = I18n.t(name.to_sym, scope: :authorizations)
+      return translate unless translate.include?('translation missing:')
+
+      translate = I18n.t(action_sym, scope: :authorizations) + ' ' + resource_class.model_name.human
+    end
+
+    # Public: Entrega el recurso asociado al rol.
+    #
+    # Returns Constant.
+    def resource_class
+      name.split('#', 2).first.pluralize.classify.constantize
+    end
+
+    # Public: Entrega la accion asociada al rol.
+    #
+    # Returns Symbol.
+    def action_sym
+      name.split('#', 2).last.to_sym
+    end
+
+    # Public: Entrega la accion y modelo asociado al rol.
+    #
+    # Returns Symbol.
+    def get_action_and_model
+      [action_sym, resource_class]
+    end
+
+    # TODO
+    # Mejorar el retorno, para saber que paso, ej: si se agregaron los 5 roles o si ya existen
+    def self.for model
+      if model.class == String
+        resource = model.classify.constantize.model_name.underscore
+      elsif model.class == Symbol
+        resource = model.to_s.classify.constantize.model_name.underscore
+      elsif model.class == Class
+        resource = model.model_name.underscore
+      end
+
+      if resource
+        self.create(name: "#{resource}#{SPLITER}read")     unless self.where(name: "#{resource}#{SPLITER}read"   ).any?
+        self.create(name: "#{resource}#{SPLITER}create")   unless self.where(name: "#{resource}#{SPLITER}create" ).any?
+        self.create(name: "#{resource}#{SPLITER}update")   unless self.where(name: "#{resource}#{SPLITER}update" ).any?
+        self.create(name: "#{resource}#{SPLITER}destroy")  unless self.where(name: "#{resource}#{SPLITER}destroy").any?
+      else
+        raise I18n.t('errors.messages.invalid_param', param: model.class)
+      end
+    end
+  end
+end

data/app/models/burlesque/role_group.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+# Public: Modulo intermedio, permite que un Role pueda ser asignado a un Grupo
+#
+module Burlesque
+  class RoleGroup < ActiveRecord::Base
+    belongs_to :role
+    belongs_to :group
+
+    validates_uniqueness_of :role_id, scope: :group_id, message: I18n.t('errors.messages.role_taken')
+
+    after_save :add_new_roles_to_admin
+
+    private
+    # Public: Actualiza los roles de los administradores luego de haber actualizado el grupo de roles.
+    #
+    # Returns nothing.
+    def add_new_roles_to_admin
+      group.admins.each do |admin|
+        admin.roles << self.role unless admin.roles.include?(self.role)
+      end
+    end
+  end
+end

data/app/views/layouts/burlesque/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Burlesque</title>
+  <%= stylesheet_link_tag    "burlesque/application", :media => "all" %>
+  <%= javascript_include_tag "burlesque/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Burlesque::Engine.routes.draw do
+end

data/db/migrate/20130725210208_create_burlesque_groups.rb

@@ -0,0 +1,9 @@
+class CreateBurlesqueGroups < ActiveRecord::Migration
+  def change
+    create_table :burlesque_groups do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130725210428_create_burlesque_roles.rb

@@ -0,0 +1,9 @@
+class CreateBurlesqueRoles < ActiveRecord::Migration
+  def change
+    create_table :burlesque_roles do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130725214806_create_burlesque_admin_groups.rb

@@ -0,0 +1,15 @@
+class CreateBurlesqueAdminGroups < ActiveRecord::Migration
+  def change
+    create_table :burlesque_admin_groups do |t|
+      t.references  :group
+
+      t.integer     :adminable_id
+      t.string      :adminable_type
+
+      t.timestamps
+    end
+
+    add_index :burlesque_admin_groups, :group_id
+    add_index :burlesque_admin_groups, [:adminable_id, :adminable_type], name: 'by_adminable'
+  end
+end