hydra-role-management 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 29cc644bd9c4ab4e8b33f15ac0391b512cbd0ed2
-  data.tar.gz: fae1f29f174e38105242a148bd04cde1d50cca15
+SHA256:
+  metadata.gz: 43d32b791bfcce71d8fb6950ac904b7cd3cf42d5374acdc1ff836844e24195cf
+  data.tar.gz: aad28432d32a9ada60bfdaec8e7233cf75c5e259c04e219a088a6e6e9ff819cf
 SHA512:
-  metadata.gz: 05c99ba950eba5d946efdfd33518e23de53c689c39c0e7b1e243b478da5daed56ce2ade1782c4b7a5aa44a261b4177e745163b3fe99ccc532bee54bac22d1053
-  data.tar.gz: 864ddfbd1372fda98f0bc004709f13a805ea45e498587c08745fd16bcb5229f0761fe4966965f6cfb94257bec2f44e18b22f557a0678bc09cb4a62468add1a75
+  metadata.gz: 0de2f191b4bded67f56f0b1e044d451e5f2508889ddc36c84302410ace557a5c0a03ef852236af590ab74f54faed6ef70dba65040aee1e3eef6b27bce6c9412c
+  data.tar.gz: 1d6d6f6591d87c94e7168eb1922eb667868dcc5a2f13e6005e5f704013d837face247f39afe3556689b185d96bab6b0da3b7f94fdf7bd509ed2489f9a8551c47

data/.circleci/config.yml

@@ -0,0 +1,68 @@
+---
+version: 2.1
+orbs:
+  samvera: samvera/circleci-orb@0
+jobs:
+  test:
+    parameters:
+      ruby_version:
+        type: string
+      bundler_version:
+        type: string
+        default: 1.17.3
+      rails_version:
+        type: string
+    executor:
+      name: 'samvera/ruby_fcrepo_solr'
+      ruby_version: << parameters.ruby_version >>
+    environment:
+      RAILS_VERSION: << parameters.rails_version >>
+      NOKOGIRI_USE_SYSTEM_LIBRARIES: true
+      ENGINE_CART_RAILS_OPTIONS: --skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-puma --skip-test
+    steps:
+      - samvera/cached_checkout
+      - samvera/bundle_for_gem:
+          ruby_version: << parameters.ruby_version >>
+          bundler_version: << parameters.bundler_version >>
+          project: hydra-role-management
+      - samvera/rubocop
+      - samvera/engine_cart_generate:
+          cache_key: v1-internal-test-app-{{ checksum "hydra-role-management.gemspec" }}-{{ checksum "spec/test_app_templates/lib/generators/test_app_generator.rb" }}-{{ checksum "lib/generators/roles/roles_generator.rb" }}-<< parameters.rails_version >>-<< parameters.ruby_version >>
+      - samvera/bundle_for_gem:
+          ruby_version: << parameters.ruby_version >>
+          bundler_version: << parameters.bundler_version >>
+          project: hydra-role-management
+      - samvera/parallel_rspec
+      - persist_to_workspace:
+          root: ~/
+          paths:
+          - project/*
+          - project/**/*
+
+workflows:
+  ci:
+    jobs:
+      - test:
+          name: ruby2-6_rails5-2
+          ruby_version: 2.6.3
+          rails_version: 5.2.3
+      - test:
+          name: ruby2-5_rails5-2
+          ruby_version: 2.5.5
+          rails_version: 5.2.3
+      - test:
+          name: ruby2-4_rails5-2
+          ruby_version: 2.4.6
+          rails_version: 5.2.3
+      - test:
+          name: ruby2-6_rails5-1
+          ruby_version: 2.6.3
+          rails_version: 5.1.7
+      - test:
+          name: ruby2-5_rails5-1
+          ruby_version: 2.5.5
+          rails_version: 5.1.7
+      - test:
+          name: ruby2-4_rails5-1
+          ruby_version: 2.4.6
+          rails_version: 5.1.7

data/.rubocop.yml

@@ -0,0 +1,50 @@
+inherit_gem:
+  bixby: bixby_default.yml
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+Bundler/DuplicatedGem:
+  Exclude:
+    - 'Gemfile'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/controllers/roles_controller_spec.rb'
+    - 'spec/controllers/user_roles_controller_spec.rb'
+    - 'spec/lib/user_roles_spec.rb'
+    - 'spec/models/role_spec.rb'
+    - 'spec/routing/role_management_routes_spec.rb'
+
+Metrics/LineLength:
+  Exclude:
+    - ''
+    - 'lib/generators/roles/roles_generator.rb'
+    - 'spec/controllers/roles_controller_spec.rb'
+    - 'spec/controllers/user_roles_controller_spec.rb'
+    - 'spec/lib/user_roles_spec.rb'
+    - 'spec/routing/role_management_routes_spec.rb'
+    - 'spec/test_app_templates/config/initializers/hydra_config.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/generators/roles/roles_generator.rb'
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/generators/roles/roles_generator.rb'
+
+Naming/FileName:
+  Exclude:
+    - 'Gemfile'
+    - 'hydra-role-management.gemspec'
+    - 'lib/hydra-role-management.rb'
+
+Rails/HasAndBelongsToMany:
+  Exclude:
+    - 'app/models/concerns/hydra/role_management/user_roles.rb'
+    - 'app/models/role.rb'
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/routing/role_management_routes_spec.rb'

data/CONTRIBUTING.md

@@ -1,21 +1,24 @@
 # How to Contribute
 
-We want your help to make Project Hydra great.
-There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
+We want your help to make the Samvera community great. There are a few guidelines
+that we need contributors to follow so that we can have a chance of
+keeping on top of things.
 
 ## Code of Conduct
 
-The Hydra community is dedicated to providing a welcoming and positive experience for all its
-members, whether they are at a formal gathering, in a social setting, or taking part in activities
-online.  Please see our [Code of Conduct](https://wiki.duraspace.org/display/hydra/Code+of+Conduct)
-for more information.
+The Samvera Community is dedicated to providing a welcoming and positive
+experience for all its members, whether they are at a formal gathering, in
+a social setting, or taking part in activities online. Please see our
+[Code of Conduct](CODE_OF_CONDUCT.md) for more information.
 
-## Hydra Project Intellectual Property Licensing and Ownership
+## Samvera Community Intellectual Property Licensing and Ownership
 
-All code contributors must have an Individual Contributor License Agreement (iCLA) on file with the Hydra Project Steering Group.
-If the contributor works for an institution, the institution must have a Corporate Contributor License Agreement (cCLA) on file.
+All code contributors must have an Individual Contributor License Agreement
+(iCLA) on file with the Samvera Steering Group. If the contributor works for
+an institution, the institution must have a Corporate Contributor License
+Agreement (cCLA) on file.
 
-https://wiki.duraspace.org/display/hydra/Hydra+Project+Intellectual+Property+Licensing+and+Ownership
+https://wiki.duraspace.org/display/samvera/Samvera+Community+Intellectual+Property+Licensing+and+Ownership
 
 You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.
 
@@ -48,7 +51,7 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
   * Please avoid working directly on the `master` branch.
   * You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful
 * Make sure you have added sufficient tests and documentation for your changes.
-  * Test functionality with RSpec; est features / UI with Capybara.
+  * Test functionality with RSpec; Test features / UI with Capybara.
 * Run _all_ the tests to assure nothing else was accidentally broken.
 
 ### Documenting Code
@@ -60,15 +63,11 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
   * If you don't know exactly what a bit of code does, it is extra likely that it needs to be documented. Take a stab at it and ask for feedback in your pull request. You can use the 'blame' button on GitHub to identify the original developer of the code and @mention them in your comment.
   * This work greatly increases the usability of the code base and supports the on-ramping of new committers.
   * We will all be understanding of one another's time constraints in this area.
-* YARD examples:
-  * [Hydra::Works::RemoveGenericFile](https://github.com/projecthydra-labs/hydra-works/blob/master/lib/hydra/works/services/generic_work/remove_generic_file.rb)
-  * [ActiveTriples::LocalName::Minter](https://github.com/ActiveTriples/active_triples-local_name/blob/master/lib/active_triples/local_name/minter.rb)
 * [Getting started with YARD](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md)
 
 ### Committing changes
 
 * Make commits of logical units.
-  * Your commit should include a high level description of your work in HISTORY.textile
 * Check for unnecessary whitespace with `git diff --check` before committing.
 * Make sure your commit messages are [well formed](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
 * If you created an issue, you can close it by including "Closes #issue" in your commit message. See [Github's blog post for more details](https://github.com/blog/1386-closing-issues-via-commit-messages)
@@ -103,6 +102,10 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
       long to fit in 72 characters
 ```
 
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+* When you are ready to submit a pull request
+
 ### Submitting Changes
 
 * Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub.
@@ -125,9 +128,7 @@ We adopted [Github's Pull Request Review](https://help.github.com/articles/about
 Common checks that may occur in our repositories:
 
 1. Travis CI - where our automated tests are running
-2. Hound CI - where we check for style violations
-3. Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve.
-4. CodeClimate - is our code remaining healthy (at least according to static code analysis)
+2. Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve.
 
 If one or more of the required checks failed (or are incomplete), the code should not be merged (and the UI will not allow it). If all of the checks have passed, then anyone on the project (including the pull request submitter) may merge the code.
 
@@ -144,16 +145,17 @@ First, the person contributing the code is putting themselves out there. Be mind
 This is your chance for a mentoring moment of another developer. Take time to give an honest and thorough review of what has changed. Things to consider:
 
   * Does the commit message explain what is going on?
-  * Does the code changes have tests? _Not all changes need new tests, some changes are refactors_
+  * Does the code changes have tests? _Not all changes need new tests, some changes are refactorings_
   * Do new or changed methods, modules, and classes have documentation?
   * Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
   * Does the description of the new/changed specs match your understanding of what the spec is doing?
+  * Did the Travis tests complete successfully?
 
 If you are uncertain, bring other contributors into the conversation by assigning them as a reviewer.
 
 # Additional Resources
 
 * [General GitHub documentation](http://help.github.com/)
-* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)
 * [Pro Git](http://git-scm.com/book) is both a free and excellent book about Git.
 * [A Git Config for Contributing](http://ndlib.github.io/practices/my-typical-per-project-git-config/)

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source "https://rubygems.org"
 
 gem 'coveralls', require: false
@@ -8,8 +9,7 @@ gemspec
 # 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__
-)))
+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
@@ -31,9 +31,9 @@ else
 
   case ENV['RAILS_VERSION']
   when /^4.2/
+    gem 'coffee-rails', '~> 4.1.0'
     gem 'responders', '~> 2.0'
     gem 'sass-rails', '>= 5.0'
-    gem 'coffee-rails', '~> 4.1.0'
   when /^4.[01]/
     gem 'sass-rails', '< 5.0'
   end

data/README.md

@@ -1,12 +1,37 @@
 # hydra-role-management
 
-[![Build Status](https://travis-ci.org/samvera/hydra-role-management.svg?branch=master)](https://travis-ci.org/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)
+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)
 
+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)
+
+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```
@@ -30,3 +55,10 @@ As of version 1.0, this gem only supports Rails 5.
 * 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 spec```
+
+# 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/).
+
+![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,20 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
 require 'bundler/setup'
-require "bundler/gem_tasks"
-
-require 'rspec/core/rake_task'
+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,31 +1,30 @@
+# 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.'
         else
-          render action: "new"
+          render action: 'new'
         end
       end
 
@@ -34,12 +33,12 @@ module Hydra
         if @role.update_attributes(role_params)
           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)
+        if @role.destroy
           redirect_to role_management.roles_path, notice: 'Role was successfully deleted.'
         else
           redirect_to role_management.roles_path
@@ -48,13 +47,13 @@ module Hydra
 
       private
 
-      def role_params
-        if !ActionController.const_defined? :StrongParameters
-          params[:role]
-        else
-          params.require(:role).permit(:name)
+        def role_params
+          if !ActionController.const_defined? :StrongParameters
+            params[:role]
+          else
+            params.require(:role).permit(:name)
+          end
         end
-      end
     end
   end
 end

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

@@ -1,5 +1,7 @@
+# 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 +17,7 @@ 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: "Unable to find the user #{params[:user_key]}" }
         end
       end
 
@@ -27,14 +29,13 @@ module Hydra
 
       protected
 
-      def find_user
-        ::User.send("find_by_#{find_column}".to_sym, params[:user_key])
-      end
+        def find_user
+          ::User.send("find_by_#{find_column}".to_sym, params[:user_key])
+        end
 
-      def find_column
-        Devise.authentication_keys.first
-      end
+        def find_column
+          Devise.authentication_keys.first
+        end
     end
   end
 end
-