radiant-rbac_base-extension 1.3.0

data/rbac_base_extension.rb

@@ -0,0 +1,28 @@
+# Uncomment this if you reference any of your controllers in activate
+require_dependency 'application_controller'
+
+class RbacBaseExtension < Radiant::Extension
+  version "#{File.read(File.expand_path(File.dirname(__FILE__)) + '/VERSION')}"
+  description "Allows other extensions to control access managed by the roles created here. Administrators may add and remove users from roles as needed without regard to the standard Radiant roles."
+  url "http://www.saturnflyer.com/"
+  
+  def activate
+    Radiant::Config['roles.admin.sees_everything'] = 'true' unless Radiant::Config['roles.admin.sees_everything']
+    if Role.table_exists?
+      tab 'Settings' do
+        add_item('Roles', '/admin/roles')
+      end
+      User.send :has_and_belongs_to_many, :roles
+      User.send :include, RbacSupport
+      admin.users.edit[:form].delete('edit_roles')
+      UserActionObserver.instance.send :add_observer!, Role
+    end
+    Admin::UsersController.class_eval {
+      helper Admin::AlterationsHelper
+    }
+  end
+  
+  def deactivate
+  end
+  
+end

data/spec/controllers/admin/roles_controller_spec.rb

@@ -0,0 +1,142 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Admin::RolesController do
+  let(:current_user){ mock_model(User)}
+  let(:role){mock_model(Role)}
+  before do
+    controller.stub!(:current_user).and_return(current_user)
+    current_user.stub!(:admin?).and_return(true)
+    current_user.stub(:has_role?).with(:admin).and_return(true)
+    current_user.stub(:locale).and_return(:en)
+  end
+  describe 'GET index' do
+    it "should assign all roles as roles" do
+      roles = []
+      Role.should_receive(:find).with(:all).and_return(roles)
+      get :index
+      assigns[:roles].should == roles
+    end
+  end
+  describe 'GET show' do
+    it "should find the role from the params" do
+      Role.should_receive(:find).with('1').and_return(role)
+      get :show, :id => '1'
+    end
+    it "should assign the found role as role" do
+      Role.stub!(:find).and_return(role)
+      get :show, :id => '1'
+      assigns[:role].should == role
+    end
+  end
+  describe 'POST create' do
+    it "should save a role from the params" do
+      role = mock_model(Role)
+      role.should_receive(:save!).and_return(true)
+      Role.should_receive(:new).and_return(role)
+      post :create
+    end
+    it "should redirect to the roles index" do
+      post :create
+      response.should redirect_to(admin_roles_path)
+    end
+    describe "with invalid params" do
+      before do
+        role = mock_model(Role)
+        @errors = []
+        @errors.stub!(:full_messages).and_return(['bad', 'error'])
+        role.stub!(:errors).and_return(@errors)
+        role.should_receive(:save!).and_raise(ActiveRecord::RecordInvalid.new(role))
+        Role.stub!(:new).and_return(role)
+      end
+      it "should render the index page" do
+        post :create
+        response.should render_template('index')
+      end
+      it "should set the flash error message to the record's full errors" do
+        @errors.should_receive(:full_messages).and_return('bad, error')
+        post :create
+        flash[:error].should == 'bad, error'
+      end
+    end
+  end  
+  describe 'DELETE destroy' do
+    before do
+      role.stub!(:destroy)
+      role.stub(:standard?).and_return(false)
+      Role.stub!(:find).and_return(role)
+    end
+    it "should find the role from the params" do
+      Role.should_receive(:find).with('1').and_return(role)
+      delete :destroy, :id => '1'
+    end
+    it "should destroy the found role" do
+      role.should_receive(:destroy).and_return(true)
+      delete :destroy, :id => '1'
+    end
+    it "should redirect to the roles index" do
+      delete :destroy, :id => '1'
+      response.should redirect_to(admin_roles_path)
+    end
+    describe "with invalid params" do
+      it "should redirect to the roles index" do
+        Role.should_receive(:find).with('1').and_raise(ActiveRecord::RecordNotFound.new(role))
+        delete :destroy, :id => '1'
+        response.should redirect_to(admin_roles_path)
+      end
+    end
+    describe "for a standard Radiant role" do
+      before do
+        role.stub!(:standard?).and_return(true)
+        Role.stub!(:find).and_return(role)
+      end
+      it "should redirect to the roles index" do
+        delete :destroy, :id => '1'
+        response.should redirect_to(admin_roles_path)
+      end
+      it "should not delete the role" do
+        role.should_not_receive(:destroy)
+        delete :destroy, :id => '1'
+      end
+    end
+  end
+  describe 'DELETE remove_user' do
+    before do
+      @user = mock_model(User)
+      role.stub!(:remove_user)
+      Role.stub!(:find).and_return(role)
+      User.stub!(:find).and_return(@user)
+      
+    end
+    it "should find the role from the params" do
+      Role.should_receive(:find).with('1').and_return(role)
+      delete :remove_user, :role_id => '1', :id => '2'
+    end
+    it "should find the user from the params" do
+      User.should_receive(:find).with('2').and_return(@user)
+      delete :remove_user, :role_id => '1', :id => '2'
+    end
+    it "should remove the user" do
+      role.should_receive(:remove_user).and_return(true)
+      delete :remove_user, :role_id => '1', :id => '2'
+    end
+  end
+  describe 'PUT update' do
+    before do
+      role.stub!(:update_attributes).and_return(true)
+      Role.stub!(:find).and_return(role)
+    end
+    it "should find the role from the params" do
+      Role.should_receive(:find).with('1').and_return(role)
+      put :update, :id => '1'
+    end
+    it "should update the role's attributes from the params" do
+      role_params = {'this' => 'that'}
+      role.should_receive(:update_attributes).with(role_params).and_return(true)
+      put :update, :id => '1', :role => role_params
+    end
+    it "should redirect to the role's page" do
+      put :update, :id => '1'
+      response.should redirect_to(admin_role_path(role))
+    end
+  end
+end

data/spec/controllers/admin/roles_routing_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Admin::RolesController, 'routing' do
+  describe "route generation" do
+    it "should map #users" do
+      '/admin/roles/1/users'.should route_to(:controller => "admin/roles", :action => "users", :role_id => "1")
+    end
+    it "should map #add_user" do
+      {:post => '/admin/roles/1/users/2'}.should route_to(:controller => "admin/roles", :action => "add_user", :role_id => "1", :id => "2")
+    end
+    it "should map #remove_user" do
+      { :delete => '/admin/roles/1/users/2'}.should route_to(:controller => "admin/roles", :action => "remove_user", :role_id => "1", :id => "2")
+    end
+  end
+  
+  describe "route recognition" do
+    it "should generate params for #add_user" do
+      params_from(:post, "/admin/roles/1/users/2").should == {:controller => 'admin/roles', :action => 'add_user', :role_id => '1', :id => '2'}
+    end
+    it "should generate params for #remove_user" do
+      params_from(:delete, "/admin/roles/1/users/2").should == {:controller => 'admin/roles', :action => 'remove_user', :role_id => '1', :id => '2'}
+    end
+    it "should generate params for #users" do
+      params_from(:get, "/admin/roles/1/users").should == {:controller => 'admin/roles', :action => 'users', :role_id => '1'}
+    end
+  end
+end

data/spec/helpers/admin/roles_helper_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Admin::RolesHelper do
+  describe "named routes" do
+    it "should write admin_role_user_path to '/admin/roles/:role_id/users/:id'" do
+      admin_role_user_path('1','2').should == '/admin/roles/1/users/2'
+    end
+    it "should write admin_role_users_path to '/admin/roles/:role_id/users'" do
+      admin_role_users_path('1').should == '/admin/roles/1/users'
+    end
+  end
+end

data/spec/models/role_spec.rb

@@ -0,0 +1,82 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Role do
+  
+  it "should err that role_name 'has already been taken' when saving without a unique name" do
+    Role.new.save!
+    lambda {
+      Role.new.save!
+    }.should raise_error(ActiveRecord::RecordInvalid, /is already in use/)
+  end
+  
+  it "should not err when saved with a standard Radiant Role name" do
+    lambda { Role.new(:role_name => 'admin').save! }.should_not raise_error(ActiveRecord::RecordInvalid,/may not be any of: admin, developer/)
+  end
+  
+  describe 'Role::RADIANT_STANDARDS' do
+    it "should be an array of 'admin' and 'designer'" do
+      Role::RADIANT_STANDARDS.should == ['admin','designer']
+    end
+  end
+  
+  it "should err when destroying a Radiant standard role" do
+    Role::RADIANT_STANDARDS.each do |role|
+      Role.create!(:role_name => role)
+      lambda { Role.find_by_role_name(role).destroy }.should raise_error(Role::ProtectedRoleError, /is a protected role and may not be removed/)
+    end
+  end
+  
+  it "should have a description" do
+    Role.new.respond_to?(:description).should be_true
+  end
+  it "should have an allow_empty field" do
+    Role.new.respond_to?(:allow_empty).should be_true
+  end
+  
+  describe 'remove_user' do
+    before do
+      @user = mock_model(User)
+      @users = [@user]
+      @users.stub!(:<<).and_return(true)
+      @role = Role.create!(:role_name => 'Test')
+      @role.stub!(:allow_empty).and_return(true)
+      @role.stub!(:users).and_return(@users)
+    end
+    it "should delete the user from the role" do
+      @role.users << @user
+      @users.stub!(:size).and_return(2)
+      @users.should_receive(:delete).with(@user).and_return(true)
+      @role.remove_user(@user)
+    end
+    it "should return true" do
+      @role.remove_user(@user).should be_true
+    end
+    describe "with 1 user and allow_empty set to false" do
+      before do
+        @users.should_receive(:size).and_return(1)
+        @role.should_receive(:allow_empty).and_return(false)
+      end
+      it "should not delete the user from the role" do
+        @users.should_not_receive(:delete)
+        @role.remove_user(@user)
+      end
+      it "should return false" do
+        @role.remove_user(@user).should_not be_true
+      end
+    end
+  end
+  
+  describe 'users' do
+    it "should return an array" do
+      Role.new.users.should == []
+    end
+  end
+  
+  describe "standard?" do
+    it "should return true if the role's downcased role_name is in the Radiant standard roles" do
+      @role = Role.new(:role_name => 'admin')
+      @role.standard?.should be_true
+    end
+  end
+  
+end

data/spec/models/user_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe User do
+  describe "roles" do
+    it "should return an array of roles" do
+      User.new.roles.should == []
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

data/spec/views/admin/roles/index_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+describe 'index' do
+  let(:users){[]}
+  let(:role){mock_model(Role,:role_name => 'Test', :description => 'The test role.', :users => users, :standard? => false)}
+  let(:roles){[role]}
+  before do
+    template.should_receive(:include_stylesheet).with('rbac/rbac')
+    users.stub!(:count)
+    assigns[:role] = role
+    assigns[:roles] = roles
+  end
+  it "should provide a link to edit each role" do
+    render 'admin/roles/index'
+    response.should have_tag('a[href=?]',/\/admin\/roles\/\d+/,'Test')
+  end
+end

data/spec/views/admin/roles/show_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+describe 'show' do
+  let(:role){mock_model(Role,:role_name => 'Test', :description => 'The test role.', :allow_empty => true)}
+  before do
+    template.should_receive(:include_stylesheet).with('rbac/rbac')
+    template.stub!(:include_javascript)
+    assigns[:role] = role
+  end
+  it "should display the role name" do
+    render 'admin/roles/show'
+    response.should have_tag('h1',/Test/)
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-rbac_base-extension
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 1
+  - 3
+  - 0
+  version: 1.3.0
+platform: ruby
+authors: 
+- Jim Gay
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-05 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: radiant
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :runtime
+  version_requirements: *id001
+description: Flexible user role management for Radiant.
+email: jim@saturnflyer.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- HELP_developer.md
+- README.markdown
+- Rakefile
+- VERSION
+- app/controllers/admin/roles_controller.rb
+- app/helpers/admin/alterations_helper.rb
+- app/helpers/admin/roles_helper.rb
+- app/models/role.rb
+- app/models/role_action_observer.rb
+- app/models/role_user.rb
+- app/views/admin/roles/_add_role_form.html.haml
+- app/views/admin/roles/index.html.haml
+- app/views/admin/roles/show.html.haml
+- app/views/admin/users/preferences.html.haml
+- config/locales/en.yml
+- config/routes.rb
+- cucumber.yml
+- db/migrate/001_create_roles.rb
+- db/migrate/002_create_role_users.rb
+- db/migrate/003_setup_standard_roles.rb
+- db/migrate/004_alter_roles.rb
+- db/migrate/005_add_standard_role_details.rb
+- db/migrate/006_add_user_info.rb
+- db/migrate/20100705182511_rename_role_developer_to_designer.rb
+- features/support/env.rb
+- features/support/paths.rb
+- lib/rbac_support.rb
+- lib/tasks/rbac_base_extension_tasks.rake
+- public/javascripts/rbac/admin/role_details.js
+- public/stylesheets/rbac/rbac.css
+- radiant-rbac_base-extension.gemspec
+- rbac_base_extension.rb
+- spec/controllers/admin/roles_controller_spec.rb
+- spec/controllers/admin/roles_routing_spec.rb
+- spec/helpers/admin/roles_helper_spec.rb
+- spec/models/role_spec.rb
+- spec/models/user_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/views/admin/roles/index_spec.rb
+- spec/views/admin/roles/show_spec.rb
+has_rdoc: true
+homepage: http://github.com/saturnflyer/radiant-rbac_base-extension
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: RBAC Base Extension for Radiant CMS
+test_files: 
+- spec/controllers/admin/roles_controller_spec.rb
+- spec/controllers/admin/roles_routing_spec.rb
+- spec/helpers/admin/roles_helper_spec.rb
+- spec/models/role_spec.rb
+- spec/models/user_spec.rb
+- spec/spec_helper.rb
+- spec/views/admin/roles/index_spec.rb
+- spec/views/admin/roles/show_spec.rb