umlaut 4.0.3 → 4.1.0.pre.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjMzYmMzYzc5YjVjOTY2MDYzZjZmOGVlOThhZTZkYTZhZWY4ZTA4Mw==
+    NThjZGZmNjFlZTgwNGVjMjg0MjJkODAwNWI4NjRiYzRjNmNlNGY5OQ==
   data.tar.gz: !binary |-
-    YzMzNzA4Y2FhOTViZDBmYjFiNGM4N2UxNDhmOTU0MjdhN2VmYWI3OQ==
+    OGQ0MGRlYzJiNmViZTQxMDQ4Y2U4MWYzOWY3MjljOWQwMWVjYmRlZQ==
 SHA512:
   metadata.gz: !binary |-
-    MTE4MWM0YjNkYzdkYTE3NWVmNmJhNmUyYTkxNDRkNTVjNDAyYTlkYTc5Y2M5
-    N2YyNzNmMzAzZDc5YzEyM2Q4YzhlMjM0ZTk4Y2RhOGYxNzQzODcxNDIzMTQz
-    YWQwZjQyNjMyMDQwOGZhZWQ1ZDRjNWZlZWQ0M2NiZjE5ZDYxODE=
+    ZGI4Njk3ZmExYzljNDcwMTMzZjA5YWQ3NTYyOGY1YWYyYTZmZjNlNTAxNDAz
+    MWYyNmZkYmJiNGEwYWViNTQ4ZDA4OWY2OGQ2MTA4ZGZiYjZkYzU5ZDEzZWQx
+    YWY3OTYwOGJiZmU4MzU5ZTJhODgzMThjOTRjNmNlMmZhOGI0NjA=
   data.tar.gz: !binary |-
-    ZDQ0Nzk0NDkwNGQ2NmU1Y2I1ZjdmMDE4OGRhN2RlZDdkNDY5MjUwMTAxNjcw
-    NWI2ZDI3NzMzZjc2MTE2Yjc5NDMyNTJjYmJhOWQzMTQyYWVlN2U4M2Y0YTMx
-    MWJiNzEwNGJhYWUzZjA1OTlmOTE4NjY1NGQxNDE3MGEwNjM0MDg=
+    NTlkNWFhNDgxMjk1MWFkYWJiZGE1ZjQ5OGE2YWJkNzc2YmIwODhiODNjMTRk
+    NmU5ODU2YTIwMWFmMDQwNGQxNTRhOGNmODFmNzVkMmU5MzcxMDM0OGYxODgx
+    ZTQ0ZGI1MjE0ZmQ3ZmIzMzFmNWMyMDNhZjgyMzhhOWNmY2I2ODI=

data/README.md

@@ -81,6 +81,12 @@ 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`. 
 
+The vcr gem is used to record HTTP transactions for tests. 
+
+There are some helpful methods for setting up and asserting in tests in
+Umlaut::TestHelp, which are used in Umlaut itself and can also be used
+in local apps or Umlaut plugins. 
+
 See also: https://github.com/team-umlaut/umlaut/wiki/Developing
 
 ## Source

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

@@ -1,4 +1,12 @@
-/* update_html.js:  Provide functions to update content on page with background responses from Umlaut. Used by Umlaut itself, as well as by third party callers.*/
+/* update_html.js:
+ *     Provide functions to update content on page with background responses from Umlaut.
+ *     Used by Umlaut itself, as well as by third party callers.
+ *
+ *     This is compiled into a standalone top-level JS file, for src'ing by third
+ *     party callers.
+ *
+ *     More information on use at https://github.com/team-umlaut/umlaut/wiki/JQuery-Content-Utility
+ */
 (function($) {
    
     function SectionTarget(config) {
@@ -6,11 +14,14 @@
        $.extend(this, config);
        
        //Defaults
-       if (this.selector == undefined)
+       if (typeof(this.selector) == 'undefined')
          this.selector = "#" + this.umlaut_section_id;
-       if (this.position == undefined)
+       if (typeof(this.position) == 'undefined')
          this.position = "html";
-              
+       // Container must be a JQuery object, if it's not
+       // passed in, use $(document)
+       if (typeof(this.container) == 'undefined')
+         this.container = $(document); // default container is document
     }
     //Callback default to no-op function please.    
     var noop = function() {};
@@ -19,53 +30,100 @@
     SectionTarget.prototype.complete = noop;
     
     SectionTarget.prototype.ensure_placement_destination = function() {
-        if ( this.selector == undefined) {
+        if ( typeof(this.selector) == 'undefined') {
           return null; 
         }
         
         //Already have it cached?
         if ( this.host_div_element ) {
           return this.host_div_element;
-        }                        
+        }
         
-        var new_div = $('<div class="umlaut" style="display:none"></div>');        
+        // Create an empty div to hold our content
+        var new_div = $('<div class="umlaut" style="display:none"></div>');
+
         // Find the first thing matched by selector, and call the
-        // method specified in "action" string on it, giving it our
+        // method specified in "position" string on it, giving it our
         // HTML to replace. This works because our actions are
         // all arguments that will take one method: html, before, after, append,
         // prepend.                       
-        $(this.selector).eq(0)[ this.position  ]( new_div );
+        this.container.find(this.selector).eq(0)[ this.position  ]( new_div );
         
         //Cache for later
         this.host_div_element = new_div;
         return this.host_div_element;
       };
-    
 
   // Define an object constructor on the global window object
   // For our UmlautHtmlUpdater object. 
   //
-  // Third 'locale' arg is optional locale string eg 'en', 'de'
+  // You need to pass the Umlaut Base URL, as well as an OpenURL kev context
+  // object.  There are additional optional parameters. 
+  //
+  // There are two argument formats you can call `new HTMLUpdater` with.
+  // Positional allows you to pass umlaut base and OpenURL:
+  //     var updater = new Umlaut.HtmlUpdater("http://umlaut.example.edu", "au=Smith&ti=Book")
+  //
+  // Or named argument style allows you to pass additional parameters,
+  // including locale and container. 
+  //
+  //     var updater = new Umlaut.HtmlUpdater({
+  //        umlaut_base: "http://umlaut.example.edu",
+  //        context_object:     "au=Smith&ti=Book",
+  //        locale:      "de",
+  //        container:  "#selector"
+  //     });
+  //
+  //  
+  //
+  // The optional 'locale' arg is a locale string eg 'en', 'de'
+  //
+  // The optional 'container' argument is a selector, DOM element, OR
+  // jQuery object. The container limits the updater's content
+  // replacements (controlled by selectors on individual sections) to within
+  // the container given. 
   //
   // Note this object is used by external sites as part of the JQuery updater
   // javascript API. This is API, which has to be callable by non-Umlaut sites.
   // Try not to change the method signature in incompatible ways. 
-  function HtmlUpdater(umlaut_base, context_object, locale) {
-    if (context_object == undefined)
-      context_object = "";
+  function HtmlUpdater(first_arg, second_arg, third_arg) {
+    if (typeof(first_arg) == "object") {
+      // Simply merge arguments object as properties on ourselves. 
+     $.extend(this, first_arg);
+    } else {
+      // positional args
+      this.umlaut_base    = first_arg;
+      this.context_object = second_arg;
+      this.locale         = third_arg;
+    }
+
+    // Argument checking
+    if (typeof(this.umlaut_base) == "undefined") {
+      throw new Error("new Umlaut.HtmlUpdater: missing umlaut_base (String) argument");
+    }
+    if (typeof(this.context_object) == "undefined") {
+      throw new Error("new Umlaut.HtmlUpdater: missing context_object (String) argument");
+    }
+
+
 
     // Remove query string (if present)
-    umlaut_base = umlaut_base.replace(/\?.*$/, '')
+    this.umlaut_base = this.umlaut_base.replace(/\?.*$/, '')
     // Remove trailing slash
-    umlaut_base = umlaut_base.replace(/\/$/,'');
-    this.umlaut_uri =  umlaut_base + '/resolve/partial_html_sections?umlaut.response_format=json&' + context_object;
-    if (locale)
-      this.umlaut_uri += "&umlaut.locale=" + locale;
+    this.umlaut_base = this.umlaut_base.replace(/\/$/,'');
+    this.umlaut_uri =  this.umlaut_base + '/resolve/partial_html_sections?umlaut.response_format=json&' + this.context_object;
+    if (this.locale)
+      this.umlaut_uri += "&umlaut.locale=" + this.locale;
 
     this.section_targets = [];
            
     this.add_section_target = function(config) {
-      this.section_targets.push( new SectionTarget(config) ); 
+      var target = new SectionTarget(config);
+      if (typeof(this.container) !== "undefined") {
+        // Turn it into a JQuery object if it wasn't already. 
+        target.container = $(this.container);
+      }
+      this.section_targets.push( target ); 
     };
     
     //default no-op call-backs
@@ -99,11 +157,11 @@
                  
                   var umlaut_html_section = myself.find_umlaut_response_section(umlaut_response, section_target.umlaut_section_id);
                                     
-                  if (umlaut_html_section == undefined) {
+                  if (typeof(umlaut_html_section) == 'undefined') {
                     continue;
                   }                  
                   var count = null;
-                  if (typeof umlaut_html_section.response_count != "undefined") { 
+                  if (typeof(umlaut_html_section.response_count) != "undefined") {
                     count = parseInt(umlaut_html_section.response_count.value);
                   }
                   var existing_element = section_target.ensure_placement_destination();
@@ -162,7 +220,7 @@
   };
   
   //Put it in a global object, leave space for other things in "Umlaut" later.
-  if (window.Umlaut == undefined)
+  if (typeof(window.Umlaut) == 'undefined')
     window.Umlaut = new Object();
   window.Umlaut.HtmlUpdater = HtmlUpdater; 
   

data/app/assets/stylesheets/umlaut/_misc.scss

@@ -9,8 +9,7 @@
   }
 }
 
-.alert {
-  font-size: 125%;
+.alert {  
   li {
     margin-top: 1em;
   }

data/app/assets/stylesheets/umlaut/_resolve.scss

@@ -19,6 +19,10 @@
     padding-left: $umlautIndent;
     text-indent: -$umlautIndent;
   }
+  // default bold response link if it's in the main section
+  .umlaut-main & .response_link {
+    font-weight: bold;
+  }
 }
 
 .umlaut-section {
@@ -34,24 +38,30 @@
     @extend .text-muted;
   }
 
-
+  /* In the sidebar, search_inside heading looks better without
+     bottom margin, cause of spacing needed for form, it just does. */
+  .umlaut-sidebar &.search_inside {
+    .section_heading h3 {
+      margin-bottom: 0;
+    }
+  }
 
   // Special looks for particular sections
-  &.fulltext {
+  &.fulltext, .page-icons {
     @include iconed-response;
     .response_item i {
       @extend .umlaut_icons-famfamfam-page-text;
     }
   }
 
-  &.audio {
+  &.audio, .sound-icons {
     @include iconed-response;
     .response_item i {
       @extend .umlaut_icons-famfamfam-page-sound;
     }
   }
 
-  &.excerpts {
+  &.excerpts, .book-open-icons {
     @include iconed-response;
     .response_item i {
       @extend .umlaut_icons-famfamfam-book-open;
@@ -62,13 +72,15 @@
     border: none;
   }
 
-  &.document_delivery {
+  &.document_delivery, .book-go-icons {
     @include iconed-response;
     .response_item i {
       @extend .umlaut_icons-famfamfam-book-go;
     }
   }
 
+  .response_item 
+
   &.related_items {
     // Margin between the 'cited by' and 'similar' lists
     .response_list + .response_list {
@@ -77,7 +89,7 @@
 
   }
 
-  &.holding {
+  &.holding, &.book-icons {
     .response_item i {
       @extend .umlaut_icons-famfamfam-book;
     }
@@ -132,8 +144,34 @@
 .umlaut-section-highlighted {
   @include umlaut-well($umlautHighlightedSectionBackgroundColor, $umlautHighlightedSectionBorderColor);
   border-radius: $umlautBorderRadiusExtraLarge;
+
+  // If a p.alert is in a highlighted section, give it special styling
+  // as a ribbon, not a box-in-box. 
+  .alert {
+    margin-left: -12px;
+    margin-right: -12px;
+
+    border-radius: 0;
+    border-left: 0;
+    border-right: 0;
+  }
+  // If it's the LAST thing in the highlighted section, do better and merge
+  // it with the box itself
+  .umlaut_section_content > .alert:last-child {
+    margin-bottom: -12px;
+    border-bottom-right-radius: $umlautBorderRadiusExtraLarge;
+    border-bottom-left-radius: $umlautBorderRadiusExtraLarge;
+  }
+  .umlaut_section_content > hr {
+    border-color: $umlautHighlightedSectionBorderColor;
+    margin-left: -12px;
+    margin-right: -12px;
+  }
+
 }
 
+
+
 .section_prompt {
   @extend .text-muted;
 }
@@ -291,10 +329,6 @@
   font-size: $font-size-base;
 }
 
-// Resolve Errors
-#service_errors_content {
-  @include umlaut-well($umlautResolveErrorBackgroundColor, $umlautResolveErrorBorderColor);
-}
 
 a:not(:hover) .coverage_summary {
   /* even though it's part of a hyperlink, we make it black for distinction */

data/app/controllers/export_email_controller.rb

@@ -11,7 +11,7 @@ class ExportEmailController < UmlautController
     @fulltexts = @user_request.get_service_type('fulltext', { :refresh=>true })
     @holdings = @user_request.get_service_type('holding', { :refresh=>true })
     if valid_email?
-      Emailer.citation(@email, @user_request, @fulltexts, @holdings).deliver
+      action_mailer_deliver Emailer.citation(@email, @user_request, @fulltexts, @holdings)
     else
       flash[:alert] = email_validation_error
       render :email and return
@@ -29,7 +29,7 @@ class ExportEmailController < UmlautController
     @email = "#{@number}@#{@provider}" unless @number.nil? or @provider.nil?
     @holding = params[:holding]
     if valid_txt_number? && valid_txt_holding?
-      Emailer.short_citation(@email, @user_request, holding_location(@holding), call_number(@holding)).deliver
+      action_mailer_deliver Emailer.short_citation(@email, @user_request, holding_location(@holding), call_number(@holding))
     else
       flash[:alert] = txt_validation_error
       render :txt and return

data/app/controllers/feedback_controller.rb

@@ -15,7 +15,7 @@ class FeedbackController < UmlautController
       )
     end
 
-    FeedbackMailer.feedback(request.host_with_port, to_address, options).deliver
+    action_mailer_deliver FeedbackMailer.feedback(request.host_with_port, to_address, options)
 
     flash[:alert_success] = "Thanks, your message has been sent."
 

data/app/controllers/umlaut/controller_behavior.rb

@@ -87,6 +87,20 @@ module Umlaut::ControllerBehavior
   end
   protected :specified_service_groups
 
+  # Call an ActionMailer::Base without deprecation warnings in Rails 4.3,
+  # but still work in earlier rails without deliver_later
+  #
+  # Calls with deliver_later in Rails 4.3. If no ActiveJob queue
+  # is set up, no problem default is immediate executor anyway. 
+  def action_mailer_deliver(mailer)
+    if mailer.respond_to?(:deliver_later)
+      mailer.deliver_later
+    else
+      mailer.deliver
+    end
+  end
+  protected :action_mailer_deliver
+
 
 
 end

data/app/controllers/umlaut_configurable.rb

@@ -234,13 +234,12 @@ module UmlautConfigurable
       # We add a custom method into the resolve_sections array, 
       # ensure_order!. 
       resolve_sections [].extend Module.new do         
-        # Convenience method for re-ordering sections 
-        # Swaps elements if necessary to ensure they are in the specified order.
-        # For example, make sure holding comes before document_delivery:
-        # resolve_sections.ensure_order!("holding", "document_delivery")
-        # Maybe in the future we'll expand this to take variable arguments. 
+
+        # Deprecated. This was a silly confusing way to do this. 
+        # See #remove and #insert below instead. 
         def self.ensure_order!(first, second)
-      
+          $stderr.puts "resolve_sections.ensure_order! is deprecated, please see resolve_sections.remove and resolve_sections.insert"
+
           list = self
       
           index1 = list.index {|s| s[:div_id].to_s == first.to_s}
@@ -250,8 +249,40 @@ module UmlautConfigurable
       
           list
         end
+
+        # Insert a section_config hash before or after an existing
+        # section, by the existing section's div_id
+        #
+        #      resolve_sections.insert_section({:div_id => "new"}, :after => "fulltext")
+        #      resolve_sections.insert_section(  resolve_sections.remove_section("document_deliver"), :before => "fulltext")
+        def self.insert_section(section_config, options = {})
+          list = self
+
+          if options[:before]
+            i = (list.find_index {|s| s[:div_id].to_s == options[:before].to_s}) || 0
+            list.insert(i, section_config)
+          elsif options[:after]
+            i = (list.find_index {|s| s[:div_id].to_s == options[:after].to_s}) || (list.length - 1)
+            list.insert(i + 1, section_config)
+          else
+            # just add at end of list
+            list << section_config
+          end
+        end
+
+        # Remove a configuration block with a certain div_id from the configuration entirely, 
+        # returning the removed configuration block (or nil if none exists). 
+        # You can re-insert it with #insert if you like. 
+        def self.remove_section(div_id)
+          list = self
+          i = list.find_index {|s| s[:div_id].to_s == div_id.to_s}
+          return list.delete_at(i) if i
+        end
+
       end
 
+
+
       ##########
       #
       # Names of these sections can be given in Rails i18n, under key
@@ -277,21 +308,7 @@ module UmlautConfigurable
         html_area :main
         partial :fulltext
         show_partial_only true
-      end
-
-      add_resolve_sections! do
-        div_id "search_inside"
-        html_area :main
-        partial "search_inside"
-        show_partial_only true
-      end
-      
-      add_resolve_sections! do
-        div_id "excerpts"
-        html_area :main
-        list_visible_limit 5
-        visibility :responses_exist
-      end
+      end      
       
       add_resolve_sections! do
         div_id "audio"        
@@ -351,6 +368,20 @@ module UmlautConfigurable
         html_area :sidebar
         visibility :in_progress
       end
+
+      add_resolve_sections! do
+        div_id "search_inside"
+        html_area :sidebar
+        partial "search_inside"
+        show_partial_only true
+      end
+      
+      add_resolve_sections! do
+        div_id "excerpts"
+        html_area :sidebar
+        list_visible_limit 5
+        visibility :responses_exist
+      end
       
       add_resolve_sections! do
         div_id "related_items"

data/app/helpers/open_search_helper.rb

@@ -1,6 +1,6 @@
 module OpenSearchHelper
 
   def opensearch_template_url
-    url_for(:controller => "search", :action => "journal_search", :rfr_id => umlaut_config.lookup('rfr_id.opensearch'), :'umlaut.title_search_type' => 'contains', :only_path => false ) + '&rft.jtitle={searchTerms}'
+    url_for(:controller => "search", :action => "journal_search", :rfr_id => umlaut_config.lookup!('rfr_ids.opensearch'), :'umlaut.title_search_type' => 'contains', :only_path => false ) + '&rft.jtitle={searchTerms}'
   end
 end

data/app/helpers/resolve_helper.rb

@@ -39,45 +39,29 @@ module ResolveHelper
   # * current Umlaut Request object
   # * string section id
   # * array of umlaut ServiceResponses already fetched for this section. 
-  def section_css_classes(umlaut_request, section_id, response_list)
+  # 
+  # third paramter used to exist but was not used, deprecated but left there
+  # for now for backwards compat. TODO. 
+  def section_css_classes(umlaut_request, section_id, unused = nil)
     classes = ["umlaut-section", section_id]
-    classes << 'umlaut-section-highlighted' if should_highlight_section?(umlaut_request, section_id, response_list)
+    classes << 'umlaut-section-highlighted' if section_highlights(umlaut_request).should_highlight_section?(section_id)
     return classes
   end
 
-  # Called by #section_css_classes. Decides if a section should get
-  # highlight styles. Default logic highlights fulltext if present,
-  # otherwise holdings/docdel sections (in some cases both even if holdings present,
-  # in some cases just docdel, depending on nature of resource.) This is
-  # something local institutions may want to supply custom logic for,
-  # over-ride this method. 
-  #
-  # This is VERY tricky to get right, BOTH becuase of local policy differences,
-  # AND becuase umlaut's concurrent service handling means things are changing
-  # all the time. Umlaut used to just highlight fulltext with responses, that's it.
-  # But we're trying something more sophisticated. You may want to over-ride with
-  # something simpler, or something better suited to local policies and conditions. 
-  def should_highlight_section?(umlaut_request, section_id, response_list)
-    case section_id
-    when "fulltext"
-      umlaut_request.get_service_type("fulltext").present?
-    when "holding"
-      umlaut_request.get_service_type("holding").present? && umlaut_request.get_service_type("fulltext").empty?
-    when "document_delivery"
-      # Only once fulltext and holdings are done being fetched. 
-      # If there's no fulltext or holdings, OR there's holdings, but
-      # it's a journal type thing, where we probably don't know if the
-      # particular volume/issue wanted is present. 
-      umlaut_request.get_service_type("fulltext").empty? && 
-      (! umlaut_request.service_types_in_progress?(["fulltext", "holding"])) && (
-        umlaut_request.get_service_type("holding").empty? || 
-        umlaut_request.referent.format == "journal"
-      )
-    end
+  # Deprecated!
+  # Left for backwards compat. TODO. 
+  def should_highlight_section?(umlaut_request, section_id)
+    $stderr.warn "should_highlight_section? is deprecated, use `section_highlighter(umlaut_request).should_highlight_section?(section_id)`"
+    highlighted_sections(umlaut_request).include? section_id.to_s
   end
 
-  def app_name
-    return umlaut_config.app_name
+  # Returns a section highlighter for the current umlaut request. 
+  # (Cached for given @umlaut_request)
+  def section_highlights(umlaut_request = @umlaut_request)
+    # Need to cache for efficiency, need to cache by request id since we take
+    # it as an arg. 
+    @_section_highlighters ||= {}
+    return @_section_highlighters[umlaut_request.id] ||= Umlaut::SectionHighlights.new(umlaut_request)
   end
 
   # size can be 'small', 'medium', or 'large.
@@ -95,7 +79,7 @@ module ResolveHelper
   def user_entered_citation?(uml_request)
     return false unless uml_request && uml_request.referrer_id
     id = uml_request.referrer_id
-    return id == 'info:sid/sfxit.com:citation' || id == umlaut_config.lookup("rfr_ids.citation") || id == umlaut_config.lookup('rfr_ids.opensearch')
+    return id == 'info:sid/sfxit.com:citation' || id == umlaut_config.lookup!("rfr_ids.citation") || id == umlaut_config.lookup!('rfr_ids.opensearch')
   end
 
   def display_not_found_warning?(uml_request)
@@ -235,11 +219,28 @@ module ResolveHelper
   # in application config resolve_sections list for a specific
   # part of the page. :main, :sidebar, or :resource_info.
   def html_sections(area)
-    umlaut_config.lookup!("resolve_sections", []).find_all do |section|
+    config_resolve_sections.find_all do |section|
       section[:html_area] == area
     end
   end
 
+  # Looks up umlaut_config.lookup!("resolve_sections"), then passes it through
+  # resolve_sections_filter config if available -- caches result in an iVar, for this
+  # action. 
+  def config_resolve_sections
+    unless defined? @_config_resolve_sections
+      @_config_resolve_sections = umlaut_config.lookup!("resolve_sections", [])
+      
+      umlaut_config.lookup!("resolve_sections_filter", []).each do |reorder_proc|
+        # clone it, so we aren't reordering the original
+        @_config_resolve_sections = @_config_resolve_sections.clone
+        reorder_proc.call(@user_request, @_config_resolve_sections)
+      end
+    end
+
+    return @_config_resolve_sections
+  end
+
   def html_section_by_div_id(div_id)
     umlaut_config.lookup!("resolve_sections", []).find do |defn|
       defn[:div_id] == div_id