fcrepo_admin 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 818278550cbf9bca1fadbcbfbdf51e8a0553a61a
-  data.tar.gz: 0a771b5118b90ee3262ddd786a41fcc806906f10
+  metadata.gz: 697245ae886c95095ba1eb747a210a45d6adaa7b
+  data.tar.gz: b7357e866a3e6f1f1fb22c221ebce0a6164d1cfd
 SHA512:
-  metadata.gz: 023c94fb6789a90551eaa827fc72b11cd7f902ff940062116e34901398021f1800cd1690be284545f13d249897a130eb8abbdecd5da2deae52f5550d5f10825d
-  data.tar.gz: 3130d3fe01e7705a496947ea1a75ff069f364580c267e480a95791a2ce492d90fbf00ffbd9c7f407f998aecf94f9bcac89495b396e755c9c28801de59d68cda6
+  metadata.gz: 36a3ce396fc62b3686027e2667b517d52434d0e1d8cc6d13feb9fc72ad80ea64c44de5912ec040f962f9922adacc61cb793bad1df2e93bb5ffb5a443b241298f
+  data.tar.gz: c5b94c71f89e975665a3737ec26170acf904e018df4d8d63af4e036fff8cf09994dcb1489f40e2648f3ec21b5f8b37db61909297fa00004dddb76dc9dc7c8cd3

data/CONTRIBUTING.md

@@ -0,0 +1,111 @@
+# 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_with Post.limit(10)
+          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.
+* Squash the commits for your branch into one commit
+  * `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.
+
+# 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/HISTORY.md

@@ -1,3 +1,12 @@
+#### 0.6.1 (2013-07-26)
+
+* Use `send(:construct_query)` on object association to get query for associated objects (Fixes #21).
+* Added `CONTRIBUTING.md` for Hydra projects.
+* Added CSS classes to datastream list table, rows, and columns.
+* Added I18n key for display when datastream label is blank.
+* Added #safe_pid methods to ActiveFedora::Base and ActiveFedora::Datastream decorators.
+* Added tests for datastreams index view.
+
 ### 0.6.0 (2013-06-27)
 
 * Feature: Display Solr index record for object.

data/README.md

@@ -16,6 +16,10 @@ See https://github.com/projecthydra/hydra-head/wiki/Installation-Prerequisites.
 
 ### Installation
 
+**Prerequisite**
+
+An existing Hydra head. If you are starting from scratch, see https://github.com/projecthydra/hydra-head for instructions on creating a new Hydra head.
+
 **Add to Gemfile**
 
 ```
@@ -24,15 +28,6 @@ gem 'fcrepo_admin'
 
 Then `bundle install`
 
-**Run the Blacklight and Hydra generators** (if this is a new Rails app, not an existing Hydra head)
-
-```
-rails g blacklight --devise
-rails g hydra:head -f
-rake db:migrate
-rails g hydra:jetty  # if you need a development copy of jetty with solr and fedora
-```
-
 **Mount the engine**
 
 In `config/routes.rb` add this line:
@@ -250,15 +245,10 @@ If Kaminari is suitably patched in the future, we will likely remove `safe_pagin
 
 ### Contributing
 
-* Consider first posting to hydra-tech@googlegroups.com with a question or bug report, or submit an issue
-  to the Github issue tracker at https://github.com/projecthydra/fcrepo-admin/issues.
-* Fork the git repository, create a feature branch, make your changes, and submit a pull request.  
-  It is preferable for all changes to be made in one commit, if possible.
-
-Thanks!
+See `CONTRIBUTING.md` in the root of the project.
 
 ### License
 
-See the LICENSE file in the root directory of the project for copyright and license information.
+See the `LICENSE` file in the root directory of the project for copyright and license information.
 
 Licenses for code copied from other projects will be included in source files as required.

data/app/controllers/fcrepo_admin/associations_controller.rb

@@ -36,7 +36,7 @@ module FcrepoAdmin
     end
 
     def get_collection_query_result
-      ActiveFedora::SolrService.query(construct_collection_query, collection_query_args)
+      ActiveFedora::SolrService.query(collection_query, collection_query_args)
     end
 
     def collection_query_args
@@ -51,11 +51,8 @@ module FcrepoAdmin
       args
     end
 
-    def construct_collection_query
-      # Copied from ActiveFedora::Associations::AssociationCollection#construct_query
-      clauses = {@association.options[:property] => @object.internal_uri}
-      clauses[:has_model] = @association.class_name.constantize.to_class_uri if @association.class_name && @association.class_name != 'ActiveFedora::Base'
-      ActiveFedora::SolrService.construct_query_for_rel(clauses)
+    def collection_query
+      @object.send(params[:id].to_sym).send(:construct_query)
     end
 
     def load_association

data/app/views/fcrepo_admin/datastreams/_datastreams_list.html.erb

@@ -1,30 +1,26 @@
-<table class="table table-bordered table-condensed table-striped">
+<table class="table table-bordered table-condensed table-striped <%= ds_list_css_class object %>">
   <thead>
     <tr>
 	  <th scope="col"><%= t("fcrepo_admin.datastreams.header.id") %></th>
-	  <% columns.each do |col| %>
+	  <% columns.each do |col| -%>
 	  <th scope="col"><%= t("fcrepo_admin.datastream.profile.keys.#{col}") %></th>
-	  <% end %>
+	  <% end -%>
     </tr>
   </thead>
   <tbody>
-    <% object.datastreams.each do |dsid, ds| %>
-      <tr>
-	    <td>
-		  <%= link_to dsid, fcrepo_admin.object_datastream_path(object, ds) %>
-		</td>
-	    <% unless ds.new? %>
-	      <% columns.each do |col| %>
-	        <td>
-			  <%= format_datastream_profile_value ds, col %>
-			</td>
-	      <% end %>
-        <% else %>
-	      <%= content_tag :td, :colspan => columns.size do %>
-		    <em><%= t("fcrepo_admin.datastream.not_persisted") %></em>
-		  <% end %>
-	    <% end %>
+    <% object.datastreams.each do |dsid, ds| -%>
+      <tr class="<%= ds_css_class ds %>">
+	    <td><%= link_to dsid, fcrepo_admin.object_datastream_path(object, ds) %></td>
+	    <% unless ds.new? -%>
+	      <% columns.each do |col| -%>
+	        <td class="<%= ds_profile_css_class ds, col %>"><%= format_datastream_profile_value ds, col %></td>
+	      <% end -%>
+        <% else -%>
+		  <td class="<%= ds_profile_css_class ds, 'not-persisted' %>" colspan="<%= columns.size %>">
+			<em><%= t("fcrepo_admin.datastream.not_persisted") %></em>
+		  </td>
+	    <% end -%>
       </tr>
-    <% end %>
+    <% end -%>
   </tbody>
 </table>

data/app/views/fcrepo_admin/shared/_context_nav.html.erb

@@ -1,4 +1,4 @@
-<div class="well">
+<div class="well well-small">
   <ul class="nav nav-list">
 	<li class="nav-header">
 	  <%= header %>

data/config/locales/fcrepo_admin.en.yml

@@ -11,6 +11,7 @@ en:
           associations: 'Associations'
           object_xml: 'Object XML'
           solr: 'Solr Record'
+          catalog: 'Catalog View'
       properties:
         title: 'Properties'
         keys:
@@ -94,6 +95,7 @@ en:
       content_not_text: 'The datastream content is not text'
       profile:
         title: 'Profile'
+        no_label: 'No label'
         keys:
           dsLabel: 'Label'
           dsMIME: 'MIME Type'

data/lib/fcrepo_admin/decorators/active_fedora/base_decorator.rb

@@ -2,6 +2,10 @@ ActiveFedora::Base.class_eval do
 
   delegate :object_xml, :models, :to => :inner_object
 
+  def safe_pid
+    pid.sub(/:/, "-")
+  end
+
   def active?
     state == 'A'
   end

data/lib/fcrepo_admin/decorators/active_fedora/datastream_decorator.rb

@@ -1,5 +1,9 @@
 ActiveFedora::Datastream.class_eval do
 
+  def safe_pid
+    pid.sub(/:/, "-")
+  end
+
   def active?
     dsState == 'A'
   end

data/lib/fcrepo_admin/helpers/datastreams_helper_behavior.rb

@@ -34,24 +34,24 @@ module FcrepoAdmin::Helpers
     end
 
     def datastream_nav_item(item)
-      case
-      when item == :dsid
+      case item
+      when :dsid
         render_datastream_dsid_label
-      when item == :version
+      when :version
         render_datastream_version unless @datastream.current_version?
-      when item == :current_version 
+      when :current_version 
         link_to_datastream item, !@datastream.current_version?, false
-      when item == :summary 
+      when :summary 
         link_to_datastream item
-      when item == :content
+      when :content
         link_to_datastream item, @datastream.content_is_text?
-      when item == :download
+      when :download
         link_to_datastream item, @datastream.content_is_downloadable?, false
-      when item == :edit
+      when :edit
         link_to_datastream item, @datastream.content_is_editable? && can?(:edit, @object)
-      when item == :upload
+      when :upload
         link_to_datastream item, @datastream.content_is_uploadable? && can?(:upload, @object)
-      when item == :history
+      when :history
         link_to_datastream item, !@datastream.new?
       else 
         custom_datastream_nav_item item
@@ -60,20 +60,20 @@ module FcrepoAdmin::Helpers
 
     def link_to_datastream(view, condition=true, unless_current=true)
       return nil unless condition
-      path = case
-             when view == :current_version
+      path = case view
+             when :current_version
                fcrepo_admin.object_datastream_path(@object, @datastream)
-             when view == :summary       
+             when :summary       
                fcrepo_admin.object_datastream_path(@object, @datastream, datastream_params)
-             when view == :content         
+             when :content         
                fcrepo_admin.content_object_datastream_path(@object, @datastream, datastream_params)
-             when view == :download
+             when :download
                fcrepo_admin.download_object_datastream_path(@object, @datastream, datastream_params)
-             when view == :edit 
+             when :edit 
                fcrepo_admin.edit_object_datastream_path(@object, @datastream)
-             when view == :upload
+             when :upload
                fcrepo_admin.upload_object_datastream_path(@object, @datastream)
-             when view == :history
+             when :history
                fcrepo_admin.history_object_datastream_path(@object, @datastream)
              end
       label = t("fcrepo_admin.datastream.nav.items.#{view}")
@@ -108,16 +108,16 @@ module FcrepoAdmin::Helpers
     end
 
     def datastream_alert(alert)
-      case
-      when alert == :system_managed
+      case alert
+      when :system_managed
         if ["DC", "RELS-EXT", "rightsMetadata", "defaultRights"].include?(@datastream.dsid)
           render_datastream_alert(alert, :caution => true)
         end
-      when alert == :not_versionable        
+      when :not_versionable        
         render_datastream_alert(alert, :caution => true) unless @datastream.versionable
-      when alert == :inactive
+      when :inactive
         render_datastream_alert(alert) if @datastream.inactive?
-      when alert == :deleted
+      when :deleted
         render_datastream_alert(alert, :css_class => "alert alert-error") if @datastream.deleted?
       end
     end
@@ -128,21 +128,28 @@ module FcrepoAdmin::Helpers
 
     def format_datastream_state(ds)
       state = ds.dsState
-      formatted = case 
-                  when state == 'A' then "A (Active)"
-                  when state == 'I' then "I (Inactive)"
-                  when state == 'D' then "D (Deleted)"
+      formatted = case state
+                  when 'A'
+                    "A (Active)"
+                  when 'I'
+                    "I (Inactive)"
+                  when 'D'
+                    "D (Deleted)"
                   end
       formatted
     end
 
     def format_datastream_control_group(ds)
       control_group = ds.controlGroup
-      formatted = case
-                  when control_group == 'M' then "M (Managed)"
-                  when control_group == 'X' then "X (Inline XML)"
-                  when control_group == 'E' then "E (External Referenced)"
-                  when control_group == 'R' then "R (Redirect)"
+      formatted = case control_group
+                  when 'M'
+                    "M (Managed)"
+                  when 'X'
+                    "X (Inline XML)"
+                  when 'E'
+                    "E (External Referenced)"
+                  when 'R'
+                    "R (Redirect)"
                   end
       formatted
     end
@@ -153,17 +160,45 @@ module FcrepoAdmin::Helpers
       version_id
     end
 
+    def format_datastream_label(ds)
+      if ds.dsLabel.blank?
+        content_tag(:em, I18n.t('fcrepo_admin.datastream.profile.no_label'))
+      else
+        ds.dsLabel
+      end
+    end
+
     def format_datastream_profile_value(ds, key)
-      case
-      when key == "dsSize" then number_to_human_size(ds.dsSize)
-      when key == "dsCreateDate" then ds.dsCreateDate.localtime
-      when key == "dsLocation" && ds.content_is_url? then link_to(ds.dsLocation, ds.dsLocation)
-      when key == "dsState" then format_datastream_state(ds)
-      when key == "dsControlGroup" then format_datastream_control_group(ds)
-      when key == "dsVersionID" then format_datastream_version_id(ds)
+      case key
+      when "dsSize"
+        number_to_human_size(ds.dsSize)
+      when "dsCreateDate"
+        ds.dsCreateDate.localtime
+      when "dsLabel"
+        format_datastream_label(ds)
+      when "dsLocation" && ds.content_is_url?
+        link_to(ds.dsLocation, ds.dsLocation)
+      when "dsState"
+        format_datastream_state(ds)
+      when "dsControlGroup"
+        format_datastream_control_group(ds)
+      when "dsVersionID"
+        format_datastream_version_id(ds)
       else ds.profile[key]
       end
     end
 
+    def ds_list_css_class(object_or_ds)
+      [object_or_ds.safe_pid, "datastreams"].join("-")
+    end
+
+    def ds_css_class(ds)
+      [ds_list_css_class(ds), ds.dsid].join("-")
+    end
+
+    def ds_profile_css_class(ds, attr)
+      [ds_css_class(ds), attr].join("-")
+    end
+
   end
 end

data/lib/fcrepo_admin/helpers/objects_helper_behavior.rb

@@ -14,11 +14,15 @@ module FcrepoAdmin::Helpers
     end
 
     def object_property(prop)
-      case
-      when prop == :state then object_state
-      when [:create_date, :modified_date].include?(prop) then object_date(@object.send(prop))
-      when prop == :models then @object.models.join("<br/>").html_safe
-      else @object.send(prop)
+      case prop
+      when :state
+        object_state
+      when :create_date, :modified_date
+        object_date(@object.send(prop))
+      when :models
+        @object.models.join("<br/>").html_safe
+      else 
+        @object.send(prop)
       end
     end
 
@@ -28,10 +32,13 @@ module FcrepoAdmin::Helpers
 
     def object_state
       state = @object.state
-      value = case 
-              when state == 'A' then "A (Active)"
-              when state == 'I' then "I (Inactive)"
-              when state == 'D' then "D (Deleted)"
+      value = case state
+              when 'A'
+                "A (Active)"
+              when 'I'
+                "I (Inactive)"
+              when 'D'
+                "D (Deleted)"
               end
       value
     end
@@ -53,16 +60,27 @@ module FcrepoAdmin::Helpers
     end
 
     def object_nav_item(item)
-      case
-      when item == :pid          then render_object_pid_label
-      when item == :summary      then link_to_object item
-      when item == :datastreams  then link_to_object item
-      when item == :permissions  then link_to_object item, @object.has_permissions? && can?(:permissions, @object)
-      when item == :associations then link_to_object item
-      when item == :audit_trail  then link_to_object item, @object.auditable? && can?(:audit_trail, @object)
-      when item == :object_xml   then link_to_object item
-      when item == :solr         then link_to_object item
-      else custom_object_nav_item item
+      case item
+      when :pid         
+        render_object_pid_label
+      when :summary     
+        link_to_object item
+      when :datastreams 
+        link_to_object item
+      when :permissions 
+        link_to_object item, @object.has_permissions? && can?(:permissions, @object)
+      when :associations
+        link_to_object item
+      when :audit_trail 
+        link_to_object item, @object.auditable? && can?(:audit_trail, @object)
+      when :object_xml  
+        link_to_object item
+      when :solr        
+        link_to_object item
+      when :catalog     
+        link_to_object item
+      else 
+        custom_object_nav_item item
       end
     end
 
@@ -73,14 +91,23 @@ module FcrepoAdmin::Helpers
     def link_to_object(view, condition=true)
       return nil unless condition
       label = t("fcrepo_admin.object.nav.items.#{view}")
-      path = case
-             when view == :summary      then fcrepo_admin.object_path(@object)
-             when view == :datastreams  then fcrepo_admin.object_datastreams_path(@object)
-             when view == :permissions  then fcrepo_admin.permissions_object_path(@object)
-             when view == :associations then fcrepo_admin.object_associations_path(@object)
-             when view == :audit_trail  then fcrepo_admin.audit_trail_object_path(@object)
-             when view == :object_xml   then fcrepo_admin.object_path(@object, :format => 'xml')
-             when view == :solr         then fcrepo_admin.solr_object_path(@object)
+      path = case view
+             when :summary     
+               fcrepo_admin.object_path(@object)
+             when :datastreams 
+               fcrepo_admin.object_datastreams_path(@object)
+             when :permissions 
+               fcrepo_admin.permissions_object_path(@object)
+             when :associations
+               fcrepo_admin.object_associations_path(@object)
+             when :audit_trail 
+               fcrepo_admin.audit_trail_object_path(@object)
+             when :object_xml  
+               fcrepo_admin.object_path(@object, :format => 'xml')
+             when :solr        
+               fcrepo_admin.solr_object_path(@object)
+             when :catalog     
+               catalog_path(@object)
              end
       link_to_unless_current label, path
     end

data/lib/fcrepo_admin/version.rb

@@ -1,3 +1,3 @@
 module FcrepoAdmin
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/spec/features/datastreams/index.html.erb_spec.rb

@@ -8,5 +8,20 @@ describe "datastreams/index.html.erb" do
     object.datastreams.each do |dsid, ds|
       page.should have_link(dsid, :href => fcrepo_admin.object_datastream_path(object, ds))
     end
-  end  
+  end
+  context "datastream is not persisted to Fedora" do
+    it "should display a 'not used' label" do
+      page.should have_xpath("//td[@class = \"#{object.safe_pid}-datastreams-content-not-persisted\" and contains(., \"#{I18n.t('fcrepo_admin.datastream.not_persisted')}\")]")
+    end
+  end
+  context "datastream label is blank" do
+    it "should display a 'no label' label" do
+      page.should have_xpath("//em[contains(., \"#{I18n.t('fcrepo_admin.datastream.profile.no_label')}\")]")
+    end
+  end
+  context "datastream label is not blank" do
+    it "should display the datastream label" do
+      page.should have_xpath("//td[@class = \"#{object.safe_pid}-datastreams-RELS-EXT-dsLabel\" and contains(., \"Fedora Object-to-Object Relationship Metadata\")]")
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fcrepo_admin
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - David Chandek-Stark
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-27 00:00:00.000000000 Z
+date: 2013-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubydora
@@ -251,6 +251,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - HISTORY.md
 - LICENSE