curate 0.6.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc4bca83d8de9ce311a2e254c8d42d6aecc871d4
-  data.tar.gz: 7f1af6dc3efc70444219c73d9edda047c6f74fa5
+  metadata.gz: 59395ca50b59f9b6078a239e94f897910cb07f8c
+  data.tar.gz: caaf8e67b45bc57f724c9b1c660f3a03299fc33f
 SHA512:
-  metadata.gz: cb7abc0b9a9df54d0df67c27a6ce6f95b4741ed431523d997dba14509791b3784c57957df75762aa12f31e0a254fefc7e03591c2231e186e438e8bce028416ad
-  data.tar.gz: 5fefe88c94701c353dcd5fef6d8d011bdcabd5329bb8ea4c59c2f227c57d831bb6413640c246105282dd461bd0150cc08f3d1c3981b4b608415223217cbb33bd
+  metadata.gz: 1da77dd060d40a9307c28220655e6be818921a7371dcff140a907db975b1a3784e51bb52c7c137c761fe2e4c9c52afec7832d67287f101169f25a403db4c94ca
+  data.tar.gz: 04b2dc97393bfd0a1125be100c6eceb0bf64de81f02977b75239ec7b989a89237ee568ed1c00f6374fb65ead6c24a1caf5340c153095eb74ab0972ed2672f14b

data/README.md

@@ -1,13 +1,34 @@
 # Curate  [![Version](https://badge.fury.io/rb/curate.png)](http://badge.fury.io/rb/curate) [![Build Status](https://travis-ci.org/projecthydra/curate.png?branch=master)](https://travis-ci.org/projecthydra/curate) [![Coverage Status](https://coveralls.io/repos/projecthydra/curate/badge.png)](https://coveralls.io/r/projecthydra/curate)
 
-## Starting a New Curate Base Application
+Curate is a [Rails engine](http://edgeguides.rubyonrails.org/engines.html) leveraging [ProjectHydra](http://projecthydra.org) and [ProjectBlacklight](http://projectblacklight.org/) components to deliver a foundation for an Institutional Repositories.
+It is released under the [Apache 2 License](./LICENSE)
+
+* [Starting a new Curate-based Rails application](#starting-a-new-curate-based-application)
+  * [or install by hand](#or-install-by-hand)
+* [Developing and contributing for the Curate gem](#developing-and-contributing-for-the-curate-gem)
+  * [Prerequisites](#prerequisites)
+  * [Clone the Curate repository](#clone-the-repo)
+  * [Jetty](#jetty)
+  * [Running the specs](#running-the-specs)
+    * [All of them](#all-of-them)
+    * [Some of them](#some-of-them)
+    * [With Zeus](#with-zeus)
+  * [Contributing back](#contributing-back)
+    * [Coding Guidelines](#coding-guidelines)
+      * [Writing Your Code](#writing-your-code)
+      * [Ruby File Structure](#ruby-file-structure)
+    * [Source Control Guidelines](#source-control-guidelines)
+* [Working on Curate while working on my Application](#working-on-curate-while-working-on-my-application)
+* [Standing up your Curate-based Rails application in Production](#standing-up-your-curate-based-rails-application-in-production)
+
+# Starting a New Curate Based Application
 
 When you generate your new Rails application, you can use Curate's application template:
 ```bash
 $ rails new my_curate_application -m https://raw.github.com/ndlib/curate/master/lib/generators/curate/application_template.rb
 ```
 
-### Or Install By Hand
+## Or Install By Hand
 
 Add the following line to your application's Gemfile:
 
@@ -19,84 +40,147 @@ $ bundle
 $ rails generate curate
 ```
 
-## Curate Developer Notes
+# Developing and Contributing for the Curate gem
 
-### Initial Setup
+## Prerequisites
 
-Add this line to `config/environments/production.rb`
+You may need to have the following installed ‡
 
-```ruby
-  config.assets.precompile += %w( modernizr.js )
-```
+* imagemagick (http://www.imagemagick.org/script/index.php)
+* fits.sh (https://code.google.com/p/fits/wiki/installing)
+* ffmpeg (optional, http://www.ffmpeg.org/)
+* Redis (http://redis.io/)
+* rubygems (http://rubygems.org/pages/download)
+* ClamAV (http://www.clamav.net/)
 
-### Jetty Commands
+‡ - Why "you may need"? Some of these are only optionally used in development and tests; But production will need it.
 
-Install jetty:
+## Clone the Curate repository
 
+From the command line:
 ```bash
-$ rake jetty:unzip
+git clone https://github.com/projecthydra/curate.git ./path/to/local
 ```
 
-Start/stop jetty:
+## Jetty
 
-```bash
-$ rake jetty:start
-$ rake jetty:stop
-```
+Curate uses Jetty for development and testing.
+You could configure it to use an alternate Fedora and SOLR location, but that is an exercise for the reader.
+**The hydra-jetty package should not be use for secure production installations**
 
-Jetty logs:
+### Install Jetty
+Install jetty, you should only need to do this once (unless you remove the ./jetty directory)
 
 ```bash
-$ tail -f jetty/jettywrapper.log
+$ rake jetty:unzip
 ```
 
-### Running the Specs
+## Running the Specs
 
-To clean & generate a dummy app that the specs will use for testing:
-```bash
-$ rake clean
-$ rake generate
-```
+Inside the Curate directory (i.e. `./path/to/local`):
 
-Make sure jetty is running before you run the specs.
+### All of Them
 
-To run the test suite:
-```bash
-$ rake spec
-```
+1. Make sure jetty is running (`rake jetty:start`); It will take a bit to spin up jetty.
+1. Make sure you have a dummy app ‡
+  1. Run `rake regenerate` build the to get a clean app ./spec/dummy
+1. Then run `rake spec`; The tests will take quite a while ‡‡
+
+‡ - A Rails engine requires a Rails application to run.
+The dummy app is an generated application inside Curate in the `./spec/internal` directory
+‡‡ - Slow tests are a big problem and we are working on speeding them up, but its complicated.
+
+### Some of Them
+
+In some cases you want to know the results of a single test. Here's how you do it.
+
+1. Make sure jetty is running (`rake jetty:start`); It will take a bit to spin up jetty.
+1. Make sure you have a dummy app ‡
+  1. Run `rake regenerate` build the to get a clean app ./spec/dummy
+1. Then run `BUNDLE_GEMFILE=spec/internal/Gemfile bundle exec rspec path/to/spec.rb:LINE` ‡
+
+‡ - With Curate being an Engine we need to point to the Dummy Application's Gemfile.
+In full Rails applications you can normally run the following `rspec path/to/spec.rb:LINE`
+
+### With Zeus
+
+> [Zeus](https://github.com/burke/zeus) preloads your Rails app so that your normal development tasks such as console, server, generate, and specs/tests take less than one second. ‡
+
+1. In terminal window #1 run `zeus start`
+1. In terminal window #2, once Zeus is started: run `zeus rake spec` for all tests; or `zeus test path/to/spec.rb:LINE` for one
+
+‡ - Loading the environment to run your tests takes less than a second. So running an individual test will take less time.
+
+## Contributing Back
+
+There is an existing [CONTRIBUTING.md](./CONTRIBUTING.md) document which is currently under review.
+
+### Coding Guidelines
+
+The [Ruby Style Guide][1] is an excellent resource for how to craft your Ruby code, in particular the [Naming section][2].
+
+**Can I break these guidelines?** Yes. But you may need to convince the person merging your changes.
+
+#### Writing Your Code
+
+We are going to do our best to follow [Sandi Metz' Rules for Developers][3]
+
+> Here are the rules:
+>
+> * Classes can be no longer than one hundred lines of code.
+> * Methods can be no longer than five lines of code.
+> * Pass no more than four parameters into a method. Hash options are parameters.
+> * Controllers can instantiate only one object. Therefore, views can only know about one instance variable and views should only send messages to that object (@object.collaborator.value is not allowed).
+
+#### Ruby File Structure
+
+* Use soft-tabs with a two space indent.
+* Never leave trailing whitespace (unless it is meaningful in the language)
+* End each file with a blank newline.
+* Please do your best to keep lines to 80 characters or fewer.
+
+### Source Control Guidelines
+
+*This is a placeholder for things to come*
+
+[Processing JIRA issues with commit messages](https://confluence.atlassian.com/display/BITBUCKET/Processing+JIRA+issues+with+commit+messages)
 
-To run a localized spec:
-```bash
-$ BUNDLE_GEMFILE=spec/internal/Gemfile bundle exec rspec path/to/spec.rb:LINE
 ```
+First line is 50 characters or less
 
-#### Or run via Zeus:
+Description of work done; wrap at 72 characters.
 
-In terminal window #1
-```bash
-$ zeus start
+HYDRASIR-123 #close Any comment to post to JIRA
 ```
 
-In terminal window #2, once Zeus is loaded:
+Make sure your JIRA email matches your Git config email (`~/.gitconfig`)
 
-```bash
-$ zeus rake spec
+[1]:https://github.com/bbatsov/ruby-style-guide "Ruby Style Guide"
+[2]:https://github.com/bbatsov/ruby-style-guide#naming "Ruby Style Guide - Naming"
+[3]:http://robots.thoughtbot.com/post/50655960596/sandi-metz-rules-for-developers "Sandi Metz' Rules for Developers"
+
+# Working on Curate while working on my Application
+
+Assuming you are wanting to work on your Curate-based application and make modifications to the Curate gem, follow these instructions.
+
+Replace the folliwing line in the Gemfile of your Curate-based application (see [Starting a New Curate Based Application](#starting-a-new-curate-based-application)):
+
+```ruby
+gem 'curate' ...
 ```
 
-Or a localized spec:
+with
 
-```bash
-$ zeus test path/to/spec.rb:LINE
+```ruby
+gem 'curate', path: './path/to/my/clone/of/curate'
 ```
 
-### Running a copy of Curate in the curate gem
+[More information about Gemfile management at Bundler.io](http://bundler.io/v1.5/gemfile.html)
 
-Given that Curate regenerates (via the `rake clean generate` tasks) you can run a functioning instance of curate in that directory.
+You can then do concurrent development on both your clone of the Curate gem and your Curate-based application.
 
-From the curate directory:
-```bash
-$ rake clean generate
-$ rake jetty:start
-$ cd ./spec/internal
-$ rails server
-```
+**NOTE: Any changes you make in the Curate gem will likely require you to restart your web-server.**
+
+# Standing up your Curate-based Rails application in Production
+
+We are working on this and have more to come.

data/app/assets/stylesheets/layout/positioning.css.scss

@@ -40,6 +40,10 @@ legend .pull-right {
   margin-top:.2em;
 }
 
+.unpadded {
+  padding:0;
+}
+
 .with-headroom {
   padding-top:3em;
 }

data/app/assets/stylesheets/modules/search_results.css.scss

@@ -36,3 +36,7 @@
 
 .search-result-details {
 }
+
+.search-result-actions {
+  text-align:right;
+}

data/app/controllers/concerns/curate/fields_for_add_to_collection.rb

@@ -3,6 +3,7 @@ module Curate::FieldsForAddToCollection
 
   included do
     helper_method :available_profiles
+    helper_method :available_collections
     helper_method :current_users_profile_sections
   end
 
@@ -16,6 +17,14 @@ protected
     current_user ? current_user.collections.to_a : []
   end
 
+  def available_collections(item = nil)
+    if item.present?
+      collection_options.reject {|n| n == item}
+    else
+      collection_options
+    end
+  end
+
   def available_profiles
     return [] unless current_user
     return [] unless current_user.profile

data/app/controllers/curation_concern/base_controller.rb

@@ -17,6 +17,7 @@ module CurationConcern
 
     with_themed_layout
     include Sufia::Noid # for normalize_identifier method
+    include Curate::FieldsForAddToCollection
 
     before_filter :authenticate_user!, :except => [:show]
     before_filter :agreed_to_terms_of_service!

data/app/controllers/curation_concern/generic_files_controller.rb

@@ -20,6 +20,7 @@ class CurationConcern::GenericFilesController < CurationConcern::BaseController
   self.curation_concern_type = GenericFile
 
   def new
+    curation_concern.copy_permissions_from(parent)
     respond_with(curation_concern)
   end
 

data/app/models/concerns/curate/ability.rb

@@ -2,12 +2,12 @@ module Curate
   module Ability
     extend ActiveSupport::Concern
     included do
-      self.ability_logic += [:curate_permissions]
+      self.ability_logic += [:curate_permissions, :collection_permissions]
     end
 
     def curate_permissions
       alias_action :confirm, :copy, :to => :update
-      can :edit, Person do |p| 
+      can :edit, Person do |p|
         p.pid == current_user.repository_id
       end
 
@@ -17,6 +17,10 @@ module Curate
       end
     end
 
+    def collection_permissions
+      can :collect, :all
+    end
+
   end
 end
 

data/app/repository_models/curation_concern/model.rb

@@ -63,7 +63,7 @@ protected
       solr_doc[Solrizer.solr_name(:collection)] ||= []
       self.collection_ids.each do |collection_id|
         collection_obj = ActiveFedora::Base.load_instance_from_solr(collection_id)
-        if collection_obj.class == Collection
+        if collection_obj.is_a?(Collection)
           solr_doc[Solrizer.solr_name(:collection, :facetable)] << collection_id
           solr_doc[Solrizer.solr_name(:collection)] << collection_id
         end

data/app/repository_models/generic_file.rb

@@ -60,4 +60,8 @@ class GenericFile < ActiveFedora::Base
   def representative
     to_param
   end
+
+  def copy_permissions_from(obj)
+    self.datastreams['rightsMetadata'].ng_xml = obj.datastreams['rightsMetadata'].ng_xml
+  end
 end

data/app/views/application/_add_to_collection_gui.html.erb

@@ -0,0 +1,19 @@
+<% button_class ||= "btn"                       %>
+<% modal_id       = "#{collectible.noid}-modal" %>
+<% modal_title_id = "#{modal_id}-title"         %>
+
+<div class="modal fade" id="<%= modal_id %>">
+  <div class="modal-dialog">
+    <div class="modal-content">
+      <div class="modal-header">
+        <h4 id="<% modal_title_id %>class="modal-title">Add <%= "#{collectible}" %> to one of your collections:</h4>
+      </div>
+      <div class="unpadded modal-body">
+        <%= render partial: 'curate/collections/form_to_add_member', locals: { collectible: collectible, fieldset_class: 'with-side-padding with-top-padding', select_label_id: modal_title_id } %>
+      </div>
+    </div>
+  </div>
+</div>
+
+<%= link_to 'Add to Collection', add_member_form_collections_path(collectible_id: collectible.pid), data: { toggle: "modal", target: ('#' + modal_id) }, method: :get, class: "add-to-collection #{button_class}", remote: true %>
+

data/app/views/catalog/_index_partials/_identifier_and_action.html.erb

@@ -1,24 +1,32 @@
-<% solr_doc = document.inner_object.solr_doc %>
+<% solr_doc          ||= document.inner_object.solr_doc                                                    %>
+<% title_link_target ||= polymorphic_path([:curation_concern, document])                                   %>
+<% title_link_text   ||= render_index_field_value(document: solr_doc, field: 'desc_metadata__title_tesim') %>
+<% edit_path         ||= edit_polymorphic_path([:curation_concern, document])                              %>
 <div class="row-fluid identifier-and-action">
   <div class="span2 list-number">
     <%= document_counter_with_offset(counter) if defined?(counter) %>
     <%= render :partial => 'catalog/_index_partials/type_display', locals: {document: document} %>
   </div>
 
-  <div class="span6">
+  <div class="span6 search-result-link">
     <%# Minimize Fedora hits by using solr_doc rather than document %>
-    <%= link_to render_index_field_value(document: solr_doc, field: 'desc_metadata__title_tesim'), polymorphic_path([:curation_concern, document]), :id => "src_copy_link_#{solr_doc.noid}" %>
+    <%= link_to title_link_text, title_link_target, :id => "src_copy_link_#{solr_doc.noid}" %>
   </div>
 
-  <div class="span4">
+  <div class="span4 search-result-actions">
     <% if current_user -%>
-      <%= render partial: 'add_to_collection_gui', locals: { document: document } %>
+      <% if can?( :edit, document ) && edit_path.present? %>
       <%= link_to(
         raw('<i class="icon-pencil icon-large"></i>'),
-        edit_polymorphic_path([:curation_concern, document]),
-          :class=> 'itemicon itemedit btn pull-right',
-          :title => "Edit #{document.human_readable_type}"
-        ) if can? :edit, document %>
-    <% end -%>
+          edit_path,
+          class: 'itemicon itemedit btn',
+          title: "Edit #{document.human_readable_type}"
+        )%>
+      <% end %>
+      <% if can? :collect, document %>
+        <%= render 'add_to_collection_gui', collectible: document %>
+      <% end %>
+    <% end %>
   </div>
-</div>
+</div>
+

data/app/views/collections/_collection.html.erb

@@ -1,34 +1,9 @@
 <%# This is a search result view %>
 <% noid = collection.noid %>
+<% solr_doc = collection.inner_object.solr_doc %>
 <li id="document_<%= noid %>" class="search-result">
 
-  <div class="row-fluid">
-
-    <div class="span2 list-number">
-      <%= document_counter_with_offset( collection_counter ) %>
-      <%= render :partial => 'catalog/_index_partials/type_display', locals: {document: collection} %>
-    </div>
-
-    <div class="span6">
-      <% solr_doc = collection.inner_object.solr_doc %>
-      <%# Minimize Fedora hits by using solr_doc rather than document %>
-      <%= link_to render_index_field_value(document: solr_doc, field: 'desc_metadata__title_tesim'), collection, :id => "src_copy_link_#{noid}" %>
-    </div>
-
-    <div class="span4">
-      <% if current_user %>
-        <%= render partial: 'add_to_collection_gui', locals: { document: collection } %>
-
-        <%= link_to(
-          raw('<i class="icon-pencil icon-large"></i>'),
-          edit_collection_path(collection),
-            :class=> 'itemicon itemedit btn pull-right',
-            :title => 'Edit Collection'
-          ) if can? :edit, collection %>
-      <% end -%>
-    </div>
-
-  </div>
+  <%= render :partial => 'catalog/_index_partials/identifier_and_action', locals: { document: collection, counter: collection_counter, title_link_target: collection, edit_path: edit_collection_path(collection), solr_doc: solr_doc } %>
 
   <div class="row-fluid">