POST /support_assignments POST /support_assignments.json
++ Source: + show + +
+# File controllers/support_assignments_controller.rb, line 30 +def create + @support_assignment = SupportAssignment.new(support_assignment_params) + + respond_to do |format| + if @support_assignment.save + format.html { redirect_to [@support_assignment.user, @support_assignment], notice: 'Support assignment was successfully created.' } + format.json { render :show, status: :created, location: @support_assignment } + else + format.html { render :new } + format.json { render json: @support_assignment.errors, status: :unprocessable_entity } + end + end +end+
DELETE /support_assignments/1 DELETE /support_assignments/1.json
++ Source: + show + +
+# File controllers/support_assignments_controller.rb, line 60 +def destroy + @support_assignment.destroy + respond_to do |format| + format.html { redirect_to support_assignments_url, notice: 'Support assignment was successfully destroyed.' } + format.json { head :no_content } + end +end+
GET /support_assignments/1/edit
++ Source: + show + +
+# File controllers/support_assignments_controller.rb, line 25 +def edit +end+
GET /support_assignments GET /support_assignments.json
++ Source: + show + +
+# File controllers/support_assignments_controller.rb, line 6 +def index + if params[:user_id].present? + @support_assignments = SupportAssignment.where(user_id: params[:user_id]).order :date + else + @support_assignments = SupportAssignment.all.order :date + end +end+
GET /support_assignments/month/1 GET /support_assignments/month/1.json
++ Source: + show + +
+# File controllers/support_assignments_controller.rb, line 77 +def month + @support_assignments = SupportAssignment.where("strftime('%m', date) + 0 = ?", params[:month].to_i).order :date + render :index +end+
GET /support_assignments/new
++ Source: + show + +
+# File controllers/support_assignments_controller.rb, line 20 +def new + @support_assignment = SupportAssignment.new +end+
GET /support_assignments/1 GET /support_assignments/1.json
++ Source: + show + +
+# File controllers/support_assignments_controller.rb, line 16 +def show +end+
GET /support_assignments/today GET /support_assignments/today.json
++ Source: + show + +
+# File controllers/support_assignments_controller.rb, line 70 +def today + @support_assignment = SupportAssignment.where(date: Date.today).first + render :show +end+
PATCH/PUT /support_assignments/1 PATCH/PUT /support_assignments/1.json
++ Source: + show + +
+# File controllers/support_assignments_controller.rb, line 46 +def update + respond_to do |format| + if @support_assignment.update(support_assignment_params) + format.html { redirect_to [@support_assignment.user, @support_assignment], notice: 'Support assignment was successfully updated.' } + format.json { render :show, status: :ok, location: [@support_assignment.user, @support_assignment] } + else + format.html { render :edit } + format.json { render json: @support_assignment.errors, status: :unprocessable_entity } + end + end +end+
Produces link for creating new assignments depending on whether the user_id +param is available
++ Source: + show + +
+# File helpers/support_assignments_helper.rb, line 3 +def new_assignment_link + if params[:user_id].present? + link_to('New Support assignment', new_user_support_assignment_path) + else + link_to('New Support assignment', new_support_assignment_path) + end +end+
Produces link for support assignments depending on wheher the user_id param +is available
++ Source: + show + +
+# File helpers/support_assignments_helper.rb, line 12 +def support_assignments_link + if params[:user_id].present? + link_to 'Back', user_support_assignments_path + else + link_to 'Back', support_assignments_path + end +end+
Produces a array of users who are available on the specified date
++ Source: + show + +
+# File models/user.rb, line 28 +def self.available_users date + (User.where(unavailable_date: nil) | User.where.not(unavailable_date: date)).to_a +end+
Assigns the user to support duty, if the user is available on the specified +date.
++ Source: + show + +
+# File models/user.rb, line 11 +def assign_duty date + support_assignments.create(date: date) if available? date +end+
Returns true if the user is available on the specified date.
++ Source: + show + +
+# File models/user.rb, line 6 +def available? date + date != unavailable_date +end+
Returns a support assignment for the user with the date in the future
++ Source: + show + +
+# File models/user.rb, line 23 +def future_assignment + support_assignments.select{ |assignment| assignment.date.future? }.first +end+
Marks the user as unavailable for duty on the specified date. If the user +was assigned to duty on this date, another user swaps duty with this user.
++ Source: + show + +
+ +POST /users POST /users.json
++ Source: + show + +
+# File controllers/users_controller.rb, line 26 +def create + @user = User.new(user_params) + + respond_to do |format| + if @user.save + format.html { redirect_to @user, notice: 'User was successfully created.' } + format.json { render :show, status: :created, location: @user } + else + format.html { render :new } + format.json { render json: @user.errors, status: :unprocessable_entity } + end + end +end+
DELETE /users/1 DELETE /users/1.json
++ Source: + show + +
+# File controllers/users_controller.rb, line 56 +def destroy + @user.destroy + respond_to do |format| + format.html { redirect_to users_url, notice: 'User was successfully destroyed.' } + format.json { head :no_content } + end +end+
GET /users/1/edit
++ Source: + show + +
+# File controllers/users_controller.rb, line 21 +def edit +end+
GET /users GET /users.json
++ Source: + show + +
+# File controllers/users_controller.rb, line 6 +def index + @users = User.all.to_a +end+
GET /users/new
++ Source: + show + +
+# File controllers/users_controller.rb, line 16 +def new + @user = User.new +end+
GET /users/1 GET /users/1.json
++ Source: + show + +
+# File controllers/users_controller.rb, line 12 +def show +end+
PATCH/PUT /users/1 PATCH/PUT /users/1.json
++ Source: + show + +
+# File controllers/users_controller.rb, line 42 +def update + respond_to do |format| + if @user.update(user_params) + format.html { redirect_to @user, notice: 'User was successfully updated.' } + format.json { render :show, status: :ok, location: @user } + else + format.html { render :edit } + format.json { render json: @user.errors, status: :unprocessable_entity } + end + end +end+
// This is a manifest file that'll be compiled into application.js, +which will include all the files // listed below. // // Any +JavaScript/Coffee file within this directory, lib/assets/javascripts, +vendor/assets/javascripts, // or any plugin's vendor/assets/javascripts +directory can be referenced here using a relative path. // // It's not +advisable to add code directly here, but if you do, it'll appear at the +bottom of the // compiled file. // // Read Sprockets README (github.com/rails/sprockets#sprockets-directives) +for details // about supported directives. // //= require jquery //= +require jquery_ujs //= require turbolinks //= require_tree .
+ +Place all the behaviors and hooks related to the matching controller here. +All this logic will automatically be available in application.js. You can +use CoffeeScript in this file: coffeescript.org/
+ +Place all the behaviors and hooks related to the matching controller here. +All this logic will automatically be available in application.js. You can +use CoffeeScript in this file: coffeescript.org/
+ +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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+compiled file so the styles you add here take precedence over styles defined in any styles
+defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+file per style scope.body {
+ +background-color: #fff;
+color: #333;
+font-family: verdana, arial, helvetica, sans-serif;
+font-size: 13px;
+line-height: 18px;}
+ +p, ol, ul, td {
+ +font-family: verdana, arial, helvetica, sans-serif;
+font-size: 13px;
+line-height: 18px;}
+ +pre {
+ +background-color: #eee;
+padding: 10px;
+font-size: 11px;}
+ +a {
+ +color: #000;
+&:visited {
+ color: #666;
+}
+&:hover {
+ color: #fff;
+ background-color: #000;
+}}
+ +div {
+ +&.field, &.actions {
+ margin-bottom: 10px;
+}}
+ +notice {
+ +color: green;}
+ +.field_with_errors {
+ +padding: 2px;
+background-color: red;
+display: table;}
+ +error_explanation {
+ +width: 450px;
+border: 2px solid red;
+padding: 7px;
+padding-bottom: 0;
+margin-bottom: 20px;
+background-color: #f0f0f0;
+h2 {
+ text-align: left;
+ font-weight: bold;
+ padding: 5px 5px 5px 15px;
+ font-size: 12px;
+ margin: -7px;
+ margin-bottom: 0px;
+ background-color: #c00;
+ color: #fff;
+}
+ul li {
+ font-size: 12px;
+ list-style: square;
+}}
+ +// Place all the styles related to the SupportAssignments controller here. +// They will automatically be included in application.css. // You can use +Sass (SCSS) here: sass-lang.com/
+ +// Place all the styles related to the Users controller here. // They will +automatically be included in application.css. // You can use Sass (SCSS) +here: sass-lang.com/
+ +json.array!(@support_assignments) do |support_assignment|
+ +json.extract! support_assignment, :id, :date, :user_id
+json.url support_assignments_url(support_assignment, format: :json)
+end
+ +json.extract! @support_assignment, :id, :date, :user_id, :created_at, +:updated_at
+ +json.array!(@users) do |user|
+ +json.extract! user, :id, :name, :unavailable_date
+json.url user_url(user, format: :json)
+end
+ +json.extract! @user, :id, :name, :unavailable_date, :created_at, +:updated_at
+ +"+w.value+"Assigns the user to support duty, if the user is available on the specified\ndate.\n"],["available?","User","classes/User.html#method-i-available-3F","(date)","
Returns true if the user is available on the specified date.\n"],["available_users","User","classes/User.html#method-c-available_users","(date)","
Produces a array of users who are available on the specified date\n"],["create","SupportAssignmentsController","classes/SupportAssignmentsController.html#method-i-create","()","
POST /support_assignments POST /support_assignments.json\n"],["create","UsersController","classes/UsersController.html#method-i-create","()","
POST /users POST /users.json\n"],["destroy","SupportAssignmentsController","classes/SupportAssignmentsController.html#method-i-destroy","()","
DELETE /support_assignments/1 DELETE /support_assignments/1.json\n"],["destroy","UsersController","classes/UsersController.html#method-i-destroy","()","
DELETE /users/1 DELETE /users/1.json\n"],["edit","SupportAssignmentsController","classes/SupportAssignmentsController.html#method-i-edit","()","
GET /support_assignments/1/edit\n"],["edit","UsersController","classes/UsersController.html#method-i-edit","()","
GET /users/1/edit\n"],["future_assignment","User","classes/User.html#method-i-future_assignment","()","
Returns a support assignment for the user with the date in the future\n"],["index","SupportAssignmentsController","classes/SupportAssignmentsController.html#method-i-index","()","
GET /support_assignments GET /support_assignments.json\n"],["index","UsersController","classes/UsersController.html#method-i-index","()","
GET /users GET /users.json\n"],["month","SupportAssignmentsController","classes/SupportAssignmentsController.html#method-i-month","()","
GET /support_assignments/month/1 GET /support_assignments/month/1.json\n"],["new","SupportAssignmentsController","classes/SupportAssignmentsController.html#method-i-new","()","
GET /support_assignments/new\n"],["new","UsersController","classes/UsersController.html#method-i-new","()","
GET /users/new\n"],["new_assignment_link","SupportAssignmentsHelper","classes/SupportAssignmentsHelper.html#method-i-new_assignment_link","()","
Produces link for creating new assignments depending on whether the user_id\nparam is available\n"],["show","SupportAssignmentsController","classes/SupportAssignmentsController.html#method-i-show","()","
GET /support_assignments/1 GET /support_assignments/1.json\n"],["show","UsersController","classes/UsersController.html#method-i-show","()","
GET /users/1 GET /users/1.json\n"],["support_assignments_link","SupportAssignmentsHelper","classes/SupportAssignmentsHelper.html#method-i-support_assignments_link","()","
Produces link for support assignments depending on wheher the user_id param\nis available\n"],["today","SupportAssignmentsController","classes/SupportAssignmentsController.html#method-i-today","()","
GET /support_assignments/today GET /support_assignments/today.json\n"],["unavailable_date=","User","classes/User.html#method-i-unavailable_date-3D","(date)","
Marks the user as unavailable for duty on the specified date. If the user\nwas assigned to duty on this …\n"],["update","SupportAssignmentsController","classes/SupportAssignmentsController.html#method-i-update","()","
PATCH/PUT /support_assignments/1 PATCH/PUT /support_assignments/1.json\n"],["update","UsersController","classes/UsersController.html#method-i-update","()","
PATCH/PUT /users/1 PATCH/PUT /users/1.json\n"],["application.js","","files/assets/javascripts/application_js.html","","
// This is a manifest file that'll be compiled into application.js,\nwhich will include all the files …\n"],["support_assignments.coffee","","files/assets/javascripts/support_assignments_coffee.html","","
Place all the behaviors and hooks related to the matching controller here.\nAll this logic will automatically …\n"],["users.coffee","","files/assets/javascripts/users_coffee.html","","
Place all the behaviors and hooks related to the matching controller here.\nAll this logic will automatically …\n"],["application.css","","files/assets/stylesheets/application_css.html","","\n
This is a manifest file that'll be compiled into application.css, which will include all the files\nlisted ...body {\n\n
background-color: #fff;\ncolor: #333;\nfont-family: verdana, arial, helvetica, sans-serif;\nfont-size: ...// Place all the styles related to the SupportAssignments controller here.\n// They will automatically …\n"],["users.scss","","files/assets/stylesheets/users_scss.html","","
// Place all the styles related to the Users controller here. // They will\nautomatically be included …\n"],["index.json.jbuilder","","files/views/support_assignments/index_json_jbuilder.html","","
json.array!(@support_assignments) do |support_assignment|\n\n
json.extract! support_assignment, :id, :date, ...json.extract! @support_assignment, :id, :date, :user_id, :created_at,\n:updated_at\n"],["index.json.jbuilder","","files/views/users/index_json_jbuilder.html","","
json.array!(@users) do |user|\n\n
json.extract! user, :id, :name, :unavailable_date\njson.url user_url(user, ...json.extract! @user, :id, :name, :unavailable_date, :created_at,\n:updated_at\n"]]}} \ No newline at end of file diff --git a/doc/js/searchdoc.js b/doc/js/searchdoc.js new file mode 100755 index 0000000..15395ea --- /dev/null +++ b/doc/js/searchdoc.js @@ -0,0 +1,449 @@ +Searchdoc = {}; + +// navigation.js ------------------------------------------ + +Searchdoc.Navigation = new function() { + this.initNavigation = function() { + var _this = this; + + $(document).keydown(function(e) { + _this.onkeydown(e); + }).keyup(function(e) { + _this.onkeyup(e); + }); + + this.navigationActive = true; + } + + this.setNavigationActive = function(state) { + this.navigationActive = state; + this.clearMoveTimeout(); + } + + + this.onkeyup = function(e) { + if (!this.navigationActive) return; + switch(e.keyCode) { + case 37: //Event.KEY_LEFT: + case 38: //Event.KEY_UP: + case 39: //Event.KEY_RIGHT: + case 40: //Event.KEY_DOWN: + case 73: // i - qwerty + case 74: // j + case 75: // k + case 76: // l + case 67: // c - dvorak + case 72: // h + case 84: // t + case 78: // n + this.clearMoveTimeout(); + break; + } + } + + this.onkeydown = function(e) { + if (!this.navigationActive) return; + switch(e.keyCode) { + case 37: //Event.KEY_LEFT: + case 74: // j (qwerty) + case 72: // h (dvorak) + if (this.moveLeft()) e.preventDefault(); + break; + case 38: //Event.KEY_UP: + case 73: // i (qwerty) + case 67: // c (dvorak) + if (e.keyCode == 38 || e.ctrlKey) { + if (this.moveUp()) e.preventDefault(); + this.startMoveTimeout(false); + } + break; + case 39: //Event.KEY_RIGHT: + case 76: // l (qwerty) + case 78: // n (dvorak) + if (this.moveRight()) e.preventDefault(); + break; + case 40: //Event.KEY_DOWN: + case 75: // k (qwerty) + case 84: // t (dvorak) + if (e.keyCode == 40 || e.ctrlKey) { + if (this.moveDown()) e.preventDefault(); + this.startMoveTimeout(true); + } + break; + case 9: //Event.KEY_TAB: + case 13: //Event.KEY_RETURN: + if (this.$current) this.select(this.$current); + break; + case 83: // s (qwerty) + case 79: // o (dvorak) + if (e.ctrlKey) { + $('#search').focus(); + e.preventDefault(); + } + break; + } + if (e.ctrlKey && e.shiftKey) this.select(this.$current); + } + + this.clearMoveTimeout = function() { + clearTimeout(this.moveTimeout); + this.moveTimeout = null; + } + + this.startMoveTimeout = function(isDown) { + if (!$.browser.mozilla && !$.browser.opera) return; + if (this.moveTimeout) this.clearMoveTimeout(); + var _this = this; + + var go = function() { + if (!_this.moveTimeout) return; + _this[isDown ? 'moveDown' : 'moveUp'](); + _this.moveTimout = setTimeout(go, 100); + } + this.moveTimeout = setTimeout(go, 200); + } + + this.moveRight = function() { + } + + this.moveLeft = function() { + } + + this.move = function(isDown) { + } + + this.moveUp = function() { + return this.move(false); + } + + this.moveDown = function() { + return this.move(true); + } +} + + +// scrollIntoView.js -------------------------------------- + +function scrollIntoView(element, view) { + var offset, viewHeight, viewScroll, height; + offset = element.offsetTop; + height = element.offsetHeight; + viewHeight = view.offsetHeight; + viewScroll = view.scrollTop; + if (offset - viewScroll + height > viewHeight) { + view.scrollTop = offset - viewHeight + height; + } + if (offset < viewScroll) { + view.scrollTop = offset; + } +} + +// panel.js ----------------------------------------------- + +Searchdoc.Panel = function(element, data, tree, frame) { + this.$element = $(element); + this.$input = $('input', element).eq(0); + this.$result = $('.result ul', element).eq(0); + this.frame = frame; + this.$current = null; + this.$view = this.$result.parent(); + this.data = data; + this.searcher = new Searcher(data.index); + + this.tree = new Searchdoc.Tree($('.tree', element), tree, this); + this.init(); +} + +Searchdoc.Panel.prototype = $.extend({}, Searchdoc.Navigation, new function() { + var suid = 1; + + this.init = function() { + var _this = this; + var observer = function() { + _this.search(_this.$input[0].value); + }; + this.$input.keyup(observer); + this.$input.click(observer); // mac's clear field + + this.searcher.ready(function(results, isLast) { + _this.addResults(results, isLast); + }) + + this.$result.click(function(e) { + _this.$current.removeClass('current'); + _this.$current = $(e.target).closest('li').addClass('current'); + _this.select(); + _this.$input.focus(); + }); + + this.initNavigation(); + this.setNavigationActive(false); + } + + this.search = function(value, selectFirstMatch) { + value = jQuery.trim(value).toLowerCase(); + this.selectFirstMatch = selectFirstMatch; + if (value) { + this.$element.removeClass('panel_tree').addClass('panel_results'); + this.tree.setNavigationActive(false); + this.setNavigationActive(true); + } else { + this.$element.addClass('panel_tree').removeClass('panel_results'); + this.tree.setNavigationActive(true); + this.setNavigationActive(false); + } + if (value != this.lastQuery) { + this.lastQuery = value; + this.firstRun = true; + this.searcher.find(value); + } + } + + this.addResults = function(results, isLast) { + var target = this.$result.get(0); + if (this.firstRun && (results.length > 0 || isLast)) { + this.$current = null; + this.$result.empty(); + } + for (var i=0, l = results.length; i < l; i++) { + target.appendChild(renderItem.call(this, results[i])); + }; + if (this.firstRun && results.length > 0) { + this.firstRun = false; + this.$current = $(target.firstChild); + this.$current.addClass('current'); + if (this.selectFirstMatch) this.select(); + scrollIntoView(this.$current[0], this.$view[0]) + } + if (jQuery.browser.msie) this.$element[0].className += ''; + } + + this.open = function(src) { + this.frame.location.href = '../' + src; + if (this.frame.highlight) this.frame.highlight(src); + } + + this.select = function() { + this.open(this.$current.data('path')); + } + + this.move = function(isDown) { + if (!this.$current) return; + var $next = this.$current[isDown ? 'next' : 'prev'](); + if ($next.length) { + this.$current.removeClass('current'); + $next.addClass('current'); + scrollIntoView($next[0], this.$view[0]); + this.$current = $next; + } + return true; + } + + function renderItem(result) { + var li = document.createElement('li'), + html = '', badge = result.badge; + html += '
'; + if (typeof badge != 'undefined') { + html += '' + escapeHTML(this.data.badges[badge] || 'unknown') + ''; + } + html += hlt(result.namespace) + '
'; + if (result.snippet) html += '' + escapeHTML(result.snippet.replace(/^
/, '')) + '
'; + li.innerHTML = html; + jQuery.data(li, 'path', result.path); + return li; + } + + function hlt(html) { + return escapeHTML(html).replace(/\u0001/g, '').replace(/\u0002/g, '') + } + + function escapeHTML(html) { + return html.replace(/[&<>]/g, function(c) { + return '&#' + c.charCodeAt(0) + ';'; + }); + } + +}); + +// tree.js ------------------------------------------------ + +Searchdoc.Tree = function(element, tree, panel) { + this.$element = $(element); + this.$list = $('ul', element); + this.tree = tree; + this.panel = panel; + this.init(); +} + +Searchdoc.Tree.prototype = $.extend({}, Searchdoc.Navigation, new function() { + this.init = function() { + var stopper = document.createElement('li'); + stopper.className = 'stopper'; + this.$list[0].appendChild(stopper); + for (var i=0, l = this.tree.length; i < l; i++) { + buildAndAppendItem.call(this, this.tree[i], 0, stopper); + }; + var _this = this; + this.$list.click(function(e) { + var $target = $(e.target), + $li = $target.closest('li'); + if ($target.hasClass('icon')) { + _this.toggle($li); + } else { + _this.select($li); + } + }) + + this.initNavigation(); + if (jQuery.browser.msie) document.body.className += ''; + } + + this.select = function($li) { + this.highlight($li); + var path = $li[0].searchdoc_tree_data.path; + if (path) this.panel.open(path); + } + + this.highlight = function($li) { + if (this.$current) this.$current.removeClass('current'); + this.$current = $li.addClass('current'); + } + + this.toggle = function($li) { + var closed = !$li.hasClass('closed'), + children = $li[0].searchdoc_tree_data.children; + $li.toggleClass('closed'); + for (var i=0, l = children.length; i < l; i++) { + toggleVis.call(this, $(children[i].li), !closed); + }; + } + + this.moveRight = function() { + if (!this.$current) { + this.highlight(this.$list.find('li:first')); + return; + } + if (this.$current.hasClass('closed')) { + this.toggle(this.$current); + } + } + + this.moveLeft = function() { + if (!this.$current) { + this.highlight(this.$list.find('li:first')); + return; + } + if (!this.$current.hasClass('closed')) { + this.toggle(this.$current); + } else { + var level = this.$current[0].searchdoc_tree_data.level; + if (level == 0) return; + var $next = this.$current.prevAll('li.level_' + (level - 1) + ':visible:first'); + this.$current.removeClass('current'); + $next.addClass('current'); + scrollIntoView($next[0], this.$element[0]); + this.$current = $next; + } + } + + this.move = function(isDown) { + if (!this.$current) { + this.highlight(this.$list.find('li:first')); + return true; + } + var next = this.$current[0]; + if (isDown) { + do { + next = next.nextSibling; + if (next && next.style && next.style.display != 'none') break; + } while(next); + } else { + do { + next = next.previousSibling; + if (next && next.style && next.style.display != 'none') break; + } while(next); + } + if (next && next.className.indexOf('stopper') == -1) { + this.$current.removeClass('current'); + $(next).addClass('current'); + scrollIntoView(next, this.$element[0]); + this.$current = $(next); + } + return true; + } + + function toggleVis($li, show) { + var closed = $li.hasClass('closed'), + children = $li[0].searchdoc_tree_data.children; + $li.css('display', show ? '' : 'none') + if (!show && this.$current && $li[0] == this.$current[0]) { + this.$current.removeClass('current'); + this.$current = null; + } + for (var i=0, l = children.length; i < l; i++) { + toggleVis.call(this, $(children[i].li), show && !closed); + }; + } + + function buildAndAppendItem(item, level, before) { + var li = renderItem(item, level), + list = this.$list[0]; + item.li = li; + list.insertBefore(li, before); + for (var i=0, l = item[3].length; i < l; i++) { + buildAndAppendItem.call(this, item[3][i], level + 1, before); + }; + return li; + } + + function renderItem(item, level) { + var li = document.createElement('li'), + cnt = document.createElement('div'), + h1 = document.createElement('h1'), + p = document.createElement('p'), + icon, i; + + li.appendChild(cnt); + li.style.paddingLeft = getOffset(level); + cnt.className = 'content'; + if (!item[1]) li.className = 'empty '; + cnt.appendChild(h1); + // cnt.appendChild(p); + h1.appendChild(document.createTextNode(item[0])); + // p.appendChild(document.createTextNode(item[4])); + if (item[2]) { + i = document.createElement('i'); + i.appendChild(document.createTextNode(item[2])); + h1.appendChild(i); + } + if (item[3].length > 0) { + icon = document.createElement('div'); + icon.className = 'icon'; + cnt.appendChild(icon); + } + + // user direct assignement instead of $() + // it's 8x faster + // $(li).data('path', item[1]) + // .data('children', item[3]) + // .data('level', level) + // .css('display', level == 0 ? '' : 'none') + // .addClass('level_' + level) + // .addClass('closed'); + li.searchdoc_tree_data = { + path: item[1], + children: item[3], + level: level + } + li.style.display = level == 0 ? '' : 'none'; + li.className += 'level_' + level + ' closed'; + return li; + } + + function getOffset(level) { + return 5 + 18*level + 'px'; + } +}); diff --git a/doc/js/searcher.js b/doc/js/searcher.js new file mode 100644 index 0000000..f854b54 --- /dev/null +++ b/doc/js/searcher.js @@ -0,0 +1,228 @@ +Searcher = function(data) { + this.data = data; + this.handlers = []; +} + +Searcher.prototype = new function() { + // search is performed in chunks of 1000 for non-blocking user input + var CHUNK_SIZE = 1000; + // do not try to find more than 100 results + var MAX_RESULTS = 100; + var huid = 1; + var suid = 1; + var runs = 0; + + this.find = function(query) { + var queries = splitQuery(query); + var regexps = buildRegexps(queries); + var highlighters = buildHilighters(queries); + var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++}; + var _this = this; + + this.currentSuid = state.n; + + if (!query) return; + + var run = function() { + // stop current search thread if new search started + if (state.n != _this.currentSuid) return; + + var results = + performSearch(_this.data, regexps, queries, highlighters, state); + var hasMore = (state.limit > 0 && state.pass < 4); + + triggerResults.call(_this, results, !hasMore); + if (hasMore) { + setTimeout(run, 2); + } + runs++; + }; + runs = 0; + + // start search thread + run(); + } + + /* ----- Events ------ */ + this.ready = function(fn) { + fn.huid = huid; + this.handlers.push(fn); + } + + /* ----- Utilities ------ */ + function splitQuery(query) { + return jQuery.grep(query.split(/(\s+|::?|\(\)?)/), function(string) { + return string.match(/\S/) + }); + } + + function buildRegexps(queries) { + return jQuery.map(queries, function(query) { + return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i') + }); + } + + function buildHilighters(queries) { + return jQuery.map(queries, function(query) { + return jQuery.map(query.split(''), function(l, i) { + return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2); + }).join(''); + }); + } + + // function longMatchRegexp(index, longIndex, regexps) { + // for (var i = regexps.length - 1; i >= 0; i--){ + // if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false; + // }; + // return true; + // } + + + /* ----- Mathchers ------ */ + + /* + * This record matches if the index starts with queries[0] and the record + * matches all of the regexps + */ + function matchPassBeginning(index, longIndex, queries, regexps) { + if (index.indexOf(queries[0]) != 0) return false; + for (var i=1, l = regexps.length; i < l; i++) { + if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) + return false; + }; + return true; + } + + /* + * This record matches if the longIndex starts with queries[0] and the + * longIndex matches all of the regexps + */ + function matchPassLongIndex(index, longIndex, queries, regexps) { + if (longIndex.indexOf(queries[0]) != 0) return false; + for (var i=1, l = regexps.length; i < l; i++) { + if (!longIndex.match(regexps[i])) + return false; + }; + return true; + } + + /* + * This record matches if the index contains queries[0] and the record + * matches all of the regexps + */ + function matchPassContains(index, longIndex, queries, regexps) { + if (index.indexOf(queries[0]) == -1) return false; + for (var i=1, l = regexps.length; i < l; i++) { + if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) + return false; + }; + return true; + } + + /* + * This record matches if regexps[0] matches the index and the record + * matches all of the regexps + */ + function matchPassRegexp(index, longIndex, queries, regexps) { + if (!index.match(regexps[0])) return false; + for (var i=1, l = regexps.length; i < l; i++) { + if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) + return false; + }; + return true; + } + + + /* ----- Highlighters ------ */ + function highlightRegexp(info, queries, regexps, highlighters) { + var result = createResult(info); + for (var i=0, l = regexps.length; i < l; i++) { + result.title = result.title.replace(regexps[i], highlighters[i]); + result.namespace = result.namespace.replace(regexps[i], highlighters[i]); + }; + return result; + } + + function hltSubstring(string, pos, length) { + return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length); + } + + function highlightQuery(info, queries, regexps, highlighters) { + var result = createResult(info); + var pos = 0; + var lcTitle = result.title.toLowerCase(); + + pos = lcTitle.indexOf(queries[0]); + if (pos != -1) { + result.title = hltSubstring(result.title, pos, queries[0].length); + } + + result.namespace = result.namespace.replace(regexps[0], highlighters[0]); + for (var i=1, l = regexps.length; i < l; i++) { + result.title = result.title.replace(regexps[i], highlighters[i]); + result.namespace = result.namespace.replace(regexps[i], highlighters[i]); + }; + return result; + } + + function createResult(info) { + var result = {}; + result.title = info[0]; + result.namespace = info[1]; + result.path = info[2]; + result.params = info[3]; + result.snippet = info[4]; + return result; + } + + /* ----- Searching ------ */ + function performSearch(data, regexps, queries, highlighters, state) { + var searchIndex = data.searchIndex; + var longSearchIndex = data.longSearchIndex; + var info = data.info; + var result = []; + var i = state.from; + var l = searchIndex.length; + var togo = CHUNK_SIZE; + var matchFunc, hltFunc; + + while (state.pass < 4 && state.limit > 0 && togo > 0) { + if (state.pass == 0) { + matchFunc = matchPassBeginning; + hltFunc = highlightQuery; + } else if (state.pass == 1) { + matchFunc = matchPassLongIndex; + hltFunc = highlightQuery; + } else if (state.pass == 2) { + matchFunc = matchPassContains; + hltFunc = highlightQuery; + } else if (state.pass == 3) { + matchFunc = matchPassRegexp; + hltFunc = highlightRegexp; + } + + for (; togo > 0 && i < l && state.limit > 0; i++, togo--) { + if (info[i].n == state.n) continue; + if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) { + info[i].n = state.n; + result.push(hltFunc(info[i], queries, regexps, highlighters)); + state.limit--; + } + }; + if (searchIndex.length <= i) { + state.pass++; + i = state.from = 0; + } else { + state.from = i; + } + } + return result; + } + + function triggerResults(results, isLast) { + jQuery.each(this.handlers, function(i, fn) { + fn.call(this, results, isLast) + }) + } +} + diff --git a/doc/panel/index.html b/doc/panel/index.html new file mode 100755 index 0000000..f815a11 --- /dev/null +++ b/doc/panel/index.html @@ -0,0 +1,73 @@ + + + + + +| + + |