hydra-role-management 0.2.1 → 1.0.3

data/Gemfile

@@ -1,15 +1,48 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'coveralls', require: false
 
 gemspec
 
-gem 'rspec-its'
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 1.1.0
+# engine_cart stanza: 0.10.0
+# the below comes from engine_cart, a gem used to test this Rails engine gem
+# in the context of a Rails app.
+file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] ||
+    ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app',
+                                          File.dirname(__FILE__)))
+if File.exist?(file)
+  begin
+    eval_gemfile file
+  rescue Bundler::GemfileError => e
+    Bundler.ui.warn '[EngineCart] Skipping Rails application dependencies:'
+    Bundler.ui.warn e.message
+  end
+else
+  Bundler.ui.warn "[EngineCart] Unmet dependencies in #{file}," \
+                            ' using placeholder dependencies'
 
-# To avoid: 'Bundler could not find compatible versions for gem "sprockets":'
-gem 'sass', '~> 3.2.15'
-gem 'sprockets', '~> 2.11.0'
+  if ENV['RAILS_VERSION']
+    if ENV['RAILS_VERSION'] == 'edge'
+      gem 'rails', github: 'rails/rails'
+      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
+    else
+      gem 'rails', ENV['RAILS_VERSION']
+    end
+  end
 
-file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path("../spec/internal", __FILE__))
-if File.exists?(file)
-  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
-  instance_eval File.read(file)
+  case ENV['RAILS_VERSION']
+  when /^4.2/
+    gem 'coffee-rails', '~> 4.1.0'
+    gem 'responders', '~> 2.0'
+    gem 'sass-rails', '>= 5.0'
+  when /^4.[01]/
+    gem 'sass-rails', '< 5.0'
+  when /^5.[12]/
+    gem 'sass-rails', '~> 5.0'
+  end
 end
+# END ENGINE_CART BLOCK

data/LICENSE.md

@@ -0,0 +1,14 @@
+Copyright 2015 Data Curation Experts
+Additional copyright may be held by others, as reflected in the commit history.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,27 +1,74 @@
-An engine gem to provide a RDBMS backed list of roles and their associated user.  This replaces the hydra default role mapper.
+# hydra-role-management
 
-This gem supports both Rails 3 and 4.
+Code: [![CircleCI](https://circleci.com/gh/samvera/hydra-role-management.svg?style=svg)](https://circleci.com/gh/samvera/hydra-role-management) [![Gem Version](https://badge.fury.io/rb/hydra-role-management.svg)](https://badge.fury.io/rb/hydra-role-management) [![Coverage Status](https://coveralls.io/repos/github/samvera/hydra-role-management/badge.svg?branch=master)](https://coveralls.io/github/samvera/hydra-role-management?branch=master)
 
-##Installing:
+Docs: [![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md) [![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE.md)
 
-* Add: ```gem 'hydra-role-management'``` to your Gemfile and then ```bundle install```
-* ```rails generate roles```
-* ```rake db:migrate```
-* Add the following [cancan](https://github.com/ryanb/cancan) abilities:
+Jump In: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samvera.org/)
+
+# What is hydra-role-management?
+
+An engine gem to provide a RDBMS backed list of roles and their associated user. This replaces the hydra default role mapper.
+
+As of version 1.0, this gem only supports Rails 5.
+
+## Product Owner & Maintenance
+
+**hydra-role-management** is a Core Component of the Samvera community. The documentation for what this means can be found [here](http://samvera.github.io/core_components.html#requirements-for-a-core-component).
+
+### Product Owner
+
+[jrgriffiniii](https://github.com/jrgriffiniii)
+
+# Help
+
+The Samvera community is here to help. Please see our [support guide](./SUPPORT.md).
+
+## Installing:
+
+- Add: `gem 'hydra-role-management'` to your Gemfile and then `bundle install`
+- `rails generate roles`
+- `rake db:migrate`
+- Add the following [cancan](https://github.com/ryanb/cancan) abilities:
 
 ```
   # app/models/ability.rb
   if current_user.admin?
-    can [:create, :show, :add_user, :remove_user, :index], Role
+    can [:create, :show, :add_user, :remove_user, :index, :edit, :update, :destroy], Role
   end
 ```
 
-##Testing:
-Given the need to support both Rails 3 and 4, the test suite has been parameterized to test against any version of Rails.
+## Testing:
+
+- Install a system javascript runtime or uncomment therubyracer in spec/support/Gemfile
+- Ensure that the testing app does not exist: `bundle exec rake engine_cart:clean`
+- Set Rails version you want to test against. For example:
+
+  - `export RAILS_VERSION=5.1.4`
+
+- Ensure that the correct version of Rails is installed: `bundle update`
+
+- Build test app: `bundle exec rake engine_cart:generate`
+
+- And run tests: `bundle exec rake ci`
+
+## Releasing
+
+1. `bundle install`
+2. Increase the version number in `lib/hydra/role_management/version.rb`
+3. Increase the same version number in `.github_changelog_generator`
+4. Update `CHANGELOG.md` by running this command:
+
+  ```
+  github_changelog_generator --user samvera --project hydra-role-management --token YOUR_GITHUB_TOKEN_HERE
+  ```
+
+5. Commit these changes to the master branch
+
+6. Run `rake release`
+
+# Acknowledgments
+
+This software has been developed by and is brought to you by the Samvera community. Learn more at the [Samvera website](http://samvera.org/).
 
-* Install a system javascript runtime or uncomment therubyracer in spec/support/Gemfile
-* Ensure that the testing app does not exist: ```bundle exec rake clean```
-* Set Rails version you want to test against.  For example:
-	* ```RAILS_VERSION=3.2.13``` or ```RAILS_VERSION=4.0.0```
-* Ensure that the correct version of Rails is installed:  ```bundle update```
-* Build test app and run tests: ```bundle exec rake spec```
+![Samvera Logo](https://wiki.duraspace.org/download/thumbnails/87459292/samvera-fall-font2-200w.png?version=1&modificationDate=1498550535816&api=v2)

data/Rakefile

@@ -1,23 +1,21 @@
 #!/usr/bin/env rake
-require 'bundler/setup'
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
-require 'rspec/core/rake_task'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
 require 'engine_cart/rake_task'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
+desc 'Run style checker'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+end
 
-desc 'Default: run ci.'
-task :default => :ci
-
-
-desc "Make clean, generate test app, and run the tests"
-task :ci => [:clean, :generate, :spec]
-
-desc "Run the tests"
-RSpec::Core::RakeTask.new(:spec)
-
-desc "Create the test rails app"
-task :generate => 'engine_cart:generate'
+desc 'Run the tests'
+task ci: [:rubocop, 'engine_cart:generate'] do
+  RSpec::Core::RakeTask.new(:spec)
+  Rake::Task['spec'].invoke
+end
 
-desc "Clean out the test rails app"
-task :clean => 'engine_cart:clean'
+task default: :ci

data/SUPPORT.md

@@ -0,0 +1,6 @@
+If you would like to report an issue, first search [the list of issues](https://github.com/samvera/hydra-role-management/issues/) to see if someone else has already reported it, and then feel free to [create a new issue](https://github.com/samvera/hydra-role-management/issues/new).
+
+If you have questions or need help, please email [the Samvera community tech list](https://groups.google.com/forum/#!forum/samvera-tech) or stop by the #dev channel in [the Samvera community Slack team](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391#Getintouch!-Slack).
+
+You can learn more about the various Samvera communication channels on the [Get in touch!](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391) wiki page.
+

data/app/controllers/concerns/hydra/role_management/roles_behavior.rb

@@ -1,46 +1,49 @@
+# frozen_string_literal: true
+
 module Hydra
   module RoleManagement
+    # Module defining Controller actions for creating and managing Roles
     module RolesBehavior
       extend ActiveSupport::Concern
 
       included do
-        load_and_authorize_resource 
+        load_and_authorize_resource
       end
 
-      def index
-      end
+      def index; end
 
       def show
         redirect_to role_management.edit_role_path(@role) if can? :edit, @role
       end
 
-      def new
-      end
+      def new; end
 
-      def edit
-      end
+      def edit; end
 
       def create
         @role = Role.new(role_params)
         if @role.save
-          redirect_to role_management.edit_role_path(@role), notice: 'Role was successfully created.'
+          redirect_to role_management.edit_role_path(@role),
+                      notice: 'Role was successfully created.'
         else
-          render action: "new"
+          render action: 'new'
         end
       end
 
       def update
         @role = Role.find(params[:id])
         if @role.update_attributes(role_params)
-          redirect_to role_management.edit_role_path(@role), notice: 'Role was successfully updated.'
+          redirect_to role_management.edit_role_path(@role),
+                      notice: 'Role was successfully updated.'
         else
-          render action: "edit"
+          render action: 'edit'
         end
       end
 
       def destroy
-        if (@role.destroy)
-          redirect_to role_management.roles_path, notice: 'Role was successfully deleted.'
+        if @role.destroy
+          redirect_to role_management.roles_path,
+                      notice: 'Role was successfully deleted.'
         else
           redirect_to role_management.roles_path
         end

data/app/controllers/concerns/hydra/role_management/user_roles_behavior.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Hydra
   module RoleManagement
+    # Module defining Controller actions for adding and managing Roles for Users
     module UserRolesBehavior
       extend ActiveSupport::Concern
 
@@ -15,7 +18,8 @@ module Hydra
           u.save!
           redirect_to role_management.role_path(@role)
         else
-          redirect_to role_management.role_path(@role), :flash=> {:error=>"Unable to find the user #{params[:user_key]}"}
+          redirect_to role_management.role_path(@role),
+                      flash: { error: "Invalid user #{params[:user_key]}" }
         end
       end
 
@@ -37,4 +41,3 @@ module Hydra
     end
   end
 end
-

data/app/controllers/roles_controller.rb

@@ -1,4 +1,6 @@
+# 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,6 @@
+# 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,8 @@
+# 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,32 @@
+# 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,14 @@
+# 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

@@ -1,26 +1,26 @@
-<h2>Role:</h2>
+<h2><%= t('role-management.edit.title') %></h2>
 <%= bootstrap_form_for @role, :url=>role_management.role_path(@role) do |f| %>
-  <%= f.text_field :name, :label=> 'Role name' %>
+  <%= f.text_field :name, :label=> t('role-management.edit.field_name') %>
 
-    <%= f.submit "Update" %>
+    <%= f.submit t('role-management.edit.update') %>
 
 <% end %>
 <% if can? :destroy, Role %>
-  <%= button_to "Delete", role_management.role_path(@role), :method=>:delete, :class=>'btn btn-danger' %>
+  <%= button_to t('role-management.edit.delete'), role_management.role_path(@role), :method=>:delete, :class=>'btn btn-danger' %>
 <% end %>
-<h3>Accounts:</h3>
+<h3><%= t('role-management.edit.accounts') %></h3>
 <ul>
   <% @role.users.each do |user| %>
     <li><%= user.user_key %>
       <% if can? :remove_user, Role %>
-        <%= button_to "Remove User", 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 %>
 </ul>
-<h3>Add a new account:</h3>
+<h3><%= t('role-management.edit.add_new_account') %></h3>
 <%= bootstrap_form_tag :url=> role_management.role_users_path(@role) do |f| %>
-  <%= f.text_field 'user_key', :label=>'User' %>
-  <%= f.submit "Add" %>
-  <%= link_to "Cancel", role_management.roles_path, :class => 'btn btn-default' %>
+  <%= f.text_field 'user_key', :label=>t('role-management.edit.user') %>
+  <%= f.submit t('role-management.edit.add') %>
+  <%= link_to t('role-management.edit.cancel'), role_management.roles_path, :class => 'btn btn-default' %>
 <% end %>

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

@@ -1,4 +1,4 @@
-<h2>Roles</h2>
+<h2><%= t('role-management.index.title') %></h2>
 <ul>
   <% @roles.each do |role| %>
     <li><%=link_to role.name, role_management.role_path(role) %></li>
@@ -6,6 +6,6 @@
 </ul>
 
 <% if can? :create, Role %>
-  <%= button_to "Create a new role", role_management.new_role_path, method: :get, class: 'btn btn-primary' %>
+  <%= button_to t('role-management.index.create'), role_management.new_role_path, method: :get, class: 'btn btn-primary' %>
 <% end %>
 

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

@@ -1,6 +1,6 @@
 <%= bootstrap_form_for @role, :url=>role_management.roles_path do |f| %>
-  <%= f.text_field :name, :label=> 'Role name' %>
-  <%= f.submit "Add" %>
-  <%= link_to "Cancel", role_management.roles_path, :class => 'btn btn-default' %>
+  <%= f.text_field :name, :label=> t('role-management.new.field_name') %>
+  <%= f.submit t('role-management.new.add') %>
+  <%= link_to t('role-management.new.cancel'), role_management.roles_path, :class => 'btn btn-default' %>
 <% end %>