umlaut 3.0.5 → 3.1.0.pre1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzY5Mzk3NDBhZjdkNGUxMDlkNWEyYmI2MzliNTU1OTM3NzUzM2RhNQ==
+  data.tar.gz: !binary |-
+    YWQ1M2NjMDliOTQxODhjODg0YWY2MjY2MTg2ODkwYTNlNmIzOGMyMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZTcyNDJkOTA3NGMyOWQxMDQ2NjVmZjkyYzkzYTM2OGI5MDNlY2I3MDFmOWU3
+    NGY2MzQ3YzdiNDI4NTUzZjg3ZTQyMzE0ZDAzNzEyZWVhODEwMjlhODFkNWFj
+    MjFhMTkwMDdiNTdiYWE2ZmIwOGRmMTBkZTZkNDg4NzE4ZDEwMjA=
+  data.tar.gz: !binary |-
+    YTVhNjI2MzI4Y2FkOWQzMmM0YjVjM2QyNGNlMDViOGExYWI3YTliYmUxNjZj
+    NWEyMDhkODg2Mzc3ZjE1ZjNkYzQxZTIyZGIwMTQ4YWMxNWUwNjliZTlkZGYw
+    MDUxYmU0OTZlZmY3YTcxNTZiMWQxY2Q4MDRkYWQ5Y2FlMmZlZjU=

data/README.md

@@ -1,4 +1,10 @@
 # Umlaut
+[![Gem Version](https://badge.fury.io/rb/umlaut.png)](http://badge.fury.io/rb/umlaut)
+[![Build Status](https://secure.travis-ci.org/team-umlaut/umlaut.png)](http://travis-ci.org/team-umlaut/umlaut)
+[![Dependency Status](https://gemnasium.com/team-umlaut/umlaut.png)](https://gemnasium.com/team-umlaut/umlaut)
+[![Code Climate](https://codeclimate.com/github/team-umlaut/umlaut.png)](https://codeclimate.com/github/team-umlaut/umlaut)
+[![Coverage Status](https://coveralls.io/repos/team-umlaut/umlaut/badge.png?branch=master)](https://coveralls.io/r/team-umlaut/umlaut)
+<!--[![Security Status](http://rails-brakeman.com/team-umlaut/umlaut.png)](http://rails-brakeman.com/team-umlaut/umlaut)-->
 
 Umlaut is software for libraries (the kind with books). 
 
@@ -8,7 +14,17 @@ knowledge base. But it's actually quite a bit more than that.
 It could also be described as: a just-in-time aggregator of  "last mile" 
 specific-citation services, taking input as OpenURL, and providing both an 
 HTML UI and an api suite for embedding Umlaut services in other products. 
-[What do you mean by this?](https://github.com/team-umlaut/umlaut/wiki/What-is-Umlaut-anyway)
+
+Umlaut's role is to provide the user with services that apply to the item of interest. 
+And services provided by various different products: including as a major target, your
+[OpenURL Knowledge Base](http://en.wikipedia.org/wiki/OpenURL_knowledge_base), but also
+including other products. Services provided by the hosting institution, licensed by the 
+hosting institution, as well as free services the hosting institution wishes to 
+advertise/recommend to it's users.
+
+Umlaut strives to supply links that take the user in as few clicks as possible to the service listed, without ever listing 'blind links' that you first have to click on to find out whether they are available. Umlaut pre-checks things when neccesary to only list services, with any needed contextual info, such that the user knows what they get when they click on it. Save the time of the user.
+
+[What do you mean by all this?](https://github.com/team-umlaut/umlaut/wiki/What-is-Umlaut-anyway)
 
 Umlaut is distributed as a ruby Rails engine gem. It's a very heavyweight engine,
 the point of distro'ing as a gem is to make it easy to keep local 
@@ -23,7 +39,7 @@ https://github.com/team-umlaut/umlaut/wiki/Installation.
 
 The Rails/Umlaut super-concise expert summary is:
 
-* Rails 3.1+
+* Rails 3.1+ (but not yet tested with Rails 4), ruby 1.9.3. 
 
 * gem 'umlaut'
 
@@ -35,8 +51,36 @@ The Rails/Umlaut super-concise expert summary is:
 
 * configuration in `./config/umlaut_services.yml` and `./app/controllers/umlaut_controller.rb` 
 
-* Umlaut uses multi-threaded concurrency in a way incompatible with development-mode class reloading. You need cache_classes=false even in dev, the Umlaut install generator changes this for you. 
-    
+* Umlaut uses multi-threaded concurrency in a way incompatible with development-mode class reloading. You need cache_classes=false even in dev, the Umlaut install generator changes this for you.
+
+## Add ons
+Some Umlaut services adapters are sufficiently complicated or are on different release cycles 
+from the core code that they merit their own gems. Generally, you will need to include these gems 
+in your application's Gemfile in order to get the described functionality.
+
+| Add on | Description |
+|:---|:---|
+| [`umlaut-primo`](https://github.com/team-umlaut/umlaut-primo) | Umlaut services to provide full text service responses, holdings, etc. from the Primo discovery solution. |
+
+
+## Developing
+
+Only spotty test coverage, sorry, but we're trying to improve. Don't trust
+if all tests pass everythings good, but if tests fail, that's an unacceptable
+commit. Try to add tests with new features, although we understand when
+nobody can figure out a good way to test (esp our legacy architecture). 
+
+Run tests with `rake test`. 
+
+Tests are with plain old Test::Unit, please. 
+
+Tests use the vcr gem where appropriate. See `./test/support/test_with_cassette`.
+
+gem skeleton was created with `rails plugin new`, which creates a dummy app
+that tests are run in context of, at `./test/dummy`. 
+
+See also: https://github.com/team-umlaut/umlaut/wiki/Developing
+
 ## Source
 
 https://github.com/team-umlaut/umlaut/
@@ -46,4 +90,3 @@ https://github.com/team-umlaut/umlaut/
 You can join the umlaut listserv at:
 http://rubyforge.org/mail/?group_id=4382
 
-## Build Status [![Build Status](https://secure.travis-ci.org/team-umlaut/umlaut.png)](http://travis-ci.org/team-umlaut/umlaut)

data/app/assets/javascripts/umlaut.js

@@ -5,13 +5,14 @@
 // to include all umlaut js.  
 
 
-// jquery and jquery-ui are required for umlaut, it's okay
+// jquery is required for umlaut, it's okay
 // if the manifest chain ends up 'require'ing twice because
 // it's mentioned in local manifest, sprockets is smart enough. 
 //= require jquery
-//= require jquery-ui
+//= require bootstrap-transition
+//= require bootstrap-modal
+//= require bootstrap-typeahead
+//= require bootstrap-collapse
 
 // Require all js files inside the 'umlaut' subdir next to this file.  
 //= require_tree './umlaut'
-
-

data/app/assets/javascripts/umlaut/ajax_windows.js

@@ -1,29 +1,47 @@
 /* ajax_windows.js.  Support for modal popup windows in Umlaut items. */
 jQuery(document).ready(function($) {
-  var ajax_form_catch, shared_modal_d;
-  shared_modal_d = $("<div></div>").dialog({
-    autoOpen: false,
-    modal: true,
-    width: "400px"
-  });
-  $(document).on("click", "a.ajax_window", function(event) {
-    $(shared_modal_d).load(this.href, function() {
-      var heading;
-      heading = shared_modal_d.find("h1, h2, h3, h4, h5, h6").eq(0).remove();
-      $(shared_modal_d).dialog("option", "title", heading.text());
-      return $(shared_modal_d).dialog("open");
-    });
+  var populate_modal = function(data, textStatus, jqXHR) {
+    // Wrap the data object in jquery object
+    var body = $(data);
+    // Remove the first heading from the returned data
+    var header = body.find("h1, h2, h3, h4, h5, h6").eq(0).remove();
+    // Remove the first submit button from the returned data
+    var footer = body.find("form").find("input[type=submit]").eq(0).remove();
+    cleanup_modal(header, body, footer)
+  }
+  var cleanup_modal = function() {
+    header = arguments[0]
+    body = arguments[1]
+    footer = arguments[2]
+    // Replace the header text if given
+    if (header) $("#modal").find(".modal-header").find(".content").text(header.text());
+    // Replace the body html if given
+    if (body) $("#modal").find(".modal-body").find(".content").html(body.html());
+    // Replace the current submit button if given
+    if (footer) $("#modal").find(".modal-footer").find(".content").html(footer);
+    // Toggle the ajax-loader
+    $("#modal").find(".modal-header").find(".ajax-loader").toggle();
+    $("#modal").find(".modal-body").find(".ajax-loader").toggle();
+    // Toggle the content
+    $("#modal").find(".modal-header").find(".content").toggle();
+    $("#modal").find(".modal-body").find(".content").toggle();
+    $("#modal").find(".modal-footer").find(".content").toggle();
+  }
+  var display_modal = function(event) {
+    event.preventDefault();
+    cleanup_modal();
+    $("#modal").modal("show");
+    $.get(this.href, "", populate_modal, "html");
     return false;
-  });
-  ajax_form_catch = function(event) {
-    $(shared_modal_d).load($(event.target).closest("form").attr("action"), $(event.target).closest("form").serialize(), function() {
-      var heading;
-      heading = shared_modal_d.find("h1, h2, h3, h4, h5, h6").eq(0).remove();
-      $(shared_modal_d).dialog("option", "title", heading.text());
-      return $(shared_modal_d).dialog("open");
-    });
+  }
+  var ajax_form_catch = function(event) {
+    event.preventDefault();
+    cleanup_modal();
+    var form =  $("#modal").find("form");
+    $.post(form.attr("action"), form.serialize(), populate_modal, "html");
     return false;
   };
-  $(document).on("click", "form.modal_dialog_form input[type=submit]", ajax_form_catch);
-  return $(document).on("submit", "form.modal_dialog_form", ajax_form_catch);
+  $(document).on("click", "a.ajax_window", display_modal);
+  $(document).on("click", "#modal .modal-footer input[type=submit]", ajax_form_catch);
+  $(document).on("submit", "#modal form", ajax_form_catch);
 });

data/app/assets/javascripts/umlaut/expand_contract_toggle.js

@@ -1,33 +1,25 @@
 /* expand_contract_toggle.js: Support for show more/hide more in lists of umlaut content.
-   
-   The JS needs to swap out the image for expand/contract toggle. AND we need
-   the URL it swaps in to be an ABSOLUTE url when we're using partial html
-   widget. 
-   
-   So we swap in a non-fingerprinted URL, even if the original was asset
-   pipline fingerprinted. sorry, best way to make it work!
 */
 jQuery(document).ready(function($) {
-   
-    $(document).on("click", ".expand_contract_toggle", function() {
-        var content = $(this).next(".expand_contract_content");
-        var icon = $(this).parent().find('img.toggle_icon');
-        
-        if (content.is(":visible")) {  
-          icon.attr("src", icon.attr("src").replace(/list_open[^.]*\.png/, "list_closed.png"));
-          $(this).find(".expand_contract_action_label").text("Show ");
-          
-          content.hide();
-          
-        }
-        else {
-          icon.attr("src", icon.attr("src").replace(/list_closed[^.]*\.png/, "list_open.png"));
-          $(this).find(".expand_contract_action_label").text("Hide ");
-          content.show();
-        }
-        
-        return false;
-    });
-    
-    
+  $(".collapse_toggle").each(function(){
+    $(this).collapse('toggle');
+  });
+  $(document).on("click", ".collapse-toggle", function(event) {
+    event.preventDefault();    
+    return false;
+  });
+  $(document).on("show", ".collapse", function(event) {
+      // Update the icon
+      $(this).parent().find('.collapse-toggle i').removeClass("umlaut_icons-list-closed").addClass("umlaut_icons-list-open");
+      // Update the action label
+      $(this).parent().find(".expand_contract_action_label").text("Hide ");
+
+  });
+  $(document).on("hide", ".collapse", function(event) {
+      // Update the icon
+      $(this).parent().find('.collapse-toggle i').removeClass("umlaut_icons-list-open").addClass("umlaut_icons-list-closed");
+      // Update the action label
+      $(this).parent().find(".expand_contract_action_label").text("Show ");
+
+  });
 });

data/app/assets/javascripts/umlaut/load_permalink.js

@@ -0,0 +1,26 @@
+jQuery(document).ready(function($) {
+
+
+	$("*[data-umlaut-toggle-permalink]").click(function(event) {
+		event.preventDefault();
+
+		var originalLink   = $(this)
+		var valueContainer = $("#umlaut-permalink-value");
+
+		if (! valueContainer.data("loaded")) {
+			valueContainer.html('<i class="spinner"></i>').show();
+
+			$.getJSON( originalLink.attr('href'), function(data) {
+				var href = data.permalink;
+				var a = $("<a/>");
+				a.attr("href", href);
+				a.text(href);
+				valueContainer.html(a).data("loaded", true).show();
+			});
+		}
+		else {
+			valueContainer.toggle();
+		}
+	});
+
+});

data/app/assets/javascripts/umlaut/search_autocomplete.js

@@ -1,46 +1,105 @@
 /* search_autocomplete.js.  Add autocomplete to Umlaut journal title search. */
 jQuery(document).ready(function($) {
-    
-    $(document).on("submit", "form.OpenURL", function() {
-       var form = $(this);
-       if ( form.find(".rft_title").val() != $(this).val()) {
-          form.find(".rft_object_id").val("");
-          form.find(".rft_title").val("");
-       }
-    });
-    
-  $("input.title_search").autocomplete({
-            minLength: 3,
-            source: function(request, response) {              
-              var form = $(this.element).closest("form");
-              $.ajax({
-                  url: form.attr("action").replace("journal_search", "auto_complete_for_journal_title"),
-                  dataType: "json",
-                  data: form.serialize(),
-                  success: function(data) {
-                    response($.map(data, function(item) {
-                      return {
-                        label: item.title,
-                        id: item.object_id
-                      }
-                    }));
-                  }
-              });
-            },
-            select: function(event, ui) {
-              var form = $(event.target).closest("form");
-              
-              form.find("input.rft_object_id").val(ui.item.id);
-              form.find("input.rft_title").val( ui.item.label );
-              form.find("select.sfx_title_search").val("exact");
-            }
-          });
-  
-});
-
-
-/*					select: function(event, ui) {
-						log(ui.item ? ("Selected: " + ui.item.value + ", geonameId: " + ui.item.id) : "Nothing selected, input was " + this.value);
-					}
-				});
-*/
+
+
+ // We override typeahead's 'render' function to NOT have the first
+ // item selected. We simply copy and pasted it, and removed the line
+ // `items.first().addClass('active')`, then set the prototype to our
+ // own function. Yes, this changes typeahead globally, sorry we don't have
+ // a way to change it just for certain typeaheads. 
+ //
+ // The default first-item-selected behavior has been hated by users
+ // in the journal search scenario, since when they hit return they
+ // get it even if they didn't want it. 
+ var newRender = function(items) {
+      var that = this
+
+      items = $(items).map(function (i, item) {
+        i = $(that.options.item).attr('data-value', item)
+        i.find('a').html(that.highlighter(item))
+        return i[0]
+      })
+
+      this.$menu.html(items)
+      return this
+ };
+ $.fn.typeahead.Constructor.prototype.render = newRender;
+ // have to fix 'select' to accomodate possible no selection too
+ $.fn.typeahead.Constructor.prototype.select = function() {
+    var val = this.$menu.find('.active').attr('data-value');
+    if (val) {
+      this.$element
+        .val(this.updater(val))
+        .change();
+    }
+    return this.hide()
+ }
+
+  $(document).on("submit", "form.OpenURL", function() {
+    var form = $(this);
+    if ( form.find(".rft_title").val() != $(this).val()) {
+      form.find(".rft_object_id").val("");
+      form.find(".rft_title").val("");
+    }
+  });
+
+  // Search for the title with the current form. Only search
+  // if there are more than two chars though!
+  //
+  var search_title = function(query, process) {
+    if (query.length > 2) {
+      var form = this.$element.closest("form");
+      var url = form.attr("action").replace("journal_search", "auto_complete_for_journal_title");
+      // Get JSON from 
+      $.getJSON(
+        form.attr("action").replace("journal_search", "auto_complete_for_journal_title"),
+        form.serialize(),
+        function(data) {
+          process(data)
+        }
+      )
+    }
+  }
+
+
+  var lookup_limit = 300; //ms 
+  // Uses a timer to only do a lookup at most once every
+  // 300ms . Based on rejected pull request at:
+  // https://github.com/twitter/bootstrap/pull/6320
+  var throttled_search_title = function(query, process) {
+    if(this.lookupTimer) {
+      clearTimeout(this.lookupTimer);
+    }
+
+    this.lookupTimer = setTimeout($.proxy(search_title, this, query, process), lookup_limit);
+    return this;
+  }
+
+  $("input.title_search").typeahead({
+    items: 10,
+    minLength: 3,
+    source: throttled_search_title,
+    highlighter: function(item) { 
+      // Bootstrap updates the item as it passes through the callback chain
+      // so this is a hack to ensure we get the proper values.
+      return "<span id=\"" + item.object_id + "\" class=\"title\">"+ item.title + "</span>"; 
+    },
+    sorter: function(items) { return items },
+    matcher: function(item) { return true; },
+    updater: function(item) {
+      // Get the selected item via our hack.
+      var selected_item = this.$menu.find('.active .title');  
+      if (selected_item.length > 0) {
+        // We set the id attribute as the object id
+        var object_id = selected_item.attr("id");
+        // We set the inner text with the title
+        var title = selected_item.text();
+        var form = this.$element.closest("form");
+        form.find("input.rft_object_id").val(object_id);
+        form.find("input.rft_title").val(title);
+        form.find("select.title_search_type").val("exact");
+        return title;
+      }
+    }
+  });
+});