curation_concerns 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89dd4ec9b6787f7448fa599e2d5ea3cd9ebc898f
-  data.tar.gz: 714d172c38c6b1201fe0f63bad2ce359f61073f4
+  metadata.gz: 782489cf38f83c30ac855fbe3a965604bc2a4169
+  data.tar.gz: db4129b1a303be1a6e1e7adc3ed000b72eb90220
 SHA512:
-  metadata.gz: 9658ecf651db9a338b058255881c6d536732bc9b4850574f94c9ee525e7e29df3b797d7e28d54aea6902836158e66ed0b95592fd38e17b220422dd6e7f29f4d1
-  data.tar.gz: 0e99bc7eaa29b260ceef72c541a75cd3ef72663f3152c290874ed2951d43e2f519fdc9bfd72f75bf2d21b215091ecc1a78262b126c8090d50100ddd9caf1fceb
+  metadata.gz: e94379134b788b2a80094661da85dec7ad9ab23094203b604e3ca229d4417a26d41a80a13b986ce907721541a503e857656abc08e651b7cfa013a94b2237c1a0
+  data.tar.gz: c77a0a7b3980c1dcd74542986d6e52041846ae11ed90afea9fd98c2b654b35a57198bbfc0a3cbf19fd102c4c7265288b6fb0bed9294efa61da8193cabe750308

data/.gitignore

@@ -1,14 +1,12 @@
-*.gem
-*.rbc
-.bundle
+/.bundle
 Gemfile.lock
 coverage
 pkg
 tmp
-*.bundle
-spec/internal
 jetty
-.rvmrc
-.ruby-*
-./spec/internal
-.DS_store
+/.rvmrc
+/.ruby-version
+/.ruby-gemset
+solr_conf/
+spec/internal
+spec/mock_upload_directory

data/.rspec

@@ -1,2 +1,2 @@
 --colour
---format documentation
+--exclude-pattern spec/internal/**/*

data/.rubocop.yml

@@ -0,0 +1,185 @@
+require: rubocop-rspec
+
+AllCops:
+  RunRailsCops: true
+  DisplayCopNames: true
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    - 'db/**/*'
+    - 'script/**/*'
+    - 'vendor/**/*'
+    - 'spec/internal/**/*'
+    - 'curation_concerns-models/app/models/concerns/curation_concerns/file_set/export.rb'
+
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'curation_concerns-models/app/services/curation_concerns/persist_derivatives.rb'
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'curation_concerns-models/app/services/curation_concerns/file_set_audit_service.rb'
+    - 'app/controllers/concerns/curation_concerns/file_sets_controller_behavior.rb'
+    - 'app/helpers/curation_concerns/curation_concerns_helper_behavior.rb'
+    - 'app/helpers/curation_concerns/attribute_helper.rb'
+    - 'curation_concerns-models/app/actors/curation_concerns/file_set_actor.rb'
+    - 'curation_concerns-models/app/actors/curation_concerns/work_actor_behavior.rb'
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'curation_concerns-models/app/services/curation_concerns/file_set_audit_service.rb'
+    - 'app/controllers/concerns/curation_concerns/file_sets_controller_behavior.rb'
+    - 'app/helpers/curation_concerns/curation_concerns_helper_behavior.rb'
+    - 'app/helpers/curation_concerns/attribute_helper.rb'
+    - 'curation_concerns-models/app/actors/curation_concerns/file_set_actor.rb'
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/generators/curation_concerns/templates/catalog_controller.rb'
+    - 'curation_concerns-models/app/models/datastreams/fits_datastream.rb'
+    - 'curation_concerns-models/app/actors/curation_concerns/file_set_actor.rb'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'app/controllers/concerns/curation_concerns/curation_concern_controller.rb'
+    - 'app/controllers/concerns/curation_concerns/users_controller_behavior.rb'
+    - 'app/controllers/concerns/curation_concerns/catalog_controller.rb'
+    - 'app/controllers/concerns/curation_concerns/file_sets_controller_behavior.rb'
+    - 'app/helpers/curation_concerns/curation_concerns_helper_behavior.rb'
+    - 'curation_concerns-models/app/models/concerns/curation_concerns/solr_document_behavior.rb'
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Style/AccessorMethodName:
+  Exclude:
+    - 'app/controllers/concerns/curation_concerns/curation_concern_controller.rb'
+
+Style/BlockEndNewline:
+  Exclude:
+    - 'spec/**/*'
+
+Style/MultilineBlockLayout:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Semicolon:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Lambda:
+  Exclude:
+    - 'spec/**/*'
+
+Style/IndentationConsistency:
+  EnforcedStyle: rails
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+Style/WordArray:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashSyntax:
+  Exclude:
+    - 'lib/generators/curation_concerns/templates/catalog_controller.rb'
+
+Style/LineEndConcatenation:
+  Exclude:
+    - 'spec/test_app_templates/lib/generators/**/*'
+    - 'curation_concerns-models/lib/generators/**/*'
+
+Style/PredicateName:
+  Exclude:
+    - 'app/helpers/curation_concerns/curation_concerns_helper_behavior.rb'
+    - 'app/controllers/concerns/curation_concerns/controller.rb'
+    - 'app/helpers/curation_concerns/collections_helper.rb'
+
+Style/GlobalVars:
+  Exclude:
+    - 'spec/**/*'
+    - 'spec/jobs/event_jobs_spec.rb'
+    - 'curation_concerns-models/lib/generators/curation_concerns/models/templates/config/redis_config.rb'
+    - 'curation_concerns-models/lib/curation_concerns/models/active_record/redis.rb'
+    - 'curation_concerns-models/lib/curation_concerns/models/active_fedora/redis.rb'
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/ClassVars:
+  Exclude:
+    - 'curation_concerns-models/lib/curation_concerns/models.rb'
+    - 'curation_concerns-models/lib/curation_concerns/models/engine.rb'
+    - 'curation_concerns-models/app/models/concerns/curation_concerns/file_set/versions.rb'
+
+Style/SignalException:
+  Enabled: false
+
+Rails/Output:
+  Exclude:
+    - 'lib/generators/**/*'
+    - 'curation_concerns-models/lib/generators/**/*'
+
+Rails/Date:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false
+
+RSpec/ExampleWording:
+  CustomTransform:
+    be: is
+    have: has
+    not: does not
+    NOT: does NOT
+  IgnoredWords:
+    - only
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/javascripts/jasmine_spec.rb'
+    - 'spec/tasks/rake_spec.rb'
+    - 'spec/jobs/event_jobs_spec.rb'
+    - 'spec/abilities/**/*'
+    - 'spec/features/**/*'
+    - 'spec/views/**/*'
+    - 'spec/routing/**/*'
+    - 'spec/inputs/**/*'
+
+RSpec/DescribedClass:
+  Exclude:
+    - 'spec/actors/curation_concerns/manages_embargoes_actor_spec.rb'

data/.travis.yml

@@ -6,13 +6,3 @@ rvm:
 env:
   global:
   - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-notifications:
-  email:
-    recipients:
-      - "eliotj@princeton.edu"
-      - "kr2@princeton.edu"
-      - "jstroop@princeton.edu"
-    on_success: "change"
-    on_failure: "always"
-    template:
-      - "%{repository}//%{branch}@%{commit} by %{author}: %{message} - %{build_url}"

data/CONTRIBUTING.md

@@ -0,0 +1,117 @@
+# 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.
+
+## Hydra Project 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.
+
+https://wiki.duraspace.org/display/hydra/Hydra+Project+Intellectual+Property+Licensing+and+Ownership
+
+You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.
+
+## Contribution Tasks
+
+* Reporting Issues
+* Making Changes
+* Submitting Changes
+* Merging Changes
+
+### Reporting Issues
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a [Github issue](./issues) by:
+  * Clearly describing the issue
+    * Provide a descriptive summary
+    * Explain the expected behavior
+    * Explain the actual behavior
+    * Provide steps to reproduce the actual behavior
+
+### Making Changes
+
+* Fork the repository on GitHub
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * To quickly create a topic branch based on master; `git branch fix/master/my_contribution master`
+  * 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 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)
+
+```
+    Present tense short summary (50 characters or less)
+
+    More detailed description, if necessary. It should be wrapped to 72
+    characters. Try to be as descriptive as you can, even if you think that
+    the commit content is obvious, it may not be obvious to others. You
+    should add such description also if it's already present in bug tracker,
+    it should not be necessary to visit a webpage to check the history.
+
+    Include Closes #<issue-number> when relavent.
+
+    Description can have multiple paragraphs and you can use code examples
+    inside, just indent it with 4 spaces:
+
+        class PostsController
+          def index
+            respond_to do |wants|
+                wants.html { render 'index' }
+            end
+          end
+        end
+
+    You can also add bullet points:
+
+    - you can use dashes or asterisks
+
+    - also, try to indent next line of a point for readability, if it's too
+      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.
+* Make sure your branch is up to date with its parent branch (i.e. master)
+  * `git checkout master`
+  * `git pull --rebase`
+  * `git checkout <your-branch>`
+  * `git rebase master`
+  * It is likely a good idea to run your tests again.
+* If you've made more than one commit take a moment to consider whether squashing commits together would help improve their logical grouping.
+  * [Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
+  * `git rebase --interactive HEAD~<number-of-commits>` ([See Github help](https://help.github.com/articles/interactive-rebase))
+  * To determine the number of commits on your branch: `git log master..<your-branch> --oneline | wc -l`
+  * Squashing your branch's changes into one commit is "good form" and helps the person merging your request to see everything that is going on.
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request from your fork to the project.
+
+### Merging Changes
+
+* It is considered "poor from" to merge your own request.
+* 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_
+  * 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.
+* If you like the pull request, but want others to chime in, create a +1 comment and tag a user.
+
+## New Developers
+A great way to get new developers involved and to learn the process is to have them go through the Hierarchy of Promises and create a pull request to improve it.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-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

@@ -7,10 +7,14 @@ gem 'slop', '~> 3.6.0' # This just helps us generate a valid Gemfile.lock when R
 
 gem 'curation_concerns-models', path: './curation_concerns-models'
 
-group :test do
+group :development, :test do
+  gem 'rubocop', require: false
+  gem 'rubocop-rspec', require: false
   gem 'simplecov', '~> 0.9', require: false
   gem 'coveralls', require: false
   gem 'poltergeist'
+  gem 'pry' unless ENV['CI']
+  gem 'pry-byebug' unless ENV['CI']
 end
 
 file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path("../spec/internal", __FILE__))
@@ -22,7 +26,6 @@ else
   if ENV['RAILS_VERSION'] and ENV['RAILS_VERSION'] !~ /^4.2/
     gem 'sass-rails', "< 5.0"
   else
-    gem 'responders', "~> 2.0"
     gem 'sass-rails', ">= 5.0"
   end
 

data/README.md

@@ -1,33 +1,42 @@
-# Curation Concern
+# CurationConcerns
+
+[![Version](https://badge.fury.io/rb/curation_concerns.png)](http://badge.fury.io/rb/curation_concerns)
 [![Build Status](https://travis-ci.org/projecthydra-labs/curation_concerns.svg?branch=master)](https://travis-ci.org/projecthydra-labs/curation_concerns)
 [![Coverage Status](https://coveralls.io/repos/projecthydra-labs/curation_concerns/badge.svg?branch=master)](https://coveralls.io/r/projecthydra-labs/curation_concerns?branch=master)
+[![Code Climate](https://codeclimate.com/github/projecthydra-labs/curation_concerns/badges/gpa.svg)](https://codeclimate.com/github/projecthydra-labs/curation_concerns)
+[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE.txt)
+[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
+[![API Docs](http://img.shields.io/badge/API-docs-blue.svg)](http://rubydoc.info/gems/curation_concerns)
+[![Stories in Ready](https://badge.waffle.io/projecthydra-labs/sufia-core.png?source=projecthydra-labs%2Fcuration_concerns&label=ready&title=Ready)](https://waffle.io/projecthydra-labs/sufia-core?source=projecthydra-labs%2Fcuration_concerns)
 
-A Hydra-based Rails Engine that extends an application, adding the ability to Create, Read, Update and Destroy (CRUD) CurationConcern objects (a.k.a. "Works") and provides a generator for defining new CurationConcern types with custom workflow, views, access controls, etc.
+A Hydra-based Rails Engine that extends an application, adding the ability to Create, Read, Update and Destroy (CRUD) objects (based on [Hydra::Works](http://github.com/projecthydra-labs/hydra-works)) and providing a generator for defining object types with custom workflows, views, access controls, etc.
 
 ## Installation
 
+Checkout the dependencies for [curation_concerns-models](https://github.com/projecthydra-labs/curation_concerns/tree/master/curation_concerns-models#dependencies), which is installed as part of curation_concerns.
+
 Add this line to your application's Gemfile:
 
     gem 'curation_concerns'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Then:
 
     $ rails generate curation_concerns:install
     $ rake db:migrate
 
-# Usage
+## Usage
 
-## Generator
+### Generator
 
-To generate a new CurationConcern type, use the `curation_concerns:work` rails generator.  Follow the Usage instructions provided on the command line when you run:
+To generate a new object type, use the `curation_concerns:work` Rails generator.  Follow the usage instructions provided on the command line when you run:
 
-    rails generate curation_concerns:work
+    $ rails generate curation_concerns:work
 
-## Virus Detection
+### Virus Detection
 
 To turn on virus detection, install clamav on your system and add the `clamav` gem to your Gemfile
 
@@ -37,10 +46,8 @@ To turn on virus detection, install clamav on your system and add the `clamav` g
 
 If you are modifying the curation_concerns gem and want to run the test suite, follow these steps to set up the test environment.
 
-```
     $ rake engine_cart:generate
     $ rake jetty:clean
-    $ rake curation_concerns:jetty:config
+    $ rake jetty:config
     $ rake jetty:start
     $ rake spec
-```

data/Rakefile

@@ -1,25 +1,37 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'bundler/setup'
-
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-Dir.glob('tasks/*.rake').each { |r| import r }
-
 require 'jettywrapper'
 require 'engine_cart/rake_task'
-Jettywrapper.hydra_jetty_version = "v8.3.1"
+require 'rubocop/rake_task'
+
+Dir.glob('tasks/*.rake').each { |r| import r }
 
 # This makes it possible to run curation_concerns:jetty:config from here.
 import 'curation_concerns-models/lib/tasks/curation_concerns-models_tasks.rake'
 
-task ci: ['engine_cart:generate', 'jetty:clean'] do
+Jettywrapper.hydra_jetty_version = 'v8.3.1'
+
+desc 'Run style checker'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.requires << 'rubocop-rspec'
+  task.fail_on_error = true
+end
+
+desc 'Run test suite and style checker'
+task spec: :rubocop do
+  RSpec::Core::RakeTask.new(:spec)
+end
+
+task ci: ['engine_cart:generate', 'jetty:clean', 'jetty:config'] do
+  puts 'running continuous integration'
   jetty_params = Jettywrapper.load_config
-  jetty_params[:startup_wait]= 90
+  jetty_params[:startup_wait] = 90
 
-  Jettywrapper.wrap(jetty_params) do
-    # run the tests
-    Rake::Task["spec"].invoke
+  error = Jettywrapper.wrap(jetty_params) do
+    Rake::Task['spec'].invoke
   end
+  fail "test failures: #{error}" if error
 end
 
 task clean: 'engine_cart:clean'

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/app/assets/javascripts/curation_concerns/application.js

@@ -1,9 +1,5 @@
-//= require jquery-ui-1.9.2/jquery.ui.widget
-//= require jquery-ui-1.9.2/jquery.ui.core
-//= require jquery-ui-1.9.2/jquery.ui.menu
-//= require jquery-ui-1.9.2/jquery.ui.position
-//= require jquery-ui-1.9.2/jquery.ui.autocomplete
-//
+//= require jquery-ui/widget
+
 //= require blacklight/blacklight
 //
 //= require bootstrap/dropdown
@@ -13,6 +9,4 @@
 //= require bootstrap/popover
 //= require bootstrap/tab
 //
-//= require handlebars
-//= require jquery.tokeninput
 //= require curation_concerns/curation_concerns

data/app/assets/javascripts/curation_concerns/curation_concerns.js

@@ -1,27 +1,13 @@
 //= require hydra-editor/hydra-editor
-//= require curation_concerns/help_modal
-//= require curation_concerns/select_works
-//= require curation_concerns/link_users
-//= require curation_concerns/link_groups
-//= require curation_concerns/proxy_rights
 //= require curation_concerns/facet_mine
-//= require curation_concerns/proxy_submission
 //= require curation_concerns/embargoes
+//= require curation_concerns/fileupload
 
 
 // Initialize plugins and Bootstrap dropdowns on jQuery's ready event as well as
 // Turbolinks's page change event.
 Blacklight.onLoad(function() {
   $('abbr').tooltip();
-  $('.link-users').linkUsers();
-  $('.link-groups').linkGroups();
-  $('.proxy-rights').proxyRights();
-
-
-//  $('#set-access-controls .datepicker').datepicker({
-//    format: 'yyyy-mm-dd',
-//    startDate: '+1d'
-//  });
 
   $("[data-toggle='dropdown']").dropdown();
 

data/app/assets/javascripts/curation_concerns/facet_mine.js

@@ -1,22 +1,16 @@
 //= require blacklight/core
 (function($) {
   var facet_mine_behavior = function() {
+    // TODO: pull in https://github.com/projecthydra-labs/curate/blob/master/app/views/catalog/_facets.html.erb
     $('#aux-search-submit-header').hide();
 
     $('input[name="works"]').on("change", function(e) {
       $(this).closest('form').submit();
     });
 
-  };  
+  };
 
-
-  // TODO when we upgrade blacklight to 4.4+, we can use Blacklight.onLoad()
-  if (typeof Turbolinks !== "undefined") {
-    $(document).on('page:load', function() {
-      facet_mine_behavior();  
-    });
-  }
-  $(document).ready(function() {
-    facet_mine_behavior();  
+  Blacklight.onLoad(function() {
+    facet_mine_behavior();
   });
 })(jQuery);

data/app/assets/javascripts/curation_concerns/fileupload.js

@@ -0,0 +1,6 @@
+//= require curation_concerns/uploader
+// This file is the default initialization of the fileupload.  If you want to call
+// curationConcernsUploader with other options (like afterSubmit), then override this file.
+Blacklight.onLoad(function() {
+  $('#fileupload').curationConcernsUploader();
+});