hydra-role-management 1.0.0 → 1.0.1

data/app/controllers/roles_controller.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
+# Controller for managing Roles
 class RolesController < ApplicationController
   include Hydra::RoleManagement::RolesBehavior
 end
-

data/app/controllers/user_roles_controller.rb

@@ -1,5 +1,5 @@
+# frozen_string_literal: true
+# Controller for managing Roles for Users
 class UserRolesController < ApplicationController
   include Hydra::RoleManagement::UserRolesBehavior
 end
-
-

data/app/models/concerns/hydra/role_management/legacy_attribute_handling.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 module Hydra
   module RoleManagement
+    # Module for ensuring compatibility with Rails releases earlier than 4.0
     module LegacyAttributeHandling
       extend ActiveSupport::Concern
       included do

data/app/models/concerns/hydra/role_management/user_roles.rb

@@ -1,30 +1,31 @@
+# frozen_string_literal: true
 module Hydra
   module RoleManagement
+    # Module offering methods for user behavior managing roles and groups
     module UserRoles
       extend ActiveSupport::Concern
+
       included do
         has_and_belongs_to_many :roles
       end
 
       def groups
         g = roles.map(&:name)
-        g += ['registered'] unless new_record? || guest? 
+        g += ['registered'] unless new_record? || guest?
         g
       end
 
       def guest?
         if defined?(DeviseGuests)
-          read_attribute :guest
+          self[:guest]
         else
           false
         end
       end
-      
 
       def admin?
         roles.where(name: 'admin').exists?
       end
-      
     end
   end
 end

data/app/models/role.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+# Class modeling Roles within the application
 class Role < ActiveRecord::Base
   has_and_belongs_to_many :users
 
-  validates :name, 
-    uniqueness: true,
-    format: { with: /\A[a-zA-Z0-9._-]+\z/,
-      :message => "Only letters, numbers, hyphens, underscores and periods are allowed"}
-
+  validates :name,
+            uniqueness: true,
+            format: {
+              with: /\A[a-zA-Z0-9._-]+\z/,
+              message: 'Only letters, numbers, hyphens, underscores and periods are allowed'
+            }
 end

data/app/views/roles/edit.html.erb

@@ -13,7 +13,7 @@
   <% @role.users.each do |user| %>
     <li><%= user.user_key %>
       <% if can? :remove_user, Role %>
-        <%= button_to t('role-management.edit.remove'), role_management.role_user_path(@role, user), :method=>:delete, :class=>'btn btn-danger' %>
+        <%= button_to t('role-management.edit.remove'), role_management.role_user_path(@role, user.id), :method=>:delete, :class=>'btn btn-danger' %>
       <% end %>
     </li>
   <% end %>

data/config/routes.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
 Hydra::RoleManagement::Engine.routes.draw do
   # Generic file routes
   resources :roles, Hydra::RoleManagement.route_options do
-    resources :users, :only=>[:create, :destroy], :controller => "user_roles"
+    resources :users, only: [:create, :destroy], controller: "user_roles"
   end
 end
-

data/hydra-role-management.gemspec

@@ -1,27 +1,32 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 require File.expand_path('../lib/hydra/role_management/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Justin Coyne"]
-  gem.email         = ["justin@curationexperts.com"]
-  gem.description   = %q{Rails engine to do user roles in an RDBMS for hydra-head}
-  gem.summary       = %q{Rails engine to do user roles in an RDBMS for hydra-head}
-  gem.homepage      = "https://github.com/samvera/hydra-role-management"
+  gem.authors       = ['Justin Coyne']
+  gem.email         = ['justin@curationexperts.com']
+  gem.description   = 'Rails engine to do user roles in an RDBMS for hydra-head'
+  gem.summary       = 'Rails engine to do user roles in an RDBMS for hydra-head'
+  gem.homepage      = 'https://github.com/samvera/hydra-role-management'
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "hydra-role-management"
-  gem.require_paths = ["lib"]
+  gem.name          = 'hydra-role-management'
+  gem.require_paths = ['lib']
   gem.version       = Hydra::RoleManagement::VERSION
   gem.license       = 'Apache 2.0'
 
-  gem.add_dependency 'bootstrap_form'
   gem.add_dependency 'blacklight'
+  gem.add_dependency 'bootstrap_form'
+  gem.add_dependency 'bundler', '>= 1.5'
   gem.add_dependency 'cancancan'
+  gem.add_dependency 'json', '~> 1.8'
+  gem.add_development_dependency 'bixby', '~> 1.0.0'
+  gem.add_development_dependency 'engine_cart', '~> 2.1'
+  gem.add_development_dependency 'pry-byebug'
+  gem.add_development_dependency 'rails-controller-testing', '~> 0'
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec-rails'
   gem.add_development_dependency 'rspec-its'
-  gem.add_development_dependency 'rails-controller-testing', '~> 0'
-  gem.add_development_dependency 'engine_cart', '~> 1.0'
+  gem.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'rspec_junit_formatter'
 end

data/lib/generators/roles/roles_generator.rb

@@ -1,27 +1,29 @@
-# -*- encoding : utf-8 -*-
+
+# frozen_string_literal: true
 require 'rails/generators'
 require 'rails/generators/migration'
 
+# Class definition for the Rails Generator integrating Roles
 class RolesGenerator < Rails::Generators::Base
   include Rails::Generators::Migration
 
   source_root File.expand_path('../templates', __FILE__)
 
-  argument     :model_name, :type => :string , :default => "user"
-  desc """
+  argument :model_name, type: :string, default: 'user'
+  desc '
 This generator makes the following changes to your application:
  1. Creates several database migrations if they do not exist in /db/migrate
  2. Adds user behavior to the user model
  2. Adds routes
-       """
+       '
 
   # Implement the required interface for Rails::Generators::Migration.
   # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
-  def self.next_migration_number(path)
-    unless @prev_migration_nr
-      @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
-    else
+  def self.next_migration_number(_path)
+    if @prev_migration_nr
       @prev_migration_nr += 1
+    else
+      @prev_migration_nr = Time.now.utc.strftime('%Y%m%d%H%M%S').to_i
     end
     @prev_migration_nr.to_s
   end
@@ -29,7 +31,7 @@ This generator makes the following changes to your application:
   # Setup the database migrations
   def copy_migrations
     # Can't get this any more DRY, because we need this order.
-    %w{user_roles.rb}.each do |f|
+    %w[user_roles.rb].each do |f|
       better_migration_template f
     end
   end
@@ -37,49 +39,45 @@ This generator makes the following changes to your application:
   # Add behaviors to the user model
   def inject_user_roles_behavior
     file_path = "app/models/#{model_name.underscore}.rb"
-    if File.exists?(file_path)
-      place_marker = if File.read(file_path).match(/include Hydra::User/)
-        /include Hydra::User/
-      elsif File.read(file_path).match(/include Blacklight::User/)
-       /include Blacklight::User/
-      end
+    if File.exist?(file_path)
+      place_marker = if File.read(file_path).match?(/include Hydra::User/)
+                       /include Hydra::User/
+                     elsif File.read(file_path).match?(/include Blacklight::User/)
+                       /include Blacklight::User/
+                     end
       if place_marker
-        code = "\n  # Connects this user object to Role-management behaviors.\n" +
-          "  include Hydra::RoleManagement::UserRoles\n\n"
-        inject_into_file file_path, code, { :after => place_marker }
+        code = "\n  # Connects this user object to Role-management behaviors.\n" \
+               "  include Hydra::RoleManagement::UserRoles\n\n"
+        inject_into_file file_path, code, after: place_marker
       else
-        puts "     \e[31mFailure\e[0m  Hydra::User is not included in #{file_path}.  Add 'include Hydra::User' and rerun."
+        Rails.logger.error "     \e[31mFailure\e[0m  Hydra::User is not included in #{file_path}.  Add 'include Hydra::User' and rerun."
       end
     else
-      puts "     \e[31mFailure\e[0m  hydra-role-management requires a user object. This generators assumes that the model is defined in the file #{file_path}, which does not exist.  If you used a different name, please re-run the generator and provide that name as an argument. Such as \b  rails -g roles client"
+      Rails.logger.error "     \e[31mFailure\e[0m  hydra-role-management requires a user object. This generators assumes that the model is defined in the file #{file_path}, which does not exist.  If you used a different name, please re-run the generator and provide that name as an argument. Such as \b  rails -g roles client"
     end
   end
 
   # The engine routes have to come after the devise routes so that /users/sign_in will work
   def inject_routes
     routing_code = "mount Hydra::RoleManagement::Engine => '/'"
-    sentinel = /devise_for :users/
-    inject_into_file 'config/routes.rb', "\n  #{routing_code}\n", { :after => sentinel, :verbose => false }
+    sentinel = /devise_for :users(.*)$/
+    inject_into_file 'config/routes.rb', "\n  #{routing_code}\n", after: sentinel, verbose: false
   end
 
   # If this gem is installed under Rails 3, an attr_accessible method is required for the Role model.  This
   # file will be added to config/initializers and the correct code will be added to the model at runtime.
   def rails3_attr_accessible
-    if !ActionController.const_defined? :StrongParameters
-      puts "Role model will include attr_accessible :name because you are installing this gem in a Rails 3 app."
-      copy_file "hydra_role_management_rails3.rb", "config/initializers/hydra_role_management_rails3.rb"
-    end
+    return if ActionController.const_defined? :StrongParameters
+    Rails.logger.info 'Role model will include attr_accessible :name because you are installing this gem in a Rails 3 app.'
+    copy_file 'hydra_role_management_rails3.rb', 'config/initializers/hydra_role_management_rails3.rb'
   end
 
   private
 
-  def better_migration_template (file)
-    begin
+    def better_migration_template(file)
       sleep 1 # ensure scripts have different time stamps
       migration_template "migrations/#{file}", "db/migrate/#{file}"
-    rescue
-      puts "  \e[1m\e[34mMigrations\e[0m  " + $!.message
+    rescue StandardError
+      Rails.logger.error "  \e[1m\e[34mMigrations\e[0m  " + $ERROR_INFO.message
     end
-  end
-
 end

data/lib/generators/roles/templates/hydra_role_management_rails3.rb

@@ -1 +1,2 @@
-Role.send :include, Hydra::RoleManagement::LegacyAttributeHandling
+# frozen_string_literal: true
+Role.send :include, Hydra::RoleManagement::LegacyAttributeHandling

data/lib/generators/roles/templates/migrations/user_roles.rb

@@ -1,9 +1,10 @@
-class UserRoles < ActiveRecord::Migration<%= '[5.0]' if Rails::VERSION::MAJOR >= 5 %>
+# frozen_string_literal: true
+class UserRoles < ActiveRecord::Migration[5.0]
   def up
     create_table :roles do |t|
       t.string :name
     end
-    create_table :roles_users, :id => false do |t|
+    create_table :roles_users, id: false do |t|
       t.references :role
       t.references :user
     end

data/lib/hydra-role-management.rb

@@ -1,12 +1,18 @@
-require "hydra/role_management"
+# frozen_string_literal: true
+require 'hydra/role_management'
 require 'bootstrap_form'
 
 module Hydra
   module RoleManagement
     mattr_accessor :route_options
     self.route_options = {}
-    
-    def self.draw_routes(router, opts={})
+
+    # Draws the routes with custom arguments passed to the #mount invocation
+    # @param router [ActionDispatch::Routing::Mapper] the Rails routing mapper
+    # @param opts [Hash] the argument passed to ActionDispatch::Routing::Mapper#mount
+    # @see http://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/Base.html
+    # (see ActionDispatch::Routing::Mapper::Base)
+    def self.draw_routes(router, opts = {})
       self.route_options = opts
       router.instance_exec do
         mount Hydra::RoleManagement::Engine => '/'

data/lib/hydra/role_management.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
 require 'cancan'
 module Hydra
   module RoleManagement
+    # Class definition for the Rails Engine
     class Engine < ::Rails::Engine
       engine_name 'role_management'
 
       # Rails 4 should do this automatically:
-      config.paths.add "app/controllers/concerns", eager_load: true
-      config.paths.add "app/models/concerns", eager_load: true
+      config.paths.add 'app/controllers/concerns', eager_load: true
+      config.paths.add 'app/models/concerns', eager_load: true
     end
   end
 end

data/lib/hydra/role_management/version.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module Hydra
   module RoleManagement
-    VERSION = "1.0.0"
+    VERSION = '1.0.1'
   end
 end

data/spec/controllers/roles_controller_spec.rb

@@ -1,51 +1,48 @@
+# frozen_string_literal: true
 describe RolesController do
+  routes { Hydra::RoleManagement::Engine.routes }
   let(:ability) do
     ability = Object.new
     ability.extend(CanCan::Ability)
     allow(controller).to receive(:current_ability).and_return(ability)
     ability
   end
-
   let(:role) do
     Role.create(name: 'foo')
   end
 
-  before(:each) do
-    @routes = Hydra::RoleManagement::Engine.routes
-  end
-
-  describe "with a user who cannot edit roles" do
-    it "should not be able to view role index" do
+  describe 'with a user who cannot edit roles' do
+    it 'is not able to view role index' do
       expect { get :index, params: {} }.to raise_error CanCan::AccessDenied
     end
-    it "should not be able to view role" do
+    it 'is not able to view role' do
       expect { get :show, params: { id: role } }.to raise_error CanCan::AccessDenied
     end
-    it "should not be able to view new role form" do
+    it 'is not able to view new role form' do
       expect { get :new }.to raise_error CanCan::AccessDenied
     end
-    it "should not be able to create a role" do
+    it 'is not able to create a role' do
       expect { post :create, params: { role: { name: 'my_role' } } }.to raise_error CanCan::AccessDenied
     end
-    it "should not be able to update a role" do
+    it 'is not able to update a role' do
       expect { put :update, params: { id: role } }.to raise_error CanCan::AccessDenied
     end
-    it "should not be able to remove a role" do
+    it 'is not able to remove a role' do
       expect { delete :destroy, params: { id: role } }.to raise_error CanCan::AccessDenied
     end
   end
 
-  describe "with a user who can read roles" do
+  describe 'with a user who can read roles' do
     before do
       ability.can :read, Role
     end
-    it "should be able to see the list of roles" do
+    it 'is able to see the list of roles' do
       get :index
       expect(response).to be_successful
       expect(assigns[:roles]).to eq [role]
     end
 
-    it "should be able to see a single role" do
+    it 'is able to see a single role' do
       get :show, params: { id: role }
       expect(response).to be_successful
       expect(assigns[:role]).to eq role
@@ -53,31 +50,31 @@ describe RolesController do
   end
 
   describe "with a user who can only update role 'foo'" do
-    it "should be redirected to edit" do
+    it 'is redirected to edit' do
       ability.can :read, Role
       ability.can :update, Role, id: role.id
       get :show, params: { id: role }
-      expect(response).to redirect_to @routes.url_helpers.edit_role_path(assigns[:role])
+      expect(response).to redirect_to routes.url_helpers.edit_role_path(assigns[:role])
     end
   end
 
-  describe "with a user who can create roles" do
+  describe 'with a user who can create roles' do
     before do
       ability.can :create, Role
     end
-    it "should be able to make a new role" do
+    it 'is able to make a new role' do
       get :new
       expect(response).to be_successful
       expect(assigns[:role]).to be_kind_of Role
     end
 
-    it "should be able to create a new role" do
+    it 'is able to create a new role' do
       post :create, params: { role: { name: 'my_role' } }
-      expect(response).to redirect_to @routes.url_helpers.edit_role_path(assigns[:role])
+      expect(response).to redirect_to routes.url_helpers.edit_role_path(assigns[:role])
       expect(assigns[:role]).not_to be_new_record
       expect(assigns[:role].name).to eq 'my_role'
     end
-    it "should not create role with an error" do
+    it 'does not create role with an error' do
       post :create, params: { role: { name: 'my role' } }
       expect(assigns[:role].name).to eq 'my role'
       expect(assigns[:role].errors[:name]).to eq ['Only letters, numbers, hyphens, underscores and periods are allowed']
@@ -85,33 +82,33 @@ describe RolesController do
     end
   end
 
-  describe "with a user who can update roles" do
+  describe 'with a user who can update roles' do
     before do
       ability.can :update, Role
     end
 
-    it "should be able to update a role" do
+    it 'is able to update a role' do
       put :update, params: { id: role, role: { name: 'my_role' } }
-      expect(response).to redirect_to @routes.url_helpers.edit_role_path(assigns[:role])
+      expect(response).to redirect_to routes.url_helpers.edit_role_path(assigns[:role])
       expect(assigns[:role]).not_to be_new_record
       expect(assigns[:role].name).to eq 'my_role'
     end
-    it "should not update role with an error" do
-      put :update,  params: { id: role, role: { name: 'my role' } }
+    it 'does not update role with an error' do
+      put :update, params: { id: role, role: { name: 'my role' } }
       expect(assigns[:role].name).to eq 'my role'
       expect(assigns[:role].errors[:name]).to eq ['Only letters, numbers, hyphens, underscores and periods are allowed']
       expect(response).to be_successful
     end
   end
 
-  describe "with a user who can remove roles" do
+  describe 'with a user who can remove roles' do
     before do
       ability.can :destroy, Role
     end
 
-    it "should be able to destroy a role" do
+    it 'is able to destroy a role' do
       delete :destroy, params: { id: role }
-      expect(response).to redirect_to @routes.url_helpers.roles_path
+      expect(response).to redirect_to routes.url_helpers.roles_path
     end
   end
 end