browse-everything 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9580ccdb2b53c75f59eb7002892d3a65c26438a407d19b383825989b43eca287
-  data.tar.gz: 8ee75aa2fa5f43768f0019456eb9eb49ab90e3ec6fc1a38008c476e47d9506d1
+  metadata.gz: 77087f10e05aea7eb2efb26ceb8df9464fdd40526f2be33140e12ca68d55a9f3
+  data.tar.gz: 2d0b4e7d61ea1f944d168db0c60713597e6b944e470d1f99b3292b11c56b7f18
 SHA512:
-  metadata.gz: c524b3167dd198a71e119b7b30d759f935e72f8fc5e894dca5af6dd5120b93cff436c1671ad589a53b8f3753c7d3b59b6cad2d16a82b3fe305b9a50e6d2f057e
-  data.tar.gz: 600342a8f49b0ac444a0bd8fc5eea6da81f065d9c5cd7ec41999ba7bb671e95229750278618ed94235759c5e255f8126fe9704864f67f8a22a575dc059edbae7
+  metadata.gz: 7f68074141160f41b9bb125afd1ae42110e36038f41c1b310d65fef69037e84fe95d07ab1b5619b4bda196e77f15262421cb801b8e16ca0acb31f7d1fc50ce63
+  data.tar.gz: f351fa62b040ba18aefc6e1f44226f610f04aca67217cd49a48ffcb0554cfc5b759e234eab73de19953f1d7960a1350dde082e6697e08f0f099b5f6c6f9904b4

data/.circleci/config.yml

@@ -1,7 +1,8 @@
 ---
 version: 2.1
 orbs:
-  samvera: samvera/circleci-orb@0
+  samvera: samvera/circleci-orb@1.0
+  browser-tools: circleci/browser-tools@1.1
 
 jobs:
   build:
@@ -12,60 +13,134 @@ jobs:
         type: string
       bundler_version:
         type: string
-        default: 2.0.1
+        default: 2.1.4
     executor:
       name: 'samvera/ruby'
       ruby_version: << parameters.ruby_version >>
     environment:
       RAILS_VERSION: << parameters.rails_version >>
     steps:
-      - samvera/cached_checkout
+      - browser-tools/install-chrome
 
-      - samvera/bundle_for_gem:
-          bundler_version: << parameters.bundler_version >>
-          ruby_version: << parameters.ruby_version >>
-          project: 'browse-everything'
+      - samvera/cached_checkout
 
-      - samvera/engine_cart_generate:
-          cache_key: v1-internal-test-app-{{ checksum "browse-everything.gemspec" }}-{{ checksum "spec/test_app_templates/lib/generators/test_app_generator.rb" }}-{{ checksum "lib/generators/browse_everything/install_generator.rb" }}-{{ checksum "lib/generators/browse_everything/config_generator.rb" }}--<< parameters.rails_version >>-<< parameters.ruby_version >>
+      - run:
+          name: Check for a branch named 'master'
+          command: |
+            git fetch --all --quiet --prune --prune-tags
+            if [[ -n "$(git branch --all --list master */master)" ]]; then
+              echo "A branch named 'master' was found. Please remove it."
+              echo "$(git branch --all --list master */master)"
+            fi
+            [[ -z "$(git branch --all --list master */master)" ]]
 
-      - samvera/bundle_for_gem:
-          ruby_version: << parameters.ruby_version >>
+      - samvera/bundle:
           bundler_version: << parameters.bundler_version >>
-          project: 'browse-everything'
+          ruby_version: << parameters.ruby_version >>
 
       - samvera/rubocop
 
-      - run:
-          name: Install Karma for JavaScript and functional tests
-          command: sudo npm install -g karma karma-jasmine karma-chrome-launcher
-
       - samvera/parallel_rspec
 
 workflows:
   ci:
     jobs:
+      - build:
+          name: "ruby3-1_rails7-0"
+          ruby_version: 3.1.2
+          rails_version: 7.0.3
+
+      - build:
+          name: "ruby3-1_rails6-1"
+          ruby_version: 3.1.2
+          rails_version: 6.1.6
+      - build:
+          name: "ruby3-0_rails6-1"
+          ruby_version: 3.0.3
+          rails_version: 6.1.6
+
+      - build:
+          name: "ruby3-0_rails6-0"
+          ruby_version: 3.0.3
+          rails_version: 6.0.4.7
+      - build:
+          name: "ruby2-7_rails6-0"
+          ruby_version: 2.7.5
+          rails_version: 6.0.4.7
+      - build:
+          name: "ruby2-6_rails6-0"
+          ruby_version: 2.6.9
+          rails_version: 6.0.4.7
+
+      - build:
+          name: "ruby2-7_rails5-2"
+          ruby_version: 2.7.5
+          rails_version: 5.2.7
       - build:
           name: "ruby2-6_rails5-2"
-          ruby_version: 2.6.3
-          rails_version: 5.2.3
+          ruby_version: 2.6.9
+          rails_version: 5.2.7
+
+      - build:
+          name: "ruby2-7_rails5-1"
+          ruby_version: 2.7.5
+          rails_version: 5.1.7
       - build:
           name: "ruby2-6_rails5-1"
-          ruby_version: 2.6.3
+          ruby_version: 2.6.9
           rails_version: 5.1.7
+
+  nightly:
+    triggers:
+      - schedule:
+          cron: "0 0 * * *"
+          filters:
+            branches:
+              only:
+                - main
+    jobs:
+      - build:
+          name: "ruby3-1_rails7-0"
+          ruby_version: 3.1.2
+          rails_version: 7.0.3
+
       - build:
-          name: "ruby2-5_rails5-2"
-          ruby_version: 2.5.5
-          rails_version: 5.2.3
+          name: "ruby3-1_rails6-1"
+          ruby_version: 3.1.2
+          rails_version: 6.1.6
       - build:
-          name: "ruby2-5_rails5-1"
-          ruby_version: 2.5.5
-          rails_version: 5.1.7
+          name: "ruby3-0_rails6-1"
+          ruby_version: 3.0.3
+          rails_version: 6.1.6
+
       - build:
-          name: "ruby2-4_rails5-2"
-          ruby_version: 2.4.6
-          rails_version: 5.2.3
+          name: "ruby3-0_rails6-0"
+          ruby_version: 3.0.3
+          rails_version: 6.0.4.7
       - build:
-          name: "ruby2-4_rails5-1"
-          ruby_version: 2.4.6
+          name: "ruby2-7_rails6-0"
+          ruby_version: 2.7.5
+          rails_version: 6.0.4.7
+      - build:
+          name: "ruby2-6_rails6-0"
+          ruby_version: 2.6.9
+          rails_version: 6.0.4.7
+
+      - build:
+          name: "ruby2-7_rails5-2"
+          ruby_version: 2.7.5
+          rails_version: 5.2.7
+      - build:
+          name: "ruby2-6_rails5-2"
+          ruby_version: 2.6.9
+          rails_version: 5.2.7
+
+      - build:
+          name: "ruby2-7_rails5-1"
+          ruby_version: 2.7.5
           rails_version: 5.1.7
+      - build:
+          name: "ruby2-6_rails5-1"
+          ruby_version: 2.6.9
+          rails_version: 5.1.7
+

data/.gitignore

@@ -16,5 +16,7 @@ spec/reports
 spec/fixtures/Getting Started.pdf
 test/tmp
 test/version_tmp
-tmp
-.internal_test_app
+spec/dummy_test_app/tmp
+spec/dummy_test_app/db
+spec/dummy_test_app/log
+!spec/dummy_test_app/tmp/.gitkeep

data/.rubocop.yml

@@ -3,71 +3,91 @@ inherit_gem:
   bixby: bixby_default.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
   DisplayCopNames: true
   Exclude:
     - 'vendor/**/*'
+    - 'spec/dummy_test_app/**/*'
+    - 'bin/rails'
 
-Rails:
-  Enabled: true
-Rails/FilePath:
-  Exclude:
-    - 'lib/generators/browse_everything/config_generator.rb'
+Style/GuardClause:
+  Enabled: false
 
-Metrics/ClassLength:
-  Max: 130
+StyleI/IfUnlessModifier:
+  Enabled: false
+
+Bundler/DuplicatedGem:
   Exclude:
-    - 'lib/browse_everything/driver/google_drive.rb'
-Metrics/LineLength:
+    - 'Gemfile'
+
+Layout/LineLength:
   Max: 400
   Exclude:
     - 'spec/lib/browse_everything/driver/box_spec.rb'
     - 'spec/lib/browse_everything/driver/dropbox_spec.rb'
+
 Metrics/BlockLength:
   Exclude:
     - '*.gemspec'
     - 'spec/**/*'
 
-RSpec/NestedGroups:
-  Enabled: false
+Metrics/ClassLength:
+  Max: 130
+  Exclude:
+    - 'lib/browse_everything/driver/google_drive.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/test_app_templates/lib/generators/test_app_generator.rb'
+
+Naming/FileName:
+  Exclude:
+    - 'browse-everything.gemspec'
+    - 'Gemfile'
+    - 'lib/browse-everything.rb'
+
+Rails:
+  Enabled: true
+
+Rails/FilePath:
+  Exclude:
+    - 'lib/generators/browse_everything/config_generator.rb'
 
 RSpec/DescribeClass:
   Exclude:
     - 'spec/javascripts/**/*'
-    
-RSpec/LeadingSubject:
-  Enabled: false
 
 RSpec/ExampleLength:
   Enabled: false
 
-RSpec/MultipleExpectations:
+RSpec/LeadingSubject:
   Enabled: false
 
-Style/NumericLiterals:
-  MinDigits: 7
-
-Layout/IndentationConsistency:
-  EnforcedStyle: rails
+RSpec/MultipleExpectations:
+  Enabled: false
 
-Naming/FileName:
-  Exclude:
-    - 'browse-everything.gemspec'
-    - 'Gemfile'
-    - 'lib/browse-everything.rb'
+RSpec/NestedGroups:
+  Enabled: false
 
 Style/MixinUsage:
   Exclude:
-    - 'spec/lib/browse_everything/driver/s3_spec.rb'
-    - 'spec/lib/browse_everything/driver/google_drive_spec.rb'
-    - 'spec/lib/browse_everything/driver/file_system_spec.rb'
-    - 'spec/lib/browse_everything/driver/dropbox_spec.rb'
-    - 'spec/lib/browse_everything/driver/box_spec.rb'
-    - 'spec/lib/browse_everything/driver/base_spec.rb'
+    - 'spec/helper/browse_everything_controller_helper_spec.rb'
     - 'spec/lib/browse_everything/browser_spec.rb'
+    - 'spec/lib/browse_everything/driver/base_spec.rb'
+    - 'spec/lib/browse_everything/driver/box_spec.rb'
+    - 'spec/lib/browse_everything/driver/dropbox_spec.rb'
+    - 'spec/lib/browse_everything/driver/file_system_spec.rb'
+    - 'spec/lib/browse_everything/driver/google_drive_spec.rb'
+    - 'spec/lib/browse_everything/driver/s3_spec.rb'
     - 'spec/services/browser_factory_spec.rb'
-    - 'spec/helper/browse_everything_controller_helper_spec.rb'
 
-Bundler/DuplicatedGem:
+Style/NumericLiterals:
+  MinDigits: 7
+
+Style/RedundantBegin:
+  Exclude:
+    - 'lib/browse_everything/browser.rb'
+
+Style/IfUnlessModifier:
   Exclude:
     - 'Gemfile'

data/.rubocop_todo.yml

@@ -31,11 +31,6 @@ Metrics/MethodLength:
 Metrics/ParameterLists:
   Max: 7
 
-# Offense count: 1
-RSpec/DescribeClass:
-  Exclude:
-    - 'spec/javascripts/jasmine_spec.rb'
-
 # Offense count: 2
 RSpec/MultipleExpectations:
   Max: 2

data/.tool-versions

@@ -0,0 +1,2 @@
+ruby 2.7.5
+nodejs lts-fermium

data/CONTRIBUTING.md

@@ -22,6 +22,28 @@ https://wiki.duraspace.org/display/samvera/Samvera+Community+Intellectual+Proper
 
 You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.
 
+## Language
+
+The language we use matters.  Today, tomorrow, and for years to come
+people will read the code we write.  They will judge us for our
+design, logic, and the words we use to describe the system.
+
+Our words should be accessible.  Favor descriptive words that give
+meaning while avoiding reinforcing systemic inequities.  For example,
+in the Samvera community, we should favor using allowed\_list instead
+of whitelist, denied\_list instead of blacklist, or source/copy
+instead of master/slave.
+
+We're going to get it wrong, but this is a call to keep working to
+make it right.  View our code and the words we choose as a chance to
+have a conversation. A chance to grow an understanding of the systems
+we develop as well as the systems in which we live.
+
+See [“Blacklists” and “whitelists”: a salutary warning concerning the
+prevalence of racist language in discussions of predatory
+publishing](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6148600/) for
+further details.
+
 ## Contribution Tasks
 
 * Reporting Issues

data/Gemfile

@@ -9,41 +9,49 @@ group :development, :test do
   gem 'pry-byebug' unless ENV['CI']
 end
 
-# BEGIN ENGINE_CART BLOCK
-# engine_cart: 0.10.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] Unable to find test application dependencies in #{file}, using placeholder dependencies"
-
-  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
+# == Extra dependencies for dummy test app ==
+#
+# Extra dependencies for dummy test app are in .gemspec as a development dependency
+# where possible. But when  dependencies vary for different versions
+# of Rails, rails-version-specific dependencies are here, behind conditionals, for now.
+#
+# TODO switch to use appraisal gem instead, encapsulating these different additional
+# dependencies per Rails version, as well as method of choosing operative rails version.
+#
+# We allow testing under multiple versions of Rails by setting ENV RAILS_VERSION,
+# used in CI, can be used locally too.
+
+# Set a default RAILS_VERSION so we make sure to get extra dependencies for it...
+
+ENV['RAILS_VERSION'] ||= "7.0.3"
+
+if ENV['RAILS_VERSION']
+  if ENV['RAILS_VERSION'] == 'edge'
+    gem 'rails', github: 'rails/rails'
+  else
+    gem 'rails', ENV['RAILS_VERSION']
   end
 
   case ENV['RAILS_VERSION']
-  when /^5\./
-    gem 'capybara', '~> 2.18.0'
-  when /^4\.2/
-    gem 'coffee-rails', '~> 4.1.0'
-    gem 'json', '~> 1.8'
-    gem 'railties', '~> 4.2'
-    gem 'responders', '~> 2.0'
-    gem 'sass-rails', '>= 5.0'
+  when /^7\.0\./
+    # rspec-rails 6.0 is required for Rails 7 support, it's currently only in pre-release,
+    # opt into it here. This should not be required when rspec-rails 6.0.0 final is released.
+    # Note rspec-rails 6.0.0 does not support rails before 6.1, so different versions of
+    # rspec-rails will be needed for different jobs, but that should happen automatically.
+    gem "rspec-rails", ">= 6.0.0.rc1"
+
+    # sprockets is optional for rails 7, but we currently require it, and test with it.
+    gem "sprockets-rails"
+  when /^6\.1\./
+    # opt into mail 2.8.0.rc1 so we get extra dependencies required for rails 6.1
+    # Once mail 2.8.0 final is released this will not be required.
+    # https://github.com/mikel/mail/pull/1472
+    gem "mail", ">= 2.8.0.rc1"
+  when /^6\.0\./
+    gem 'sass-rails', '>= 6'
+  when /^5\.[12]\./
+    gem 'sass-rails', '~> 5.0'
+    gem 'sprockets', '~> 3.7'
+    gem 'thor', '~> 0.20'
   end
 end
-# END ENGINE_CART BLOCK
-
-eval_gemfile File.expand_path('spec/test_app_templates/Gemfile.extra', File.dirname(__FILE__)) unless File.exist?(file)

data/README.md

@@ -3,7 +3,6 @@
 Code:
 [![Gem Version](https://badge.fury.io/rb/browse-everything.png)](http://badge.fury.io/rb/browse-everything)
 [![CircleCI](https://circleci.com/gh/samvera/browse-everything.svg?style=svg)](https://circleci.com/gh/samvera/browse-everything)
-[![Coverage Status](https://coveralls.io/repos/samvera/browse-everything/badge.svg?branch=master&service=github)](https://coveralls.io/github/samvera/browse-everything?branch=master)
 
 Docs:
 [![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
@@ -25,6 +24,36 @@ download the files.
 
 **This gem does not depend on hydra-head**
 
+## Technical Debt/Legacy warning
+
+This is code with a long history that has a number of known problems;
+we are trying to keep it alive for existing projects using it. But caution is
+advised in introducing it, in it's present form, to new projects.
+
+A significant overhaul of this gem may be desirable (with backwards-breaking
+changes), to better accomplish gem goals. But there has not been the
+interest/resources in the community to accomplish that at present.
+
+Some known current issues (Jun 2022):
+
+* The S3 adapter is known working; but it's not clear if other adapters using
+OAuth2 (main use case for this gem) are in fact working reliably. And there
+is some concern that the current browse-everything integration API may not be
+compatible with proper OAuth/OAuth2 flows to support OAuth integrations --
+originally the main use case of this gem.
+
+* The CSS and Javascript were both written for use with the sprockets Rails
+asset pipeline.  Recent versions of Rails may require custom configuration
+to use sprockets (especially for JS), which is not currently covered in
+instructions here. Using other means of including CSS and JS may require
+confusing customization also not fully covered here.
+
+* Javascript depends on JQuery, bootstrap (3 or 4; 5 untested), as well as a
+vendored copy of a jquery.treetable plugin.
+
+* CSS is provided for compatibilty with bootstrap 3 or bootstrap 4, but not
+bootstrap 5 (or no bootstrap at all)
+
 ## Product Owner & Maintenance
 
 BrowseEverything is a Core Component of the Samvera community. The documentation for
@@ -33,20 +62,24 @@ what this means can be found
 
 ### Product Owner
 
-[mbklein](https://github.com/mbklein)
+[jrgriffiniii](https://github.com/jrgriffiniii)
 
 # Getting Started
 
 ## Supported Ruby Releases
-Currently, the following releases of Ruby are supported:
-- 2.6.3
-- 2.5.5
-- 2.4.6
+Currently, the following releases of Ruby are tested:
+- 3.1
+- 3.0
+- 2.7
+- 2.6
 
 ## Supported Rails Releases
 The supported Rail releases follow those specified by [the security policy of the Rails Community](https://rubyonrails.org/security/).  As is the case with the supported Ruby releases, it is recommended that one upgrades from any Rails release no longer receiving security updates.
-- 5.2.3
-- 5.1.7
+- 7.0
+- 6.1
+- 6.0
+- 5.2
+- 5.1
 
 ## Installation
 
@@ -98,29 +131,6 @@ If your app has installed a previous version of browse-everything, you may have
 
 However, we also recommend merging the contents of this file into your main `application.scss` file, as documented in the current install instructions. With the separate generated file with bootstrap imports, you may likely be including bootstrap CSS in your generated CSS bundle twice, if you also have that import in your main application.scss already.
 
-## Testing
-This is a Rails Engine which is tested using the [engine_cart](https://github.com/cbeer/engine_cart) Gem and rspec.
-
-One rspec test invokes [karma](https://karma-runner.github.io/latest/index.html) to run Javascript tests. For this test to succeed, you need to install karma on your system, first by making sure `npm` is installed, and then run `npm install -g karma karma-jasmine karma-chrome-launcher`.
-
-Test suites may be executed with the following invocation:
-
-```bash
-bundle exec rake
-```
-
-Tests by default will be run with bootstrap-4 integration. To test bootstrap-3 integration: `TEST_BOOTSTRAP=3 bundle exec rake`.
-
-### Testing Problems
-Should you attempt to execute the test suite and encounter the following error:
-```bash
-Your Ruby version is 2.x.x, but your Gemfile specified 2.y.z
-```
-...then you must clean the internal test app generated by `engine_cart` with the following:
-```bash
-bundle exec rake engine_cart:clean
-```
-
 ## Usage
 
 ### Adding Providers
@@ -251,6 +261,31 @@ See `spec/support/app/views/file_handler/index.html` for an example use case. Yo
 create a fully-functioning demo app in `spec/internal` (though you will have to create
 `spec/internal/config/browse_everything.providers.yml` file with your own configuration info.)
 
+## Development Testing
+
+This is a Rails Engine which is tested using an in-repo "dummy" app, in the style of skeletons
+generated by `rails plugin new --full`.
+
+### Rails utilities
+
+This gives you Rails-provided tools you can run in project home dir, like: `./bin/rails console`, `./bin/rails server` (to start the dummy app in dev mode), `bundle exec rake db:drop db:create db:migrate` (db management in dummy app).
+
+### Test suite
+
+Full CI/test suite may be executed with the following invocation:
+
+```bash
+bundle exec rake
+```
+
+Or individually, `bundle exec rubocop`, `bundle exec rspec`.
+
+### Testing with different versions of dependencies
+
+You can test with different versions of rails by setting ENV variable `RAILS_VERSION` to a specific version like `"6.1.2"` or `"7.0.0"`, perhaps by `export RAILS_ENV=7.0.0` to set it in your shell session.
+
+After changing `RAILS_VERSION` you may have to run `rm Gemfile.lock` and `bundle install` again. If you get a `Bundler could not find compatible versions...` error, for instance.
+
 # Help
 
 The Samvera community is here to help. Please see our [support guide](./SUPPORT.md).

data/Rakefile

@@ -1,10 +1,18 @@
 # frozen_string_literal: true
 
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy_test_app/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
 require 'bundler/gem_tasks'
 
 Dir.glob('tasks/*.rake').each { |r| import r }
 
 require 'rspec/core/rake_task'
-require 'engine_cart/rake_task'
 
 task default: [:ci]