hydra-editor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 571d39b6d853b20a3baf98bc1d1caf420023706c
+  data.tar.gz: 6ac9a10325b875a13436ed242ec16be90af61437
+SHA512:
+  metadata.gz: aa37e1d8040349218d33d67d62e33f43f495dabdc0a61caf2800e990e8347e8854aa6d8e3566ff419bdaf9a4a3f1781d4f0ad9557cd3768c474e27f61329be61
+  data.tar.gz: d5f804f41cb7b3d8fc043e54f1977b51110666e37ea3fced3acaed258b1d86d3e42a4e5c0cbadf5f0f504df3c87068307dd7e2fdb03010bb122b2a7fa029d1bd

data/README.md

@@ -0,0 +1,51 @@
+# HydraEditor
+
+To use add to your gemfile:
+
+```ruby
+gem 'hydra-editor'
+```
+
+And to config/routes.rb add:
+
+```ruby
+  mount HydraEditor::Engine => '/'
+```
+
+In your initialization set ```HydraEditor.models```
+
+```ruby
+# config/initializers/hydra_editor.rb
+HydraEditor.models = ["RecordedAudio", "PdfModel"]
+```
+
+You can customize the names of your fields/models by adding to your translation file:
+
+```yaml
+# config/locales/en.yml
+en:
+  hydra:
+    field_label:
+      source2: "Alternate Source"
+      dateCreated: "Date Created"
+      dateAvailable: "Date Available"
+    model_label:
+      PdfModel: "PDF"
+      RecordedAudio: "audio"
+
+```
+
+Expects the following interface on your hydra models:
+
+```terms_for_editing``` returns an array of model attributes to edit
+
+Add the javascript by adding this line to your app/assets/javascript/application.js:
+
+```javascript
+//= require hydra-editor/hydra-editor
+```
+
+Add the stylesheets by adding this line to your app/assets/stylesheets/application.css:
+```css
+ *= require hydra-editor/hydra-editor
+```

data/Rakefile

@@ -0,0 +1,57 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HydraEditor'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+Bundler::GemHelper.install_tasks
+
+dummy = File.expand_path('../spec/dummy', __FILE__)
+rakefile = File.join(dummy, 'Rakefile')
+
+task :clean do
+  sh "rm -rf #{dummy}"
+end
+
+task :setup do
+  unless File.exists?("#{dummy}/Rakefile")
+    `rails new #{dummy}`
+    `cp -r spec/support/Gemfile #{dummy}/`
+    `cp -r spec/support/lib/generators #{dummy}/lib`
+    Dir.chdir(dummy) do
+      sh "rails g blacklight --devise"
+      sh "rails g hydra:head -f"
+      sh "rm spec/models/user_spec.rb" # generated by devise
+      puts "Generating test app"
+      sh "rails generate test_app"
+      puts "running migrations"
+      sh 'rake db:migrate db:test:prepare'
+    end
+  end
+end
+
+task :spec => :setup do
+  here = File.expand_path("../", __FILE__)
+  Dir.chdir(dummy) do
+    Bundler.with_clean_env do
+      sh "bundle exec rspec --color -I#{here}/spec #{here}/spec"
+    end
+  end
+end

data/app/assets/javascripts/hydra-editor/editMetadata.js

@@ -0,0 +1,4 @@
+$(function() {
+  $('form.editor').multiForm();
+});
+

data/app/assets/javascripts/hydra-editor/hydra-editor.js

@@ -0,0 +1,2 @@
+//= require hydra-editor/multiForm
+//= require hydra-editor/editMetadata

data/app/assets/javascripts/hydra-editor/multiForm.js

@@ -0,0 +1,58 @@
+(function( $ ){
+
+  $.fn.multiForm = function( options ) {  
+
+    // Create some defaults, extending them with any options that were provided
+    var settings = $.extend( { }, options);
+
+    function addField() {
+      var cloneId = this.id.replace("submit", "clone");
+      var newId = this.id.replace("submit", "elements");
+      var cloneElem = $('#'+cloneId).clone();
+      // change the add button to a remove button
+      var plusbttn = cloneElem.find('#'+this.id);
+      plusbttn.html('-<span class="accessible-hidden">remove this '+ this.name.replace("_", " ") +'</span>');
+      plusbttn.on('click',removeField);
+
+      // remove the help tag on subsequent added fields
+      cloneElem.find('.formHelp').remove();
+      cloneElem.find('i').remove();
+      cloneElem.find('.modal-div').remove();
+
+      //clear out the value for the element being appended
+      //so the new element has a blank value
+      cloneElem.find('input[type=text]').attr("value", "");
+      cloneElem.find('input[type=text]').attr("required", false);
+
+      if (settings.afterAdd) {
+        settings.afterAdd(this, cloneElem);
+      }
+
+
+      $('#'+newId).append(cloneElem);
+      cloneElem.find('input[type=text]').focus();
+      return false;
+    }
+
+    function removeField () {
+      // get parent and remove it
+      $(this).parent().remove();
+      return false;
+    }
+
+    return this.each(function() {        
+
+      // Tooltip plugin code here
+      /*
+       * adds additional metadata elements
+       */
+      $('.adder', this).click(addField);
+
+      $('.remover', this).click(removeField);
+
+
+    });
+
+  };
+})( jQuery );  
+

data/app/assets/stylesheets/hydra-editor/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/hydra-editor/hydra-editor.css

@@ -0,0 +1,6 @@
+/* use if a label should be hidden from view but available to screen readers */
+.accessible-hidden {
+  position: absolute !important;
+  clip: rect(1px 1px 1px 1px); /* IE6, IE7 */
+  clip: rect(1px, 1px, 1px, 1px);
+}

data/app/controllers/concerns/records_controller_behavior.rb

@@ -0,0 +1,75 @@
+module RecordsControllerBehavior
+  def new
+    authorize! :create, ActiveFedora::Base
+    unless has_valid_type?
+      render 'choose_type'
+      return
+    end
+
+    @record = params[:type].constantize.new
+    initialize_fields
+  end
+
+  def edit
+    @record = ActiveFedora::Base.find(params[:id], cast: true)
+    authorize! :edit, @record
+    initialize_fields
+  end
+
+  def create
+    authorize! :create, ActiveFedora::Base
+    unless has_valid_type?
+      redirect_to hydra_editor.new_record_path, :flash=> {error: "Lost the type"}
+      return
+    end
+    @record = params[:type].constantize.new
+    set_attributes
+
+    respond_to do |format|
+      if @record.save
+        format.html { redirect_to main_app.catalog_path(@record), notice: 'Object was successfully created.' }
+        # ActiveFedora::Base#to_json causes a circular reference.  Do somethign easy
+        data = @record.terms_for_editing.inject({}) { |h,term|  h[term] = @record[term]; h } 
+        format.json { render json: data, status: :created, location: hydra_editor.record_path(@record) }
+      else
+        format.html { render action: "new" }
+        format.json { render json: @record.errors, status: :unprocessable_entity }
+      end
+    end
+
+  end
+
+  def update
+    @record = ActiveFedora::Base.find(params[:id], cast: true)
+    authorize! :update, @record
+    set_attributes
+    respond_to do |format|
+      if @record.save
+        format.html { redirect_to main_app.catalog_path(@record), notice: 'Object was successfully updated.' }
+        format.json { head :no_content }
+      else
+        format.html { render action: "edit" }
+        format.json { render json: @record.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  protected
+
+  # Override this method if you want to set different metadata on the object
+  def set_attributes
+    @record.attributes = params[@record.class.model_name.underscore]
+  end
+
+
+  def has_valid_type?
+    HydraEditor.models.include? params[:type]
+  end
+
+  def initialize_fields
+    @record.terms_for_editing.each do |key|
+      # if value is empty, we create an one element array to loop over for output 
+      @record[key] = [''] if @record[key].empty?
+    end
+  end
+end

data/app/controllers/records_controller.rb

@@ -0,0 +1,3 @@
+class RecordsController < ApplicationController
+  include RecordsControllerBehavior
+end

data/app/helpers/concerns/records_helper_behavior.rb

@@ -0,0 +1,59 @@
+module RecordsHelperBehavior
+  
+  def metadata_help(key)
+    I18n.t("hydra.metadata_help.#{key}", default: key.to_s.humanize)
+  end
+
+  def field_label(key)
+    I18n.t("hydra.field_label.#{key}", default: key.to_s.humanize)
+  end
+
+  def model_label(key)
+    I18n.t("hydra.model_label.#{key}", default: key.to_s.humanize)
+  end
+
+  def object_type_options
+    @object_type_options ||= HydraEditor.models.inject({}) do |h, model|
+        label = model_label(model)
+        h["#{label[0].upcase}#{label[1..-1]}"] = model
+        h
+    end
+  end
+
+  def render_edit_field_partial(key, locals)
+    render_edit_field_partial_with_action('records', key, locals)
+  end
+
+  def render_batch_edit_field_partial(key, locals)
+    render_edit_field_partial_with_action('batch_edit', key, locals)
+  end
+
+  def add_field (key)
+    more_or_less_button(key, 'adder', '+')
+  end
+
+  def subtract_field (key)
+    more_or_less_button(key, 'remover', '-')
+  end
+
+ private 
+
+  def render_edit_field_partial_with_action(action, key, locals)
+    if lookup_context.find_all("#{action}/edit_fields/_#{key}").any?
+      render :partial => "#{action}/edit_fields/#{key}", :locals=>locals.merge({key: key})
+    else
+      render :partial => "#{action}/edit_fields/default", :locals=>locals.merge({key: key})
+    end
+  end
+  
+  def more_or_less_button(key, html_class, symbol)
+    # TODO, there could be more than one element with this id on the page, but the fuctionality doesn't work without it.
+    content_tag('button', class: "#{html_class} btn", id: "additional_#{key}_submit", name: "additional_#{key}") do
+      (symbol + 
+      content_tag('span', class: 'accessible-hidden') do
+        "add another #{key.to_s}"
+      end).html_safe
+    end
+  end
+  
+end

data/app/helpers/records_helper.rb

@@ -0,0 +1,3 @@
+module RecordsHelper
+  include RecordsHelperBehavior
+end

data/app/views/records/_edit_field.html.erb

@@ -0,0 +1,15 @@
+<% render_req ||= true # render_req is true for single file edit, false for batch edit%>
+<div class="control-group">
+  <% vals =  @record[key] %>
+  <% if render_req && @record.required?(key) %>
+    <% tmp = '<span class="error">*</span>' + field_label(key) %>
+    <%= f.label key, tmp.html_safe, :class=>"control-label"  %>
+  <% else %>
+    <%= f.label key, field_label(key), :class=>"control-label"%>
+  <% end %>
+
+  <% vals.to_ary.each_with_index do |v, index| %>
+    <%= render_edit_field_partial(key, f:f,  v: v, index: index, render_req: render_req) %>
+  <% end %>
+ </div><!-- /control-group -->
+

data/app/views/records/_form.html.erb

@@ -0,0 +1,16 @@
+<%= bootstrap_form_for @record, :url=>@record.new_record? ? hydra_editor.records_path : hydra_editor.record_path(@record), html: {:class => 'form-inline editor'} do |f| %>
+  <div id="descriptions_display">
+    <h2 class="non lower">Descriptions <small class="pull-right"><span class="error">*</span> indicates required fields</small> </h2>
+    <div class="well">
+      <% @record.terms_for_editing.each do |term| %>
+        <%= render :partial => "edit_field", :locals => {:f =>f, :render_req => true, :key => term } %>
+      <% end %>
+    </div><!-- /well -->
+  </div>
+  <%= hidden_field_tag :type, params[:type] %>
+  <%= f.actions do %>
+    <%= f.submit 'Save' %>
+    <%= f.cancel %>
+  <% end %>
+<% end %>
+

data/app/views/records/choose_type.html.erb

@@ -0,0 +1,8 @@
+<h1>Create a new record</h1>
+
+<%= bootstrap_form_tag hydra_editor.new_record_path, :method=>:get do |f| %>
+  <%= bootstrap_select_tag :type, options_for_select(object_type_options) %>
+  <%= bootstrap_actions do %>
+    <%= bootstrap_submit_tag 'Next'%>
+  <% end %>
+<% end %>

data/app/views/records/edit.html.erb

@@ -0,0 +1,3 @@
+<h1>Edit <%= Array(@record.title).first %></h1>
+<%= render :partial=>'form' %>
+

data/app/views/records/edit_fields/_default.html.erb

@@ -0,0 +1,10 @@
+      <div class="controls" <%  if index == 0 %> id="additional_<%= key.to_s %>_clone" <% end %>>
+        <% required = render_req && (index == 0) && @record.required?(key) %>
+        <%= text_field_tag "#{@record.class.model_name.underscore}[#{key.to_s}][]", v,  :id => "#{@record.class.model_name.underscore}_#{key.to_s}", :class => "input-large", :required => required  %>
+        <% unless @record.class.unique?(key) %>
+          <%= render :partial=>"records/edit_fields/suffix", :locals=>{key: key, index: index} %>
+        <% end %>
+      </div>
+      <div id="additional_<%= key %>_elements"></div>
+
+

data/app/views/records/edit_fields/_suffix.html.erb

@@ -0,0 +1,6 @@
+        <% if index == 0  %>
+          <%= add_field(key) %>
+        <% else %>
+          <%= subtract_field(key) %>
+        <% end %>
+

data/app/views/records/new.html.erb

@@ -0,0 +1,2 @@
+<h1>Create a new <%= model_label(params[:type]) %> record</h1>
+<%= render :partial=>'form' %>

data/config/routes.rb

@@ -0,0 +1,4 @@
+HydraEditor::Engine.routes.draw do
+  resources :records, only: [:new, :edit, :create, :update], :constraints => { :id => /[a-zA-Z0-9_.:]+/ }
+
+end

data/lib/hydra-editor.rb

@@ -0,0 +1,12 @@
+require "hydra_editor/engine"
+require "bootstrap_forms"
+
+module HydraEditor
+  def self.models= val
+    @models = val
+  end
+
+  def self.models
+    @models ||= []
+  end
+end