60 |
65 |
66 |
67 |
--------------------------------------------------------------------------------
/config/environments/development.rb:
--------------------------------------------------------------------------------
1 | Rails.application.configure do
2 | # Settings specified here will take precedence over those in config/application.rb.
3 |
4 | # In the development environment your application's code is reloaded on
5 | # every request. This slows down response time but is perfect for development
6 | # since you don't have to restart the web server when you make code changes.
7 | config.cache_classes = false
8 |
9 | # Do not eager load code on boot.
10 | config.eager_load = false
11 |
12 | # Show full error reports and disable caching.
13 | config.consider_all_requests_local = true
14 | config.action_controller.perform_caching = false
15 |
16 | # Don't care if the mailer can't send.
17 | config.action_mailer.raise_delivery_errors = false
18 |
19 | # Print deprecation notices to the Rails logger.
20 | config.active_support.deprecation = :log
21 |
22 | # Raise an error on page load if there are pending migrations.
23 | config.active_record.migration_error = :page_load
24 |
25 | # Debug mode disables concatenation and preprocessing of assets.
26 | # This option may cause significant delays in view rendering with a large
27 | # number of complex assets.
28 | config.assets.debug = true
29 |
30 | # Asset digests allow you to set far-future HTTP expiration dates on all assets,
31 | # yet still be able to expire them through the digest params.
32 | config.assets.digest = true
33 |
34 | # Adds additional error checking when serving assets at runtime.
35 | # Checks for improperly declared sprockets dependencies.
36 | # Raises helpful error messages.
37 | config.assets.raise_runtime_errors = true
38 |
39 | # Raises error for missing translations
40 | # config.action_view.raise_on_missing_translations = true
41 | end
42 |
--------------------------------------------------------------------------------
/public/422.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
61 |
63 | We're sorry, but something went wrong.
62 |If you are the application owner check the logs for more information.
64 |
60 |
66 |
67 |
68 |
--------------------------------------------------------------------------------
/public/404.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
61 |
64 | The change you wanted was rejected.
62 |Maybe you tried to change something you didn't have access to.
63 |If you are the application owner check the logs for more information.
65 |
60 |
66 |
67 |
68 |
--------------------------------------------------------------------------------
/config/environments/test.rb:
--------------------------------------------------------------------------------
1 | Rails.application.configure do
2 | # Settings specified here will take precedence over those in config/application.rb.
3 |
4 | # The test environment is used exclusively to run your application's
5 | # test suite. You never need to work with it otherwise. Remember that
6 | # your test database is "scratch space" for the test suite and is wiped
7 | # and recreated between test runs. Don't rely on the data there!
8 | config.cache_classes = true
9 |
10 | # Do not eager load code on boot. This avoids loading your whole application
11 | # just for the purpose of running a single test. If you are using a tool that
12 | # preloads Rails for running tests, you may have to set it to true.
13 | config.eager_load = false
14 |
15 | # Configure static file server for tests with Cache-Control for performance.
16 | config.serve_static_files = true
17 | config.static_cache_control = 'public, max-age=3600'
18 |
19 | # Show full error reports and disable caching.
20 | config.consider_all_requests_local = true
21 | config.action_controller.perform_caching = false
22 |
23 | # Raise exceptions instead of rendering exception templates.
24 | config.action_dispatch.show_exceptions = false
25 |
26 | # Disable request forgery protection in test environment.
27 | config.action_controller.allow_forgery_protection = false
28 |
29 | # Tell Action Mailer not to deliver emails to the real world.
30 | # The :test delivery method accumulates sent emails in the
31 | # ActionMailer::Base.deliveries array.
32 | config.action_mailer.delivery_method = :test
33 |
34 | # Randomize the order test cases are executed.
35 | config.active_support.test_order = :random
36 |
37 | # Print deprecation notices to the stderr.
38 | config.active_support.deprecation = :stderr
39 |
40 | # Raises error for missing translations
41 | # config.action_view.raise_on_missing_translations = true
42 | end
43 |
--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
1 | source 'https://rubygems.org'
2 |
3 |
4 | # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
5 | gem 'rails', '4.2.0'
6 | # Use sqlite3 as the database for Active Record
7 | gem 'sqlite3'
8 | # Use SCSS for stylesheets
9 | gem 'sass-rails', '~> 5.0'
10 | # Use Uglifier as compressor for JavaScript assets
11 | gem 'uglifier', '>= 1.3.0'
12 | # Use CoffeeScript for .coffee assets and views
13 | gem 'coffee-rails', '~> 4.1.0'
14 | # See https://github.com/sstephenson/execjs#readme for more supported runtimes
15 | # gem 'therubyracer', platforms: :ruby
16 |
17 | # Use jquery as the JavaScript library
18 | gem 'jquery-rails'
19 | # Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
20 | gem 'turbolinks'
21 | # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
22 | gem 'jbuilder', '~> 2.0'
23 | # bundle exec rake doc:rails generates the API under doc/api.
24 | gem 'sdoc', '~> 0.4.0', group: :doc
25 |
26 | # Use ActiveModel has_secure_password
27 | gem 'bcrypt', '~> 3.1.7'
28 |
29 | # Use Unicorn as the app server
30 | # gem 'unicorn'
31 |
32 | # Use Capistrano for deployment
33 | # gem 'capistrano-rails', group: :development
34 |
35 | group :development, :test do
36 | # Call 'byebug' anywhere in the code to stop execution and get a debugger console
37 | gem 'byebug'
38 |
39 | # Access an IRB console on exception pages or by using <%= console %> in views
40 | gem 'web-console', '~> 2.0'
41 |
42 | # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
43 | gem 'spring'
44 |
45 | gem 'rspec-rails'
46 | end
47 |
48 | gem 'pundit'
49 | gem 'kaminari'
50 |
51 | gem 'redis-throttle', git: 'git://github.com/andreareginato/redis-throttle.git'
52 |
53 | gem 'rack-cors'
54 |
55 | gem 'responders'
56 |
57 | gem 'awesome_print'
58 |
59 | gem 'database_cleaner'
60 |
61 |
62 |
--------------------------------------------------------------------------------
/spec/spec_helper.rb:
--------------------------------------------------------------------------------
1 | # This file is copied to spec/ when you run 'rails generate rspec:install'
2 | ENV["RAILS_ENV"] ||= 'test'
3 | require File.expand_path("../../config/environment", __FILE__)
4 | require 'rspec/rails'
5 | require 'rspec/autorun'
6 |
7 | # Requires supporting ruby files with custom matchers and macros, etc,
8 | # in spec/support/ and its subdirectories.
9 | Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
10 |
11 | # Checks for pending migrations before tests are run.
12 | # If you are not using ActiveRecord, you can remove this line.
13 | ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)
14 |
15 | RSpec.configure do |config|
16 | # ## Mock Framework
17 | #
18 | # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
19 | #
20 | # config.mock_with :mocha
21 | # config.mock_with :flexmock
22 | # config.mock_with :rr
23 |
24 | # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
25 | config.fixture_path = "#{::Rails.root}/spec/fixtures"
26 |
27 | # If you're not using ActiveRecord, or you'd prefer not to run each of your
28 | # examples within a transaction, remove the following line or assign false
29 | # instead of true.
30 | config.use_transactional_fixtures = true
31 |
32 | # If true, the base class of anonymous controllers will be inferred
33 | # automatically. This will be the default behavior in future versions of
34 | # rspec-rails.
35 | config.infer_base_class_for_anonymous_controllers = false
36 |
37 | # Run specs in random order to surface order dependencies. If you find an
38 | # order dependency and want to debug it, you can fix the order by providing
39 | # the seed, which is printed after each run.
40 | # --seed 1234
41 | config.order = "random"
42 |
43 | config.before(:suite) do
44 | DatabaseCleaner.strategy = :transaction
45 | DatabaseCleaner.clean_with(:truncation)
46 | end
47 |
48 | config.around(:each) do |example|
49 | DatabaseCleaner.cleaning do
50 | example.run
51 | end
52 | end
53 |
54 | end
55 |
--------------------------------------------------------------------------------
/app/docs/slate/source/javascripts/app/search.js:
--------------------------------------------------------------------------------
1 | (function (global) {
2 | 'use strict';
3 |
4 | var $global = $(global);
5 | var content, darkBox, searchResults;
6 | var highlightOpts = { element: 'span', className: 'search-highlight' };
7 |
8 | var index = new lunr.Index();
9 |
10 | index.ref('id');
11 | index.field('title', { boost: 10 });
12 | index.field('body');
13 | index.pipeline.add(lunr.trimmer, lunr.stopWordFilter);
14 |
15 | $(populate);
16 | $(bind);
17 |
18 | function populate() {
19 | $('h1, h2').each(function() {
20 | var title = $(this);
21 | var body = title.nextUntil('h1, h2');
22 | index.add({
23 | id: title.prop('id'),
24 | title: title.text(),
25 | body: body.text()
26 | });
27 | });
28 | }
29 |
30 | function bind() {
31 | content = $('.content');
32 | darkBox = $('.dark-box');
33 | searchResults = $('.search-results');
34 |
35 | $('#input-search').on('keyup', search);
36 | }
37 |
38 | function search(event) {
39 | unhighlight();
40 | searchResults.addClass('visible');
41 |
42 | // ESC clears the field
43 | if (event.keyCode === 27) this.value = '';
44 |
45 | if (this.value) {
46 | var results = index.search(this.value).filter(function(r) {
47 | return r.score > 0.0001;
48 | });
49 |
50 | if (results.length) {
51 | searchResults.empty();
52 | $.each(results, function (index, result) {
53 | var elem = document.getElementById(result.ref);
54 | searchResults.append("
61 |
64 | The page you were looking for doesn't exist.
62 |You may have mistyped the address or the page may have moved.
63 |If you are the application owner check the logs for more information.
65 |
51 | <%= image_tag "logo.png" %>
52 | <% if language_tabs %>
53 |
79 |
54 | <% language_tabs.each do |lang| %>
55 | <% if lang.is_a? Hash %>
56 | <%= lang.values.first %>
57 | <% else %>
58 | <%= lang %>
59 | <% end %>
60 | <% end %>
61 |
62 | <% end %>
63 | <% if current_page.data.search %>
64 |
65 |
66 |
67 |
70 |
71 | <% if current_page.data.toc_footers %>
72 |
77 | <% end %>
78 |
80 |
81 |
101 |
102 |
103 |
--------------------------------------------------------------------------------
/app/docs/slate/source/stylesheets/_variables.scss:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright 2008-2013 Concur Technologies, Inc.
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License"); you may
5 | not use this file except in compliance with the License. You may obtain
6 | a copy of the License at
7 |
8 | http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 | License for the specific language governing permissions and limitations
14 | under the License.
15 | */
16 |
17 |
18 | ////////////////////////////////////////////////////////////////////////////////
19 | // CUSTOMIZE SLATE
20 | ////////////////////////////////////////////////////////////////////////////////
21 | // Use these settings to help adjust the appearance of Slate
22 |
23 |
24 | // BACKGROUND COLORS
25 | ////////////////////
26 | $nav-bg: #393939;
27 | $examples-bg: #393939;
28 | $code-bg: #292929;
29 | $code-annotation-bg: #1c1c1c;
30 | $nav-subitem-bg: #262626;
31 | $nav-active-bg: #2467af;
32 | $lang-select-border: #000;
33 | $lang-select-bg: #222;
34 | $lang-select-active-bg: $examples-bg; // feel free to change this to blue or something
35 | $lang-select-pressed-bg: #111; // color of language tab bg when mouse is pressed
36 | $main-bg: #eaf2f6;
37 | $aside-notice-bg: #8fbcd4;
38 | $aside-warning-bg: #c97a7e;
39 | $aside-success-bg: #6ac174;
40 | $search-notice-bg: #c97a7e;
41 |
42 |
43 | // TEXT COLORS
44 | ////////////////////
45 | $main-text: #333; // main content text color
46 | $nav-text: #fff;
47 | $nav-active-text: #fff;
48 | $lang-select-text: #fff; // color of unselected language tab text
49 | $lang-select-active-text: #fff; // color of selected language tab text
50 | $lang-select-pressed-text: #fff; // color of language tab text when mouse is pressed
51 |
52 |
53 | // SIZES
54 | ////////////////////
55 | $nav-width: 230px; // width of the navbar
56 | $examples-width: 50%; // portion of the screen taken up by code examples
57 | $logo-margin: 20px; // margin between nav items and logo, ignored if search is active
58 | $main-padding: 28px; // padding to left and right of content & examples
59 | $nav-padding: 15px; // padding to left and right of navbar
60 | $nav-v-padding: 10px; // padding used vertically around search boxes and results
61 | $nav-indent: 10px; // extra padding for ToC subitems
62 | $code-annotation-padding: 13px; // padding inside code annotations
63 | $h1-margin-bottom: 21px; // padding under the largest header tags
64 | $tablet-width: 930px; // min width before reverting to tablet size
65 | $phone-width: $tablet-width - $nav-width; // min width before reverting to mobile size
66 |
67 |
68 | // FONTS
69 | ////////////////////
70 | %default-font {
71 | font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
72 | font-size: 13px;
73 | }
74 |
75 | %header-font {
76 | @extend %default-font;
77 | font-weight: bold;
78 | }
79 |
80 | %code-font {
81 | font-family: Consolas, Menlo, Monaco, "Lucida Console", "Liberation Mono", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Courier New", monospace, serif;
82 | font-size: 12px;
83 | line-height: 1.5;
84 | }
85 |
86 |
87 | // OTHER
88 | ////////////////////
89 | $nav-active-shadow: #000;
90 | $nav-footer-border-color: #666;
91 | $nav-embossed-border-top: #000;
92 | $nav-embossed-border-bottom: #939393;
93 | $main-embossed-text-shadow: 0px 1px 0px #fff;
94 | $search-box-border-color: #666;
95 |
96 |
97 | ////////////////////////////////////////////////////////////////////////////////
98 | // INTERNAL
99 | ////////////////////////////////////////////////////////////////////////////////
100 | // These settings are probably best left alone.
101 |
102 | %break-words {
103 | -ms-word-break: break-all;
104 | word-break: break-all;
105 |
106 | /* Non standard for webkit */
107 | word-break: break-word;
108 |
109 | -webkit-hyphens: auto;
110 | -moz-hyphens: auto;
111 | hyphens: auto;
112 | }
113 |
--------------------------------------------------------------------------------
/app/docs/slate/source/javascripts/lib/jquery.highlight.js:
--------------------------------------------------------------------------------
1 | /*
2 | * jQuery Highlight plugin
3 | *
4 | * Based on highlight v3 by Johann Burkard
5 | * http://johannburkard.de/blog/programming/javascript/highlight-javascript-text-higlighting-jquery-plugin.html
6 | *
7 | * Code a little bit refactored and cleaned (in my humble opinion).
8 | * Most important changes:
9 | * - has an option to highlight only entire words (wordsOnly - false by default),
10 | * - has an option to be case sensitive (caseSensitive - false by default)
11 | * - highlight element tag and class names can be specified in options
12 | *
13 | * Usage:
14 | * // wrap every occurrance of text 'lorem' in content
15 | * // with (default options)
16 | * $('#content').highlight('lorem');
17 | *
18 | * // search for and highlight more terms at once
19 | * // so you can save some time on traversing DOM
20 | * $('#content').highlight(['lorem', 'ipsum']);
21 | * $('#content').highlight('lorem ipsum');
22 | *
23 | * // search only for entire word 'lorem'
24 | * $('#content').highlight('lorem', { wordsOnly: true });
25 | *
26 | * // don't ignore case during search of term 'lorem'
27 | * $('#content').highlight('lorem', { caseSensitive: true });
28 | *
29 | * // wrap every occurrance of term 'ipsum' in content
30 | * // with
31 | * $('#content').highlight('ipsum', { element: 'em', className: 'important' });
32 | *
33 | * // remove default highlight
34 | * $('#content').unhighlight();
35 | *
36 | * // remove custom highlight
37 | * $('#content').unhighlight({ element: 'em', className: 'important' });
38 | *
39 | *
40 | * Copyright (c) 2009 Bartek Szopka
41 | *
42 | * Licensed under MIT license.
43 | *
44 | */
45 |
46 | jQuery.extend({
47 | highlight: function (node, re, nodeName, className) {
48 | if (node.nodeType === 3) {
49 | var match = node.data.match(re);
50 | if (match) {
51 | var highlight = document.createElement(nodeName || 'span');
52 | highlight.className = className || 'highlight';
53 | var wordNode = node.splitText(match.index);
54 | wordNode.splitText(match[0].length);
55 | var wordClone = wordNode.cloneNode(true);
56 | highlight.appendChild(wordClone);
57 | wordNode.parentNode.replaceChild(highlight, wordNode);
58 | return 1; //skip added node in parent
59 | }
60 | } else if ((node.nodeType === 1 && node.childNodes) && // only element nodes that have children
61 | !/(script|style)/i.test(node.tagName) && // ignore script and style nodes
62 | !(node.tagName === nodeName.toUpperCase() && node.className === className)) { // skip if already highlighted
63 | for (var i = 0; i < node.childNodes.length; i++) {
64 | i += jQuery.highlight(node.childNodes[i], re, nodeName, className);
65 | }
66 | }
67 | return 0;
68 | }
69 | });
70 |
71 | jQuery.fn.unhighlight = function (options) {
72 | var settings = { className: 'highlight', element: 'span' };
73 | jQuery.extend(settings, options);
74 |
75 | return this.find(settings.element + "." + settings.className).each(function () {
76 | var parent = this.parentNode;
77 | parent.replaceChild(this.firstChild, this);
78 | parent.normalize();
79 | }).end();
80 | };
81 |
82 | jQuery.fn.highlight = function (words, options) {
83 | var settings = { className: 'highlight', element: 'span', caseSensitive: false, wordsOnly: false };
84 | jQuery.extend(settings, options);
85 |
86 | if (words.constructor === String) {
87 | words = [words];
88 | }
89 | words = jQuery.grep(words, function(word, i){
90 | return word != '';
91 | });
92 | words = jQuery.map(words, function(word, i) {
93 | return word.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
94 | });
95 | if (words.length == 0) { return this; };
96 |
97 | var flag = settings.caseSensitive ? "" : "i";
98 | var pattern = "(" + words.join("|") + ")";
99 | if (settings.wordsOnly) {
100 | pattern = "\\b" + pattern + "\\b";
101 | }
102 | var re = new RegExp(pattern, flag);
103 |
104 | return this.each(function () {
105 | jQuery.highlight(this, re, settings.element, settings.className);
106 | });
107 | };
108 |
109 |
--------------------------------------------------------------------------------
/app/docs/slate/source/fonts/icomoon.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
--------------------------------------------------------------------------------
/app/views/docs/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
82 | <%= yield %>
83 | <% current_page.data.includes && current_page.data.includes.each do |include| %>
84 | <%= partial "includes/#{include}" %>
85 | <% end %>
86 |
87 |
88 | <% if language_tabs %>
89 |
100 |
90 | <% language_tabs.each do |lang| %>
91 | <% if lang.is_a? Hash %>
92 | <%= lang.values.first %>
93 | <% else %>
94 | <%= lang %>
95 | <% end %>
96 | <% end %>
97 |
98 | <% end %>
99 | 
26 |
27 |
28 |
43 | 
30 |
44 |
45 |
155 |
156 |
157 |
--------------------------------------------------------------------------------
/Gemfile.lock:
--------------------------------------------------------------------------------
1 | GIT
2 | remote: git://github.com/andreareginato/redis-throttle.git
3 | revision: 98cf0bf5f2c3955408f2b5667c7b6ddcd459b6d4
4 | specs:
5 | redis-throttle (0.0.1)
6 | activesupport
7 | hiredis
8 | rack
9 | rack-throttle
10 | redis
11 | redis-namespace
12 |
13 | GEM
14 | remote: https://rubygems.org/
15 | specs:
16 | actionmailer (4.2.0)
17 | actionpack (= 4.2.0)
18 | actionview (= 4.2.0)
19 | activejob (= 4.2.0)
20 | mail (~> 2.5, >= 2.5.4)
21 | rails-dom-testing (~> 1.0, >= 1.0.5)
22 | actionpack (4.2.0)
23 | actionview (= 4.2.0)
24 | activesupport (= 4.2.0)
25 | rack (~> 1.6.0)
26 | rack-test (~> 0.6.2)
27 | rails-dom-testing (~> 1.0, >= 1.0.5)
28 | rails-html-sanitizer (~> 1.0, >= 1.0.1)
29 | actionview (4.2.0)
30 | activesupport (= 4.2.0)
31 | builder (~> 3.1)
32 | erubis (~> 2.7.0)
33 | rails-dom-testing (~> 1.0, >= 1.0.5)
34 | rails-html-sanitizer (~> 1.0, >= 1.0.1)
35 | activejob (4.2.0)
36 | activesupport (= 4.2.0)
37 | globalid (>= 0.3.0)
38 | activemodel (4.2.0)
39 | activesupport (= 4.2.0)
40 | builder (~> 3.1)
41 | activerecord (4.2.0)
42 | activemodel (= 4.2.0)
43 | activesupport (= 4.2.0)
44 | arel (~> 6.0)
45 | activesupport (4.2.0)
46 | i18n (~> 0.7)
47 | json (~> 1.7, >= 1.7.7)
48 | minitest (~> 5.1)
49 | thread_safe (~> 0.3, >= 0.3.4)
50 | tzinfo (~> 1.1)
51 | arel (6.0.0)
52 | awesome_print (1.2.0)
53 | bcrypt (3.1.10)
54 | binding_of_caller (0.7.2)
55 | debug_inspector (>= 0.0.1)
56 | builder (3.2.2)
57 | byebug (4.0.5)
58 | columnize (= 0.9.0)
59 | coffee-rails (4.1.0)
60 | coffee-script (>= 2.2.0)
61 | railties (>= 4.0.0, < 5.0)
62 | coffee-script (2.4.1)
63 | coffee-script-source
64 | execjs
65 | coffee-script-source (1.9.1.1)
66 | columnize (0.9.0)
67 | database_cleaner (1.3.0)
68 | debug_inspector (0.0.2)
69 | diff-lcs (1.2.5)
70 | erubis (2.7.0)
71 | execjs (2.5.2)
72 | globalid (0.3.5)
73 | activesupport (>= 4.1.0)
74 | hiredis (0.6.0)
75 | i18n (0.7.0)
76 | jbuilder (2.2.13)
77 | activesupport (>= 3.0.0, < 5)
78 | multi_json (~> 1.2)
79 | jquery-rails (4.0.3)
80 | rails-dom-testing (~> 1.0)
81 | railties (>= 4.2.0)
82 | thor (>= 0.14, < 2.0)
83 | json (1.8.2)
84 | kaminari (0.16.3)
85 | actionpack (>= 3.0.0)
86 | activesupport (>= 3.0.0)
87 | loofah (2.0.1)
88 | nokogiri (>= 1.5.9)
89 | mail (2.6.3)
90 | mime-types (>= 1.16, < 3)
91 | mime-types (2.5)
92 | mini_portile (0.6.2)
93 | minitest (5.6.0)
94 | multi_json (1.11.0)
95 | nokogiri (1.6.6.2)
96 | mini_portile (~> 0.6.0)
97 | pundit (1.0.0)
98 | activesupport (>= 3.0.0)
99 | rack (1.6.0)
100 | rack-cors (0.4.0)
101 | rack-test (0.6.3)
102 | rack (>= 1.0)
103 | rack-throttle (0.4.0)
104 | rack (>= 1.0.0)
105 | rails (4.2.0)
106 | actionmailer (= 4.2.0)
107 | actionpack (= 4.2.0)
108 | actionview (= 4.2.0)
109 | activejob (= 4.2.0)
110 | activemodel (= 4.2.0)
111 | activerecord (= 4.2.0)
112 | activesupport (= 4.2.0)
113 | bundler (>= 1.3.0, < 2.0)
114 | railties (= 4.2.0)
115 | sprockets-rails
116 | rails-deprecated_sanitizer (1.0.3)
117 | activesupport (>= 4.2.0.alpha)
118 | rails-dom-testing (1.0.6)
119 | activesupport (>= 4.2.0.beta, < 5.0)
120 | nokogiri (~> 1.6.0)
121 | rails-deprecated_sanitizer (>= 1.0.1)
122 | rails-html-sanitizer (1.0.2)
123 | loofah (~> 2.0)
124 | railties (4.2.0)
125 | actionpack (= 4.2.0)
126 | activesupport (= 4.2.0)
127 | rake (>= 0.8.7)
128 | thor (>= 0.18.1, < 2.0)
129 | rake (10.4.2)
130 | rdoc (4.2.0)
131 | json (~> 1.4)
132 | redis (3.2.1)
133 | redis-namespace (1.5.2)
134 | redis (~> 3.0, >= 3.0.4)
135 | responders (2.1.0)
136 | railties (>= 4.2.0, < 5)
137 | rspec-core (2.14.7)
138 | rspec-expectations (2.14.5)
139 | diff-lcs (>= 1.1.3, < 2.0)
140 | rspec-mocks (2.14.5)
141 | rspec-rails (2.14.1)
142 | actionpack (>= 3.0)
143 | activemodel (>= 3.0)
144 | activesupport (>= 3.0)
145 | railties (>= 3.0)
146 | rspec-core (~> 2.14.0)
147 | rspec-expectations (~> 2.14.0)
148 | rspec-mocks (~> 2.14.0)
149 | sass (3.4.13)
150 | sass-rails (5.0.3)
151 | railties (>= 4.0.0, < 5.0)
152 | sass (~> 3.1)
153 | sprockets (>= 2.8, < 4.0)
154 | sprockets-rails (>= 2.0, < 4.0)
155 | tilt (~> 1.1)
156 | sdoc (0.4.1)
157 | json (~> 1.7, >= 1.7.7)
158 | rdoc (~> 4.0)
159 | spring (1.3.4)
160 | sprockets (3.0.2)
161 | rack (~> 1.0)
162 | sprockets-rails (2.2.4)
163 | actionpack (>= 3.0)
164 | activesupport (>= 3.0)
165 | sprockets (>= 2.8, < 4.0)
166 | sqlite3 (1.3.10)
167 | thor (0.19.1)
168 | thread_safe (0.3.5)
169 | tilt (1.4.1)
170 | turbolinks (2.5.3)
171 | coffee-rails
172 | tzinfo (1.2.2)
173 | thread_safe (~> 0.1)
174 | uglifier (2.7.1)
175 | execjs (>= 0.3.0)
176 | json (>= 1.8.0)
177 | web-console (2.1.2)
178 | activemodel (>= 4.0)
179 | binding_of_caller (>= 0.7.2)
180 | railties (>= 4.0)
181 | sprockets-rails (>= 2.0, < 4.0)
182 |
183 | PLATFORMS
184 | ruby
185 |
186 | DEPENDENCIES
187 | awesome_print
188 | bcrypt (~> 3.1.7)
189 | byebug
190 | coffee-rails (~> 4.1.0)
191 | database_cleaner
192 | jbuilder (~> 2.0)
193 | jquery-rails
194 | kaminari
195 | pundit
196 | rack-cors
197 | rails (= 4.2.0)
198 | redis-throttle!
199 | responders
200 | rspec-rails
201 | sass-rails (~> 5.0)
202 | sdoc (~> 0.4.0)
203 | spring
204 | sqlite3
205 | turbolinks
206 | uglifier (>= 1.3.0)
207 | web-console (~> 2.0)
208 |
--------------------------------------------------------------------------------
/app/docs/slate/source/javascripts/lib/energize.js:
--------------------------------------------------------------------------------
1 | /**
2 | * energize.js v0.1.0
3 | *
4 | * Speeds up click events on mobile devices.
5 | * https://github.com/davidcalhoun/energize.js
6 | */
7 |
8 | (function() { // Sandbox
9 | /**
10 | * Don't add to non-touch devices, which don't need to be sped up
11 | */
12 | if(!('ontouchstart' in window)) return;
13 |
14 | var lastClick = {},
15 | isThresholdReached, touchstart, touchmove, touchend,
16 | click, closest;
17 |
18 | /**
19 | * isThresholdReached
20 | *
21 | * Compare touchstart with touchend xy coordinates,
22 | * and only fire simulated click event if the coordinates
23 | * are nearby. (don't want clicking to be confused with a swipe)
24 | */
25 | isThresholdReached = function(startXY, xy) {
26 | return Math.abs(startXY[0] - xy[0]) > 5 || Math.abs(startXY[1] - xy[1]) > 5;
27 | };
28 |
29 | /**
30 | * touchstart
31 | *
32 | * Save xy coordinates when the user starts touching the screen
33 | */
34 | touchstart = function(e) {
35 | this.startXY = [e.touches[0].clientX, e.touches[0].clientY];
36 | this.threshold = false;
37 | };
38 |
39 | /**
40 | * touchmove
41 | *
42 | * Check if the user is scrolling past the threshold.
43 | * Have to check here because touchend will not always fire
44 | * on some tested devices (Kindle Fire?)
45 | */
46 | touchmove = function(e) {
47 | // NOOP if the threshold has already been reached
48 | if(this.threshold) return false;
49 |
50 | this.threshold = isThresholdReached(this.startXY, [e.touches[0].clientX, e.touches[0].clientY]);
51 | };
52 |
53 | /**
54 | * touchend
55 | *
56 | * If the user didn't scroll past the threshold between
57 | * touchstart and touchend, fire a simulated click.
58 | *
59 | * (This will fire before a native click)
60 | */
61 | touchend = function(e) {
62 | // Don't fire a click if the user scrolled past the threshold
63 | if(this.threshold || isThresholdReached(this.startXY, [e.changedTouches[0].clientX, e.changedTouches[0].clientY])) {
64 | return;
65 | }
66 |
67 | /**
68 | * Create and fire a click event on the target element
69 | * https://developer.mozilla.org/en/DOM/event.initMouseEvent
70 | */
71 | var touch = e.changedTouches[0],
72 | evt = document.createEvent('MouseEvents');
73 | evt.initMouseEvent('click', true, true, window, 0, touch.screenX, touch.screenY, touch.clientX, touch.clientY, false, false, false, false, 0, null);
74 | evt.simulated = true; // distinguish from a normal (nonsimulated) click
75 | e.target.dispatchEvent(evt);
76 | };
77 |
78 | /**
79 | * click
80 | *
81 | * Because we've already fired a click event in touchend,
82 | * we need to listed for all native click events here
83 | * and suppress them as necessary.
84 | */
85 | click = function(e) {
86 | /**
87 | * Prevent ghost clicks by only allowing clicks we created
88 | * in the click event we fired (look for e.simulated)
89 | */
90 | var time = Date.now(),
91 | timeDiff = time - lastClick.time,
92 | x = e.clientX,
93 | y = e.clientY,
94 | xyDiff = [Math.abs(lastClick.x - x), Math.abs(lastClick.y - y)],
95 | target = closest(e.target, 'A') || e.target, // needed for standalone apps
96 | nodeName = target.nodeName,
97 | isLink = nodeName === 'A',
98 | standAlone = window.navigator.standalone && isLink && e.target.getAttribute("href");
99 |
100 | lastClick.time = time;
101 | lastClick.x = x;
102 | lastClick.y = y;
103 |
104 | /**
105 | * Unfortunately Android sometimes fires click events without touch events (seen on Kindle Fire),
106 | * so we have to add more logic to determine the time of the last click. Not perfect...
107 | *
108 | * Older, simpler check: if((!e.simulated) || standAlone)
109 | */
110 | if((!e.simulated && (timeDiff < 500 || (timeDiff < 1500 && xyDiff[0] < 50 && xyDiff[1] < 50))) || standAlone) {
111 | e.preventDefault();
112 | e.stopPropagation();
113 | if(!standAlone) return false;
114 | }
115 |
116 | /**
117 | * Special logic for standalone web apps
118 | * See http://stackoverflow.com/questions/2898740/iphone-safari-web-app-opens-links-in-new-window
119 | */
120 | if(standAlone) {
121 | window.location = target.getAttribute("href");
122 | }
123 |
124 | /**
125 | * Add an energize-focus class to the targeted link (mimics :focus behavior)
126 | * TODO: test and/or remove? Does this work?
127 | */
128 | if(!target || !target.classList) return;
129 | target.classList.add("energize-focus");
130 | window.setTimeout(function(){
131 | target.classList.remove("energize-focus");
132 | }, 150);
133 | };
134 |
135 | /**
136 | * closest
137 | * @param {HTMLElement} node current node to start searching from.
138 | * @param {string} tagName the (uppercase) name of the tag you're looking for.
139 | *
140 | * Find the closest ancestor tag of a given node.
141 | *
142 | * Starts at node and goes up the DOM tree looking for a
143 | * matching nodeName, continuing until hitting document.body
144 | */
145 | closest = function(node, tagName){
146 | var curNode = node;
147 |
148 | while(curNode !== document.body) { // go up the dom until we find the tag we're after
149 | if(!curNode || curNode.nodeName === tagName) { return curNode; } // found
150 | curNode = curNode.parentNode; // not found, so keep going up
151 | }
152 |
153 | return null; // not found
154 | };
155 |
156 | /**
157 | * Add all delegated event listeners
158 | *
159 | * All the events we care about bubble up to document,
160 | * so we can take advantage of event delegation.
161 | *
162 | * Note: no need to wait for DOMContentLoaded here
163 | */
164 | document.addEventListener('touchstart', touchstart, false);
165 | document.addEventListener('touchmove', touchmove, false);
166 | document.addEventListener('touchend', touchend, false);
167 | document.addEventListener('click', click, true); // TODO: why does this use capture?
168 |
169 | })();
--------------------------------------------------------------------------------
/app/docs/slate/README.md:
--------------------------------------------------------------------------------
1 | Slate
2 | ========
3 |
4 | [](https://travis-ci.org/tripit/slate) [](https://gemnasium.com/tripit/slate)
5 |
6 | Slate helps you create beautiful API documentation. Think of it as an intelligent, responsive documentation template for your API.
7 |
8 |
46 |
61 |
73 |
74 |
97 |
147 |
148 |
149 | 介绍
47 | 48 |API 文档
49 | 50 |获取用户信息
51 | 52 |V1
53 | 54 |HTTP 请求
55 | 56 |GET http://my-site/api/v1/users/<id>
请求参数
59 | 60 || 参数名 | 63 |是否必需 | 64 |描述 | 65 |
|---|---|---|
| id | 69 |是 | 70 |用户 id | 71 |
响应
75 |
76 | {
77 | "user":
78 | {
79 | "id":1,
80 | "email":"test-user-00@mail.com",
81 | "name":"test-user-00",
82 | "activated":"2015-05-02T07:47:14.697Z",
83 | "admin":false,
84 | "created_at":"2015-05-02T07:47:14.708Z",
85 | "updated_at":"2015-05-02T07:47:14.708Z"
86 | }
87 | }
88 | Errors
91 | 92 | 93 | 94 |The Kittn API uses the following error codes:
95 | 96 || Error Code | 99 |Meaning | 100 |
|---|---|
| 400 | 104 |Bad Request – Your request sucks | 105 |
| 401 | 108 |Unauthorized – Your API key is wrong | 109 |
| 403 | 112 |Forbidden – The kitten requested is hidden for administrators only | 113 |
| 404 | 116 |Not Found – The specified kitten could not be found | 117 |
| 405 | 120 |Method Not Allowed – You tried to access a kitten with an invalid method | 121 |
| 406 | 124 |Not Acceptable – You requested a format that isn’t json | 125 |
| 410 | 128 |Gone – The kitten requested has been removed from our servers | 129 |
| 418 | 132 |I’m a teapot | 133 |
| 429 | 136 |Too Many Requests – You’re requesting too many kittens! Slow down! | 137 |
| 500 | 140 |Internal Server Error – We had a problem with our server. Try again later. | 141 |
| 503 | 144 |Service Unavailable – We’re temporarially offline for maintanance. Please try again later. | 145 |
150 |
154 |
151 | ruby
152 |
153 | 
9 |
10 | *The example above was created with Slate. Check it out at [tripit.github.io/slate](http://tripit.github.io/slate).*
11 |
12 | Features
13 | ------------
14 |
15 | * **Clean, intuitive design** — with Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by [Stripe's](https://stripe.com/docs/api) and [Paypal's](https://developer.paypal.com/webapps/developer/docs/api/) API docs. Slate is responsive, so it looks great on tablets, phones, and even print.
16 |
17 | * **Everything on a single page** — gone are the days where your users had to search through a million pages to find what they wanted. Slate puts the entire documentation on a single page. We haven't sacrificed linkability, though. As you scroll, your browser's hash will update to the nearest header, so linking to a particular point in the documentation is still natural and easy.
18 |
19 | * **Slate is just Markdown** — when you write docs with Slate, you're just writing Markdown, which makes it simple to edit and understand. Everything is written in Markdown — even the code samples are just Markdown code blocks!
20 |
21 | * **Write code samples in multiple languages** — if your API has bindings in multiple programming languages, you easily put in tabs to switch between them. In your document, you'll distinguish different languages by specifying the language name at the top of each code block, just like with Github Flavored Markdown!
22 |
23 | * **Out-of-the-box syntax highlighting** for [almost 60 languages](http://rouge.jayferd.us/demo), no configuration required.
24 |
25 | * **Automatic, smoothly scrolling table of contents** on the far left of the page. As you scroll, it displays your current position in the document. It's fast, too. We're using Slate at TripIt to build documentation for our new API, where our table of contents has over 180 entries. We've made sure that the performance remains excellent, even for larger documents.
26 |
27 | * **Let your users update your documentation for you** — by default, your Slate-generated documentation is hosted in a public Github repository. Not only does this mean you get free hosting for your docs with Github Pages, but it also makes it's simple for other developers to make pull requests to your docs if they find typos or other problems. Of course, if you don't want to, you're welcome to not use Github and host your docs elsewhere!
28 |
29 | Getting starting with Slate is super easy! Simply fork this repository, and then follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](http://tripit.github.io/slate).
30 |
31 |
32 |
33 | Getting Started with Slate
34 | ------------------------------
35 |
36 | ### Prerequisites
37 |
38 | You're going to need:
39 |
40 | - **Linux or OS X** — Windows may work, but is unsupported.
41 | - **Ruby, version 1.9.3 or newer**
42 | - **Bundler** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal.
43 |
44 | ### Getting Set Up
45 |
46 | 1. Fork this repository on Github.
47 | 2. Clone *your forked repository* (not our original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/slate.git`
48 | 3. `cd slate`
49 | 4. Install all dependencies: `bundle install`
50 | 5. Start the test server: `bundle exec middleman server`
51 |
52 | Or use the included Dockerfile! (must install Docker first)
53 |
54 | ```shell
55 | docker build -t slate .
56 | docker run -d -p 4567:4567 slate
57 | ```
58 |
59 | You can now see the docs at ",
253 | options: {
254 | disabled: false,
255 |
256 | // callbacks
257 | create: null
258 | },
259 | _createWidget: function( options, element ) {
260 | element = $( element || this.defaultElement || this )[ 0 ];
261 | this.element = $( element );
262 | this.uuid = widget_uuid++;
263 | this.eventNamespace = "." + this.widgetName + this.uuid;
264 |
265 | this.bindings = $();
266 | this.hoverable = $();
267 | this.focusable = $();
268 |
269 | if ( element !== this ) {
270 | $.data( element, this.widgetFullName, this );
271 | this._on( true, this.element, {
272 | remove: function( event ) {
273 | if ( event.target === element ) {
274 | this.destroy();
275 | }
276 | }
277 | });
278 | this.document = $( element.style ?
279 | // element within the document
280 | element.ownerDocument :
281 | // element is window or document
282 | element.document || element );
283 | this.window = $( this.document[0].defaultView || this.document[0].parentWindow );
284 | }
285 |
286 | this.options = $.widget.extend( {},
287 | this.options,
288 | this._getCreateOptions(),
289 | options );
290 |
291 | this._create();
292 | this._trigger( "create", null, this._getCreateEventData() );
293 | this._init();
294 | },
295 | _getCreateOptions: $.noop,
296 | _getCreateEventData: $.noop,
297 | _create: $.noop,
298 | _init: $.noop,
299 |
300 | destroy: function() {
301 | this._destroy();
302 | // we can probably remove the unbind calls in 2.0
303 | // all event bindings should go through this._on()
304 | this.element
305 | .unbind( this.eventNamespace )
306 | .removeData( this.widgetFullName )
307 | // support: jquery <1.6.3
308 | // http://bugs.jquery.com/ticket/9413
309 | .removeData( $.camelCase( this.widgetFullName ) );
310 | this.widget()
311 | .unbind( this.eventNamespace )
312 | .removeAttr( "aria-disabled" )
313 | .removeClass(
314 | this.widgetFullName + "-disabled " +
315 | "ui-state-disabled" );
316 |
317 | // clean up events and states
318 | this.bindings.unbind( this.eventNamespace );
319 | this.hoverable.removeClass( "ui-state-hover" );
320 | this.focusable.removeClass( "ui-state-focus" );
321 | },
322 | _destroy: $.noop,
323 |
324 | widget: function() {
325 | return this.element;
326 | },
327 |
328 | option: function( key, value ) {
329 | var options = key,
330 | parts,
331 | curOption,
332 | i;
333 |
334 | if ( arguments.length === 0 ) {
335 | // don't return a reference to the internal hash
336 | return $.widget.extend( {}, this.options );
337 | }
338 |
339 | if ( typeof key === "string" ) {
340 | // handle nested keys, e.g., "foo.bar" => { foo: { bar: ___ } }
341 | options = {};
342 | parts = key.split( "." );
343 | key = parts.shift();
344 | if ( parts.length ) {
345 | curOption = options[ key ] = $.widget.extend( {}, this.options[ key ] );
346 | for ( i = 0; i < parts.length - 1; i++ ) {
347 | curOption[ parts[ i ] ] = curOption[ parts[ i ] ] || {};
348 | curOption = curOption[ parts[ i ] ];
349 | }
350 | key = parts.pop();
351 | if ( arguments.length === 1 ) {
352 | return curOption[ key ] === undefined ? null : curOption[ key ];
353 | }
354 | curOption[ key ] = value;
355 | } else {
356 | if ( arguments.length === 1 ) {
357 | return this.options[ key ] === undefined ? null : this.options[ key ];
358 | }
359 | options[ key ] = value;
360 | }
361 | }
362 |
363 | this._setOptions( options );
364 |
365 | return this;
366 | },
367 | _setOptions: function( options ) {
368 | var key;
369 |
370 | for ( key in options ) {
371 | this._setOption( key, options[ key ] );
372 | }
373 |
374 | return this;
375 | },
376 | _setOption: function( key, value ) {
377 | this.options[ key ] = value;
378 |
379 | if ( key === "disabled" ) {
380 | this.widget()
381 | .toggleClass( this.widgetFullName + "-disabled", !!value );
382 |
383 | // If the widget is becoming disabled, then nothing is interactive
384 | if ( value ) {
385 | this.hoverable.removeClass( "ui-state-hover" );
386 | this.focusable.removeClass( "ui-state-focus" );
387 | }
388 | }
389 |
390 | return this;
391 | },
392 |
393 | enable: function() {
394 | return this._setOptions({ disabled: false });
395 | },
396 | disable: function() {
397 | return this._setOptions({ disabled: true });
398 | },
399 |
400 | _on: function( suppressDisabledCheck, element, handlers ) {
401 | var delegateElement,
402 | instance = this;
403 |
404 | // no suppressDisabledCheck flag, shuffle arguments
405 | if ( typeof suppressDisabledCheck !== "boolean" ) {
406 | handlers = element;
407 | element = suppressDisabledCheck;
408 | suppressDisabledCheck = false;
409 | }
410 |
411 | // no element argument, shuffle and use this.element
412 | if ( !handlers ) {
413 | handlers = element;
414 | element = this.element;
415 | delegateElement = this.widget();
416 | } else {
417 | element = delegateElement = $( element );
418 | this.bindings = this.bindings.add( element );
419 | }
420 |
421 | $.each( handlers, function( event, handler ) {
422 | function handlerProxy() {
423 | // allow widgets to customize the disabled handling
424 | // - disabled as an array instead of boolean
425 | // - disabled class as method for disabling individual parts
426 | if ( !suppressDisabledCheck &&
427 | ( instance.options.disabled === true ||
428 | $( this ).hasClass( "ui-state-disabled" ) ) ) {
429 | return;
430 | }
431 | return ( typeof handler === "string" ? instance[ handler ] : handler )
432 | .apply( instance, arguments );
433 | }
434 |
435 | // copy the guid so direct unbinding works
436 | if ( typeof handler !== "string" ) {
437 | handlerProxy.guid = handler.guid =
438 | handler.guid || handlerProxy.guid || $.guid++;
439 | }
440 |
441 | var match = event.match( /^([\w:-]*)\s*(.*)$/ ),
442 | eventName = match[1] + instance.eventNamespace,
443 | selector = match[2];
444 | if ( selector ) {
445 | delegateElement.delegate( selector, eventName, handlerProxy );
446 | } else {
447 | element.bind( eventName, handlerProxy );
448 | }
449 | });
450 | },
451 |
452 | _off: function( element, eventName ) {
453 | eventName = (eventName || "").split( " " ).join( this.eventNamespace + " " ) +
454 | this.eventNamespace;
455 | element.unbind( eventName ).undelegate( eventName );
456 |
457 | // Clear the stack to avoid memory leaks (#10056)
458 | this.bindings = $( this.bindings.not( element ).get() );
459 | this.focusable = $( this.focusable.not( element ).get() );
460 | this.hoverable = $( this.hoverable.not( element ).get() );
461 | },
462 |
463 | _delay: function( handler, delay ) {
464 | function handlerProxy() {
465 | return ( typeof handler === "string" ? instance[ handler ] : handler )
466 | .apply( instance, arguments );
467 | }
468 | var instance = this;
469 | return setTimeout( handlerProxy, delay || 0 );
470 | },
471 |
472 | _hoverable: function( element ) {
473 | this.hoverable = this.hoverable.add( element );
474 | this._on( element, {
475 | mouseenter: function( event ) {
476 | $( event.currentTarget ).addClass( "ui-state-hover" );
477 | },
478 | mouseleave: function( event ) {
479 | $( event.currentTarget ).removeClass( "ui-state-hover" );
480 | }
481 | });
482 | },
483 |
484 | _focusable: function( element ) {
485 | this.focusable = this.focusable.add( element );
486 | this._on( element, {
487 | focusin: function( event ) {
488 | $( event.currentTarget ).addClass( "ui-state-focus" );
489 | },
490 | focusout: function( event ) {
491 | $( event.currentTarget ).removeClass( "ui-state-focus" );
492 | }
493 | });
494 | },
495 |
496 | _trigger: function( type, event, data ) {
497 | var prop, orig,
498 | callback = this.options[ type ];
499 |
500 | data = data || {};
501 | event = $.Event( event );
502 | event.type = ( type === this.widgetEventPrefix ?
503 | type :
504 | this.widgetEventPrefix + type ).toLowerCase();
505 | // the original event may come from any element
506 | // so we need to reset the target on the new event
507 | event.target = this.element[ 0 ];
508 |
509 | // copy original event properties over to the new event
510 | orig = event.originalEvent;
511 | if ( orig ) {
512 | for ( prop in orig ) {
513 | if ( !( prop in event ) ) {
514 | event[ prop ] = orig[ prop ];
515 | }
516 | }
517 | }
518 |
519 | this.element.trigger( event, data );
520 | return !( $.isFunction( callback ) &&
521 | callback.apply( this.element[0], [ event ].concat( data ) ) === false ||
522 | event.isDefaultPrevented() );
523 | }
524 | };
525 |
526 | $.each( { show: "fadeIn", hide: "fadeOut" }, function( method, defaultEffect ) {
527 | $.Widget.prototype[ "_" + method ] = function( element, options, callback ) {
528 | if ( typeof options === "string" ) {
529 | options = { effect: options };
530 | }
531 | var hasOptions,
532 | effectName = !options ?
533 | method :
534 | options === true || typeof options === "number" ?
535 | defaultEffect :
536 | options.effect || defaultEffect;
537 | options = options || {};
538 | if ( typeof options === "number" ) {
539 | options = { duration: options };
540 | }
541 | hasOptions = !$.isEmptyObject( options );
542 | options.complete = callback;
543 | if ( options.delay ) {
544 | element.delay( options.delay );
545 | }
546 | if ( hasOptions && $.effects && $.effects.effect[ effectName ] ) {
547 | element[ method ]( options );
548 | } else if ( effectName !== method && element[ effectName ] ) {
549 | element[ effectName ]( options.duration, options.easing, callback );
550 | } else {
551 | element.queue(function( next ) {
552 | $( this )[ method ]();
553 | if ( callback ) {
554 | callback.call( element[ 0 ] );
555 | }
556 | next();
557 | });
558 | }
559 | };
560 | });
561 |
562 | var widget = $.widget;
563 |
564 |
565 |
566 | }));
567 |
--------------------------------------------------------------------------------
/app/docs/slate/source/javascripts/lib/jquery.tocify.js:
--------------------------------------------------------------------------------
1 | //= require ./jquery_ui
2 | /* jquery Tocify - v1.8.0 - 2013-09-16
3 | * http://www.gregfranko.com/jquery.tocify.js/
4 | * Copyright (c) 2013 Greg Franko; Licensed MIT
5 | * Modified lightly by Robert Lord to fix a bug I found,
6 | * and also so it adds ids to headers
7 | * also because I want height caching, since the
8 | * height lookup for h1s and h2s was causing serious
9 | * lag spikes below 30 fps */
10 |
11 | // Immediately-Invoked Function Expression (IIFE) [Ben Alman Blog Post](http://benalman.com/news/2010/11/immediately-invoked-function-expression/) that calls another IIFE that contains all of the plugin logic. I used this pattern so that anyone viewing this code would not have to scroll to the bottom of the page to view the local parameters that were passed to the main IIFE.
12 | (function(tocify) {
13 |
14 | // ECMAScript 5 Strict Mode: [John Resig Blog Post](http://ejohn.org/blog/ecmascript-5-strict-mode-json-and-more/)
15 | "use strict";
16 |
17 | // Calls the second IIFE and locally passes in the global jQuery, window, and document objects
18 | tocify(window.jQuery, window, document);
19 |
20 | }
21 |
22 | // Locally passes in `jQuery`, the `window` object, the `document` object, and an `undefined` variable. The `jQuery`, `window` and `document` objects are passed in locally, to improve performance, since javascript first searches for a variable match within the local variables set before searching the global variables set. All of the global variables are also passed in locally to be minifier friendly. `undefined` can be passed in locally, because it is not a reserved word in JavaScript.
23 | (function($, window, document, undefined) {
24 |
25 | // ECMAScript 5 Strict Mode: [John Resig Blog Post](http://ejohn.org/blog/ecmascript-5-strict-mode-json-and-more/)
26 | "use strict";
27 |
28 | var tocClassName = "tocify",
29 | tocClass = "." + tocClassName,
30 | tocFocusClassName = "tocify-focus",
31 | tocHoverClassName = "tocify-hover",
32 | hideTocClassName = "tocify-hide",
33 | hideTocClass = "." + hideTocClassName,
34 | headerClassName = "tocify-header",
35 | headerClass = "." + headerClassName,
36 | subheaderClassName = "tocify-subheader",
37 | subheaderClass = "." + subheaderClassName,
38 | itemClassName = "tocify-item",
39 | itemClass = "." + itemClassName,
40 | extendPageClassName = "tocify-extend-page",
41 | extendPageClass = "." + extendPageClassName;
42 |
43 | // Calling the jQueryUI Widget Factory Method
44 | $.widget("toc.tocify", {
45 |
46 | //Plugin version
47 | version: "1.8.0",
48 |
49 | // These options will be used as defaults
50 | options: {
51 |
52 | // **context**: Accepts String: Any jQuery selector
53 | // The container element that holds all of the elements used to generate the table of contents
54 | context: "body",
55 |
56 | // **ignoreSelector**: Accepts String: Any jQuery selector
57 | // A selector to any element that would be matched by selectors that you wish to be ignored
58 | ignoreSelector: null,
59 |
60 | // **selectors**: Accepts an Array of Strings: Any jQuery selectors
61 | // The element's used to generate the table of contents. The order is very important since it will determine the table of content's nesting structure
62 | selectors: "h1, h2, h3",
63 |
64 | // **showAndHide**: Accepts a boolean: true or false
65 | // Used to determine if elements should be shown and hidden
66 | showAndHide: true,
67 |
68 | // **showEffect**: Accepts String: "none", "fadeIn", "show", or "slideDown"
69 | // Used to display any of the table of contents nested items
70 | showEffect: "slideDown",
71 |
72 | // **showEffectSpeed**: Accepts Number (milliseconds) or String: "slow", "medium", or "fast"
73 | // The time duration of the show animation
74 | showEffectSpeed: "medium",
75 |
76 | // **hideEffect**: Accepts String: "none", "fadeOut", "hide", or "slideUp"
77 | // Used to hide any of the table of contents nested items
78 | hideEffect: "slideUp",
79 |
80 | // **hideEffectSpeed**: Accepts Number (milliseconds) or String: "slow", "medium", or "fast"
81 | // The time duration of the hide animation
82 | hideEffectSpeed: "medium",
83 |
84 | // **smoothScroll**: Accepts a boolean: true or false
85 | // Determines if a jQuery animation should be used to scroll to specific table of contents items on the page
86 | smoothScroll: true,
87 |
88 | // **smoothScrollSpeed**: Accepts Number (milliseconds) or String: "slow", "medium", or "fast"
89 | // The time duration of the smoothScroll animation
90 | smoothScrollSpeed: "medium",
91 |
92 | // **scrollTo**: Accepts Number (pixels)
93 | // The amount of space between the top of page and the selected table of contents item after the page has been scrolled
94 | scrollTo: 0,
95 |
96 | // **showAndHideOnScroll**: Accepts a boolean: true or false
97 | // Determines if table of contents nested items should be shown and hidden while scrolling
98 | showAndHideOnScroll: true,
99 |
100 | // **highlightOnScroll**: Accepts a boolean: true or false
101 | // Determines if table of contents nested items should be highlighted (set to a different color) while scrolling
102 | highlightOnScroll: true,
103 |
104 | // **highlightOffset**: Accepts a number
105 | // The offset distance in pixels to trigger the next active table of contents item
106 | highlightOffset: 40,
107 |
108 | // **theme**: Accepts a string: "bootstrap", "jqueryui", or "none"
109 | // Determines if Twitter Bootstrap, jQueryUI, or Tocify classes should be added to the table of contents
110 | theme: "bootstrap",
111 |
112 | // **extendPage**: Accepts a boolean: true or false
113 | // If a user scrolls to the bottom of the page and the page is not tall enough to scroll to the last table of contents item, then the page height is increased
114 | extendPage: true,
115 |
116 | // **extendPageOffset**: Accepts a number: pixels
117 | // How close to the bottom of the page a user must scroll before the page is extended
118 | extendPageOffset: 100,
119 |
120 | // **history**: Accepts a boolean: true or false
121 | // Adds a hash to the page url to maintain history
122 | history: true,
123 |
124 | // **scrollHistory**: Accepts a boolean: true or false
125 | // Adds a hash to the page url, to maintain history, when scrolling to a TOC item
126 | scrollHistory: false,
127 |
128 | // **hashGenerator**: How the hash value (the anchor segment of the URL, following the
129 | // # character) will be generated.
130 | //
131 | // "compact" (default) - #CompressesEverythingTogether
132 | // "pretty" - #looks-like-a-nice-url-and-is-easily-readable
133 | // function(text, element){} - Your own hash generation function that accepts the text as an
134 | // argument, and returns the hash value.
135 | hashGenerator: "compact",
136 |
137 | // **highlightDefault**: Accepts a boolean: true or false
138 | // Set's the first TOC item as active if no other TOC item is active.
139 | highlightDefault: true
140 |
141 | },
142 |
143 | // _Create
144 | // -------
145 | // Constructs the plugin. Only called once.
146 | _create: function() {
147 |
148 | var self = this;
149 |
150 | self.tocifyWrapper = $('.tocify-wrapper');
151 | self.extendPageScroll = true;
152 |
153 | // Internal array that keeps track of all TOC items (Helps to recognize if there are duplicate TOC item strings)
154 | self.items = [];
155 |
156 | // Generates the HTML for the dynamic table of contents
157 | self._generateToc();
158 |
159 | // Caches heights and anchors
160 | self.cachedHeights = [],
161 | self.cachedAnchors = [];
162 |
163 | // Adds CSS classes to the newly generated table of contents HTML
164 | self._addCSSClasses();
165 |
166 | self.webkit = (function() {
167 |
168 | for(var prop in window) {
169 |
170 | if(prop) {
171 |
172 | if(prop.toLowerCase().indexOf("webkit") !== -1) {
173 |
174 | return true;
175 |
176 | }
177 |
178 | }
179 |
180 | }
181 |
182 | return false;
183 |
184 | }());
185 |
186 | // Adds jQuery event handlers to the newly generated table of contents
187 | self._setEventHandlers();
188 |
189 | // Binding to the Window load event to make sure the correct scrollTop is calculated
190 | $(window).load(function() {
191 |
192 | // Sets the active TOC item
193 | self._setActiveElement(true);
194 |
195 | // Once all animations on the page are complete, this callback function will be called
196 | $("html, body").promise().done(function() {
197 |
198 | setTimeout(function() {
199 |
200 | self.extendPageScroll = false;
201 |
202 | },0);
203 |
204 | });
205 |
206 | });
207 |
208 | },
209 |
210 | // _generateToc
211 | // ------------
212 | // Generates the HTML for the dynamic table of contents
213 | _generateToc: function() {
214 |
215 | // _Local variables_
216 |
217 | // Stores the plugin context in the self variable
218 | var self = this,
219 |
220 | // All of the HTML tags found within the context provided (i.e. body) that match the top level jQuery selector above
221 | firstElem,
222 |
223 | // Instantiated variable that will store the top level newly created unordered list DOM element
224 | ul,
225 | ignoreSelector = self.options.ignoreSelector;
226 |
227 | // If the selectors option has a comma within the string
228 | if(this.options.selectors.indexOf(",") !== -1) {
229 |
230 | // Grabs the first selector from the string
231 | firstElem = $(this.options.context).find(this.options.selectors.replace(/ /g,"").substr(0, this.options.selectors.indexOf(",")));
232 |
233 | }
234 |
235 | // If the selectors option does not have a comman within the string
236 | else {
237 |
238 | // Grabs the first selector from the string and makes sure there are no spaces
239 | firstElem = $(this.options.context).find(this.options.selectors.replace(/ /g,""));
240 |
241 | }
242 |
243 | if(!firstElem.length) {
244 |
245 | self.element.addClass(hideTocClassName);
246 |
247 | return;
248 |
249 | }
250 |
251 | self.element.addClass(tocClassName);
252 |
253 | // Loops through each top level selector
254 | firstElem.each(function(index) {
255 |
256 | //If the element matches the ignoreSelector then we skip it
257 | if($(this).is(ignoreSelector)) {
258 | return;
259 | }
260 |
261 | // Creates an unordered list HTML element and adds a dynamic ID and standard class name
262 | ul = $("