shoulda-matchers 2.6.1 → 2.6.2

data/doc_config/yard/templates/default/fulldoc/html/full_list_method.erb

@@ -0,0 +1,8 @@
+<% n = 1 %>
+<% @items.each do |item| %>
+  <li class="r<%= n %> <%= item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
+    <%= linkify item, h(item.name(true)) %>
+    <small>(<%= item.namespace.title %>)</small>
+  </li>
+  <% n = n == 2 ? 1 : 2 %>
+<% end %>

data/doc_config/yard/templates/default/fulldoc/html/js/app.js

@@ -0,0 +1,298 @@
+function createSourceLinks() {
+  $('.method_details_list .source_code').
+    before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
+  $('.toggleSource').toggle(function() {
+    $(this).parent().nextAll('.source_code').show();
+    $(this).text("Hide source");
+    StickyHeaders.update();
+  },
+  function() {
+    $(this).parent().nextAll('.source_code').hide();
+    $(this).text("View source");
+    StickyHeaders.update();
+  });
+}
+
+function createDefineLinks() {
+  var tHeight = 0;
+  $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
+  $('.toggleDefines').toggle(function() {
+    tHeight = $(this).parent().prev().height();
+    $(this).prev().show();
+    $(this).parent().prev().height($(this).parent().height());
+    $(this).text("(less)");
+    StickyHeaders.update();
+  },
+  function() {
+    $(this).prev().hide();
+    $(this).parent().prev().height(tHeight);
+    $(this).text("more...");
+    StickyHeaders.update();
+  });
+}
+
+function createFullTreeLinks() {
+  var tHeight = 0;
+  $('.inheritanceTree').toggle(function() {
+    tHeight = $(this).parent().prev().height();
+    $(this).parent().toggleClass('showAll');
+    $(this).text("(hide)");
+    $(this).parent().prev().height($(this).parent().height());
+    StickyHeaders.update();
+  },
+  function() {
+    $(this).parent().toggleClass('showAll');
+    $(this).parent().prev().height(tHeight);
+    $(this).text("show all");
+    StickyHeaders.update();
+  });
+}
+
+function hideSearchFrameOnBlur() {
+  $(document.body).on('click', hideSearchFrame);
+}
+
+function initSearchFrameLinks() {
+  var search = $('.js-search');
+  var items = search.find('li');
+  var links = search.find('a');
+  var frame = $('.js-search-frame');
+
+  function listen() {
+    links.on('click', function (event) {
+      event.preventDefault();
+      event.stopPropagation();
+      toggle(this, this.href);
+    });
+
+    $(document).on('keydown', function (event) {
+      if (event.which == 27) {
+        close();
+      }
+    })
+
+    $(document).on('click', function (event) {
+      close();
+    })
+  }
+
+  function toggle(link, frameSrc) {
+    if (isOpen() && clickedOnSameLink(frameSrc)) {
+      close();
+    } else {
+      open(link, frameSrc);
+    }
+  }
+
+  function isOpen() {
+    return frame.hasClass('open');
+  }
+
+  function clickedOnSameLink(location) {
+    return frame.attr('src') === location;
+  }
+
+  function reset() {
+    items.removeClass('active');
+  }
+
+  function open(link, location) {
+    reset();
+    $(link).parent().addClass('active');
+    frame.attr('src', location).one('load', function () {
+      frame.addClass('open');
+    })
+  }
+
+  function close() {
+    reset();
+    frame.removeClass('open');
+  }
+
+  listen();
+}
+
+
+function linkSummaries() {
+  $('.summary_signature').click(function() {
+    document.location = $(this).find('a').attr('href');
+  });
+}
+
+function framesInit() {
+  if (hasFrames) {
+    document.body.className = 'frames';
+    $('#menu .noframes a').attr('href', document.location);
+    try {
+      window.top.document.title = $('html head title').text();
+    } catch(error) {
+      // some browsers will not allow this when serving from file://
+      // but we don't want to stop the world.
+    }
+  }
+  else {
+    $('#menu .noframes a').text('frames').attr('href', framesUrl);
+  }
+}
+
+function keyboardShortcuts() {
+  if (window.top.frames.main) return;
+
+  $(document).keypress(function(evt) {
+    if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
+
+    if (
+      typeof evt.target !== "undefined" &&
+      (evt.target.nodeName == "INPUT" || evt.target.nodeName == "TEXTAREA")
+    ) return;
+
+    switch (evt.charCode) {
+      case 67: case 99:  $('#class_list_link').click(); break;  // 'c'
+      case 77: case 109: $('#method_list_link').click(); break; // 'm'
+      case 70: case 102: $('#file_list_link').click(); break;   // 'f'
+      default: break;
+    }
+  });
+}
+
+function summaryToggle() {
+  $('.summary_toggle').click(function() {
+    if (localStorage) {
+      localStorage.summaryCollapsed = $(this).text();
+    }
+    $('.summary_toggle').each(function() {
+      $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
+      var next = $(this).parent().parent().nextAll('ul.summary').first();
+      if (next.hasClass('compact')) {
+        next.toggle();
+        next.nextAll('ul.summary').first().toggle();
+      }
+      else if (next.hasClass('summary')) {
+        var list = $('<ul class="summary compact" />');
+        list.html(next.html());
+        list.find('.summary_desc, .note').remove();
+        list.find('a').each(function() {
+          $(this).html($(this).find('strong').html());
+          $(this).parent().html($(this)[0].outerHTML);
+        });
+        next.before(list);
+        next.toggle();
+      }
+    });
+    StickyHeaders.update();
+    return false;
+  });
+  if (localStorage) {
+    if (localStorage.summaryCollapsed == "collapse") {
+      $('.summary_toggle').first().click();
+    }
+    else localStorage.summaryCollapsed = "expand";
+  }
+}
+
+function fixOutsideWorldLinks() {
+  $('a').each(function() {
+    if (window.location.host != this.host) this.target = '_parent';
+  });
+}
+
+function generateTOC() {
+  if ($('#filecontents').length === 0) return;
+  var _toc = $('<ol class="top"></ol>');
+  var show = false;
+  var toc = _toc;
+  var counter = 0;
+  var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
+  var i;
+  if ($('#filecontents h1').length > 1) tags.unshift('h1');
+  for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
+  var lastTag = parseInt(tags[0][1], 10);
+  $(tags.join(', ')).each(function() {
+    if ($(this).parents('.method_details .docstring').length != 0) return;
+    if (this.id == "filecontents") return;
+    show = true;
+    var thisTag = parseInt(this.tagName[1], 10);
+    if (this.id.length === 0) {
+      var proposedId = $(this).attr('toc-id');
+      if (typeof(proposedId) != "undefined") this.id = proposedId;
+      else {
+        var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
+        if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
+        this.id = proposedId;
+      }
+    }
+    if (thisTag > lastTag) {
+      for (i = 0; i < thisTag - lastTag; i++) {
+        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+      }
+    }
+    if (thisTag < lastTag) {
+      for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
+    }
+    var title = $(this).attr('toc-title');
+    if (typeof(title) == "undefined") title = $(this).text();
+    toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
+    lastTag = thisTag;
+  });
+  if (!show) return;
+  html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
+  $('#content').prepend(html);
+  $('#toc').append(_toc);
+  $('#toc .hide_toc').toggle(function() {
+    $('#toc .top').slideUp('fast');
+    $('#toc').toggleClass('hidden');
+    $('#toc .title small').toggle();
+  }, function() {
+    $('#toc .top').slideDown('fast');
+    $('#toc').toggleClass('hidden');
+    $('#toc .title small').toggle();
+  });
+  $('#toc .float_toc').toggle(function() {
+    $(this).text('float');
+    $('#toc').toggleClass('nofloat');
+  }, function() {
+    $(this).text('left');
+    $('#toc').toggleClass('nofloat');
+  });
+}
+
+function removeDlBoxIfEmpty() {
+  var $box = $('dl.box')
+  if (!$box.text().trim()) {
+    $box.remove();
+  }
+}
+
+function makeHeadersSticky() {
+  StickyHeaders
+    .set({
+      contentContainer: '#main',
+      stickyHeaderContainer: '#header',
+      switchOnCollisionWith: 'top',
+      fillHeadersWith: function (node) {
+        return $('<h3>').text(node.find('strong').text());
+      }
+    })
+    .add('.method_details > h3')
+    .activate();
+}
+
+function updateStickyHeaders() {
+  setTimeout(function () {
+    StickyHeaders.update()
+  }, 100)
+}
+
+$(makeHeadersSticky);
+$(framesInit);
+$(createSourceLinks);
+$(createDefineLinks);
+$(createFullTreeLinks);
+$(initSearchFrameLinks);
+$(linkSummaries);
+$(keyboardShortcuts);
+$(summaryToggle);
+$(fixOutsideWorldLinks);
+$(generateTOC);
+$(removeDlBoxIfEmpty);
+$(updateStickyHeaders);

data/doc_config/yard/templates/default/fulldoc/html/js/full_list.js

@@ -0,0 +1 @@
+// Override with nothing

data/doc_config/yard/templates/default/fulldoc/html/js/jquery.stickyheaders.js

@@ -0,0 +1,289 @@
+window.StickyHeaders = (function ($) {
+  var me = {},
+      body, config, contentContainer, currentHeaderRangeIndex,
+      currentScrollOffset, elem, headerRanges, headers, isScrolling,
+      lastScrollOffset, selectors, stickyHeaderContainer;
+
+  function init() {
+    config = {
+      switchOnCollisionWith: 'top',
+      copy: 'element'
+    };
+    selectors = [];
+    headers = [];
+    headerRanges = [];
+
+    currentHeaderRangeIndex = -1;
+    currentScrollOffset = 0;
+    lastScrollOffset = 0;
+    isScrolling = false;
+
+    createStickyHeader();
+  }
+
+  function createStickyHeader() {
+    elem = $('<div>').attr('id', 'sticky-header');
+  }
+
+  function setHeaders() {
+    var elements = [],
+        stickyHeaderLineHeight = parseCssValue(elem.css('line-height')),
+        stickyHeaderTopPadding;
+
+    headers = [];
+    $.each(selectors, function (_, selector) {
+      contentContainer.find(selector).each(function (_, element) {
+        var $element = $(element),
+            fontSize = parseCssValue($element.css('font-size')),
+            topOffset = (
+              element.offsetTop +
+              parseFloat($element.css('padding-top'), 10) +
+              (- ((stickyHeaderLineHeight - fontSize) / 2))
+            ),
+            height = Math.round($element.height()),
+            outerHeight = Math.round($element.outerHeight(true)),
+            bottomOffset = topOffset + outerHeight;
+
+        headers.push({
+          element: element,
+          $element: $element,
+          topOffset: topOffset,
+          bottomOffset: bottomOffset
+        });
+      })
+    })
+  }
+
+  function setHeaderRanges() {
+    var offsetProp = config.switchOnCollisionWith + 'Offset',
+        start, end;
+
+    headerRanges = [];
+    for (var i = 0, len = headers.length; i < len; i++) {
+      start = headers[i][offsetProp];
+
+      if (headers[i+1]) {
+        end = headers[i+1][offsetProp];
+      } else {
+        end = null;
+      }
+
+      headerRanges.push({
+        start: start,
+        end: end,
+        element: headers[i].element
+      });
+    }
+
+    //debugHeaderRanges();
+  }
+
+  function debugHeaderRanges() {
+    contentContainer.find('.header-range-debug').remove();
+
+    $.each(headerRanges, function (i, range) {
+      var color = 'hsla('+(20*i)+', 100%, 50%, 0.15)',
+          debug = $('<div>')
+            .addClass('header-range-debug')
+            .css({
+              width: '100%',
+              position: 'absolute',
+              top: range.start + 'px',
+              height: (range.end === null ? '1px' : (range.end - range.start) + 'px'),
+              backgroundColor: color,
+              borderTop: '1px solid black'
+            })
+            .appendTo(contentContainer)
+
+      debug.append(
+        $('<div>')
+          .css({
+            position: 'absolute',
+            top: 0,
+            right: 0,
+            height: '2em',
+            lineHeight: '2em',
+            width: '40em',
+            fontSize: '13px',
+            backgroundColor: 'black',
+            color: 'white',
+            padding: '0 5px'
+          })
+          .text(headers[i].$element.text() + ' (#' + i + ')')
+      )
+    })
+  }
+
+  function setCurrentHeaderIndex() {
+    var scrollTop = contentContainer.scrollTop();
+
+    for (var i = 0, len = headers.length; i < len; i++) {
+      if (scrollTop < headers[i].bottomOffset) {
+        break;
+      }
+      currentHeaderIndex = i;
+    }
+  }
+
+  function render() {
+    var clonedHeader;
+
+    if (currentHeaderRangeIndex < 0 || currentHeaderRangeIndex > headerRanges.length-1) {
+      elem.removeClass('show');
+      body.removeClass('has-sticky-header');
+    }
+    else {
+      var realHeader = $(headerRanges[currentHeaderRangeIndex].element);
+
+      if (typeof config.fillHeadersWith === 'function') {
+        elem.html(config.fillHeadersWith(realHeader));
+      } else if (config.fillHeadersWith === 'content') {
+        elem.html(realHeader.clone().html());
+      } else {
+        elem.html(realHeader.clone());
+      }
+
+      elem.addClass('show');
+      body.addClass('has-sticky-header');
+    }
+
+    return me;
+  }
+
+  function determineCurrentHeaderRangeIndex(startIndex, direction) {
+    var index = startIndex;
+    while (true) {
+      currentHeaderRange = headerRanges[index];
+      if (!currentHeaderRange || isWithinRange(currentScrollOffset, currentHeaderRange)) {
+        break;
+      } else {
+        index += direction;
+      }
+    }
+    return index;
+  }
+
+  function onScroll() {
+    if (!headerRanges.length) {
+      return;
+    }
+
+    currentScrollOffset = contentContainer.scrollTop();
+
+    if (currentScrollOffset > headerRanges[0].start) {
+      var newCurrentHeaderRangeIndex = currentHeaderRangeIndex;
+      var currentHeaderRange = headerRanges[newCurrentHeaderRangeIndex];
+
+      if (newCurrentHeaderRangeIndex < 0) {
+        newCurrentHeaderRangeIndex = 0;
+      }
+
+      if (currentScrollOffset < lastScrollOffset) {
+        // scrolling up
+        newCurrentHeaderRangeIndex = determineCurrentHeaderRangeIndex(newCurrentHeaderRangeIndex, -1);
+      } else {
+        // scrolling down
+        newCurrentHeaderRangeIndex = determineCurrentHeaderRangeIndex(newCurrentHeaderRangeIndex, +1);
+      }
+    } else {
+      newCurrentHeaderRangeIndex = -1;
+    }
+
+    // only re-render when necessary
+    if (newCurrentHeaderRangeIndex !== undefined && currentHeaderRangeIndex !== newCurrentHeaderRangeIndex) {
+      currentHeaderRangeIndex = newCurrentHeaderRangeIndex;
+      render();
+    }
+
+    lastScrollOffset = currentScrollOffset;
+  }
+
+  function listenToScroll(element, callback, options) {
+    options = options || {};
+
+    if (options.every) {
+      element.on('scroll', function () {
+        isScrolling = true;
+      })
+
+      setInterval(function () {
+        if (isScrolling) {
+          callback();
+          isScrolling = false;
+        }
+      }, options.every);
+    }
+    else {
+      element.on('scroll', callback);
+    }
+  }
+
+  function isWithinRange(number, range) {
+    return (
+      number >= range.start &&
+      (
+        range.end === undefined ||
+        range.end === null ||
+        number <= range.end
+      )
+    );
+  }
+
+  function parseCssValue(value) {
+    if (value === null || value === undefined) {
+      return 0;
+    } else {
+      return parseInt(value, 10);
+    }
+  }
+
+  me.setHeaders = setHeaders;
+  me.setHeaderRanges = setHeaderRanges;
+
+  me.set = function (/* key, value | config */) {
+    if ($.isPlainObject(arguments[0])) {
+      $.extend(config, arguments[0]);
+    } else {
+      config[arguments[0]] = arguments[1];
+    }
+    return me;
+  }
+
+  me.add = function (/* selectors... */) {
+    selectors.push.apply(selectors, arguments);
+    return me;
+  }
+
+  me.activate = function () {
+    body = $('body');
+    contentContainer = config.contentContainer ? $(config.contentContainer) : body;
+    stickyHeaderContainer = config.stickyHeaderContainer ? $(config.stickyHeaderContainer) : contentContainer;
+
+    stickyHeaderContainer.append(elem);
+    setHeaders();
+    setHeaderRanges();
+    setCurrentHeaderIndex();
+
+    return me;
+  }
+
+  me.update = function () {
+    setHeaders();
+    setHeaderRanges();
+    render();
+
+    listenToScroll(contentContainer, onScroll);
+  }
+
+  me.getHeaders = function () {
+    return headers;
+  }
+
+  me.getHeaderRanges = function () {
+    return headerRanges;
+  }
+
+  init();
+
+  return me;
+})(jQuery);