hydra 9.1.0.rc1 → 9.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 833fc88fc2195a9ee04063deb11435802bbbd2ec
-  data.tar.gz: 2dcc80b20b70b834e71cbf25fbfd13915e263cc0
+  metadata.gz: 1f0ef7db5ac29816927f7c025d320d6e48baed46
+  data.tar.gz: 4108a9a10ac2dc8df682e38c1c9072d6b3a1a86c
 SHA512:
-  metadata.gz: 4cd84b988f85a8cbc79a4c38b4396663bddcec717401dc0961a938f36b10d328783f60bc7681d71df5e00e406de19af7881580c45f60f1941181076e5e031213
-  data.tar.gz: e0764b715e4cde9e9fe9b126a392c3a9fc3a7564b53fc7a218e15fe1e23b8686a2e380303f3b2580773bb5fd578aa013e9cc64af8445a3bd94881053b7738bc6
+  metadata.gz: 3cb9547c9700c4be877811e0e3ca8eba89a19586e7c174d06d05206d587f5575dcc4d5af07da31ba7afec5ff3880da4642f705db4738e1dc944af67ac472176c
+  data.tar.gz: c5e88e91f867e6b92966d45401454c87d2ca0fd1def9f8ce7cf80028d3f49ae8b312121bc89207e2e45e6420ea25dd7ea5336967e51ad155cd1e5dbc67d741bf

data/CONTRIBUTING.md

@@ -16,6 +16,8 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
 
 * Reporting Issues
 * Making Changes
+* Documenting Code
+* Committing Changes
 * Submitting Changes
 * Merging Changes
 
@@ -38,6 +40,26 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
   * Then checkout the new branch with `git checkout fix/master/my_contribution`.
   * 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.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+
+### Documenting Code
+
+* All new public methods, modules, and classes should include inline documentation in [YARD](http://yardoc.org/).
+  * Documentation should seek to answer the question "why does this code exist?"
+* Document private / protected methods as desired.
+* If you are working in a file with no prior documentation, do try to document as you gain understanding of the code.
+  * 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.
@@ -72,10 +94,6 @@ 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.
@@ -99,6 +117,7 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
 * Please take the time to review the changes and get a sense of what is being 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 refactorings_
+  * Do all new methods, modules, and classes have comments? Do changed methods, modules, and classes have comments?
   * Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
   * Did the Travis tests complete successfully?
 * If you are uncertain, bring other contributors into the conversation by creating a comment that includes their @username.

data/README.md

@@ -5,7 +5,7 @@ This gem provides a distribution-like snapshot of all dependencies within the co
 * [solrizer](https://github.com/projecthydra/solrizer) - translates indexing directives into Solr field names
 * [om](https://github.com/projecthydra/om) - a library for defining templates for xml metadata formats
 * [nom-xml](https://github.com/cbeer/nom-xml) - an alternative to om
-* [active-fedora](https://github.com/projecthydra/active_fedora) - an ORM for Fedora and Solr
+* [active-fedora](https://github.com/projecthydra/active_fedora) - a Ruby gem for creating and managing objects in Fedora and Solr
 * [blacklight](https://github.com/projectblacklight/blacklight) - web front end for Solr document discovery (search)
 * [hydra-head](https://github.com/projecthydra/hydra-head) - integration between Blacklight and ActiveFedora. Provides access controls and gated searching.
 * [jettywrapper](https://github.com/projecthydra/jettywrapper) - Utilities for starting up a jetty server with Solr and Fedora useful in development and testing.

data/hydra.gemspec

@@ -23,17 +23,17 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.license = 'APACHE2'
 
-  gem.add_dependency 'jettywrapper', '~> 2.0.0'
-  gem.add_dependency 'active-fedora', '~> 9.1.1'
-  gem.add_dependency 'hydra-head', '~> 9.1.4'
-  gem.add_dependency 'rails', '~> 4.1'
+  gem.add_dependency 'fcrepo_wrapper', '~> 0.1.2'
+  gem.add_dependency 'active-fedora', '~> 9.8.0'
+  gem.add_dependency 'hydra-head', '~> 9.6.0'
+  gem.add_dependency 'rails', '~> 4.2'
   gem.add_dependency 'om', '~> 3.1.0'
   gem.add_dependency 'solrizer', '~> 3.3.0'
-  gem.add_dependency 'rsolr', '~> 1.0.10'
-  gem.add_dependency 'blacklight', '~> 5.13.1'
-  gem.add_dependency 'nokogiri', '~> 1.6.5'
-  gem.add_dependency 'ldp', '~> 0.3.0'
-  gem.add_dependency 'active-triples', '~> 0.6.0'
+  gem.add_dependency 'rsolr', '~> 1.0.13'
+  gem.add_dependency 'blacklight', '~> 6.0.1'
+  gem.add_dependency 'nokogiri', '~> 1.6.7'
+  gem.add_dependency 'ldp', '~> 0.4.1'
+  gem.add_dependency 'active-triples', '~> 0.7.4'
   gem.add_dependency 'nom-xml', '~> 0.5.1'
-  gem.add_development_dependency 'github_api', '~> 0.10.1'
+  gem.add_development_dependency 'github_api', '~> 0.13'
 end

data/lib/generators/hydra/install_generator.rb

@@ -5,9 +5,11 @@ module Hydra
     desc 'Generate a new hydra project'
 
     def run_other_generators
-      generate("blacklight:install --devise")
-      generate('hydra:head -f')
-      rake('db:migrate')
+      Bundler.with_clean_env do
+        generate("blacklight:install --devise")
+        generate('hydra:head -f')
+        rake('db:migrate')
+      end
     end
   end
-end
+end

data/lib/hydra/version.rb

@@ -1,3 +1,3 @@
 module Hydra
-  VERSION = "9.1.0.rc1"
+  VERSION = "9.1.0.rc2"
 end

data/script/grant_revoke_gem_authority.rb

@@ -1,82 +1,139 @@
-# To run:
-# $ ruby ./script/grant_revoke_gem_authority.rb
-RUBYGEM_NAMES = [
-  'active-fedora',
-  'active_fedora-registered_attributes',
-  'active_fedora_relsint',
-  'browse-everything',
-  'hydra',
-  'hydra-access-controls',
-  'hydra-batch-edit',
-  'hydra-collections',
+# 1. Get a personal access token from GitHub with the following scopes enabled:
+#    * public_repo
+#    * read:org
+#    * user:email
+# 2. Set an ENV variable named 'GITHUB_HYDRA_TOKEN' containing your token
+# 3. Then run this script:
+#    $ ruby ./script/grant_revoke_gem_authority.rb
+#
+# To also revoke ownership from users whose email addresses are not in the list:
+# $ WITH_REVOKE=true ruby ./script/grant_revoke_gem_authority.rb
+
+require 'github_api'
+require 'open3'
+
+AUTHORIZATION_TOKEN = ENV['GITHUB_HYDRA_TOKEN'] || raise("GitHub authorization token was not found in the GITHUB_HYDRA_TOKEN environment variable")
+ORGANIZATION_NAMES = ['projecthydra', 'projecthydra-labs', 'projecthydra-deprecated']
+# Some GitHub user instances do not have an email address defined,
+# so start with the prior list of addresses (registered with Rubygems.org)
+KNOWN_COMMITTER_EMAIL_ADDRESSES = {
+  'awead' => "amsterdamos@gmail.com",
+  'atz' => 'ohiocore@gmail.com',
+  'barmintor' => "armintor@gmail.com",
+  'bess' => "bess@stanford.edu",
+  'cam156' => "cam156@psu.edu",
+  'cbeer' => "chris@cbeer.info",
+  'cjcolvar' => "cjcolvar@indiana.edu",
+  'DanCoughlin' => "dan.coughlin@gmail.com",
+  'dchandekstark' => "dchandekstark@gmail.com",
+  'elrayle' => 'elrayle@hotmail.com',
+  'escowles' => 'escowles@ticklefish.org',
+  'hackmastera' => 'anna3lc@gmail.com',
+  'jeremyf' => "jeremy.n.friesen@gmail.com",
+  'jkeck' => "jessie.keck@gmail.com",
+  'coblej' => "jim.coble@duke.edu",
+  'jpstroop' => "jpstroop@gmail.com",
+  'jcoyne' => "justin@curationexperts.com",
+  'mjgiarlo' => "leftwing@alumni.rutgers.edu",
+  'mark-dce' => "mark@curationexperts.com",
+  'mbklein' => "mbklein@gmail.com",
+  'mkorcy' => "mkorcy@gmail.com",
+  'ndushay' => "ndushay@stanford.edu",
+  'tpendragon' => "tpendragon@princeton.edu"
+}
+# Some GitHub repositories are named differently from their gems
+KNOWN_MISMATCHED_GEM_NAMES = {
+  'active_fedora' => 'active-fedora',
+  'fcrepo-admin' => 'fcrepo_admin',
+  'questioning_authority' => 'qa'
+}
+# GitHub repositories with matching gems that aren't from Hydra
+FALSE_POSITIVES = [
+  'hypatia',
+  'rdf-vocab'
+]
+# Gems that do not have their own GitHub repositories
+HANGERS_ON = [
   'hydra-core',
-  'hydra-derivatives',
-  'hydra-editor',
-  'hydra-head',
-  'hydra-ldap',
-  'hydra-migrate',
-  'hydra-mods',
-  'hydra-role-management',
-  'hydra-file_characterization',
-  'jettywrapper',
-  'curate',
-  'om',
-  'qa',
-  'rubydora',
-  'solrizer',
-  'solrizer-fedora',
-  'sufia',
-  'sufia-models',
+  'hydra-access-controls',
+  'sufia-models'
 ]
-
-HYDRA_COMMITTER_EMAILS = [
-  "amsterdamos@gmail.com",
-  "armintor@gmail.com",
-  "bess@stanford.edu",
-  "cam156@psu.edu",
-  "chris@cbeer.info",
-  "cjcolvar@indiana.edu",
-  "dan.coughlin@gmail.com",
-  "dchandekstark@gmail.com",
-  "edwin.shin@yourmediashelf.com",
-  "jeremy.n.friesen@gmail.com",
-  "jessie.keck@gmail.com",
-  "jim.coble@duke.edu",
-  "jpstroop@gmail.com",
-  "justin@curationexperts.com",
-  "leftwing@alumni.rutgers.edu",
-  "mark@curationexperts.com",
-  "matt@curationexperts.com",
-  "mbklein@gmail.com",
-  "mkorcy@gmail.com",
-  "mstrom81@gmail.com",
-  "ndushay@stanford.edu",
+# Email addresses that are known not to be registered at rubygems.organization
+SKIP_EMAILS = [
+  'ggeisler@gmail.com'
 ]
 
+puts "(Hang in there! This script takes a couple minutes to run.)"
+
+github = Github.new(oauth_token: AUTHORIZATION_TOKEN, auto_pagination: true)
+
+# Get the ID of the GitHub-provided "Owners" team from the projecthydra org
+# We don't currently grant gem ownership to the folks in the other two orgs
+# (This just preserves the prior behavior.)
+owner_team_id = github.orgs.teams.list('projecthydra').select { |team| team.name == 'Owners' }.first.id
+owners = github.orgs.teams.list_members(owner_team_id)
+# Start with the prior (known to work) list of email addresses
+committer_map = KNOWN_COMMITTER_EMAIL_ADDRESSES.dup
+owners.each do |owner|
+  user = github.users.get(user: owner.login)
+  # Move along if the user doesn't have an email addy or if there's already an entry in the map
+  next if !user.respond_to?(:email) || user.email.nil? || user.email.empty? || !committer_map[user.login].nil?
+  committer_map[user.login] = user.email
+end
+committer_emails = committer_map.values.sort.uniq
+
+# Keep track of things
 @errors = []
+@bogus_gem_names = []
+@gem_names = HANGERS_ON
 
-def system_command_with_error_check(command)
-  if !system(command)
-    @errors << "ERROR FOR: #{command}"
+def exists?(name)
+  system("gem owner #{name} > /dev/null 2>&1")
+end
+
+def replace_known_mismatch(name)
+  KNOWN_MISMATCHED_GEM_NAMES.fetch(name, name)
+end
+
+ORGANIZATION_NAMES.each do |org_name|
+  github.repos.list(org: org_name).each do |repo|
+    name = replace_known_mismatch(repo.name)
+    if exists?(name)
+      @gem_names << name
+    else
+      @bogus_gem_names << repo.full_name
+    end
   end
 end
 
-RUBYGEM_NAMES.each do |gemname|
+def gem_owner_with_error_check(gemname, params)
+  Open3.popen3("gem owner #{gemname} #{params}") do |stdin, stdout, stderr, wait_thr|
+    stdin.close
+    @errors << "#{gemname} #{params}: #{stdout.read.chomp}" unless wait_thr.value.success?
+  end
+end
+
+@gem_names.reject { |gemname| FALSE_POSITIVES.include?(gemname) }.each do |gemname|
   current_committers = `gem owner #{gemname} | grep -e ^-`.split("\n")
   current_committers.collect! { |cc| cc.sub(/^.\s+/,'')}
 
   if ENV.fetch('WITH_REVOKE', false)
-    committers_to_remove = current_committers - HYDRA_COMMITTER_EMAILS
-    remove_params = committers_to_remove.map {|email| "-r #{email}"}.join(' ')
-    system_command_with_error_check("gem owner #{gemname} #{remove_params}")
+    committers_to_remove = current_committers - committer_emails
+    remove_params = committers_to_remove.map { |email| "-r #{email}" }.join(' ')
+    gem_owner_with_error_check(gemname, remove_params)
   end
 
-  committers_to_add = HYDRA_COMMITTER_EMAILS - current_committers
-  add_params = committers_to_add.map {|email| "-a #{email}"}.join(' ')
-  system_command_with_error_check("gem owner #{gemname} #{add_params}")
+  committers_to_add = committer_emails - current_committers - SKIP_EMAILS
+  add_params = committers_to_add.map { |email| "-a #{email}" }.join(' ')
+  gem_owner_with_error_check(gemname, add_params)
+end
+
+if !@bogus_gem_names.empty?
+  $stderr.puts("WARNING: These Hydra repositories do not have gems: #{@bogus_gem_names.join(', ')}")
+  $stderr.puts("\n")
 end
 
-if ! @errors.empty?
+if !@errors.empty?
   $stderr.puts("The following errors were encountered:")
   $stderr.puts(%(#{@errors.join("\n")}))
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra
 version: !ruby/object:Gem::Version
-  version: 9.1.0.rc1
+  version: 9.1.0.rc2
 platform: ruby
 authors:
 - Jeremy Friesen
@@ -9,64 +9,64 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jettywrapper
+  name: fcrepo_wrapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: active-fedora
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 9.1.1
+        version: 9.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 9.1.1
+        version: 9.8.0
 - !ruby/object:Gem::Dependency
   name: hydra-head
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 9.1.4
+        version: 9.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 9.1.4
+        version: 9.6.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: om
   requirement: !ruby/object:Gem::Requirement
@@ -101,70 +101,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.10
+        version: 1.0.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.10
+        version: 1.0.13
 - !ruby/object:Gem::Dependency
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.13.1
+        version: 6.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.13.1
+        version: 6.0.1
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.5
+        version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.5
+        version: 1.6.7
 - !ruby/object:Gem::Dependency
   name: ldp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: active-triples
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.4
 - !ruby/object:Gem::Dependency
   name: nom-xml
   requirement: !ruby/object:Gem::Requirement
@@ -185,14 +185,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '0.13'
 description: Project Hydra Stack Dependencies
 email:
 - jeremy.n.friesen@gmail.com
@@ -270,8 +270,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Project Hydra Stack Dependencies
 test_files: []
+has_rdoc: