kotovalexarian-likes-github
/
capistrano
mirror of https://github.com/capistrano/capistrano
1
0
Fork 0
Code Releases Activity

Merge remote-tracking branch 'docs-temp/docs-subdir' into merge-docs-again

This commit is contained in:
Matt Brictson 2016-08-26 16:55:24 -07:00
parent 781f294690 9d62e3d7b6
commit b956d1f16c
No known key found for this signature in database
GPG Key ID: 2F279EAD1F2ACFAF
98 changed files with 14326 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -21,4 +21,5 @@ tags
test/tmp
test/version_tmp
tmp
/docs/_site/
vendor/

1
docs/CNAME Normal file
View File

@ -0,0 +1 @@
capistranorb.com

8
docs/Gemfile Normal file
View File

@ -0,0 +1,8 @@
source "https://rubygems.org"
# keep versions up-to-date with the actual GitHub Pages setup
# https://pages.github.com/versions/
# just do `bundle update` to get the latest version.
gem 'github-pages'

129
docs/Gemfile.lock Normal file
View File

@ -0,0 +1,129 @@
GEM
remote: https://rubygems.org/
specs:
RedCloth (4.2.9)
activesupport (4.2.5.1)
i18n (~> 0.7)
json (~> 1.7, >= 1.7.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.3.8)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.10.0)
colorator (0.1)
ethon (0.8.1)
ffi (>= 1.3.0)
execjs (2.6.0)
faraday (0.9.2)
multipart-post (>= 1.2, < 3)
ffi (1.9.10)
gemoji (2.1.0)
github-pages (45)
RedCloth (= 4.2.9)
github-pages-health-check (= 0.6.0)
jekyll (= 3.0.2)
jekyll-coffeescript (= 1.0.1)
jekyll-feed (= 0.3.1)
jekyll-gist (= 1.4.0)
jekyll-mentions (= 1.0.0)
jekyll-paginate (= 1.1.0)
jekyll-redirect-from (= 0.9.1)
jekyll-sass-converter (= 1.3.0)
jekyll-seo-tag (= 0.1.4)
jekyll-sitemap (= 0.10.0)
jekyll-textile-converter (= 0.1.0)
jemoji (= 0.5.1)
kramdown (= 1.9.0)
liquid (= 3.0.6)
mercenary (~> 0.3)
rdiscount (= 2.1.8)
redcarpet (= 3.3.3)
rouge (= 1.10.1)
terminal-table (~> 1.4)
github-pages-health-check (0.6.0)
addressable (~> 2.3)
net-dns (~> 0.8)
public_suffix (~> 1.4)
typhoeus (~> 0.7)
html-pipeline (2.3.0)
activesupport (>= 2, < 5)
nokogiri (>= 1.4)
i18n (0.7.0)
jekyll (3.0.2)
colorator (~> 0.1)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 3.0)
mercenary (~> 0.3.3)
rouge (~> 1.7)
safe_yaml (~> 1.0)
jekyll-coffeescript (1.0.1)
coffee-script (~> 2.2)
jekyll-feed (0.3.1)
jekyll-gist (1.4.0)
octokit (~> 4.2)
jekyll-mentions (1.0.0)
html-pipeline (~> 2.2)
jekyll (~> 3.0)
jekyll-paginate (1.1.0)
jekyll-redirect-from (0.9.1)
jekyll (>= 2.0)
jekyll-sass-converter (1.3.0)
sass (~> 3.2)
jekyll-seo-tag (0.1.4)
jekyll (>= 2.0)
jekyll-sitemap (0.10.0)
jekyll-textile-converter (0.1.0)
RedCloth (~> 4.0)
jekyll-watch (1.3.1)
listen (~> 3.0)
jemoji (0.5.1)
gemoji (~> 2.0)
html-pipeline (~> 2.2)
jekyll (>= 2.0)
json (1.8.3)
kramdown (1.9.0)
liquid (3.0.6)
listen (3.0.5)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9)
mercenary (0.3.5)
mini_portile2 (2.0.0)
minitest (5.8.4)
multipart-post (2.0.0)
net-dns (0.8.0)
nokogiri (1.6.7.2)
mini_portile2 (~> 2.0.0.rc2)
octokit (4.2.0)
sawyer (~> 0.6.0, >= 0.5.3)
public_suffix (1.5.3)
rb-fsevent (0.9.7)
rb-inotify (0.9.7)
ffi (>= 0.5.0)
rdiscount (2.1.8)
redcarpet (3.3.3)
rouge (1.10.1)
safe_yaml (1.0.4)
sass (3.4.21)
sawyer (0.6.0)
addressable (~> 2.3.5)
faraday (~> 0.8, < 0.10)
terminal-table (1.5.2)
thread_safe (0.3.5)
typhoeus (0.8.0)
ethon (>= 0.8.0)
tzinfo (1.2.2)
thread_safe (~> 0.1)
PLATFORMS
ruby
DEPENDENCIES
github-pages
BUNDLED WITH
1.11.2

23
docs/README.md Normal file
View File

@ -0,0 +1,23 @@
# capistranorb.com
This is the repository that generates the [capistranorb.com](http://capistranorb.com/) site. Feel free to send pull requests to make improvements to Capistrano's documentation!
### Quick start
This is a GitHub Pages project, which means it is built using Jekyll. To run the site locally, you'll need a functioning Ruby environment.
After checking out the capistrano-documentation project, run:
```
bundle install
```
Then start the Jekyll server with:
```
bundle exec jekyll serve
```
You should now be able to preview the site on `http://localhost:4000`. After making any changes to markdown or HTML files, just refresh your browser to see the results. You do not have to restart the Jekyll process.
More information: [Using Jekyll with Pages](https://help.github.com/articles/using-jekyll-with-pages/).

7
docs/_config.yml Normal file
View File

@ -0,0 +1,7 @@
name: Capistrano
highlighter: rouge
safe: true
lsi: false
redcarpet:
extensions: ["no_intra_emphasis", "fenced_code_blocks", "autolink", "tables", "with_toc_data"]
exclude: ["Gemfile", "Gemfile.lock", "README.md", "vendor"]

1
docs/_includes/carbon.html Normal file
View File

@ -0,0 +1 @@
<script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=capistranorbcom" id="_carbonads_js"></script>

25
docs/_includes/footer.html Normal file
View File

@ -0,0 +1,25 @@
<footer>
<div class="row">
<div class="large-4 columns">
<ul>
<li><a href="/documentation/overview/what-is-capistrano/">About Capistrano</a></li>
<li><a href="https://github.com/capistrano/capistrano/blob/master/CONTRIBUTING.md">Contributing</a></li>
<li><a href="https://rubygems.org/gems/capistrano/versions">Releases</a></li>
</ul>
</div>
<div class="large-4 columns">
<ul>
<li><a href="http://stackoverflow.com/questions/tagged/capistrano">StackOverflow</a></li>
<li><a href="https://groups.google.com/forum/#!forum/capistrano">Mailing List</a></li>
</ul>
</div>
<div class="large-4 columns">
<ul class="social icons">
<li><a href="//twitter.com/capistranorb"><i class="foundicon-twitter"></i></a></li>
<li><a href="//github.com/capistrano"><i class="foundicon-github"></i></a></li>
</ul>
</div>
</div>
</footer>

6
docs/_includes/google_tag_manager.html Normal file
View File

@ -0,0 +1,6 @@
<!-- Google Tag Manager -->
<noscript>
<iframe src="//www.googletagmanager.com/ns.html?id=GTM-KLDBJG" height="0" width="0" style="display:none;visibility:hidden"></iframe>
</noscript>
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-KLDBJG');</script>
<!-- End Google Tag Manager -->

24
docs/_includes/header.html Normal file
View File

@ -0,0 +1,24 @@
<div class="harrowBanner">
<div class="harrowBanner__newRibbon">New!</div>
<h2 class="harrowBanner__title">Our web-based Capistrano</h2>
<p class="harrowBanner__p">
Improve collaboration within your team.
<br/>
Hosted, secure and available any time, from anywhere.
</p>
<a href="https://www.harrow.io/hosted-capistrano-for-teams/?utm_source=CAP&utm_medium=BAN&utm_term=00001&utm_campaign=00002&utm_campaign=CAP_BAN_00001_00002#hosted-capistrano-for-teams" class="harrowBanner__ctaButton">Try it now!</a>
<a href="#" class="harrowBanner__dismissLink">No thanks</a>
</div>
<div class="header">
<div class="row">
<div class="large-12 column">
<a href="/" class="brand">
<img src="/images/CapistranoLogo.png" alt="capistrano logo" />
</a>
</div>
<!-- <div class="large&#45;4 column"> -->
<!-- {% include carbon.html %} -->
<!-- </div> -->
</div>
</div>

30
docs/_includes/metrics.html Normal file
View File

@ -0,0 +1,30 @@
<script type="text/javascript">
var _gauges = _gauges || [];
(function() {
var t = document.createElement('script');
t.type = 'text/javascript';
t.async = true;
t.id = 'gauges-tracker';
t.setAttribute('data-site-id', '51c83c32613f5d7df70000bc');
t.src = '//secure.gaug.es/track.js';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(t, s);
})();
</script>
<script type="text/javascript">
setTimeout(function(){var a=document.createElement("script");
var b=document.getElementsByTagName("script")[0];
a.src=document.location.protocol+"//dnn506yrbagrg.cloudfront.net/pages/scripts/0017/6418.js?"+Math.floor(new Date().getTime()/3600000);
a.async=true;a.type="text/javascript";b.parentNode.insertBefore(a,b)}, 1);
</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-41970098-1', 'capistranorb.com');
ga('send', 'pageview');
</script>

84
docs/_includes/navigation.html Normal file
View File

@ -0,0 +1,84 @@
<ul class="side-nav">
<h5>Search</h5>
<form action="https://www.google.com/search" method="get">
<input type="hidden" name="as_sitesearch" value="capistranorb.com">
<input type="search" name="q" placeholder="Search terms" autocomplete="off">
</form>
<li class="divider"></li>
<h5>Hosted Capistrano</h5>
<li><a href="https://www.harrow.io/hosted-capistrano-for-teams/?utm_source=CAP&utm_medium=BAN&utm_term=00001&utm_campaign=00004&utm_campaign=CAP_BAN_00001_00004#hosted-capistrano-for-teams" title="Harrow | Seamless collaboration for software teams">Try The New Cloud Capistrano</a></li>
<li><a href="/documentation/harrow">Learn more</a></li>
<li class="divider"></li>
<h5>Overview</h5>
<li><a href="/documentation/overview/what-is-capistrano/">What is Capistrano?</a></li>
<li class="divider"></li>
<h5>Getting Started</h5>
<li><a href="https://github.com/capistrano/capistrano/blob/master/README.md">The Readme, start here!</a></li>
<li><a href="/documentation/getting-started/installation/">Installation</a></li>
<li><a href="/documentation/getting-started/structure/">Structure</a></li>
<li><a href="/documentation/getting-started/configuration/">Configuration</a></li>
<li><a href="/documentation/getting-started/user-input/">User Input</a></li>
<li><a href="/documentation/getting-started/preparing-your-application/">Preparing Your Application</a></li>
<li><a href="/documentation/getting-started/flow/">Flow</a></li>
<li><a href="/documentation/getting-started/rollbacks/">Rollbacks</a></li>
<li><a href="/documentation/getting-started/cold-start/">Cold Start</a></li>
<li><a href="/documentation/getting-started/tasks/">Tasks</a></li>
<li><a href="/documentation/getting-started/local-tasks/">Local Tasks</a></li>
<li><a href="/documentation/getting-started/before-after/">Before / After Hooks</a></li>
<li><a href="/documentation/getting-started/authentication-and-authorisation/">Authentication &amp; Authorisation</a></li>
<li class="divider"></li>
<h5>Advanced Features</h5>
<li><a href="/documentation/advanced-features/console/">Console</a></li>
<li><a href="/documentation/advanced-features/ptys/">PTYs</a></li>
<li><a href="/documentation/advanced-features/filtering/">Filtering</a></li>
<li><a href="/documentation/advanced-features/properties/">Properties</a></li>
<li><a href="/documentation/advanced-features/property-filtering/">Property Filtering</a></li>
<li><a href="/documentation/advanced-features/host-filtering/">Host filtering</a></li>
<li><a href="/documentation/advanced-features/role-filtering/">Role Filtering</a></li>
<li><a href="/documentation/advanced-features/overriding-capistrano-tasks/">Overriding Capistrano Tasks</a></li>
<li><a href="/documentation/advanced-features/remote-file/">Remote File Task</a></li>
<li><a href="/documentation/advanced-features/ssh-kit">Remote Commands with SSHKit</a></li>
<li><a href="/documentation/advanced-features/ignoring">Preventing file deployment with gitattributes</a></li>
<li><a href="/documentation/advanced-features/validation-of-variables">Validation of variables</a></li>
<li class="divider"></li>
<h5>Plugins</h5>
<li><a href="https://github.com/capistrano/bundler/">Bundler</a></li>
<li><a href="https://github.com/capistrano/composer/">Composer</a></li>
<li><a href="https://github.com/capistrano/drupal-deploy/">Drupal</a></li>
<li><a href="https://github.com/capistrano/laravel/">Laravel</a></li>
<li><a href="https://github.com/capistrano/npm/">npm</a></li>
<li><a href="https://github.com/capistrano/passenger/">Phusion Passenger</a></li>
<li><a href="https://github.com/capistrano/chruby/">chruby</a></li>
<li><a href="https://github.com/capistrano/rbenv/">rbenv</a></li>
<li><a href="https://github.com/capistrano/rvm/">RVM</a></li>
<li><a href="https://github.com/capistrano/rails/">Ruby on Rails</a></li>
<li><a href="https://github.com/capistrano/symfony/">Symfony</a></li>
<li><a href="/documentation/third-party-plugins/">3<sup>rd</sup> Party Plugins</a></li>
<li class="divider"></li>
<h5>FAQ</h5>
<li><a href="/documentation/faq/why-does-something-work-in-my-ssh-session-but-not-in-capistrano/">Why does something work in an SSH session, but not in Capistrano?</a></li>
<li><a href="/documentation/faq/how-can-i-access-stage-configuration-variables/">How can I access stage configuration variables?</a></li>
<li><a href="/documentation/faq/how-can-i-check-for-existing-remote-file/">How can I check for existing remote file?</a></li>
<li><a href="/documentation/faq/how-can-i-get-capistrano-to-prompt-for-a-password/">How can I get Capistrano to prompt for a password?</a></li>
<li><a href="/documentation/faq/how-can-i-set-capistrano-configuration-paths/">How can I set Capistrano configuration paths?</a></li>
<li><a href="http://lee.hambley.name/2013/06/11/using-capistrano-v3-with-chef.html">Should I use Capistrano to provision my servers?</a></li>
<li class="divider"></li>
<h5>Legacy</h5>
<li><a href="https://github.com/capistrano/capistrano-2.x-docs/">Capistrano 2 Documentation Repository</a></li>
<li><a href="/documentation/upgrading/">Upgrading from Capistrano 2.x to 3</a></li>
<li class="divider"></li>
<h5>Recent Announcements</h5>
{% for post in site.posts %}
<li><a href="{{ post.url }}"><span class="post-date">{{ post.date | date_to_string }}</span> {{ post.title }}</a></li>
{% endfor %}
</ul>

66
docs/_layouts/default.html Normal file
View File

@ -0,0 +1,66 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>{{ page.title }}</title>
<link href='http://fonts.googleapis.com/css?family=Enriqueta' rel='stylesheet' type='text/css'>
<script type="text/javascript" src="//use.typekit.net/itm5ubu.js"></script>
<script type="text/javascript">try{Typekit.load();}catch(e){}</script>
<link rel="stylesheet" href="/css/foundation.css" />
<link rel="stylesheet" href="/css/capistrano.css">
<link rel="stylesheet" href="/css/social_foundicons.css" />
<link rel="stylesheet" href="/css/okaidia.css">
<link rel="stylesheet" href="/css/syntax.css">
<script src="/js/vendor/custom.modernizr.js"></script>
</head>
<body>
{% include metrics.html %}
{% include header.html %}
<div class="row">
<div class="large-4 columns">
{% include navigation.html %}
</div>
<div class="large-8 column">
<div class="content">
<h2>{{ page.title }}</h2>
{{ content }}
</div>
</div>
</div>
{% include footer.html %}
<script src="/js/jquery-1.7.min.js"></script>
<script src="/js/jquery.cookie.js"></script>
<script type="text/javascript">
$(function(){
if ($.cookie('harrowBanner__dismissed') != '1') {
$('.harrowBanner').css('display', 'block');
ga('send', 'event', 'harrowBanner', 'shown');
} else {
ga('send', 'event', 'harrowBanner', 'alreadydismissed');
}
$(".harrowBanner__ctaButton").on('click', function (e) {
ga('send', 'event', 'harrowBanner', 'clickthrough');
});
$(".harrowBanner__dismissLink").on('click', function (e) {
$.cookie('harrowBanner__dismissed', '1', { path: "/", expires: 10 });
$('.harrowBanner').hide();
ga('send', 'event', 'harrowBanner', 'dismiss');
});
});
</script>
<script src="/js/jquery.githubRepoWidget.min.js"></script>
<script src="/js/prism.js"></script>
<script src="/js/prism.ruby.js"></script>
<a href="https://github.com/capistrano/capistrano"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png" alt="Fork me on GitHub"></a>
{% include google_tag_manager.html %}
</body>
</html>

8
docs/_layouts/post.html Normal file
View File

@ -0,0 +1,8 @@
---
layout: default
---
<p class="meta">{{ page.date | date_to_string }}</p>
<div id="post">
{{ content }}
</div>

572
docs/_posts/2013-06-01-release-announcement.markdown Normal file
View File

@ -0,0 +1,572 @@
---
layout: post
title: "Capistrano Version 3 Release Announcement"
date: 2013-06-01
---
After what seems like years of work, the Capistrano team (that's Tom and I)
are pleased to announce the first *major* release of Capistrano in almost 5
years.
The reasons behind the length of time between the last architectural overhaul
and this one are numerous, but it can be summarised to say that Capistrano is a
widely used tool, and when working around software deployment it's really a
question of downtime. If we had changed something significant in Capistrano we
could have taken a lot of sites offline, and made a lot of people very
unhappy. Until this point we haven't felt that the time has been ripe where
the benefits of a slightly rocky upgrade path are worth the risks of downtime.
It also hasn't helped historically that we've only just gotten to grips with
Ruby 1.9, and that Bundler's near ubiquity means that now it's trivial to lock
a Gem at a specific version. With other tools in the Ruby ecosystem it's
become easier for us to make significant changes to a tool upon which many
hundreds of thousands of people rely.
### Design Goals
We had a few goals for this release, in no particular order they were:
* **Get away from our own DSL solution.** Great DSL alternatives (Rake, Sake, Thor,
etc) are already widely used.
* **Better modularisation.** to enable people outside the Rails community to
benefit from Capistrano's *best-practice* workflow, and to enable people in
the Rails community to pick and choose support for components they use
(Database Migrations, Asset Pipeline, etc)
* **Easier Debugging.** A lot of problems with Capistrano come from weirdness
surrounding environmental issues around PTY vs non-TTY environments, login
and non-login shells not to mention *environment managers* such as rvm,
rbenv and nvm.
* **Speed.** We know that in a lot of environments speed of deployment is a
huge factor, since Rails introduced the *Asset Pipeline* it's not uncommon
for a deploy that formerly took 5 seconds now takes 5 minutes. This really
is mostly out of our control, but with improved support for parallelism,
rolling restarts we feel confident that things will be quicker and easier to
keep running quickly now.
* **Applicability.** We've always maintained that Capistrano is a terrible
tool for system provisioning, and that more often than not servers are
better being setup with Chef, Puppet or similar, whilst we still agree with
that, the new features in Capistrano really lend themselves to integrating
with these kinds of tools.
### What's missing?
Before we get too carried away it's worth shortlisting the things that don't
exist in version three, ***yet***.
* **SSH Gateway Support** SSH Gateway support hasn't been implemented in
version three yet, I hope that this will be done soon. As I have no direct
need for it, I haven't the means to test it with a view to implementing it,
yet.
* **Mecurial, Subversion, and CVS Support** These have been removed as we've
been able to implement the Git SCM in an incredibly neat way that isn't
compatible with the others. We wanted to break the cycle of always sticking
with the lowest common denominator, so we are **actively** looking for
people who are interested in contributing, or sharing expertise on the
*best-practice* way of speedily deploying from your respective choice of
source control.
* **`HOSTFILTER` ,`ROLEFILTER` and friends** These have gone away because we
always felt they were endemic of a bad design decision about using
Environmental Variables. These will be coming back as flags passed to `cap`
on the CLI, and options that can be set on the `Capistrano::Application` Ruby
class.
* **Shell** The shell has been removed temporarily pending a neater
implementation, we've got something that we are playing with internally, but
it needs better `readline` support, and some more controls around what to do
when things go badly on some servers, but not others.
* **Cold Deploy** The `cap deploy:cold` is a really old legacy component,
orignally from the days of the `script/spinner` where deploying cold
(starting workers that weren't running), and deploying a *warm* system were
different (restarting existing worker pools, which wasn't fun!) By and large
these things have gone away, and it's time `deploy:cold` went away. It's
safe in every case we could find to call setup, and seed and other Rake
tasks without things blowing up, and that should be the approach we take.
Tasks on the server should be idempotent, and if something is called twice,
let it be.
### What's new?
Each section here really deserves it's own sub-heading as some of the new
features are awesome.
#### Rake Integration
We have moved away from our own DSL implemenation to implement Capistrano as a
*Rake* application.
Rake has always supported being sub-classed, so to speak as a
*sub-application*; it is however poorly documented. By subclassing
`Rake::Application` one can specify what the *Rakefile* should look like, where
to search for it, and how to load other *Rakefiles*.
The *Rake* DSL is widely used, well known and very powerful. As Rake is
essentially a dependency resolution system, it offers a lot of nice ways to,
for example build a tarball as a dependency of uploading it and deploying it.
This has allowed us to do away with the *copy* strategy all together, as it
can now be implemented from scratch in fewer than ten lines of code.
The guiding principle is dependency resolution, and interoperability with
other tools, for example:
{% highlight ruby %}
# Capistrano 3.0.x
task :notify do
this_release_tag = sh("git describe --abbrev=0 --tags")
last_ten_commits = sh("git log #{this_release_tag}~10..#{this_release_tag}")
Mail.deliver do
to "team@example.com"
subject "Releasing #{this_release_tag} Now!"
body last_ten_commits
end
end
namespace :deploy
task default: :notify
end
{% endhighlight %}
The last three lines rely on Rake's additive task declaration, by redefining the
`deploy:default` task by adding another dependency. Rake will automatically
resolve this dependency at Runtime, mailing the recent changelog to your team,
assuming everything is setup correctly.
#### Built-In Stage Support
In former versions of Capistrano *stage* support was an after thought,
provided through the `capistrano-ext` Gem, and laterally merged into the main
codebase, people insisted in still using the `capistrano-ext` version
regardless.
In Capistrano 3.0.x there's stage support built-in, at installation time, two
stages will be created by default, *staging* and *production*; it's easy to
add more, just add a file to `config/deploy/______.rb` which follows the
conventions established in the examples we created for you.
To create different stages at installation time, simply set the `STAGES`
environmental variable to a comma separated list of stages:
{% highlight bash %}
$ cap install STAGES=staging,production,ci,qa
{% endhighlight %}
#### Parallelism
In former versions of Capistrano there was a *parallel* option to run
different tasks differently on groups of servers, it looked something like
this:
{% highlight ruby %}
# Capistrano 2.0.x
task :restart do
parallel do |session|
session.when "in?(:app)", "/u/apps/social/script/restart-mongrel"
session.when "in?(:web)", "/u/apps/social/script/restart-apache"
session.else "echo nothing to do"
end
end
{% endhighlight %}
This always felt a little unclean, and indeed it's a hack that was originally
implemeted to facilitate rolling deployments at a large German firm by a
couple of freelancers who were consulting with them. (Hint, one of those guys
went on to found Travis-CI!)
The equivalent code in under Capistrano v3 would look like this:
{% highlight ruby %}
# Capistrano 3.0.x
task :restart do
on :all, in: :parallel do |host|
if host.roles.include?(:app)
execute "/u/apps/social/script/restart-mongrel"
elsif host.roles.include?(:web)
execute "/u/apps/social/script/restart-web"
else
info sprintf("Nothing to do for %s with roles %s", host,
host.properties.roles)
end
end
end
{% endhighlight %}
The second block of code, that representing the new Rake derived DSL and
demonstrating how to use the parallel execution mode is a little longer, but I
think it's clearer, more idiomatic Ruby code which relies less on an intimate
knowledge of how the Capistrano DSL happens to work. It also hints at the
built-in logging subsystem, keep reading to learn more.
Other modes for parallelism include:
{% highlight ruby %}
# Capistrano 3.0.x
on :all, in: :groups, limit: 3, wait: 5 do
# Take all servers, in groups of three which execute in parallel
# wait five seconds between groups of servers.
# This is perfect for rolling restarts
end
on :all, in: :sequence, wait: 15 do
# This takes all servers, in sequence and waits 15 seconds between
# each server, this might be perfect if you are afraid about
# overloading a shared resource, or want to defer the asset compilation
# over your cluster owing to worries about load
end
on :all, in: :parallel do
# This will simply try and execute the commands contained within
# the block in parallel on all servers. This might be perfect for kicking
# off something like a Git checkout or similar.
end
{% endhighlight %}
The internal tasks, for standard deploy recipes make use of all of these as is
appropriate for the normal case, no need to be afraid of scary slow deploys
again!
#### Streaming IO
This IO streaming model means that results from commands, the commands
themselves and any other arbitrary output are sent as objects to a class with
an `IO`ish interface, the class knows what to do with these things. There's a
*progress* formatter which prints dots for each command that is called, as
well as a *pretty* formatter which prints the full command, it's output on
standard out and standard error, as well as the final return status. It would
be trivial to implement HTML formatters, or formatters that reported to your
IRC room, or to email. I look forward to seeing more of these cropping up in
the community.
#### Host Definition Access
If you didn't skim over the *Parallism* section above, you might have noticed we
did something clever that wasn't possible in Capistrano v2; we accessed the
`host` inside the execution block.
For a lot of reasons in Capistrano v2 is wasn't possible to do this, the block
was essentially evaluated once and called verbatim on each host. This lead to
disappointing missing features such as not being able to pull the host list
out of Capistrano and examine the roles to do something like controlling Chef
solo, or similar.
In Capistrano v3 the `host` object is the same object that is created when a
server is defined, and is internally used, for example to pass to an ERB
template for rendering a last-deploy message that is dumped onto each server
after a successful deployment. The last deploy log includes everything
Capistrano knew about that server during the deployment.
> Users of Capistrano v2 may be familiar with the perenial `cap deploy:cleanup`
problem which came to light when servers differed in their old releases list,
imagine a scenario with two servers, one has been your bread-and-butter since
you launched, it has hundreds of old releases from all your wonderful deploys
over the months or years. The second server has been in the cluster for about
a month, it didn't quite slot-in cleanly, so the list of old releases looks a
bit weird, you deleted a few by hand, and anyway there might only be ten-or-so
releases there.
> Now imagine that you call `cap deploy:cleanup`, old `capture()`
implementations silently only ran on the first server that matched the
properties defined, so server one returned a list of ~95 old timestamped
release directories. Next Capistrano v2 would call `rm -rf
release1..release95` on **both** servers, causing server two to error out, and
leaving an undefined state on server one, as Capistrano would simply hang up
both connections.
This cleanup routine can now be better implemented as follows (which is
actually more or less the actual implementation in the the new Gem):
{% highlight ruby %}
# Capistrano 3.0.x
desc "Cleanup all old releases (keeps #{fetch(:releases_to_keep_on_cleanup)}
old releases"
task :cleanup do
keep_releases = fetch(:releases_to_keep_on_cleanup)
releases = capture(:ls, fetch(:releases_directory))
releases_to_delete = releases.sort_by { |r| r.to_i }.slice(1..-(keep_releases + 1))
releases_to_delete.each do |r|
execute :rm, fetch(:releases_directory).join(r)
end
end
{% endhighlight %}
Some handy things to note here are that both server one and server two in our
contrived example will both evaluate that independently, and when both servers
are finished removing old releases the `task :cleanup` block will have
finished.
Also in Capistrano v3 most path variables are [`Pathname`] objects, so they natively
respond to things like `#basename`, `#expand_path`, `#join` and similar.
**Warning:** `#expand_path` probably won't do what you expect, it will execute
on your *workstation* machine, and not on the remote host, so it's possible
that it will return an error in the case of paths which exist remotely but not
locally.
#### Host Properties
As the `host` object is now available to the task blocks, it made sense to make
it possible to store arbitrarty values against them.
Enter `host.properties`. This is a simple
[*OpenStruct*](http://www.ruby-doc.org/stdlib-2.0/libdoc/ostruct/rdoc/OpenStruct.html)
which can be used to store any additional properties which are important for
your application.
An example of it's usage might be:
{% highlight ruby %}
h = SSHKit::Host.new 'example.com'
h.properties.roles ||= %i{wep app}
{% endhighlight %}
#### More Expressive Command Language
In Capistrano v2, it wasn't uncommon to find commands such as:
{% highlight ruby %}
# Capistrano 2.0.x
task :precompile, :roles => lambda { assets_role }, :except => { :no_release => true } do
run <<-CMD.compact
cd -- #{latest_release} &&
RAILS_ENV=#{rails_env.to_s.shellescape} #{asset_env} #{rake} assets:precompile
CMD
end
{% endhighlight %}
In Capistrano v3 this looks more like this:
{% highlight ruby %}
# Capistrano 3.0.x
task :precompile do
on :sprockets_asset_host, reject: lambda { |h| h.properties.no_release } do
within fetch(:latest_release_directory) do
with rails_env: fetch(:rails_env) do
execute :rake, 'assets:precompile'
end
end
end
end
{% endhighlight %}
Again, with other examples this format is a little longer, but much more
expressive, and all the nightmare of shell escaping is handled interally for
you, environmental variables are capitalised and applied at the correct point
(i.e between the `cd` and `rake` calls in this case).
Other options here include `as :a_user` and
#### Better *magic* Variable Support
In Capistrano v2 there were certain bits of magic where if calling a variable
and `NoMethodError` would have been raised (for example the
`latest_release_directory` variable). This variable never existed on the
global namespace, as a fall-back the list of `set()` variables would be
consulted.
This magic led to times when people were not recognising that magic variables
were even being used. The magic variable system of Capistrano v2 did also
include a way to `fetch(:some_variable, 'with a default value')` incase the
variable might not be set already, but it wasn't widely used, and more often
than not people just used things like `latest_release_directory` never knowing
that behind the scenes an exception was raised, then rescued, and that
`:latest_release_directory` in the variable map was actually a continuation
that was evaluated the first time it was used, and the value then cached until
the end of the script.
The system has now 100% less magic. If you set a variable using `set()`, it
can be fetched with `fetch()`, if the value you set into the variable responds
to `#call` then it will be executed in the current context whenever it is
used, the values will not be cached, unless your continuation does some
explicit caching. *Again, we are favoring clarity over micro optimisation*.
#### SSHKit
Many of the new features in Capistrano which relate to logging, formatting,
SSH, connection management and pooling, parallelism, batch execution and more
are from a library that fell out of the Capistrano v3 development process.
[*SSHKit*](https://github.com/leehambley/sshkit) is a lower level toolkit, a level higher than *Net::SSH* still,
but lacking the roles, environments, rollbacks and other higher level features
from Capistrano.
SSHkit is ideal for use if you need to just connect to a machine and run some
arbitrary command, for example:
{% highlight ruby %}
# Rakefile (even without Capistrano loaded)
require 'sshkit'
desc "Check the uptime of example.com"
task :uptime do |h|
execute :uptime
end
{% endhighlight %}
There is much more than can be done with SSHKit, and we have quite an
extensive [list of
examples](https://github.com/leehambley/sshkit/blob/master/EXAMPLES.md). For
the most part with Capistrano v3, anything that happens inside of an `on()`
block is happening in SSHkit, and the documentation from that library is the
place to go to find more information.
#### Command Mapping
This is another feature from SSHKit, designed to remove a little ambiguity
from preceedings, there is a so-called command map for commands.
When executing something like:
{% highlight ruby %}
# Capistrano 2.0.x
execute "git clone ........ ......."
{% endhighlight %}
The command is passed through to the remote server *completely unchanged*.
This includes the options which might be set, such as user, directory, and
environmental variables. **This is by design.** This feature is designed to
allow people to write non-trivial commands in
[heredocs](https://en.wikipedia.org/wiki/Here_document) when the need arises,
for example:
{% highlight ruby %}
# Capistrano 3.0.x
execute <<-EOBLOCK
# All of this block is interpreted as Bash script
if ! [ -e /tmp/somefile ]
then touch /tmp/somefile
chmod 0644 /tmp/somefile
fi
EOBLOCK
{% endhighlight %}
**Caveat:** The SSHKit multiline command sanitizing logic will remove line feeds and add an `;` after each line to separate the commands. So make sure you are not putting a newline between `then` and the following command.
The idiomatic way to write that command in Capistrano v3 is to use the
separated variadaric method to specify the command:
{% highlight ruby %}
# Capistrano 3.0.x
execute :git, :clone, "........", "......."
{% endhighlight %}
... or for the larger example
{% highlight ruby %}
# Capistrano 3.0.x
file = '/tmp/somefile'
unless test("-e #{file}")
execute :touch, file
end
{% endhighlight %}
In this way the *command map* is consulted, the command map maps all unknown
commands (which in this case is `git`, the rest of the line are *arguments* to
`git` ) are mapped to `/usr/bin/env ...`. Meaning that this command would be
expanded to `/usr/bin/env git clone ...... ......` which is what happens when
`git` is called without a full path, the `env` program is consulted (perhaps
indirectly) to determine which `git` to run.
Commands such as `rake` and `rails` are often better prefixed by `bundle
exec`, and in this case could be mapped to:
{% highlight ruby %}
SSHKit.config.command_map[:rake] = "bundle exec rake"
SSHKit.config.command_map[:rails] = "bundle exec rails"
{% endhighlight %}
There can also be a `lambda` or `Proc` applied in place of the mapping like so:
{% highlight ruby %}
SSHKit.config.command_map = Hash.new do |hash, key|
if %i{rails rake bundle clockwork heroku}.include?(key.to_sym)
hash[key] = "/usr/bin/env bundle exec #{key}"
else
hash[key] = "/usr/bin/env #{key}"
end
end
{% endhighlight %}
Between these two options there should be quite powerful options to map
commands in your environment without having to override internal tasks from
Capistrano just because a path is different, or a binary has a different name.
This can also be *slightly* abused in environments where *shim* executables
are used, for example `rbenv` *wrappers*:
{% highlight ruby %}
SSHKit.config.command_map = Hash.new do |hash, key|
if %i{rails rake bundle clockwork heroku}.include?(key.to_sym)
hash[key] = "/usr/bin/env myproject_bundle exec myproject_#{key}"
else
hash[key] = "/usr/bin/env #{key}"
end
end
{% endhighlight %}
The above assumes that you have done something like `rbenv wrapper default
myproject` which creates wrapper binaries which correctly set up the Ruby
environment without requiring an interactive login shell.
#### Testing
The old test suite for Capistrano was purely unit tests, and didn't cover a
wide variety of problem cases, specifically nothing in the `deploy.rb` (that is
the actual *deployment* code) was tested at all; because of having our own DSL
implementation, and other slightly odd design points, it was painful to test
the actual *recipes*.
Testing has been a focus of Capistrano v3. The *integration* test suite uses
Vagrant to boot a machine, configures certain scenarios using portable shell
script, and then executes commands against them, deploying common
configurations to typical Linux systems. This is slow to execute, but offers
stronger guarantees that nothing is broken that we've ever been able to give
before.
Capistrano v3 also offers a possibility to swap out backend implementations.
This is interesting because for the purpose of testing your *own* recipes you
can use a *printer* backend, and verify that the output matched what you
expected, or use a stubbed backend upon which you can verify that calls were
made, or not made as expected.
#### Arbitrary Logging
Capistrano exposes the methods `debug()`, `info()`, `warn()`, `error()` and
`fatal()` inside of `on()` blocks which can be used to log using the existing
logging infrastructure and streaming IO formatters:
{% highlight ruby %}
# Capistrano 3.0.x
on hosts do |host|
f = '/some/file'
if test("[ -d #{f} ]")
execute :touch, f
else
info "#{f} already exists on #{host}!"
end
end
{% endhighlight %}
### Upgrading
The best place to go here is the [upgrading documentation](/documentation/upgrading/) to get deeper
into the specifics.
The simple version is to say that there is *no **direct** upgrade path*,
versions two and three are incompatible.
This is partly by design, the old DSL was imprecise in places that would have
made doing the right thing in most cases tricky, we opted to invest in more
features and better reliability than investing in keeping a backwards
compatible API.
There are a number of *gotchas* listed below, but the main points are the new
names of the built-in roles, as well as that by default Capistrano v3 is
platform agnostic, if you need Rails support, for migrations, asset pipeline
and such like, then it's required to `require` the support files.
### Gotchas
#### Rake DSL Is Additive
In Capistrano v2 if you re-define a task then it replaces the original
implemetation, this has been used by people to replace internal tasks
piecemeal with their own implementations
#### `sudo` Behaviour

138
docs/css/capistrano.css Normal file
View File

@ -0,0 +1,138 @@
body {
font-family: "proxima-nova",sans-serif;
}
#carbonads img {
float: left;
margin-right: 1em;
}
#carbonads .carbon-text {
display: block;
font-size: 0.9em;
color: silver;
}
#carbonads .carbon-poweredby {
font-size: 0.75em;
display: block;
color: silver
}
.header {
margin-bottom: 30px;
padding-top: 20px;
background-color: #1C1B39;
min-height: 170px;
}
.harrowBanner {
overflow: hidden;
position: absolute;
top: 140px;
max-width: 650px;
left:0;
right:0;
box-shadow: 5px 5px 15px rgba(0,0,0, 0.5);
max-width: 60%;
margin: auto;
/* outline: 1px dotted pink; */
text-align: center;
background-color: rgba(28, 25, 59, 0.95);
border: 2px solid rgba(255, 255, 255, 0.75);
padding: 20px 40px;
z-index: 10000;
display: none;
}
.harrowBanner__newRibbon {
width: 200px;
background-color: #95b;
position: absolute;
top: 0px;
left: -65px;
text-align: center;
line-height: 50px;
letter-spacing: 1px;
color: #f0f0f0;
transform: rotate(-45deg);
-webkit-transform: rotate(-45deg);
box-shadow: 0 0 15px rgba(255, 255, 255, 0.3);
font-weight: bold;
}
.harrowBanner__title {
color: #fff;
}
.harrowBanner__p {
color: #fff;
}
.harrowBanner__ctaButton {
background-color: #4CC1DD;
border-radius: 3px;
font-weight: bold;
padding: 10px 20px;
color: #fff;
display: inline-block;
margin-bottom: 20px;
}
.harrowBanner__dismissLink {
color: #fff;
font-size: 75%;
display: block;
}
h1, h2, h3, h4, h5, h6 {
font-weight: 400;
font-family: 'Enriqueta', serif;
}
/*p code, li code {
padding: 3px;
background-color: #E6E6E6;
font-family: "droid-sans-mono", Consolas, Monaco, 'Andale Mono', monospace;
font-size: 0.9em;
color: #222;
border-radius: 3px;
}*/
footer {
padding: 1em;
background-color: #222;
color: #fff;
}
footer a {
color: #fff;
}
footer ul.social.icons {
list-style-type: none;
}
li {
margin-left: 2em;
}
footer ul.social.icons li {
float: left;
margin-left: 10px;
font-size: 5em;
}
.github-widget {
margin-bottom: 1em;
}
.github-box .github-box-download {
height: 44px !important;
}
/*pre code {
color: #fff;
}*/

109
docs/css/dreamweaver.css Normal file
View File

@ -0,0 +1,109 @@
/**
* Dreamweaver theme
*
* @author Sean Coker
* @url http://seancoker.com
* @version 1.0
*/
pre {
/* original is white background with no border */
background-color: #fff;
word-wrap: break-word;
margin: 0;
padding: 10px;
color: #000;
font-size: 13px;
line-height: 16px;
margin-bottom: 20px
}
pre, code {
font-family: monospace;
}
pre .comment {
color: #888;
}
pre .support {
color: #cd57d5;
}
pre .constant.numeric, pre .php.embedded {
color: #fa0002;
font-weight: bold;
}
pre .keyword, pre .constant.language {
color: #000789;
font-weight: bold;
}
pre .selector, pre .support.property, pre .entity.name.function {
color: #000;
}
pre .storage.function, pre .variable.self, pre .support.function, pre .constant.language {
color: #000;
font-weight: bold;
}
pre .string {
color: #0d43fa;
font-weight: normal;
}
pre .css-property + span, pre .keyword.unit, pre .support.css-value {
color: #0d43fa !important;
font-weight: normal !important;
}
pre .entity.tag.style + .string, pre .php.embedded .constant.language, pre .php.embedded .keyword {
color: #37a348 !important;
}
pre .support.method {
color: #2bd5bb;
}
pre .entity.name {
color: #fd74e0;
}
pre .support.css-property, pre .support.tag-name, pre .support.tag, pre .support.attribute, pre .support.attribute + .operator {
color: #000789;
}
pre .storage.module, pre .storage.class {
color: #122573;
font-weight: bold;
}
pre .css.embedded .support.tag, pre .css.embedded .style.tag {
color: #cd57d5;
}
pre .keyword.operator {
color: #2852eb;
font-weight: normal;
}
pre .php.embedded .variable, pre .php.embedded .storage.function {
color: #0d43fa;
font-weight: normal;
}
pre .php.embedded .string, pre .js.embedded .tag.script {
color: #c4001e;
}
pre .php.embedded .comment {
color: #f4b441;
font-weight: normal;
}
pre .php.embedded .function.name {
color: #000;
font-weight: normal;
}

4257
docs/css/foundation.css vendored Normal file
View File

File diff suppressed because it is too large Load Diff

1
docs/css/foundation.min.css vendored Normal file
View File

File diff suppressed because one or more lines are too long

88
docs/css/github.css Normal file
View File

@ -0,0 +1,88 @@
/**
* GitHub theme
*
* @author Craig Campbell
* @version 1.0.4
*/
pre {
border: 1px solid #ccc;
word-wrap: break-word;
padding: 6px 10px;
line-height: 19px;
margin-bottom: 20px;
}
code {
border: 1px solid #eaeaea;
margin: 0px 2px;
padding: 0px 5px;
font-size: 12px;
}
pre code {
border: 0px;
padding: 0px;
margin: 0px;
-moz-border-radius: 0px;
-webkit-border-radius: 0px;
border-radius: 0px;
}
pre, code {
font-family: Consolas, 'Liberation Mono', Courier, monospace;
color: #333;
background: #f8f8f8;
-moz-border-radius: 3px;
-webkit-border-radius: 3px;
border-radius: 3px;
}
pre, pre code {
font-size: 13px;
}
pre .comment {
color: #998;
}
pre .support {
color: #0086B3;
}
pre .tag, pre .tag-name {
color: navy;
}
pre .keyword, pre .css-property, pre .vendor-prefix, pre .sass, pre .class, pre .id, pre .css-value, pre .entity.function, pre .storage.function {
font-weight: bold;
}
pre .css-property, pre .css-value, pre .vendor-prefix, pre .support.namespace {
color: #333;
}
pre .constant.numeric, pre .keyword.unit, pre .hex-color {
font-weight: normal;
color: #099;
}
pre .entity.class {
color: #458;
}
pre .entity.id, pre .entity.function {
color: #900;
}
pre .attribute, pre .variable {
color: teal;
}
pre .string, pre .support.value {
font-weight: normal;
color: #d14;
}
pre .regexp {
color: #009926;
}

402
docs/css/normalize.css vendored Normal file
View File

@ -0,0 +1,402 @@
/*! normalize.css v2.1.1 | MIT License | git.io/normalize */
/* ==========================================================================
HTML5 display definitions
========================================================================== */
/**
* Correct `block` display not defined in IE 8/9.
*/
article,
aside,
details,
figcaption,
figure,
footer,
header,
hgroup,
main,
nav,
section,
summary {
display: block;
}
/**
* Correct `inline-block` display not defined in IE 8/9.
*/
audio,
canvas,
video {
display: inline-block;
}
/**
* Prevent modern browsers from displaying `audio` without controls.
* Remove excess height in iOS 5 devices.
*/
audio:not([controls]) {
display: none;
height: 0;
}
/**
* Address styling not present in IE 8/9.
*/
[hidden] {
display: none;
}
/* ==========================================================================
Base
========================================================================== */
/**
* 1. Prevent system color scheme's background color being used in Firefox, IE,
* and Opera.
* 2. Prevent system color scheme's text color being used in Firefox, IE, and
* Opera.
* 3. Set default font family to sans-serif.
* 4. Prevent iOS text size adjust after orientation change, without disabling
* user zoom.
*/
html {
background: #fff; /* 1 */
color: #000; /* 2 */
font-family: sans-serif; /* 3 */
-ms-text-size-adjust: 100%; /* 4 */
-webkit-text-size-adjust: 100%; /* 4 */
}
/**
* Remove default margin.
*/
body {
margin: 0;
}
/* ==========================================================================
Links
========================================================================== */
/**
* Address `outline` inconsistency between Chrome and other browsers.
*/
a:focus {
outline: thin dotted;
}
/**
* Improve readability when focused and also mouse hovered in all browsers.
*/
a:active,
a:hover {
outline: 0;
}
/* ==========================================================================
Typography
========================================================================== */
/**
* Address variable `h1` font-size and margin within `section` and `article`
* contexts in Firefox 4+, Safari 5, and Chrome.
*/
h1 {
font-size: 2em;
margin: 0.67em 0;
}
/**
* Address styling not present in IE 8/9, Safari 5, and Chrome.
*/
abbr[title] {
border-bottom: 1px dotted;
}
/**
* Address style set to `bolder` in Firefox 4+, Safari 5, and Chrome.
*/
b,
strong {
font-weight: bold;
}
/**
* Address styling not present in Safari 5 and Chrome.
*/
dfn {
font-style: italic;
}
/**
* Address differences between Firefox and other browsers.
*/
hr {
-moz-box-sizing: content-box;
box-sizing: content-box;
height: 0;
}
/**
* Address styling not present in IE 8/9.
*/
mark {
background: #ff0;
color: #000;
}
/**
* Correct font family set oddly in Safari 5 and Chrome.
*/
code,
kbd,
pre,
samp {
font-family: monospace, serif;
font-size: 1em;
}
/**
* Improve readability of pre-formatted text in all browsers.
*/
pre {
white-space: pre-wrap;
}
/**
* Set consistent quote types.
*/
q {
quotes: "\201C" "\201D" "\2018" "\2019";
}
/**
* Address inconsistent and variable font size in all browsers.
*/
small {
font-size: 80%;
}
/**
* Prevent `sub` and `sup` affecting `line-height` in all browsers.
*/
sub,
sup {
font-size: 75%;
line-height: 0;
position: relative;
vertical-align: baseline;
}
sup {
top: -0.5em;
}
sub {
bottom: -0.25em;
}
/* ==========================================================================
Embedded content
========================================================================== */
/**
* Remove border when inside `a` element in IE 8/9.
*/
img {
border: 0;
}
/**
* Correct overflow displayed oddly in IE 9.
*/
svg:not(:root) {
overflow: hidden;
}
/* ==========================================================================
Figures
========================================================================== */
/**
* Address margin not present in IE 8/9 and Safari 5.
*/
figure {
margin: 0;
}
/* ==========================================================================
Forms
========================================================================== */
/**
* Define consistent border, margin, and padding.
*/
fieldset {
border: 1px solid #c0c0c0;
margin: 0 2px;
padding: 0.35em 0.625em 0.75em;
}
/**
* 1. Correct `color` not being inherited in IE 8/9.
* 2. Remove padding so people aren't caught out if they zero out fieldsets.
*/
legend {
border: 0; /* 1 */
padding: 0; /* 2 */
}
/**
* 1. Correct font family not being inherited in all browsers.
* 2. Correct font size not being inherited in all browsers.
* 3. Address margins set differently in Firefox 4+, Safari 5, and Chrome.
*/
button,
input,
select,
textarea {
font-family: inherit; /* 1 */
font-size: 100%; /* 2 */
margin: 0; /* 3 */
}
/**
* Address Firefox 4+ setting `line-height` on `input` using `!important` in
* the UA stylesheet.
*/
button,
input {
line-height: normal;
}
/**
* Address inconsistent `text-transform` inheritance for `button` and `select`.
* All other form control elements do not inherit `text-transform` values.
* Correct `button` style inheritance in Chrome, Safari 5+, and IE 8+.
* Correct `select` style inheritance in Firefox 4+ and Opera.
*/
button,
select {
text-transform: none;
}
/**
* 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
* and `video` controls.
* 2. Correct inability to style clickable `input` types in iOS.
* 3. Improve usability and consistency of cursor style between image-type
* `input` and others.
*/
button,
html input[type="button"], /* 1 */
input[type="reset"],
input[type="submit"] {
-webkit-appearance: button; /* 2 */
cursor: pointer; /* 3 */
}
/**
* Re-set default cursor for disabled elements.
*/
button[disabled],
html input[disabled] {
cursor: default;
}
/**
* 1. Address box sizing set to `content-box` in IE 8/9.
* 2. Remove excess padding in IE 8/9.
*/
input[type="checkbox"],
input[type="radio"] {
box-sizing: border-box; /* 1 */
padding: 0; /* 2 */
}
/**
* 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome.
* 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome
* (include `-moz` to future-proof).
*/
input[type="search"] {
-webkit-appearance: textfield; /* 1 */
-moz-box-sizing: content-box;
-webkit-box-sizing: content-box; /* 2 */
box-sizing: content-box;
}
/**
* Remove inner padding and search cancel button in Safari 5 and Chrome
* on OS X.
*/
input[type="search"]::-webkit-search-cancel-button,
input[type="search"]::-webkit-search-decoration {
-webkit-appearance: none;
}
/**
* Remove inner padding and border in Firefox 4+.
*/
button::-moz-focus-inner,
input::-moz-focus-inner {
border: 0;
padding: 0;
}
/**
* 1. Remove default vertical scrollbar in IE 8/9.
* 2. Improve readability and alignment in all browsers.
*/
textarea {
overflow: auto; /* 1 */
vertical-align: top; /* 2 */
}
/* ==========================================================================
Tables
========================================================================== */
/**
* Remove most spacing between table cells.
*/
table {
border-collapse: collapse;
border-spacing: 0;
}

109
docs/css/okaidia.css Normal file
View File

@ -0,0 +1,109 @@
/**
* okaidia theme for JavaScript, CSS and HTML
* Loosely based on Monokai textmate theme by http://www.monokai.nl/
* @author ocodia
*/
code[class*="language-"],
pre[class*="language-"] {
color: #f8f8f2;
font-size: 0.9em;
text-shadow: 0px 1px rgba(0,0,0,0.3);
font-family: "droid-sans-mono", Consolas, Monaco, 'Andale Mono', monospace;
direction: ltr;
text-align: left;
white-space: pre;
word-spacing: normal;
-moz-tab-size: 4;
-o-tab-size: 4;
tab-size: 4;
-webkit-hyphens: none;
-moz-hyphens: none;
-ms-hyphens: none;
hyphens: none;
}
/* Code blocks */
pre[class*="language-"] {
padding: 1em;
margin: .5em 0;
overflow: auto;
}
:not(pre) > code[class*="language-"],
pre[class*="language-"] {
background: #272822;
}
/* Inline code */
:not(pre) > code[class*="language-"] {
padding: .1em;
border-radius: .3em;
}
.token.comment,
.token.prolog,
.token.doctype,
.token.cdata {
color: slategray;
}
.token.punctuation {
color: #f8f8f2;
}
.namespace {
opacity: .7;
}
.token.property,
.token.tag {
color: #f92672;
}
.token.boolean,
.token.number{
color: #ae81ff;
}
.token.symbol,
.token.selector,
.token.attr-name,
.token.string {
color: #a6e22e;
}
.token.operator,
.token.entity,
.token.url,
.language-css .token.string,
.style .token.string {
color: #f8f8f2;
}
.token.atrule,
.token.attr-value
{
color: #e6db74;
}
.token.keyword{
color: #f92672;
}
.token.regex,
.token.important {
color: #fd971f;
}
.token.important {
font-weight: bold;
}
.token.entity {
cursor: help;
}

117
docs/css/prism.css Normal file
View File

@ -0,0 +1,117 @@
/**
* prism.js default theme for JavaScript, CSS and HTML
* Based on dabblet (http://dabblet.com)
* @author Lea Verou
*/
code[class*="language-"],
pre[class*="language-"] {
color: black;
text-shadow: 0 1px white;
font-family: Consolas, Monaco, 'Andale Mono', monospace;
direction: ltr;
text-align: left;
white-space: pre;
word-spacing: normal;
-moz-tab-size: 4;
-o-tab-size: 4;
tab-size: 4;
-webkit-hyphens: none;
-moz-hyphens: none;
-ms-hyphens: none;
hyphens: none;
}
::-moz-selection {
text-shadow: none;
background: #b3d4fc;
}
::selection {
text-shadow: none;
background: #b3d4fc;
}
@media print {
code[class*="language-"],
pre[class*="language-"] {
text-shadow: none;
}
}
/* Code blocks */
pre[class*="language-"] {
padding: 1em;
margin: .5em 0;
overflow: auto;
}
:not(pre) > code[class*="language-"],
pre[class*="language-"] {
background: #f5f2f0;
}
/* Inline code */
:not(pre) > code[class*="language-"] {
padding: .1em;
border-radius: .3em;
}
.token.comment,
.token.prolog,
.token.doctype,
.token.cdata {
color: slategray;
}
.token.punctuation {
color: #999;
}
.namespace {
opacity: .7;
}
.token.property,
.token.tag,
.token.boolean,
.token.number {
color: #905;
}
.token.selector,
.token.attr-name,
.token.string {
color: #690;
}
.token.operator,
.token.entity,
.token.url,
.language-css .token.string,
.style .token.string {
color: #a67f59;
background: hsla(0,0%,100%,.5);
}
.token.atrule,
.token.attr-value,
.token.keyword {
color: #07a;
}
.token.regex,
.token.important {
color: #e90;
}
.token.important {
font-weight: bold;
}
.token.entity {
cursor: help;
}

148
docs/css/social_foundicons.css Executable file
View File

@ -0,0 +1,148 @@
/* font-face */
@font-face {
font-family: "SocialFoundicons";
src: url("../fonts/social_foundicons.eot");
src: url("../fonts/social_foundicons.eot?#iefix") format("embedded-opentype"), url("../fonts/social_foundicons.woff") format("woff"), url("../fonts/social_foundicons.ttf") format("truetype"), url("../fonts/social_foundicons.svg#SocialFoundicons") format("svg");
font-weight: normal;
font-style: normal;
}
/* global foundicon styles */
[class*="foundicon-"] {
display: inline;
width: auto;
height: auto;
line-height: inherit;
vertical-align: baseline;
background-image: none;
background-position: 0 0;
background-repeat: repeat;
}
[class*="foundicon-"]:before {
font-family: "SocialFoundicons";
font-weight: normal;
font-style: normal;
text-decoration: inherit;
}
/* icons */
.foundicon-thumb-up:before {
content: "\f000";
}
.foundicon-thumb-down:before {
content: "\f001";
}
.foundicon-rss:before {
content: "\f002";
}
.foundicon-facebook:before {
content: "\f003";
}
.foundicon-twitter:before {
content: "\f004";
}
.foundicon-pinterest:before {
content: "\f005";
}
.foundicon-github:before {
content: "\f006";
}
.foundicon-path:before {
content: "\f007";
}
.foundicon-linkedin:before {
content: "\f008";
}
.foundicon-dribbble:before {
content: "\f009";
}
.foundicon-stumble-upon:before {
content: "\f00a";
}
.foundicon-behance:before {
content: "\f00b";
}
.foundicon-reddit:before {
content: "\f00c";
}
.foundicon-google-plus:before {
content: "\f00d";
}
.foundicon-youtube:before {
content: "\f00e";
}
.foundicon-vimeo:before {
content: "\f00f";
}
.foundicon-flickr:before {
content: "\f010";
}
.foundicon-slideshare:before {
content: "\f011";
}
.foundicon-picassa:before {
content: "\f012";
}
.foundicon-skype:before {
content: "\f013";
}
.foundicon-steam:before {
content: "\f014";
}
.foundicon-instagram:before {
content: "\f015";
}
.foundicon-foursquare:before {
content: "\f016";
}
.foundicon-delicious:before {
content: "\f017";
}
.foundicon-chat:before {
content: "\f018";
}
.foundicon-torso:before {
content: "\f019";
}
.foundicon-tumblr:before {
content: "\f01a";
}
.foundicon-video-chat:before {
content: "\f01b";
}
.foundicon-digg:before {
content: "\f01c";
}
.foundicon-wordpress:before {
content: "\f01d";
}

126
docs/css/social_foundicons_ie7.css Normal file
View File

@ -0,0 +1,126 @@
/* general icons for IE7 */
[class*="foundicon-"] {
font-family: "SocialFoundicons";
font-weight: normal;
font-style: normal;
}
.foundicon-thumb-up {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf000;");
}
.foundicon-thumb-down {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf001;");
}
.foundicon-rss {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf002;");
}
.foundicon-facebook {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf003;");
}
.foundicon-twitter {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf004;");
}
.foundicon-pinterest {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf005;");
}
.foundicon-github {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf006;");
}
.foundicon-path {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf007;");
}
.foundicon-linkedin {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf008;");
}
.foundicon-dribbble {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf009;");
}
.foundicon-stumble-upon {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf00a;");
}
.foundicon-behance {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf00b;");
}
.foundicon-reddit {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf00c;");
}
.foundicon-google-plus {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf00d;");
}
.foundicon-youtube {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf00e;");
}
.foundicon-vimeo {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf00f;");
}
.foundicon-flickr {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf010;");
}
.foundicon-slideshare {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf011;");
}
.foundicon-picassa {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf012;");
}
.foundicon-skype {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf013;");
}
.foundicon-steam {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf014;");
}
.foundicon-instagram {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf015;");
}
.foundicon-foursquare {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf016;");
}
.foundicon-delicious {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf017;");
}
.foundicon-chat {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf018;");
}
.foundicon-torso {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf019;");
}
.foundicon-tumblr {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf01a;");
}
.foundicon-video-chat {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf01b;");
}
.foundicon-digg {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf01c;");
}
.foundicon-wordpress {
*zoom: expression(this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf01d;");
}

60
docs/css/syntax.css Normal file
View File

@ -0,0 +1,60 @@
.highlight { background: #ffffff; padding: 10px; }
.highlight .c { color: #999988; font-style: italic } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { font-weight: bold } /* Keyword */
.highlight .o { font-weight: bold } /* Operator */
.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #999999 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #aaaaaa } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { font-weight: bold } /* Keyword.Constant */
.highlight .kd { font-weight: bold } /* Keyword.Declaration */
.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
.highlight .kr { font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #009999 } /* Literal.Number */
.highlight .s { color: #d14 } /* Literal.String */
.highlight .na { color: #008080 } /* Name.Attribute */
.highlight .nb { color: #0086B3 } /* Name.Builtin */
.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
.highlight .no { color: #008080 } /* Name.Constant */
.highlight .ni { color: #800080 } /* Name.Entity */
.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
.highlight .nn { color: #555555 } /* Name.Namespace */
.highlight .nt { color: #000080 } /* Name.Tag */
.highlight .nv { color: #008080 } /* Name.Variable */
.highlight .ow { font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mf { color: #009999 } /* Literal.Number.Float */
.highlight .mh { color: #009999 } /* Literal.Number.Hex */
.highlight .mi { color: #009999 } /* Literal.Number.Integer */
.highlight .mo { color: #009999 } /* Literal.Number.Oct */
.highlight .sb { color: #d14 } /* Literal.String.Backtick */
.highlight .sc { color: #d14 } /* Literal.String.Char */
.highlight .sd { color: #d14 } /* Literal.String.Doc */
.highlight .s2 { color: #d14 } /* Literal.String.Double */
.highlight .se { color: #d14 } /* Literal.String.Escape */
.highlight .sh { color: #d14 } /* Literal.String.Heredoc */
.highlight .si { color: #d14 } /* Literal.String.Interpol */
.highlight .sx { color: #d14 } /* Literal.String.Other */
.highlight .sr { color: #009926 } /* Literal.String.Regex */
.highlight .s1 { color: #d14 } /* Literal.String.Single */
.highlight .ss { color: #990073 } /* Literal.String.Symbol */
.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
.highlight .vc { color: #008080 } /* Name.Variable.Class */
.highlight .vg { color: #008080 } /* Name.Variable.Global */
.highlight .vi { color: #008080 } /* Name.Variable.Instance */
.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */

33
docs/documentation/advanced-features/console/index.markdown Normal file
View File

@ -0,0 +1,33 @@
---
title: Console
layout: default
---
**Note:** Here be dragons. The console is very immature, but it's much more
cleanly architected than previous incarnations and it'll only get better from
here on in.
Execute arbitrary remote commands, to use this simply add
`require 'capistrano/console'` which will add the necessary tasks to your
environment:
```bash
$ bundle exec cap staging console
```
Then, after setting up the server connections, this is how that might look:
```bash
$ bundle exec cap production console
capistrano console - enter command to execute on production
production> uptime
INFO [94db8027] Running /usr/bin/env uptime on leehambley@example.com:22
DEBUG [94db8027] Command: /usr/bin/env uptime
DEBUG [94db8027] 17:11:17 up 50 days, 22:31, 1 user, load average: 0.02, 0.02, 0.05
INFO [94db8027] Finished in 0.435 seconds command successful.
production> who
INFO [9ce34809] Running /usr/bin/env who on leehambley@example.com:22
DEBUG [9ce34809] Command: /usr/bin/env who
DEBUG [9ce34809] leehambley pts/0 2013-06-13 17:11 (port-11262.pppoe.wtnet.de)
INFO [9ce34809] Finished in 0.420 seconds command successful.
```

62
docs/documentation/advanced-features/filtering/index.markdown Normal file
View File

@ -0,0 +1,62 @@
---
title: Filtering
layout: default
---
Filtering is the term given to reducing the entire set of servers declared in a stage file
to a smaller set. There are three types of filters used in Capistrano (Host, Role and
Property) and they take effect in two quite different ways because of the two distinct
uses to which the declarations of servers, roles and properties are put in tasks:
* To determine _configurations_: typically by using the `roles()`, `release_roles()` and
`primary()` methods. Typically these are used outside the scope of the `on()` method.
* To _interact_ with remote hosts using the `on()` method
An illustration of this would be to create a `/etc/krb5.conf` file containing the list of
available KDC's by using the list of servers returned by `roles(:kdc)` and then uploading
it to all client machines using `on(roles(:all)) do upload!(file) end`
A problem with this arises when _filters_ are used. Filters are designed to limit the
actual set of hosts that are used to a subset of those in the overall stage, but how
should that apply in the above case?
If the filter applies to both the _interaction_ and _configuration_ aspects, any configuration
files deployed will not be the same as those on the hosts excluded by the filters. This is
almost certainly not what is wanted, the filters should apply only to the _interactions_
ensuring that any configuration files deployed will be identical across the stage.
So we define two different categories of filter, the interaction ones which are called _On-Filters_
and the configuration ones which are _Property-Filters_
### On-Filtering
On-filters apply only to the `on()` method that invokes SSH. There are two types:
* [Host Filters](/documentation/advanced-features/host-filtering/), and
* [Role Filters](/documentation/advanced-features/role-filtering/)
In both the above cases, when filters are specified using comma separated lists, the final
filter is the _union_ of all of the components. However when multiple filters are declared
the result is the _intersection_.
This means that you can filter by both role and host but you will get the _intersection_
of the servers. For example, lets say you filtered by the role `app`, then by
the hostnames `server1` and `server2`. Capistrano would first filter the
available servers to only those with the role `app`, then filter them
to look for servers with the hostname `server1` or `server2`. If only `server2`
had the role `app` (`server1` has some other role), then in this situation your
task would only run on `server2`.
### Property-Filtering
Property-filters select servers based on the value of their properties alone and
are specified by options passed to the `roles()` method (and implicitly in methods
like `release_roles()` and `primary()`)
An example of that is the 'no_release' property and it's use in the `release_roles()` method.
See the [documentation](/documentation/advanced-features/property-filtering/) for
details

71
docs/documentation/advanced-features/host-filtering/index.markdown Normal file
View File

@ -0,0 +1,71 @@
---
title: Host filtering
layout: default
---
You may encounter situations where you only want to deploy to a subset of
the servers defined in your configuration. For example, a single server or
set of servers may be misbehaving, and you want to re-deploy to just these
servers without deploying to every server.
You can use the *host filter* to restrict Capistrano tasks to only servers
that match a given set of hostnames.
If the filter matches no servers, no actions will be taken.
If you specify a filter, it will match servers that have the listed hostnames,
and it will run *all* the roles for each server. In other words, it only affects
the servers the task runs on, not what tasks are run on a server.
### Specifying a host filter
There are three ways to specify the host filter.
#### Environment variable
Capistrano will read the host filter from the environment variable `HOSTS`
if it is set. You can set it inline:
```bash
HOSTS=server1,server2 cap production deploy
```
Specify multiple hosts by separating them with a comma.
#### In configuration
You can set the host filter inside your deploy configuration. For example,
you can set the following inside `config/deploy.rb`:
```ruby
set :filter, :hosts => %w{server1 server2}
```
Note that you specify the filter as an array rather than as a comma-separated
list of servers when using this method.
Note that the keyname `:host` is also supported.
#### On the command line
In a similar way to using the environment variable, you can set the role
filter by specifying it as a command line argument to `cap`:
```bash
cap --hosts=server1,server2 production deploy
```
Like the environment variable method, specify multiple servers by separating
them with a comma.
### Using Regular Expressions
If the host name in a filter doesn't match the set of valid characters for a DNS name
(Given by the regular expression `/^[-A-Za-z0-9.]+$/`) then it's assumed to be a regular
expression in standard Ruby syntax.
For example, if you had three servers named localrubyserver1, localrubyserver2, and amazonrubyserver1, but only wanted to deploy to localrubyserver*, you call Capistrano with a regex:
```bash
cap --hosts=^localrubyserver production deploy
```

15
docs/documentation/advanced-features/ignoring/index.markdown Normal file
View File

@ -0,0 +1,15 @@
---
title: Ignoring
layout: default
---
Files commited to version control (i.e. not in .gitignore) can still be ignored when deploying. To ignore these files or directories, simply add them to .gitattributes:
```bash
config/deploy/deploy.rb export-ignore
config/deploy/ export-ignore
```
These files will be kept in version control but not deployed to the server.
*Note:* This feature is probably unnecessary unless the root of your repository is also your web server's docroot. For example, in a Rails application, the docroot is the `public/` folder. Since all of the Capistrano configuration lives above or beside this folder, it cannot be served and is not a security risk. If the docroot is indeed at the base of the repository, consider changing that by moving the code at the repository base to a subdirectory such as public_html instead of using this feature. Note that this feature is very specific to Git and will not work on other SCMs.

70
docs/documentation/advanced-features/overriding-capistrano-tasks/index.markdown Normal file
View File

@ -0,0 +1,70 @@
---
title: Overriding Capistrano tasks
layout: default
---
When re-defining a task in Capistrano v2, the original task was replaced. The
Rake DSL on which Capistrano v3 is built is additive however, which means that
given the following definitions
```ruby
task :foo do
puts "foo"
end
task :foo do
puts "bar"
end
```
Will print both `foo` and `bar`.
But it is also possible to completely clear a task and then re-defining it
from scratch. A `Rake::Task` provides the `clear` method for this, which
internally performs three separate actions:
- `clear_prerequisites`
- `clear_actions`
- `clear_comments`
Clearing the prerequisites (i.e. any dependencies that may have been defined
for a task) is probably not what you want, though. Let's say, for example,
that you want to re-define the `deploy:revert_release` task, which is defined
as follows:
```ruby
task :revert_release => :rollback_release_path do
# ...
end
```
Calling `clear` on this task and then re-defining it results in
`rollback_release_path` never being called, thus breaking rollback behavior.
Under most circumstances, you will simply want to use `clear_actions`, which
removes the specified task's behaviour, but does not alter it's dependencies
or comments:
```ruby
task :init do
puts "init"
end
task :foo => :init do
puts "foo"
end
Rake::Task["foo"].clear_actions
task :foo do
puts "bar"
end
```
Running the `foo` task will print
```ruby
init
bar
```
---

210
docs/documentation/advanced-features/properties/index.markdown Normal file
View File

@ -0,0 +1,210 @@
---
title: Properties
layout: default
---
Server objects in Capistrano essentially consist of a name and a hash: The name is the DNS
name (or IP address) and the hash contains the 'Properties' of the server. These
properties are of two sorts: ones required by Capistrano (_Capistrano Properties_) and
ones available for use by the Application (_Custom Properties_). These share the same
namespace (there is only one underlying hash!) so the names of custom properties are
restricted.
### Capistrano Properties
The Capistrano properties are those used to SSH into the server and those that support the
basic _role_ functionality. These are:
* `:user` - the name of the SSH user for the server
* `:password` - for the SSH user
* `:port` - the port number of the SSH daemon on the server
* `:roles` - an array of rolenames
* `:ssh_options` - a hash of SSH parameters (see below)
* `:primary` - a boolean that indicates whether the server should be considered primary or
not.
The `:user`, `:port` and `:password` may be specified as follows:
* As part of the hostname in the form 'user@host:port' without a password,
* In the properties `:user`, `:password` and `:port`, and
* In the property `:ssh_options` (with the same keys)
#### Precedence
The SSH related properties are set with the following precedence, beginning with the
highest:
* Property declarations on the server or role. The last property declaration overrides all
the previous server or role declarations
* Values specified in the hostname string
* Values in the server or role `:ssh_options` property
* The stage global variable `:ssh_options`
* The SSHKit backend `ssh_options`
* The settings in your local `~/.ssh/config` file
Note however that defaults taken from these places will _not_ be reflected back into the
server properties, so `host.user` will be nil if a lower precedence default is being used.
### Custom Properties
When using Capistrano as a general purpose deployment framework (above and beyond it's
traditional use for Rails deployments) it becomes important to be able to store additional
parameters. You can think of Capistrano as an _MVC_ framework for deployments, where the
stage file (representing all the relationships between application components) is the
_Model_, the tasks (enabling model changes to be actioned) are the _Controllers_, and the
actual physical embodiments (typically configuration files on running servers) are the
_Views_.
### Property Access from within Tasks
The properties on Capistrano server are accessible programmatically from a Capistrano
task. _Capistrano_ properties are available through methods on the host object itself and
_Custom_ properties via methods on the `properties` attribute of the host.
These methods have the expected names: `user`, `port` and so on. An exception is the
`ssh_config` which is available via the `netssh_options` method.
The following feature is new in Capistrano 3.3.6 and above.
Within the scope of an `on()` block, the host that is yielded is a *copy* of the underlying
host, which allows you to temporarily override any of the properties by calling the setter
method. An example is:
```ruby
on roles(:all) do |host|
host.user = 'root'
host.password = 'supersecret'
execute :yum, 'makecache'
end
```
This temporarily sets the SSH user to 'root' (with an appropriate password) without
affecting the SSH user defined for the server in the configuration.
### Property setting in Complex Configurations
As configurations involve more servers it helps to be able to define a set of
properties at the role level, and have those be overridden by a later definition at the
server level. This keeps your configuration as DRY as possible. A typical requirement is
defining a set of Redis servers which all have the same port parameter and are all slaves
except for one which is the master.
To allow this properties can be set at both the _Server_ and _Role_ level. The guiding
principle is that the properties are _merged_ and that __the last definition wins__.
In practice we finesse this slightly depending on the type of the properties value:
* _scalar_ values will be overridden
* _hash_ values will have their keys merged with duplicate keys taking on
the value of the last one.
* _array_ values will have subsequent entries appended to the array
#### Example of Server and Role Properties
The above Redis requirement can be met using the following declarations in the stage file:
```ruby
role :redis, %w{ r1.example.com r2.example.com r3.example.com }, redis: { port: 6379, master: false },
server 'r1.example.com', redis: { port: 6380, master: true }
```
#### Conventions for Role Properties
This is complicated by the fact that a single machine may serve multiple roles, and in
fact a single machine may need to do the same role twice! An example of this might be in a
development situation where you want a single machine to be the database server, a primary
Redis server and a slave Redis server.
To solve this problem we adopt a convention for the use of server properties:
* Server properties for a given role should be stored with the keyname equal to the role.
The contents of the property can be a scalar, array or hash.
* Multiple occurrences of a role on the same server should have the contents be an array,
in which the successive elements denote each instance.
The following example shows a configuration with multiple Redis and Sentinel roles on the
same server:
```ruby
server 'dev.local', roles: %w{db web redis sentinel worker}, primary: true,
redis: [ { name: 'resque', port: 6379, db: 0, downtime: 10, master: true },
{ name: 'resque', port: 6380, db: 0, downtime: 10 } ],
sentinel: [ { port: 26379 }, { port: 26380 }, { port: 26381 } ]
```
These properties can be accessed in the ordinary way, but to assist in obtaining them you
can use the `role_properties()` function (see below).
## Setting Properties
Properties can be set at both the role and server levels.
### Role Properties
The declaration of a role takes an array of server names and a trailing hash of
properties. By convention the first server in a role declaration is taken to be the
primary, but the `:primary` property will not actually be set in such a case.
### Server Properties
The declaration of a server takes the name of a server and a trailing hash of properties.
One of those properties must be `:role` and have a value which is an array of role names.
### Accessing Properties
#### The `roles()` Method
The `roles()` method takes one or more role names (or an array of roles) followed by an
optional [Property Filter](/documentation/advanced-features/property-filtering)) and
returns an array of `Capistrano::Configuration::Server` objects that belong to those
roles. These have the following useful attributes:
* `hostname` - a String
* `properties.keys` - the names of the available properties
* `properties` - a hash-like object that stores the properties.
It uses Ruby's 'method_missing' to provide a method for each valid key.
* `roles` - a Set of role names as symbols
The servers retrieved by this method are NOT filtered by any host or role filters.
#### The `role_properties()` Method
This takes a list of roles (followed by an optional [Property
Filter](/documentation/advanced-features/property-filtering)) and returns an array of
hashes containing the properties with the keys `:hostname` and `:role` added:
```ruby
task :props do
rps = role_properties(:redis, :sentinel)
rps.each do |props|
puts props.inspect
end
end
# Produces...
{:name=>"resque", :port=>6379, :db=>0, :downtime=>10, :master=>true, :role=>:redis, :hostname=>"dev.local"}
{:name=>"resque", :port=>6380, :db=>0, :downtime=>10, :role=>:redis, :hostname=>"dev.local"}
{:port=>26379, :role=>:sentinel, :hostname=>"dev.local"}
{:port=>26380, :role=>:sentinel, :hostname=>"dev.local"}
{:port=>26381, :role=>:sentinel, :hostname=>"dev.local"}
```
Alternatively you can supply a block and it will yield the hostname, role and properties:
```ruby
task :props_block do
role_properties(:sentinel) do |hostname, role, props|
puts "Host: #{hostname}, Role: #{role}, #{props.inspect}"
end
end
# Produces...
Host: dev.local, Role: sentinel, {:port=>26379}
Host: dev.local, Role: sentinel, {:port=>26380}
Host: dev.local, Role: sentinel, {:port=>26381}
```
Note that unlike `on()` this function doesn't cause any remote execution to occur, it is purely for
configuration purposes.

57
docs/documentation/advanced-features/property-filtering/index.markdown Normal file
View File

@ -0,0 +1,57 @@
---
title: Property Filtering
layout: default
---
Options may be passed to the `roles()` method (and implicitly in methods like
`release_roles()` and `primary()`) that affect the set of servers returned. These options
take the form of a Hash passed as the last parameter. Each of the key/value pairs in the
hash are evaluated in the sequence they are declared and if all are true for a specific
server then the server will be returned. The keys must always be symbols which have the
following meaning:
* `:filter`, or `:select`: The value is either a property keyname or a lambda which is
called with the server as parameter. The value must return true for the server to be
included.
* `:exclude`: As above but the value must return false for the server to be included.
* Any other symbol is taken as a server property name whose value must equal the given value.
A lambda will not be called if one is supplied!
### Examples
```ruby
server 'example1.com', roles: %w{web}, active: true
server 'example2.com', roles: %w{web}
server 'example3.com', roles: %w{app web}, active: true
server 'example4.com', roles: %w{app}, primary: true
server 'example5.com', roles: %w{db}, no_release: true, active:true
task :demo do
puts "All active release roles: 1,3"
release_roles(:all, filter: :active).each do |r|
puts "#{r.hostname}"
end
puts "All active roles: 1,3,5"
roles(:all, active: true).each do |r|
puts "#{r.hostname}"
end
puts "All web and db roles with selected names: 2,3"
roles(:web, :db, select: ->(s){ s.hostname =~ /[234]/}).each do |r|
puts "#{r.hostname}"
end
puts "All with no active property: 2,4"
roles(:all, active: nil).each do |r|
puts "#{r.hostname}"
end
puts "All except active: 2,4"
roles(:all, exclude: :active).each do |r|
puts "#{r.hostname}"
end
puts "All primary: 4"
roles(:all, select: :primary).each do |r|
puts "#{r.hostname}"
end
end
```

27
docs/documentation/advanced-features/ptys/index.markdown Normal file
View File

@ -0,0 +1,27 @@
---
title: PTYs
layout: default
---
There is a configuration option which asks the backend driver to ask the
remote host to assign the connection a *pty*. A *pty* is a pseudo-terminal,
which in effect means *tell the backend that this is an __interactive__
session*. This is normally a bad idea.
Most of the differences are best explained by [this
page](https://github.com/sstephenson/rbenv/wiki/Unix-shell-initialization)
from the author of *rbenv*.
**When Capistrano makes a connection it is a *non-login*, *non-interactive*
shell. This was not an accident!**
It's often used as a band aid to cure issues related to RVM and rbenv not
loading login and shell initialisation scripts. In these scenarios RVM and
rbenv are the tools at fault, or at least they are being used incorrectly.
Whilst, especially in the case of language runtimes (Ruby, Node, Python and
friends in particular) there is a temptation to run multiple versions in
parallel on a single server and to switch between them using environmental
variables, this is an anti-pattern, and symptomatic of bad design (e.g. you're
testing a second version of Ruby in production because your company lacks the
infrastructure to test this in a staging environment).

25
docs/documentation/advanced-features/remote-file/index.markdown Normal file
View File

@ -0,0 +1,25 @@
---
title: Remote file task
layout: default
---
**Warning: `remote_file` is deprecated and will be removed in Capistrano 3.7.0**
The `remote_file` task is allowing the existence of a remote file to be set as a prerequisite. These tasks can in turn depend on local files if required. In this implementation, the fact that we're dealing with a file in the shared path is assumed.
As an example, this task can be used to ensure that files to be linked exist
before running the check:linked_files task:
```ruby
namespace :deploy do
namespace :check do
task :linked_files => 'config/newrelic.yml'
end
end
remote_file 'config/newrelic.yml' => '/tmp/newrelic.yml', roles: :app
file '/tmp/newrelic.yml' do |t|
sh "curl -o #{t.name} https://rpm.newrelic.com/accounts/xx/newrelic.yml"
end
```

68
docs/documentation/advanced-features/role-filtering/index.markdown Normal file
View File

@ -0,0 +1,68 @@
---
title: Role filtering
layout: default
---
You may have situations where you only want to deploy to servers matching
a single role. For example, you may have changed some aspect of how the web
role works, but don't want to trigger a deployment to your database servers.
You can use the *role filter* to restrict Capistrano tasks to only servers
match a given role or roles.
If the filter matches no servers, no actions will be taken.
If you specify a filter, it will match any servers that have that role, but
it will _only_ run the tasks for that role, not for any other roles that
server may have. For example, if you filtered for servers with the `web` role,
and a server had both the `web` and `db` role, only the `web` role would
be executed on it.
### Specifying a role filter
There are three ways to specify the role filter.
#### Environment variable
Capistrano will read the role filter from the environment variable `ROLES`
if it is set. You can set it inline:
```bash
ROLES=app,web cap production deploy
```
Specify multiple roles by separating them with a comma.
#### In configuration
You can set the role filter inside your deploy configuration. For example,
you can set the following inside `config/deploy.rb`:
```ruby
set :filter, :roles => %w{app web}
```
Note that you specify the filter as an array rather than as a comma-separated
list of roles when using this method.
Note that the keyname `:role` is also supported.
#### On the command line
In a similar way to using the environment variable, you can set the role
filter by specifying it as a command line argument to `cap`:
```bash
cap --roles=app,web production deploy
```
Like the environment variable method, specify multiple roles by separating them
with a comma.
### Using Regular Expressions
Since role names are Ruby symbols they can legitimately contain any characters. However to
allow multiple of them to be specified on one line we use the comma as a separator.
To use a regular expression for a role filter begin and end the string with '/'. Because
of the above these regular expressions may not contain a comma.

30
docs/documentation/advanced-features/ssh-kit/index.markdown Normal file
View File

@ -0,0 +1,30 @@
---
title: Remote commands with SSH Kit
layout: default
---
Capistrano executes commands on remote servers using [**SSHKit**](https://github.com/capistrano/sshkit).
An example setting a working directory, user and environment variable:
```ruby
on roles(:app), in: :sequence, wait: 5 do
within "/opt/sites/example.com" do
# commands in this block execute in the
# directory: /opt/sites/example.com
as :deploy do
# commands in this block execute as the "deploy" user.
with rails_env: :production do
# commands in this block execute with the environment
# variable RAILS_ENV=production
rake "assets:precompile"
runner "S3::Sync.notify"
end
end
end
end
```
For more examples, see the EXAMPLES.md file in the [**SSHKit**](https://github.com/capistrano/sshkit) project:
[https://github.com/capistrano/sshkit/blob/master/EXAMPLES.md](https://github.com/capistrano/sshkit/blob/master/EXAMPLES.md)

16
docs/documentation/advanced-features/validation-of-variables/index.markdown Normal file
View File

@ -0,0 +1,16 @@
---
layout: default
title: Validation of variables
---
To validate a variable, each time before it is set, define a validation:
```ruby
validate :some_key do |key, value|
if value.length < 5
raise Capistrano::ValidationError, "Length of #{key} is too short!"
end
end
```
Multiple validations can be assigned to a single key. Validations will be executed in the order of registration.

51
docs/documentation/faq/how-can-i-access-stage-configuration-variables/index.markdown Normal file
View File

@ -0,0 +1,51 @@
---
title: How can I access stage configuration variables?
layout: default
---
Configuration variables are access with the fetch method, like so:
```ruby
local = fetch(:configuration_variable, _default_value_)
```
This works fine when accessing configuration variables defined within the same file. For example accessing a previously set configuration variable defined in deploy.rb or accessing a set configuration variable in a stage file.
The deploy.rb configuration is executed first and then the stage file(s) from config/deploy/*.rb are executed next. This means that the configuration variables set in deploy.rb are available to the stage files, but configuration variables created in a stage file are not available in deploy.rb. To access them they must be lazily loaded in deploy.rb. This works because all configuration variables (from both deploy.rb and the current stage file) have been defined by the time the tasks run and access the variables.
For example, let's create a configuration variable in the production and staging files and access the current one from deploy.rb.
config/deploy/production.rb
```ruby
set :app_domain, "www.my_application.com"
```
config/deploy/staging.rb
```ruby
set :app_domain, "stage.application_test.com"
```
These variables are not available in deploy.rb using `fetch(:nginx_port)` or `fetch(:app_domain)` because they are not defined when deploy.rb is executed. They can, however, be lazily loaded using a lambda in deploy.rb like this:
config/deploy.rb
```ruby
set :nginx_server_name, ->{ fetch(:app_domain) }
set :puma_bind, ->{ "unix:/tmp/#{fetch(:app_domain)}.sock" }
```
Now the `:nginx_server_name` and `:puma_bind` variables will be lazily assigned the values set in which ever stage file was used to deploy.
If you need to create nested hashes, you might find `do/end` syntax more readable:
```ruby
set :database_yml, -> do
{
production: {
host: 'localhost'
}
}
end
```

13
docs/documentation/faq/how-can-i-check-for-existing-remote-file/index.markdown Normal file
View File

@ -0,0 +1,13 @@
---
title: How can I check for existing remote file?
layout: default
---
The `test` method is best used for file checking with bash conditionals
```ruby
if test("[ -f /tmp/foo ]")
# do stuff
end
```

12
docs/documentation/faq/how-can-i-get-capistrano-to-prompt-for-a-password/index.markdown Normal file
View File

@ -0,0 +1,12 @@
---
title: How can I get Capistrano to prompt for a password?
layout: default
---
Password authentication can be done via `ask` in your deploy environment file (e.g.: config/environments/production.rb)
```ruby
# Capistrano > 3.2.0 supports echo: false
ask(:password, nil, echo: false)
server 'server.domain.com', user: 'ssh_user_name', port: 22, password: fetch(:password), roles: %w{web app db}
```

40
docs/documentation/faq/how-can-i-set-capistrano-configuration-paths/index.markdown Normal file
View File

@ -0,0 +1,40 @@
---
title: How can I set Capistrano configuration paths?
layout: default
---
Capistrano `config` and `tasks` paths can be explicitly defined, like so:
Capfile
```ruby
# default deploy_config_path is 'config/deploy.rb'
set :deploy_config_path, 'cap/deploy.rb'
# default stage_config_path is 'config/deploy'
set :stage_config_path, 'cap/stages'
# previous variables MUST be set before 'capistrano/setup'
require 'capistrano/setup'
# default tasks path is `lib/capistrano/tasks/*.rake`
# (note that you can also change the file extensions)
Dir.glob('cap/tasks/*.rb').each { |r| import r }
```
Here is the corresponding capistrano configuration structure:
```bash
├── Capfile
└── cap
├── stages
│ ├── production.rb
│ └── staging.rb
├── tasks
│ └── custom_tasks.rb
└── deploy.rb
```
<div class="alert-box alert">
Be aware that you will have to provide an absolute path, if you want your "deploy_config_path" to be "capistrano/deploy.rb".
See <a href="https://github.com/capistrano/capistrano/issues/1519#issuecomment-152357282">this issue</a> for more explanations and how to get an absolute path in Ruby.
</div>

122
docs/documentation/faq/why-does-something-work-in-my-ssh-session-but-not-in-capistrano/index.markdown Normal file
View File

@ -0,0 +1,122 @@
---
title: Why does something work in my SSH session, but not in Capistrano?
layout: default
---
This is possibly one of the most complicated support questions that can be
asked, the only real answer is ***it depends***.
It's really a question of which *kind* of shell Capistrano is using, it's a
matrix of possibilities concerning `login`, `non-login`, `interactive`, or
`non-interactive`.
**By default Capistrano always assigns a `non-login`, `non-interactive` shell.**
## Shell Modes
Unix shells can be started in one of three modes, an unnamed *basic* mode,
which almost never happens, as a `login` shell, or as an `interactive` shell.
Depending which mode a shell starts in (and which shell you are using) this
will affect which startup (more commonly known as *dot*-files) files, if any
are loaded, [here's](#which_startup_files_loaded) more or less the matrix of what is loaded when.
## What about the Capistrano option to assign a `pty`?
This option has been hugely misleadingly used, if you ask SSH to provide a
`pty` you are effectively telling SSH that *"I'll connect this session to a
user terminal"*, thus programs on the receiving end expect that they can prompt
for input, and provide coloured output, etc. In short they think they're
talking to you over an interactive session, because by assigning a `pty`, Bash
has been started in `non-login`, `interactive` mode.
Read more about this:
* [In the "Bash Startup Files" section of the Bash
manual](https://www.gnu.org/software/bash/manual/html_node/Bash-Startup-Files.html)
* [At Sam Stephenson's excellent *Unix shell initialization* wiki
page](https://github.com/sstephenson/rbenv/wiki/Unix-shell-initialization)
* [Interactive and non-interactive shells and scripts
documentation](http://www.tldp.org/LDP/abs/html/intandnonint.html)
## How does what Capistrano does differ from an SSH session
By default Capistrano prefers to start a *non-login, non-interactive
shell*, to try and isolate the environment and make sure that things work as
expected, regardless of any changes that might happen on the server side.
In contrast when you log into a machine with your terminal, into a regular
Bash session, the `--login` option to Bash is implied granting you a `login`
shell, and because you are in a terminal, ssh asks the ssh server to provide a
pty so that you may start an interactive session. Thus you get an `interactive
login` shell, the exact opposite of what we need for Capistrano!
## How can I check?
I actually had to look this up, most of the time it's common sense, but
[stackoverflow to the rescue](http://unix.stackexchange.com/a/26782), let's
figure this out!
First, we'll try a *real* SSH session, logging in via our terminal, and seeing
what happens:
```bash
me@localhost $ ssh me@remote
me@remote $ [[ $- == *i* ]] && echo 'Interactive' || echo 'Not interactive'
Interactive
me@remote $ shopt -q login_shell && echo 'Login shell' || echo 'Not login shell'
Login shell
```
Contrast that with what happens when we hand the command to run to the SSH
command line without logging in first...
```bash
me@localhost $ ssh me@remote "[[ $- == *i* ]] && echo 'Interactive' || echo 'Not interactive'"
Interactive
me@localhost $ ssh me@remote "shopt -q login_shell && echo 'Login shell' || echo 'Not login shell'"
Not login shell
```
Here we can see that Bash is still starting in **interactive** mode when we're
just running a single command, that's because the terminal we are using is
interactive, and SSH inherits that and passes that on to the remote server.
When we try the same with Capistrano we'll see yet another set of results; we
can have a very simple, Capfile, we don't even need to load the default
recipes to test this:
```ruby
# Capistrano 3
task :query_interactive do
on 'me@remote' do
info capture("[[ $- == *i* ]] && echo 'Interactive' || echo 'Not interactive'")
end
end
task :query_login do
on 'me@remote' do
info capture("shopt -q login_shell && echo 'Login shell' || echo 'Not login shell'")
end
end
```
Gives us the following:
```bash
me@localhost $ cap query_login
INFO Not login shell
me@localhost $ cap query_interactive
INFO Not interactive
```
## <a id="which_startup_files_loaded"></a>Which shell startup files do get loaded?
Best explained with this diagram, yes it's that complicated:
<figure class="panel">
<img src="/images/BashStartupFiles1.png" title="Bash Startup Files" alt="Bash Startup Files" />
<figcaption>
<p>Source: <a href="http://www.solipsys.co.uk/new/BashInitialisationFiles.html">http://www.solipsys.co.uk/new/BashInitialisationFiles.html</a></p>
</figcaption>
</figure>

379
docs/documentation/getting-started/authentication-and-authorisation/index.markdown Normal file
View File

@ -0,0 +1,379 @@
---
title: Authentication & Authorisation
layout: default
---
**Note:** In the documentation we simply recommend creating a single
deployment user, and sharing it between team members. If you know why this is
a bad idea (or why this may be against regulations in your jurisdiction in
some cases), we assume that you know well enough how to use groups, umasking
and setgid bits to make this work reliably for unique logins across team
members.
To create this deploy user we'll assume something like the following has been
done:
```bash
root@remote $ adduser deploy
root@remote $ passwd -l deploy
```
The first line creates a completely standard user, it has a home directory,
which we'll need in a moment, and has a shell, so it may log in. This needs to
be done **on every server in your environment**.
The second line *locks* the user, it changes the user's password to an
untypable string, guaranteeing that the user has no password which can be used
to log in.
### Authentication
There are two places that we need automated, promptless authentication:
1. **From our workstation/notebook/etc to our servers.** We do this with **SSH
keys**, passphrase protected, ideally, using a **key agent**.
2. **From our servers to the repository host**. We do this so that our servers
can check out our application code from Github, or similar and install it
to the servers. This is usually done using **SSH agent forwarding**, HTTP
authentication, or with deploy keys.
#### 1.1 SSH keys from workstation to servers
An SSH key is a mechanism that allows a *public* half one key to be placed on
a server, when we want to authenticate with that server, our SSH client uses
the **private** part of that key to negotiate with the server, if the keys are
correct, we are allowed to login.
**Note:** If you are on Windows, you can use Git for Windows to generate ssh keys. To do this, follow this steps:
1. Install [Git for Windows](https://git-scm.com/download/win).
2. Open "Git Bash" and follow next instructions always inside Git Bash prompt.
3. Activate ssh-agent: ```$ eval "$(ssh-agent -s)" ```
**Note:** If you want to use [Putty tool](http://www.putty.org/) to connect to remote server (from Windows) with ssh keys, then you need to generate ppk file, through puttygen tool.
**Hint:** If you have more than one developer in your team, they should all add their
public key to the `deploy` user's `authorized_keys` file, that way if someone
quits or gets fired, you can remove their key from that file, and the rest of
you can keep on shipping!
Then we need to create the key.
```bash
me@localhost $ ssh-keygen -t rsa -C 'me@my_email_address.com'
```
You'll be prompted for a passphrase, that's fine. Type one and keep it safe.
This passphrase ensures that if your computer is stolen, people still need a
passphrase to access your keys, in order to access your servers.
To avoid having to type this passphrase every time you need to use a key, most
operating systems have a concept of a *key agent*. This *key agent* stores SSH
keys securely between uses, typically the first time a key is needed in a
given time period, the SSH agent will load the key, prompt you for your
passphrase and then the key agent will remember the key for a certain amount
of time (on OSX it tends to be indefinite, on linux this can vary from 15
minutes upwards.)
We can see which keys are loaded in the SSH agent by running `ssh-add -l`
```bash
me@localhost $ ssh-add -l
2048 af:ce:7e:c5:93:18:39:ff:54:20:7a:2d:ec:05:7c:a5 /Users/me/.ssh/id_rsa (RSA)
```
If you don't see any keys listed, you can simply run `ssh-add`:
```bash
me@localhost $ ssh-add
Identity added: /Users/me/.ssh/id_rsa (/Users/me/.ssh/id_rsa)
```
Typically, ssh-add will ask you for the passphrase when you add a key.
**Note:** Although it's not mandatory to use an SSH agent (one could simply
use an unpassphrased key, and rely on SSH to find the key and exchange it).
Using an SSH agent makes things more secure, because we can use a passphrased
key without being prompts every time it is used. It **also** allows us to use
this same key to access the repository *via* the server without creating an
additional identity.
At this point with the key loaded into the agent, we need to put the
**public** part of the key into a file on each remote server called
`/home/users/deploy/.ssh/authorized_keys`, to get the contents of that file,
we can ask our local key agent for the public parts of the keys it has loaded:
```bash
me@localhost $ ssh-add -L
ssh-rsa jccXJ/JRfGxnkh/8iL........dbfCH/9cDiKa0Dw8XGAo01mU/w== /Users/me/.ssh/id_rsa
```
This will be a lot longer when you run it, I snipped the output because it
looked bad.
This line, as one line, needs to make it to the remote server and be added *to
it's own line* of the `deploy` user's `~/.ssh/authorized_keys` file. This file
then needs to be changed to permission mode `0600` (owner read/write, group
none, other none), in the `~/.ssh` directory which needs the permissions
`0700` (owner read/write/execute, group none, other none).
If you are on linux there often exists a command
[`ssh-copy-id`](http://linux.die.net/man/1/ssh-copy-id) which streamlines this
process, otherwise the workflow is something like:
```bash
me@localhost $ ssh root@remote
root@remote $ su - deploy
deploy@remote $ cd ~
deploy@remote $ mkdir .ssh
deploy@remote $ echo "ssh-rsa jccXJ/JRfGxnkh/8iL........dbfCH/9cDiKa0Dw8XGAo01mU/w== /Users/me/.ssh/id_rsa" >> .ssh/authorized_keys
deploy@remote $ chmod 700 .ssh
deploy@remote $ chmod 600 .ssh/authorized_keys
```
**Remember:** This needs to be done on every server you want to use, you can
use the same key for each one, but only one key per developer is recommended.
*Private* keys are named as such for a reason!
If we did all that correctly, we should now be able to do something like this:
```bash
me@localhost $ ssh deploy@one-of-my-servers.com 'hostname; uptime'
one-of-my-servers.com
19:23:32 up 62 days, 44 min, 1 user, load average: 0.00, 0.01, 0.05
```
That should happen without having to enter a passphrase for your SSH key, or
prompting you for an SSH password (which the deploy user doesn't have anyway).
Verify that this works for all of your servers, and put your private key
somewhere safe. If you're working with multiple team members, it often pays to
collect everyone's public keys, indeed if your team is already using SSH keys
to access Github, you can reach any user's SSH keys at the following URL:
* `https://github.com/theirusername.keys`
This can make getting user's keys onto servers much easier, as you can simply
`curl`/`wget` each user's key into the authorized keys file on the server
directly from Github.
<blockquote class="twitter-tweet"><p>TIL <a
href="https://twitter.com/github">@github</a> exposes the ssh public keys for
users. <a href="https://t.co/Wo9g8nxI">https://t.co/Wo9g8nxI</a> Handy for
adding devs to servers/repos.</p>&mdash; Postmodern (@postmodern_mod3) <a
href="https://twitter.com/postmodern_mod3/statuses/300438256200339456">February
10, 2013</a></blockquote>
<script async src="//platform.twitter.com/widgets.js"
charset="utf-8"></script>
If your server isn't accessible directly and you need to use the SSH
ProxyCommand option, you should do
```ruby
require 'net/ssh/proxy/command'
set :ssh_options, proxy: Net::SSH::Proxy::Command.new('ssh mygateway.com -W %h:%p')
# OR
server 'internal-hostname',
ssh_options: {
proxy: Net::SSH::Proxy::Command.new('ssh mygateway.com -W %h:%p'),
}
```
#### 1.2 From our servers to the repository host
With access from workstations to the servers settled, there is another hop to
contend with, which is letting the deploy user get access to the code
repository automatically. The options in order of preference:
##### 1.2.1 SSH Agent Forwarding
As we've already set up an SSH agent, we can use the *agent forwarding*
feature of SSH to make this key agent available to further *hops*. In short,
we can use **our own ssh key** to authenticate ourselves from the server to
Github.
Here's how we can check if that works, first get the URL of the repository:
```bash
me@localhost $ git config remote.origin.url
git@github.com:capistrano/rails3-bootstrap-devise-cancan.git
```
Here we're listing our private (for testing purposes) fork of the
rails3-bootstrap-devise-cancan repository forked from the Rails Examples and
Tutorials project.
We can try to access the repository via our server by doing the following:
```bash
# List SSH keys that are loaded into the agent
me@localhost $ ssh-add -l
# Make sure they key is loaded if 'ssh-add -l' didn't show anything
me@localhost $ ssh-add
me@localhost $ ssh -A deploy@one-of-my-servers.com 'git ls-remote git@github.com:capistrano/rails3-bootstrap-devise-cancan.git'
```
We first check that the agent has the keys loaded. If not we simply load it
and enter the passphrase when prompted.
Finally we use `ls-remote` from Git to list the remote objects, this is the
exact same check that Capistrano does internally before attempting to deploy.
The `-A` option may, or may not be required on your system, it's worth trying
it both ways just to know how your system treats agent forwarding by default.
If you get the error "host key verification failed." log in into your server
and run as the deploy user the command `ssh git@github.com` to add github.com
to the list of known hosts.
From the SSH documentation:
```bash
-A Enables forwarding of the authentication agent connection. This can also be
specified on a per-host basis in a configuration file.
Agent forwarding should be enabled with caution. Users with the ability to
bypass file permissions on the remote host (for the agent's UNIX-domain
socket) can access the local agent through the forwarded connection. An
attacker cannot obtain key material from the agent, however they can perform
operations on the keys that enable them to authenticate using the identities
loaded into the agent.
```
In layman's terms, you shouldn't use SSH agent forwarding to machines where you
don't trust the administrators, as they can can override the permissions on
the system and use your keys as if they were you. That said, if you can't
trust your server administrators, perhaps they shouldn't have access to your
servers!
##### 1.2.2 HTTP Authentication
In the case of HTTP authentication **be sure to use HTTPS**, otherwise your
password will be sent in cleartext over the network, depending what your hosts
network infrastructure looks like that might be *very* bad news.
Typically when we try and list our remote objects, using the https method from
Github, we'll be prompted for a username and password:
##### 1.2.2.1 With a regular username/password
```bash
me@localhost $ git ls-remote https://github.com/capistrano/rails3-bootstrap-devise-cancan.git
Username for 'https://github.com': myownusername
Password for 'https://capistrano@github.com':
```
This challenge response prompt doesn't work well for automating things, so
there are two ways to get around this depending on your server's host
operating system, the first is to use a `netrc` file, we won't talk about that
because the netrc is a global file that doesn't lend itself well to security.
The other mechanism, and the reason that its **very** important to always use
HTTPS not plain ol' HTTP is to embed the username and password in the URL,
note this won't work well if your password has special characters:
```bash
me@localhost $ git ls-remote https://capistrano:ourverysecretpassword@github.com/capistrano/rails3-bootstrap-devise-cancan.git
3419812c9f146d9a84b44bcc2c3caef94da54758HEAD
3419812c9f146d9a84b44bcc2c3caef94da54758HEADrefs/heads/master
```
The bigger problem with passwords, whether inlined into the URL, or entered
into a `netrc` file, is that the password gives access to **your entire Github
Account** not just to one single repository.
##### 1.2.2.2 With an OAuth Personal API Token
This mechanism still gives access to **every repository** you can access, but
at Github, they recently rolled out a feature called [Personal API
Tokens](https://github.com/blog/1509-personal-api-tokens) which allow you to
do something like this:
```bash
me@localhost $ git ls-remote https://XXXX:@github.com/capistrano/rails3-bootstrap-devise-cancan.git
3419812c9f146d9a84b44bcc2c3caef94da54758HEAD
3419812c9f146d9a84b44bcc2c3caef94da54758HEADrefs/heads/master
```
Where `XXXX` is a personal API token, as such:
![Github Personal API Token Page](/images/github-personal-api-token-page.png)
##### 1.2.3 Deploy Keys
Deploy keys, a feature of Github, and some other platforms allow you to
generate a **second** set of SSH keys for the connection between Github and
the servers themselves.
Slightly perversely in this case the public key is uploaded to the repository
host, and the private key must be copied to each server that you want to
deploy to.
Github has a quite excellent guide on this, much of which (unsurprisingly)
overlaps with the SSH key instructions above.
* [Github Help: Managing Deploy Keys](https://help.github.com/articles/managing-deploy-keys)
### Authorisation
The second part of this topic is that our deploy user needs to be authorised
to work in the deployment directory, on the server. That means we need to be
able to work, ideally without `sudo` (none of the default Capistrano recipes
expect `sudo` to be available), or for your custom recipes, you will need to
have configured *passwordless* `sudo`. Configuring `sudo` to give some users
access to some commands under some circumstances is beyond the scope of this
documentation, but sufficed to say something like:
```bash
deploy ALL=NOPASSWD:/etc/init.d/mysqld, /etc/init.d/apache2
```
This example would give the user named `deploy` access to call `sudo
/etc/init.d/mysql _________` and the same for the `apache2` control script.
**Granting passwordless sudo should not be done lightly.** It can be dangerous.
For example if an unprivileged user can *edit* the script that they can run
as root, they can easily edit it to do anything they want that is evil. Use
this carefully, and ideally architect your systems so that non-privileged
users can restart services, or that services restart *themselves* when they
notice a change.
To configure this hierarchy, ignoring for the moment the passwordless `sudo`
access that you may or may not need depending how well your servers are setup:
```bash
me@localhost $ ssh root@remote
# Capistrano will use /var/www/....... where ... is the value set in
# :application, you can override this by setting the ':deploy_to' variable
root@remote $ deploy_to=/var/www/rails3-bootstrap-devise-cancan-demo
root@remote $ mkdir -p ${deploy_to}
root@remote $ chown deploy:deploy ${deploy_to}
root@remote $ umask 0002
root@remote $ chmod g+s ${deploy_to}
root@remote $ mkdir ${deploy_to}/{releases,shared}
root@remote $ chown deploy ${deploy_to}/{releases,shared}
```
**Note:** The `chmod g+s` is a really handy, and little known Unix feature, it
means that at the operating system level, without having to pay much attention
to the permissions at runtime, all files an directories created inside the
`${deploy_to}` directory will inherit the group ownership, that means in this
case even though we are root, the files will be created being owned by `root`
with the group `deploy`, the `umask 0002` ensures that the files created
*during this session* are created with the permissions *owner read/write,
group: read/write, other: none*. This means that we'll be able to read these
files from Apache, or our web server by running the web server in the `deploy`
group namespace.
```bash
root@remote # stat -c "%A (%a) %n" ${deploy_to}/
drwx--S--- (2700) /var/www/rails3-bootstrap-devise-cancan-demo
root@remote # stat -c "%A (%a) %n" ${deploy_to}/*
drwxrwsr-x (2775) /var/www/rails3-bootstrap-devise-cancan-demo/releases
drwxrwsr-x (2775) /var/www/rails3-bootstrap-devise-cancan-demo/shared
```

55
docs/documentation/getting-started/before-after/index.markdown Normal file
View File

@ -0,0 +1,55 @@
---
title: Before / After Hooks
layout: default
---
Where calling on the same task name, executed in order of inclusion
```ruby
# call an existing task
before :starting, :ensure_user
after :finishing, :notify
# or define in block
before :starting, :ensure_user do
#
end
after :finishing, :notify do
#
end
```
If it makes sense for your use case (often, that means *generating a file*)
the Rake prerequisite mechanism can be used:
```ruby
desc "Create Important File"
file 'important.txt' do |t|
sh "touch #{t.name}"
end
desc "Upload Important File"
task :upload => 'important.txt' do |t|
on roles(:all) do
upload!(t.prerequisites.first, '/tmp')
end
end
```
The final way to call out to other tasks is to simply `invoke()` them:
```ruby
namespace :example do
task :one do
on roles(:all) { info "One" }
end
task :two do
invoke "example:one"
on roles(:all) { info "Two" }
end
end
```
This method is widely used.

211
docs/documentation/getting-started/cold-start/index.markdown Normal file
View File

@ -0,0 +1,211 @@
---
title: Cold Start
layout: default
---
At this point we should have a deploy user on all the servers we intend to
deploy to, that user should have permission to write to wherever we plan on
deploying to, by default that'll be something like `/var/www/my-application`.
We've set up the directory with decent permissions so that we can deploy
without breaking things, and that everyone on our team can deploy, too.
Let's run through what we've done so far, and how to check it's all working,
in the last step of this part of the guide we'll create the production-only
shared files.
Again, this guide assumes Ruby on Rails, but most of everything we're doing so
far is applicable in slightly modified forms to other frameworks and
technologies.
### 1. Checking the directory structure on the remote machine:
```bash
me@localhost $ ssh deploy@remote 'ls -lR /var/www/my-application'
my-application:
total 8
drwxrwsr-x 2 deploy deploy 4096 Jun 24 20:55 releases
drwxrwsr-x 2 deploy deploy 4096 Jun 24 20:55 shared
my-application/releases:
total 0
my-application/shared:
total 0
```
This checks in one simple command that the ssh keys you setup are working (you
might yet be prompted for the password), and the permissions on the directory
can be seen.
### 2. Writing our first *cap task* to formalize this into a check!
Now that we know how to check for permissions, and repository access, we'll
quickly introduce ourselves to a quick Cap task to check these things on all
the machines for us:
```ruby
desc "Check that we can access everything"
task :check_write_permissions do
on roles(:all) do |host|
if test("[ -w #{fetch(:deploy_to)} ]")
info "#{fetch(:deploy_to)} is writable on #{host}"
else
error "#{fetch(:deploy_to)} is not writable on #{host}"
end
end
end
```
Running this should give you a pretty decent overview, one line of output for
each server. It's also your first introduction to the API of Capistrano for
writing your own tasks, namely `desc()`, `task()`, `on()`, `roles()`,
`test()`, `info()`, and `error()`.
The first two methods, `desc()` and `task()` are actually from Rake, the
library that forms the foundation of the Capistrano task system, the other
methods are part of our sub-project
[**SSHKit**](https://github.com/capistrano/sshkit). We'll dive into those more
later, but add those lines to a file in `./lib/capistrano/tasks`, call it
something like `access_check.rake`, and run `cap -T` from the top directory and
we'll be able to see the task listed:
```bash
me@localhost $ bundle exec cap -T
# ... lots of other tasks ...
cap check_write_permissions # Check that we can access everything
# ... lots of other tasks ...
```
Then we simply call it:
```bash
me@localhost $ bundle exec cap staging check_write_permissions
DEBUG [82c92144] Running /usr/bin/env [ -w /var/www/my-application ] on myserver.com
DEBUG [82c92144] Command: [ -w /var/www/my-application ]
DEBUG [82c92144] Finished in 0.456 seconds command successful.
INFO /var/www/my-application is writable on myserver.com
```
If we've done something wrong, that won't happen and we'll know that we need
to jump on the mailing list to get help, into IRC or ask a friend.
Depending how you have set your Git authentication credentials up, checking
Git can be a bit complicated, so we've shipped a task in the core library that
can check your git access, Git isn't particularly scriptable, so one has to
wrap Git in a shell script that makes it behave.
Capistrano does just this, so to check if the Git access is working, we can
simply call:
```bash
me@localhost $ cap staging git:check
```
This task is defined in the default Git SCM-strategy and looks a lot like what
we wrote above to check the file permissions, however the Git check recipe is
a bit more complicated, having to potentially deal with three different
authentication schemes, which need to be worked around differently. This task
expresses a *dependency* on the `git:git-wrapper` task which is resolved first
for us by Capistrano. (This is one of the pieces we inherit from Rake)
If this fails we'll see:
```bash
me@localhost $ cap staging git:check
cap staging git:check
DEBUG Uploading /tmp/git-ssh.sh 0%
INFO Uploading /tmp/git-ssh.sh 100%
INFO [118bd3e4] Running /usr/bin/env chmod +x /tmp/git-ssh.sh on example.com
DEBUG [118bd3e4] Command: /usr/bin/env chmod +x /tmp/git-ssh.sh
INFO [118bd3e4] Finished in 0.049 seconds command successful.
INFO [a996463f] Running /usr/bin/env git ls-remote git@github.com:capistrano/rails3-bootstrap-devise-cancan.git on harrow
DEBUG [a996463f] Command: ( GIT_ASKPASS=/bin/echo GIT_SSH=/tmp/git-ssh.sh /usr/bin/env git ls-remote git@github.com:capistrano/rails3-bootstrap-devise-cancan.git )
DEBUG [a996463f] Warning: Permanently added 'github.com,204.232.175.90' (RSA) to the list of known hosts.
DEBUG [a996463f] Permission denied (publickey).
DEBUG [a996463f] fatal: The remote end hung up unexpectedly
cap aborted!
git stdout: Nothing written
git stderr: Nothing written
Tasks: TOP => git:check
(See full trace by running task with --trace)
```
This'll typically come out looking more beautiful depending on your terminal
colour support, you may well see something like this:
![Capistrano Git Check Colour Example](/images/git-check-example-screenshot.png)
To run through that shortly, what did we do:
1. We asked Capistrano to run the command `git:check`.
2. Capistrano recognised that in order to fulfil this request, it had to first
execute the task `git:wrapper`, a *prerequisite*.
3. Capistrano executed the `git:wrapper` task, and uploaded the
`/tmp/git-ssh.sh` file, and made it executable.
This script is actually processed as a template.
4. With the git wrapper in place, we can safely script against Git without it
prompting us for input, so we ask git to `ls-remote` on the repository we
defined. As this exited with an [unclean
status](https://en.wikipedia.org/wiki/Exit_status), Capistrano aborted, and
printed out the error messages for us to try and figure out what broke.
In this case, we'll be using SSH agent forwarding, we can check if that's
working by writing a tiny Cap task, or simply using SSH to do it for us, the
choice is yours:
```ruby
# lib/capistrano/tasks/agent_forwarding.rake
desc "Check if agent forwarding is working"
task :forwarding do
on roles(:all) do |h|
if test("env | grep SSH_AUTH_SOCK")
info "Agent forwarding is up to #{h}"
else
error "Agent forwarding is NOT up to #{h}"
end
end
end
```
That gave the output:
```bash
cap staging forwarding
DEBUG [f1269276] Running /usr/bin/env env | grep SSH_AUTH_SOCK on example.com
DEBUG [f1269276] Command: env | grep SSH_AUTH_SOCK
DEBUG [f1269276] SSH_AUTH_SOCK=/tmp/ssh-nQUEmyQ2nS/agent.2546
DEBUG [f1269276] Finished in 0.453 seconds command successful.
INFO Agent forwarding is up to example.com
```
If you don't feel like writing a Capistrano task, one could simply do:
```bash
me@localhost $ ssh -A example.com 'env | grep SSH_AUTH_SOCK'
SSH_AUTH_SOCK=/tmp/ssh-Tb6X8V53tm/agent.2934
```
If we see the `SSH_AUTH_SOCK` output, that's a pretty good indication that SSH
agent forwarding is enabled, and if on your local machine `ssh-add -l` shows
you an SSH key, then we're good to go. **Make sure that you're using the
`git@...` repository URL**
```bash
cap staging git:check
DEBUG Uploading /tmp/git-ssh.sh 0%
INFO Uploading /tmp/git-ssh.sh 100%
INFO [21382716] Running /usr/bin/env chmod +x /tmp/git-ssh.sh on example.com
DEBUG [21382716] Command: /usr/bin/env chmod +x /tmp/git-ssh.sh
INFO [21382716] Finished in 0.047 seconds command successful.
INFO [f40edfbb] Running /usr/bin/env git ls-remote git@github.com:capistrano/rails3-bootstrap-devise-cancan.git on example.com
DEBUG [f40edfbb] Command: ( GIT_ASKPASS=/bin/echo GIT_SSH=/tmp/git-ssh.sh /usr/bin/env git ls-remote git@github.com:capistrano/rails3-bootstrap-devise-cancan.git )
DEBUG [f40edfbb] 3419812c9f146d9a84b44bcc2c3caef94da54758 HEAD
DEBUG [f40edfbb] 3419812c9f146d9a84b44bcc2c3caef94da54758 refs/heads/master
INFO [f40edfbb] Finished in 3.319 seconds command successful.
```
![Capistrano Git Check Colour Example](/images/successful-git-check-example-screenshot.png)
*Note:* If you get an error like `scp: /tmp/git-ssh.sh: Permission denied`, you may need to set the `:tmp_dir` param.

141
docs/documentation/getting-started/configuration/index.markdown Normal file
View File

@ -0,0 +1,141 @@
---
title: Configuration
layout: default
---
## Location
Configuration variables can be either global or specific to your stage.
* global
* `config/deploy.rb`
* stage specific
* `config/deploy/<stage_name>.rb`
## Access
Each variable can be set to a specific value:
```ruby
set :application, 'MyLittleApplication'
# use a lambda to delay evaluation
set :special_thing, -> { "SomeThing_#{fetch :other_config}" }
```
A value can be retrieved from the configuration at any time:
```ruby
fetch :application
# => "MyLittleApplication"
fetch(:special_thing, 'some_default_value')
# will return the value if set, or the second argument as default value
```
**New in Capistrano 3.5:** for a variable that holds an Array, easily add values to it using `append`. This comes in especially handy for `:linked_dirs` and `:linked_files` (see Variables reference below).
```ruby
append :linked_dirs, ".bundle", "tmp"
```
The inverse is also available: `remove` will strive to drop an entry from an array. This comes in handy if you have a shared configuration which sets an array but a specific config doesn't need one of the elements.
```ruby
remove :linked_dirs, ".bundle", "tmp"
```
## Variables
The following variables are settable:
* `:application`
* The name of the application.
* `:deploy_to`
* **default:** `-> { "/var/www/#{fetch(:application)}" }`
* The path on the remote server where the application should be deployed.
* If application contains whitespace or such this path might be invalid. See Structure for the exact directories used.
* `:scm`
* **default:** `:git`
* The Source Control Management used.
* Currently :git, :hg and :svn are supported. Plugins might add additional ones.
* `:repo_url`
* URL to the repository.
* Must be a valid URL for the used SCM.
* Example: `set :repo_url, 'git@example.com:me/my_repo.git'` for a git repo located in /home/git/me
* Hint #1: to access a repo on a machine using a non-standard ssh port: `set :repo_url, 'ssh://git@example.com:30000/~/me/my_repo.git'`
* Hint #2: when using :svn and branches, declare the repo_url like this: `set :repo_url, -> { "svn://myhost/myrepo/#{fetch(:branch)}" }`
* `:branch`
* **default:** `'master'`
* The branch name to be deployed from SCM.
* `:svn_username`
* When using :svn, provides the username for authentication.
* `:svn_password`
* When using :svn, provides the password for authentication.
* `:svn_revision`
* **New in version 3.5**
* When using :svn, set the specific revision number you want to deploy.
* `:repo_path`
* **default:** `-> { "#{fetch(:deploy_to)}/repo" }`
* The path on the remote server where the repository should be placed.
* This does not normally need to be set
* `:repo_tree`
* **default:** None. The whole repository is normally deployed.
* The subtree of the repository to deploy.
* Currently only implemented for Git and Hg.
* `:linked_files`
* **default:** `[]`
* Listed files will be symlinked into each release directory during deployment.
* Can be used for persistent configuration files like `database.yml`. See Structure for the exact directories.
* `:linked_dirs`
* **default:** `[]`
* Listed directories will be symlinked into the release directory during deployment.
* Can be used for persistent directories like uploads or other data. See Structure for the exact directories.
* `:default_env`
* **default:** `{}`
* Default shell environment used during command execution.
* Can be used to set or manipulate specific environment variables (e.g. `$PATH` and such).
* `:keep_releases`
* **default:** `5`
* The last `n` releases are kept for possible rollbacks.
* The cleanup task detects outdated release folders and removes them if needed.
* `:tmp_dir`
* **default:** `'/tmp'`
* Temporary directory used during deployments to store data.
* If you have a shared web host, this setting may need to be set (e.g. /home/user/tmp/capistrano).
* `:local_user`
* **default:** `-> { Etc.getlogin }`
* Username of the local machine used to update the revision log.
* `:pty`
* **default:** `false`
* Used in SSHKit.
* `:log_level`
* **default:** `:debug`
* Used in SSHKit.
* `:format`
* **default:** `:pretty`
* Used in SSHKit.
Capistrano plugins can provide their own configuration variables. Please refer
to the plugin documentation for the specifics. Plugins are allowed to add or
manipulate default values as well as already user-defined values after the
plugin is loaded.

111
docs/documentation/getting-started/flow/index.markdown Normal file
View File

@ -0,0 +1,111 @@
---
title: Flow
layout: default
---
Capistrano v3 provides a default **deploy flow** and a **rollback flow**:
### Deploy flow
When you run `cap production deploy`, it invokes the following tasks in
sequence:
```ruby
deploy:starting - start a deployment, make sure everything is ready
deploy:started - started hook (for custom tasks)
deploy:updating - update server(s) with a new release
deploy:updated - updated hook
deploy:publishing - publish the new release
deploy:published - published hook
deploy:finishing - finish the deployment, clean up everything
deploy:finished - finished hook
```
Notice there are several hook tasks e.g. `:started`, `:updated` for
you to hook up custom tasks into the flow using `after()` and `before()`.
### Rollback flow
When you run `cap production deploy:rollback`, it invokes the following
tasks in sequence:
```ruby
deploy:starting
deploy:started
deploy:reverting - revert server(s) to previous release
deploy:reverted - reverted hook
deploy:publishing
deploy:published
deploy:finishing_rollback - finish the rollback, clean up everything
deploy:finished
```
As you can see, rollback flow shares many tasks with deploy flow. But note
that, rollback flow runs its own `:finishing_rollback` task because its
cleanup process is usually different from deploy flow.
### Flow examples
Assume you require the following files in `Capfile`,
```ruby
# Capfile
require 'capistrano/setup'
require 'capistrano/deploy'
require 'capistrano/bundler'
require 'capistrano/rails/assets'
require 'capistrano/rails/migrations'
```
When you run `cap production deploy`, it runs these tasks:
```ruby
deploy
deploy:starting
[before]
deploy:ensure_stage
deploy:set_shared_assets
deploy:check
deploy:started
deploy:updating
git:create_release
deploy:symlink:shared
deploy:updated
[before]
deploy:bundle
[after]
deploy:migrate
deploy:compile_assets
deploy:normalize_assets
deploy:publishing
deploy:symlink:release
deploy:published
deploy:finishing
deploy:cleanup
deploy:finished
deploy:log_revision
```
For `cap production deploy:rollback`, it runs these tasks:
```ruby
deploy
deploy:starting
[before]
deploy:ensure_stage
deploy:set_shared_assets
deploy:check
deploy:started
deploy:reverting
deploy:revert_release
deploy:reverted
[after]
deploy:rollback_assets
deploy:publishing
deploy:symlink:release
deploy:published
deploy:finishing_rollback
deploy:cleanup_rollback
deploy:finished
deploy:log_revision
```

106
docs/documentation/getting-started/installation/index.markdown Normal file
View File

@ -0,0 +1,106 @@
---
title: Installation
layout: default
---
Capistrano is bundled as a Ruby Gem. **It requires Ruby 2.0 or newer.**
Capistrano can be installed as a standalone Gem, or bundled into your
application.
<div class="alert">
It is recommended to fix the version number when using Capistrano, and is
therefore recommended to use an appropriate bundler.
</div>
### General Usage
The following command will install the latest released capistrano `v3` revision:
```bash
$ gem install capistrano
```
Or grab the bleeding edge head from:
```bash
$ git clone https://github.com/capistrano/capistrano.git
$ cd capistrano
$ gem build *.gemspec
$ gem install *.gem
```
### Usage in a Rails project
Add the following lines to the Gemfile:
```ruby
group :development do
gem 'capistrano-rails', '~> 1.1'
end
```
The `capistrano-rails` gem includes extras specifically designed for Ruby on
Rails, specifically:
* Asset Pipeline Support
* Database Migration Support
The documentation for these components can be found in
[their][capistrano-rails-asset-pipeline-readme],
[respective][capistrano-rails-gem-bundler-readme],
[READMEs][capistrano-rails-database-migrations-readme]. However for the most
part, to get the best, and most sensible results, simply `require` in
Capfile, after the `require 'capistrano/deploy'` line:
```ruby
require 'capistrano/rails'
```
##### SSH
Capistrano deploys using SSH. Thus, you must be able to SSH (ideally with keys
and ssh-agent) from the deployment system to the destination system for
Capistrano to work.
You can test this using a ssh client, e.g. `ssh myuser@destinationserver`. If
you cannot connect at all, you may need to set up the SSH server or resolve
firewall/network issues. Look for a tutorial (here are suggestions for
[Ubuntu](https://help.ubuntu.com/community/SSH) and
[RedHat/CentOS](http://www.cyberciti.biz/faq/centos-ssh/)).
If a password is requested when you log in, you may need to set up SSH keys.
GitHub has a [good tutorial](https://help.github.com/articles/generating-ssh-keys/)
on creating these (follow steps 1 through 3). You will need to add your public
key to `~/.ssh/authorized_keys` on the destination server as the deployment user
(append on a new line).
More information on SSH and login is available via the
[Authentication and Authorisation](http://capistranorb.com/documentation/getting-started/authentication-and-authorisation/)
section of the guide.
If you are still struggling to get login working, try the
[Capistrano SSH Doctor](https://github.com/capistrano-plugins/capistrano-ssh-doctor)
plugin.
##### Help! I was using Capistrano `v2.x` and I didn't want to upgrade!
If you are using Capistrano `v2.x.x` and have also installed Capistrano `v3`
by mistake, then you can lock your Gem version for Capistrano at something
like:
```ruby
gem 'capistrano', '~> 2.15' # Or whatever patch release you are using
```
This is the [pessimistic operator][rubygems-pessimistic-operator] which
installs the closest matching version, at the time of writing this would
install `2.15.4`, and any other point-release in the `2.15.x` family without
the risk of accidentally upgrading to `v3`.
[rubygems]: http://rubygems.org/
[rubygems-pessimistic-operator]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
[capistrano-rails-asset-pipeline-readme]: https://github.com/capistrano/rails/blob/master/README.md
[capistrano-rails-database-migrations-readme]: https://github.com/capistrano/rails/blob/master/README.md
[capistrano-rails-gem-bundler-readme]: https://github.com/capistrano/bundler/blob/master/README.md

35
docs/documentation/getting-started/local-tasks/index.markdown Normal file
View File

@ -0,0 +1,35 @@
---
title: Local Tasks
layout: default
---
Local tasks can be run by replacing `on` with `run_locally`:
```ruby
desc 'Notify service of deployment'
task :notify do
run_locally do
with rails_env: :development do
rake 'service:notify'
end
end
end
```
Of course, you can always just use standard ruby syntax to run things locally:
```ruby
desc 'Notify service of deployment'
task :notify do
%x('RAILS_ENV=development bundle exec rake "service:notify"')
end
```
Alternatively you could use the rake syntax:
```ruby
desc "Notify service of deployment"
task :notify do
sh 'RAILS_ENV=development bundle exec rake "service:notify"'
end
```

197
docs/documentation/getting-started/preparing-your-application/index.markdown Normal file
View File

@ -0,0 +1,197 @@
---
title: Preparing Your Application
layout: default
---
<div class="alert-box radius">
This will focus on preparing a Rails application, but most ideas expressed
here have parallels in Python, or PHP applications
</div>
### 1. Commit your application to some externally available source control hosting provider.
If you are not doing so already, you should host your code somewhere with a
provider such as GitHub, BitBucket, Codeplane, or repositoryhosting.com.
Capistrano currently supports Git, Mercurial, and SVN out of the box.
There might be 3<sup>rd</sup> party plugins adding support for various other systems.
### 2. Move secrets out of the repository.
<div class="alert-box alert">
If you've accidentally committed state secrets to the repository, you might
want to take
<a href="https://help.github.com/articles/remove-sensitive-data">special steps</a>
to erase them from the repository history for all time.
</div>
Ideally one should remove `config/database.yml` to something like
`config/database.yml.example`. You and your team should copy the example file
into place on their development machines, under Capistrano. This leaves the
`database.yml` filename unused so that we can symlink the production database
configuration into place at deploy time.
The original `database.yml` should be added to the `.gitignore` (or your SCM's
parallel concept of ignored files)
```bash
$ cp config/database.yml{,.example}
$ echo config/database.yml >> .gitignore
```
This should be done for any other secret files, we'll create the production
version of the file when we deploy, and symlink it into place.
### 3. Initialize Capistrano in your application.
```bash
$ cd my-project
$ cap install
```
This will create a bunch of files, the important ones are:
```bash
├── Capfile
├── config
│   ├── deploy
│   │   ├── production.rb
│   │   └── staging.rb
│   └── deploy.rb
└── lib
└── capistrano
└── tasks
```
Your new Capfile will automatically include any tasks from any `*.rake` files
in `lib/capistrano/tasks`.
### 4. Configure your server addresses in the generated files.
We'll just work with the staging environment here, so you can pretend that
`config/deploy/production.rb` doesn't exist, for the most part that's your
business.
Capistrano breaks down common tasks into a notion of *roles*, that is, taking
a typical Rails application that we have roughly speaking three roles, `web`,
`app`, and `db`.
The three roles can be confusing, as the boundary of web and app servers is a bit blurry if, for example,
using [Passenger](https://www.phusionpassenger.com/) with Apache, which in effect embeds your app server in the
web server (embeds Passenger in the Apache process itself). Confusingly,
Passenger can also be used in modes where this isn't true, so we'll ignore
that for the time being. If you know the difference (i.e you are using
nginx as your web server, and puma/unicorn, or similar for your app server,
that should be fine), then we can assume that they're the same, which is pretty
common.
The example file generated will look something like this:
```ruby
set :stage, :staging
# Simple Role Syntax
# ==================
# Supports bulk-adding hosts to roles, the primary
# server in each group is considered to be the first
# unless any hosts have the primary property set.
role :app, %w{example.com}
role :web, %w{example.com}
role :db, %w{example.com}
# Extended Server Syntax
# ======================
# This can be used to drop a more detailed server
# definition into the server list. The second argument
# is something that quacks like a hash and can be used
# to set extended properties on the server.
server 'example.com', roles: %w{web app}, my_property: :my_value
# set :rails_env, :staging
```
Servers can be defined in two ways, implicitly using the simple `role` syntax and
explicitly using the extended `server` syntax. Both result in one or more servers for
each role being defined. The `app` and `db` roles are just placeholders, if you are using
the `capistrano/rails-*` addons (more on that later) then they have a meaning, but if you
are deploying something simpler, feel free to delete them if they're meaningless to you.
Both types can specify optional _properties_ to be associated with a server or role. These
properties include Capistrano-required ones such as the SSH options (username, port, keys
etc.) and also arbitrary custom properties. They are there in case people want to build the
server list more comprehensively from something like the *EC2* command line tools, and
want to use the extended properties for something that makes sense in their environment.
The following shows defining two servers: one where we set the
username, and another where we set the port. These host strings are parsed and expanded
out in to the equivalent of the server line after the comment:
```ruby
# using simple syntax
role :web, %w{hello@world.com example.com:1234}
# using extended syntax (which is equivalent)
server 'world.com', roles: [:web], user: 'hello'
server 'example.com', roles: [:web], port: 1234
```
<div class="alert-box radius"> You can define a server or role using both syntaxes and the
properties will be merged. See the Properties Documentation for details
</div>
<div class="alert-box alert"> If you define servers with either the simple or the extended
syntax and explicitly specify a user or a port number, the last definition will win. This
is identical behaviour to scalar custom properties. In older versions of Capistrano,
<b>multiple</b> servers were created and the merging was ill-defined. </div>
### 5. Set the shared information in `deploy.rb`.
The `deploy.rb` is a place where the configuration common to each environment
can be specified, normally the *repository URL* and the *user as whom to
deploy* are specified here.
The generated sample file starts with the following, and is followed by a few
self-documenting, commented-out configuration options, feel free to play with
them a little:
```ruby
set :application, 'my_app_name'
set :repo_url, 'git@example.com:me/my_repo.git'
ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }
```
Here we'd set the name of the application, ideally in a way that's safe for
filenames on your target operating system.
Second we set the repository URL, and this *MUST* be somewhere that the server we
are deploying to can reach.
Here's how this might look in a typical example: note that we'll cover
authentication in the next chapter, but for now we'll assume this repository is
open source, taking an example application from the [Rails Examples and
Tutorials](http://railsapps.github.io/) site. There we'll find maintained a
handful of typical Rails apps with typical dependencies.
The Rails application they host, which uses Devise (for authentication) and
Cancan (for authorisation) along side Twitter Bootstrap for assets has been
forked to the Capistrano repository, but you can find the (unchanged) original
[here](https://github.com/RailsApps/rails3-bootstrap-devise-cancan).
```ruby
set :application, 'rails3-bootstrap-devise-cancan-demo'
set :repo_url, 'https://github.com/capistrano/rails3-bootstrap-devise-cancan'
set :branch, 'master'
```
I've simplified the `:branch` variable to simply be a `set` variable, and not a
question prompt, as this repository only has a master branch.
## Roundup
**At this point Capistrano knows where to find our servers, and where to find
our code.**
We've not covered how we authorise our servers to check out our code (there
are three pretty good ways of doing that with Git), nor have we determined how
to authorise Capistrano on our servers yet.

42
docs/documentation/getting-started/rollbacks/index.markdown Normal file
View File

@ -0,0 +1,42 @@
---
title: Rollbacks
layout: default
---
In the majority of failed deployment situations, it probably makes more sense to revert the bad code and redeploy, rather than running deploy:rollback. Capistrano provides basic rollback support, but as each application and system handles rollbacks differently, it is up to the individual to test and validate that rollback behaves correctly for their use case. For example, capistrano-rails will run special tasks on rollback to fix the assets, but does nothing special with database migrations.
Correctly rolling back a release is a complex process that depends on the specifics of your application and the Capistrano plugins you've assembled. *Be proactive and test your rollback procedure before trying it for the first time in a time of crisis.*
When a deployment is run, Capistrano executes one task at a time on all servers and waits for that task to be done before moving on to the next one. If a task fails on a server, Capistrano exits without waiting for further tasks. In a multiple server situation, when a task fails on one server by exiting with a non-0 exit code, Capistrano closes the SSH connections to any still in-progress servers and their tasks exit.
If the error occurs during a deployment task which is prior to the final cutover, for example during creation of symlinks, the process will simply stop and the previously deployed application will continue to run. However if the failing deployment task is after `deploy:symlink:release`, during which the `current` symlink is moved to the newly deployed code, this may result in an inconsistent state which may be solved by executing `cap [stage] deploy:rollback`. Rollback can also be a solution for issues with failed deployments due to buggy code or other reasons.
Per http://capistranorb.com/documentation/getting-started/flow/, the standard deployment and rollback processes are nearly identical. The difference is that in a deploy, the `deploy:updating` and `deploy:updated` tasks are executed, while in a rollback, the `deploy:reverting` and `deploy:reverted` (a hook task) tasks are run. Also, instead of `deploy:finishing`, `deploy:finishing_rollback` is run, as cleanup can sometimes be different.
### `deploy:reverting`
This starts by setting the release_path to the last known good release path. It does this by obtaining a list of folders in the releases folder and if there are at least two, sets the second to last release as the release_path. It also sets the `rollback_timestamp` to this same release which it uses for the log entry.
Once this has been set, the remaining standard deployment tasks flip the symlink accordingly.
### `deploy:finishing_rollback`
To finish the rollback, Capistrano creates a tarball of the failed release in the deploy path, and then deletes the release folder.
### `deploy:failed`
In a situation where `cap [stage] deploy` fails, the `deploy:failed` hook is invoked. You can add custom rollback tasks to this hook:
```ruby
after 'deploy:failed', :send_for_help do
#
end
```
This is different from a specifically invoked rollback, and is application specific. *For reasons stated above, it can be dangerous to use this hook without careful testing.*
### `deploy:rollback ROLLBACK_RELEASE=release`
Rollback to a specific release using the `ROLLBACK_RELEASE` environment variable.
e.g. `cap staging deploy:rollback ROLLBACK_RELEASE=20160614133327`

56
docs/documentation/getting-started/structure/index.markdown Normal file
View File

@ -0,0 +1,56 @@
---
title: Structure
layout: default
---
Capistrano uses a strictly defined directory hierarchy on each remote server to organise the source code and other deployment-related data. The root path of this structure can be defined with the configuration variable `:deploy_to`.
Assuming your `config/deploy.rb` contains this:
```ruby
set :deploy_to, '/var/www/my_app_name'
```
Then inspecting the directories inside `/var/www/my_app_name` looks like this:
```bash
├── current -> /var/www/my_app_name/releases/20150120114500/
├── releases
│   ├── 20150080072500
│   ├── 20150090083000
│   ├── 20150100093500
│   ├── 20150110104000
│   └── 20150120114500
├── repo
│ └── <VCS related data>
├── revisions.log
└── shared
└── <linked_files and linked_dirs>
```
* `current` is a symlink pointing to the latest release. This symlink is
updated at the end of a successful deployment. If the deployment fails in any
step the `current` symlink still points to the old release.
* `releases` holds all deployments in a timestamped folder. These folders are
the target of the `current` symlink.
* `repo` holds the version control system configured. In case of a git
repository the content will be a raw git repository (e.g. objects, refs,
etc.).
* `revisions.log` is used to log every deploy or rollback. Each entry is
timestamped and the executing user (username from local machine) is listed.
Depending on your VCS data like branchnames or revision numbers are listed as
well.
* `shared` contains the `linked_files` and `linked_dirs` which are symlinked
into each release. This data persists across deployments and releases. It
should be used for things like database configuration files and static and
persistent user storage handed over from one release to the next.
The application is completely contained within the path of `:deploy_to`. If
you plan on deploying multiple applications to the same server, simply choose
a different `:deploy_to` path.

24
docs/documentation/getting-started/tasks/index.markdown Normal file
View File

@ -0,0 +1,24 @@
---
title: Tasks
layout: default
---
```ruby
server 'example.com', roles: [:web, :app]
server 'example.org', roles: [:db, :workers]
desc "Report Uptimes"
task :uptime do
on roles(:all) do |host|
execute :any_command, "with args", :here, "and here"
info "Host #{host} (#{host.roles.to_a.join(', ')}):\t#{capture(:uptime)}"
end
end
```
**Note**:
**tl;dr**: `execute(:bundle, :install)` and `execute('bundle install')` don't behave identically!
`execute()` has a subtle behaviour. When calling `within './directory' { execute(:bundle, :install) }` for example, the first argument to `execute()` is a *Stringish* with ***no whitespace***. This allows the command to pass through the [SSHKit::CommandMap](https://github.com/capistrano/sshkit#the-command-map) which enables a number of powerful features.
When the first argument to `execute()` contains whitespace, for example `within './directory' { execute('bundle install') }` (or when using a heredoc), neither Capistrano, nor SSHKit can reliably predict how it should be shell escaped, and thus cannot perform any context, or command mapping, that means that the `within(){}` (as well as `with()`, `as()`, etc) have no effect. There have been a few attempts to resolve this, but we don't consider it a bug although we acknowledge that it might be a little counter intuitive.

48
docs/documentation/getting-started/user-input/index.markdown Normal file
View File

@ -0,0 +1,48 @@
---
title: User Input
layout: default
---
User input can be required in a task or during configuration:
```ruby
# used in a configuration
set :database_name, ask('Enter the database name:')
# used in a task
desc "Ask about breakfast"
task :breakfast do
ask(:breakfast, "pancakes")
on roles(:all) do |h|
execute "echo \"$(whoami) wants #{fetch(:breakfast)} for breakfast!\""
end
end
```
When using `ask` to get user input, you can pass `echo: false` to prevent the
input from being displayed. This option should be used to ask the user for
passwords and other sensitive data during a deploy run.
```ruby
set :database_password, ask('Enter the database password:', 'default', echo: false)
```
If you only pass in a symbol this will be printed as text for the user and the
input will be saved to this variable:
```ruby
ask(:database_encoding, 'UTF-8')
fetch(:database_encoding)
# => contains the user input (or the default)
# once the above line got executed
```
You can use `ask` to set a server- or role-specific configuration variable.
```ruby
set :password, ask('Server password', nil)
server 'example.com', user: 'ssh_user_name', port: 22, password: fetch(:password), roles: %w{web app db}
```

50
docs/documentation/harrow/index.markdown Normal file
View File

@ -0,0 +1,50 @@
---
title: What is Harrow?
layout: default
---
### Harrow is a web-based platform for continuous integration and deployment built by the Capistrano team.
There are many continuous integration tools in the world already, Harrow is
ours. It is designed to "feel" familiar to Capistrano users.
![Harrow, web-based Capistrano](/images/capistrano-logo-harrow-logo-c-primary-darker-w640.png)
Although Harrow is designed to work well for Capistrano-style use-cases, it is
by no means limited to only being used for Capistrano, or even for deployment.
Some of the features which make Harrow ideal for automating tools such as
Capistrano:
* A discrete concept of scripts and environments, allowing reuse of scripts in
different settings using different configurations
* A pure JSON-HAL API allowing integrations and tools
* Powerful triggers and notifications allowing the construction of pipelines
starting with git changes
Harrow, much like Capistrano can also be used to:
* To automate common tasks in software teams
* To drive infrastructure provisioning tools such as *chef-solo*, *Ansible* or similar
Again, like Capistrano, Harrow is also *very* scriptable, and can be integrated
with any other software to form part of a larger tool.
#### How To Use Harrow
1. Sign up for a Harrow [account](https://www.app.harrow.io/#/a/signin)
2. Connect your Git repository using our setup wizard
3. Choose "Capistrano" as the project template
#### What does it cost, and how does that affect Capistrano
Harrow has very reasonable [pricing](https://harrow.io/pricing/). As a
comparison with other continuous integration tools, some of our customers have
cut their monthly outgoing by a factor of 5 or more.
For individual users, it's free to use forever. To work with collaborators in
your projects, paid plans start at just $29/mo.
Capistrano is unaffected by Harrow. Capistrano will remain liberally licensed
(currently MIT) and will include discrete hooks offering Harrow to users
without being intrusive.

85
docs/documentation/overview/what-is-capistrano/index.markdown Normal file
View File

@ -0,0 +1,85 @@
---
title: What is Capistrano?
layout: default
---
### Capistrano is a remote server automation tool.
It supports the scripting and execution of arbitrary tasks, and includes a set of sane-default deployment workflows.
Capistrano can be used to:
* Reliably deploy web application to any number of machines simultaneously,
in sequence or as a rolling set
* To automate audits of any number of machines (checking login logs,
enumerating uptimes, and/or applying security patches)
* To script arbitrary workflows over SSH
* To automate common tasks in software teams.
* To drive infrastructure provisioning tools such as *chef-solo*, *Ansible* or similar.
Capistrano is also *very* scriptable, and can be integrated with any other
Ruby software to form part of a larger tool.
#### What does it look like?
![Capistrano 3.5 / Airbrussh formatter screenshot](/images/airbrussh-screenshot.png)
#### What else is in the box?
There's lots of cool stuff in the Capistrano toy box:
* Interchangeable output formatters (progress, pretty, html, etc)
* Easy to add support for other source control management software.
* A rudimentary multi-console for running Capistrano interactively.
* Host and Role filters for partial deploys, or partial-cluster maintenance.
* Recipes for the Rails asset pipelines, and database migrations.
* Support for complex environments.
* A sane, expressive API:
```ruby
desc "Show off the API"
task :ditty do
on roles(:all) do |host|
# Capture output from the remote host, and re-use it
# we can reflect on the `host` object passed to the block
# and use the `info` logger method to benefit from the
# output formatter that is selected.
uptime = capture('uptime')
if host.roles.include?(:web)
info "Your webserver #{host} has uptime: #{uptime}"
end
end
on roles(:app) do
# We can set environmental variables for the duration of a block
# and move the process into a directoy, executing arbitrary tasks
# such as letting Rails do some heavy lifting.
with({:rails_env => :production}) do
within('/var/www/my/rails/app') do
execute :rails, :runner, 'MyModel.something'
end
end
end
on roles(:db) do
# We can even switch users, provided we have support on the remote
# server for switching to that user without being prompted for a
# passphrase.
as 'postgres' do
widgets = capture "echo 'SELECT * FROM widgets;' | psql my_database"
if widgets.to_i < 50
warn "There are fewer than 50 widgets in the database on #{host}!"
end
end
end
on roles(:all) do
# We can even use `test` the way the Unix gods intended
if test("[ -d /some/directory ]")
info "Phew, it's ok, the directory exists!"
end
end
end
```

43
docs/documentation/third-party-plugins/index.markdown Normal file
View File

@ -0,0 +1,43 @@
---
title: 3rd Party Plugins
layout: default
---
Here are some Capistrano plugins you might find useful.
This list is neither complete nor audited in any way.
<div class="github-widget" data-repo="capistrano-plugins/capistrano-postgresql"></div>
<div class="github-widget" data-repo="capistrano-plugins/capistrano-unicorn-nginx"></div>
<div class="github-widget" data-repo="capistrano-plugins/capistrano-rbenv-install"></div>
<div class="github-widget" data-repo="capistrano-plugins/capistrano-safe-deploy-to"></div>
<div class="github-widget" data-repo="capistrano-plugins/capistrano-ssh-doctor"></div>
<div class="github-widget" data-repo="scottsuch/capistrano-graphite"></div>
<div class="github-widget" data-repo="dei79/capistrano-rails-collection"></div>
<div class="github-widget" data-repo="qhwa/capistrano-hostmenu"></div>
<div class="github-widget" data-repo="mattbrictson/airbrussh"></div>
<div class="github-widget" data-repo="capistrano-plugins/capistrano-faster-assets"></div>
<div class="github-widget" data-repo="ydkn/capistrano-rails-console"></div>
<div class="github-widget" data-repo="seuros/capistrano-sidekiq"></div>
<div class="github-widget" data-repo="sgruhier/capistrano-db-tasks"></div>
<div class="github-widget" data-repo="mydrive/capistrano-deploytags"></div>
<div class="github-widget" data-repo="a2ikm/capistrano-pending"></div>
<div class="github-widget" data-repo="seuros/capistrano-puma"></div>
<div class="github-widget" data-repo="sambauers/capistrano-committed"></div>
<div class="github-widget" data-repo="aidistan/capistrano-pm2"></div>

138
docs/documentation/upgrading/index.markdown Normal file
View File

@ -0,0 +1,138 @@
---
title: "Upgrading from v2.x.x"
layout: default
---
1.
Update your Gemfile: `gem 'capistrano', '~> 3.0', require: false, group: :development`
If you deploy Rails, you wil also need `capistrano-rails` and `capistrano-bundler` gems (Rails and Bundler integrations were moved out from Capistrano 3).
```ruby
group :development do
gem 'capistrano-rails', '~> 1.1', require: false
gem 'capistrano-bundler', '~> 1.1', require: false
end
```
You can add idiomatic support for your preferred ruby version manager: rvm, rbenv, chruby.
```ruby
group :development do
gem 'capistrano-rvm', '~> 0.1', require: false
gem 'capistrano-rbenv', '~> 2.0', require: false
gem 'capistrano-chruby', github: 'capistrano/chruby', require: false
end
```
2.
We recommend to capify the project from scratch and move definitions from old to new configs then.
```bash
mkdir old_cap
mv Capfile old_cap
mv config/deploy.rb old_cap
mv config/deploy/ old_cap # --> only for multistage setups
```
It's time to capify:
```bash
cap install
```
3.
Capistrano 3 is multistage by default, so you will have `config/deploy/production.rb` and `config/deploy/staging.rb` right after capifying.
If you need only one stage, remove these files and declare stage (for example `production`) and servers in `config/deploy.rb`.
4.
Update `config/deploy/production.rb` and `config/deploy/staging.rb` to have relevant data there. You may also want to add more stages from old configs (`old_cap/deploy/`).
5.
If you had a gateway server set doing `set :gateway, "www.capify.org"` you should upgrade to
```ruby
require 'net/ssh/proxy/command'
set :ssh_options, proxy: Net::SSH::Proxy::Command.new('ssh mygateway.com -W %h:%p')
```
Or the per-server `ssh_options` equivalent.
6.
Now you need to refactor your old `deploy.rb` (also `Capfile`, but in most of cases developers didn't change it in Capistrano 2.x). Move parameters (like `set :deploy_to, "/home/deploy/#{application}"` or `set :keep_releases, 4`) to `config/deploy.rb` and tasks to `Capfile`.
*Important: `repository` option was renamed to `repo_url`; `default_environment` option was renamed to `default_env`.*
Notice that some parameters are not necessary anymore: `use_sudo`, `normalize_asset_timestamps`.
7.
If you didn't use `deploy_to` before and deployed to `/u/apps/your_app_name`, you need one more change. Now default deploy path is `/var/www/app_name` and your config will be broken after upgrade. Just declare custom `deploy_to` option:
```ruby
set :deploy_to, "/u/apps/#{fetch(:application)}"
```
But in advance, `/u/apps` is not the best place to store apps and we advice you to change it later.
8.
Keep editing Capfile and uncomment addons you need, such as rbenv/rvm, bundler or rails.
```ruby
require 'capistrano/rails'
require 'capistrano/bundler'
require 'capistrano/rbenv'
```
9.
Yay! Try to deploy with your new config set. If you discover any missing info in this upgrade guide, you're welcome to contribute to it.
# General recommendations
#### Use DSL instead of writing ENV variables
Instead of:
```ruby
run <<-CMD.compact
cd -- #{latest_release} &&
RAILS_ENV=#{rails_env.to_s.shellescape} #{asset_env} #{rake} assets:precompile
CMD
```
It's better to use:
```ruby
on roles :all do
within fetch(:latest_release_directory) do
with rails_env: fetch(:rails_env) do
execute :rake, 'assets:precompile'
end
end
end
```
Note: 'within' blocks are required to be wrapped in an 'on' block for the dsl to recognize it
You may only have one 'with' block per call. If you need more than one env set, use the syntax in the 'with' block arg like this (pass it a map):
```ruby
on roles :all do
within fetch(:latest_release_directory) do
with rails_env: fetch(:rails_env), rails_relative_url_root: '/home' do
execute :rake, 'assets:precompile', env: {rails_env: fetch(:rails_env), rails_relative_url_root: ''}
end
end
end
```
# Notable differences between 2.x and 3
#### Cleanup
Capistrano 3 now runs the `deploy:cleanup` task as part of the standard deploy workflow and keeps 5 releases by default. Previously this was left for you to add manually, if required. To change the number of releases kept set the `keep_releases` configuration variable:
```ruby
set :keep_releases, 10
```

BIN
docs/favicon.ico Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

BIN
docs/fonts/social_foundicons.eot Normal file
View File

Binary file not shown.

15
docs/fonts/social_foundicons.svg Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" standalone="no"?> <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd" > <svg xmlns="http://www.w3.org/2000/svg" width="100%" height="100%">
<defs >
<font id="socialfoundicons" horiz-adv-x="933" ><font-face
font-family="Social Foundicons"
units-per-em="1000"
panose-1="0 0 0 0 0 0 0 0 0 0"
ascent="1000"
descent="0"
alphabetic="0" />
<missing-glyph horiz-adv-x="250" />
<glyph unicode=" " glyph-name="space" horiz-adv-x="250" />
<glyph unicode="~" glyph-name="asciitilde" horiz-adv-x="1000" />
</font>
</defs>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 614 B

BIN
docs/fonts/social_foundicons.ttf Normal file
View File

Binary file not shown.

BIN
docs/fonts/social_foundicons.woff Normal file
View File

Binary file not shown.

BIN
docs/images/BashStartupFiles1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 45 KiB

BIN
docs/images/CapistranoAvatar.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.0 KiB

BIN
docs/images/CapistranoGraphic.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

BIN
docs/images/CapistranoGraphicWireframe.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 65 KiB

BIN
docs/images/CapistranoLogo.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.6 KiB

BIN
docs/images/airbrussh-screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 180 KiB

BIN
docs/images/capistrano-logo-harrow-logo-c-primary-darker-w640.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 28 KiB

BIN
docs/images/git-check-example-screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 78 KiB

BIN
docs/images/github-personal-api-token-page.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 23 KiB

BIN
docs/images/successful-git-check-example-screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 71 KiB

35
docs/index.markdown Normal file
View File

@ -0,0 +1,35 @@
---
layout: default
title: A remote server automation and deployment tool written in Ruby.
---
### A Simple Task
```ruby
role :demo, %w{example.com example.org example.net}
task :uptime do
on roles(:demo), in: :parallel do |host|
uptime = capture(:uptime)
puts "#{host.hostname} reports: #{uptime}"
end
end
```
Capistrano extends the *Rake* DSL with methods specific to running commands
`on()` servers.
### For Any Language
Capistrano is written in Ruby, but it can easily be used to deploy any
language.
If your language or framework has special deployment requirements, Capistrano can easily be
extended to support them.
### Source Code
<div class="github-widget" data-repo="capistrano/capistrano"></div>
<div class="github-widget" data-repo="capistrano/capistrano.github.io"></div>
<div class="github-widget" data-repo="capistrano/documentation"></div>
<div class="github-widget" data-repo="capistrano/documentation.github.io"></div>

15
docs/js/foundation.min.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

52
docs/js/foundation/foundation.alerts.js vendored Normal file
View File

@ -0,0 +1,52 @@
/*jslint unparam: true, browser: true, indent: 2 */
;(function ($, window, document, undefined) {
'use strict';
Foundation.libs.alerts = {
name : 'alerts',
version : '4.2.2',
settings : {
speed: 300, // fade out speed
callback: function (){}
},
init : function (scope, method, options) {
this.scope = scope || this.scope;
if (typeof method === 'object') {
$.extend(true, this.settings, method);
}
if (typeof method !== 'string') {
if (!this.settings.init) { this.events(); }
return this.settings.init;
} else {
return this[method].call(this, options);
}
},
events : function () {
var self = this;
$(this.scope).on('click.fndtn.alerts', '[data-alert] a.close', function (e) {
e.preventDefault();
$(this).closest("[data-alert]").fadeOut(self.speed, function () {
$(this).remove();
self.settings.callback();
});
});
this.settings.init = true;
},
off : function () {
$(this.scope).off('.fndtn.alerts');
},
reflow : function () {}
};
}(Foundation.zj, this, this.document));

516
docs/js/foundation/foundation.clearing.js vendored Normal file
View File

@ -0,0 +1,516 @@
/*jslint unparam: true, browser: true, indent: 2 */
;(function ($, window, document, undefined) {
'use strict';
Foundation.libs.clearing = {
name : 'clearing',
version : '4.2.2',
settings : {
templates : {
viewing : '<a href="#" class="clearing-close">&times;</a>' +
'<div class="visible-img" style="display: none"><img src="//:0">' +
'<p class="clearing-caption"></p><a href="#" class="clearing-main-prev"><span></span></a>' +
'<a href="#" class="clearing-main-next"><span></span></a></div>'
},
// comma delimited list of selectors that, on click, will close clearing,
// add 'div.clearing-blackout, div.visible-img' to close on background click
close_selectors : '.clearing-close',
// event initializers and locks
init : false,
locked : false
},
init : function (scope, method, options) {
var self = this;
Foundation.inherit(this, 'set_data get_data remove_data throttle data_options');
if (typeof method === 'object') {
options = $.extend(true, this.settings, method);
}
if (typeof method !== 'string') {
$(this.scope).find('ul[data-clearing]').each(function () {
var $el = $(this),
options = options || {},
lis = $el.find('li'),
settings = self.get_data($el);
if (!settings && lis.length > 0) {
options.$parent = $el.parent();
self.set_data($el, $.extend({}, self.settings, options, self.data_options($el)));
self.assemble($el.find('li'));
if (!self.settings.init) {
self.events().swipe_events();
}
}
});
return this.settings.init;
} else {
// fire method
return this[method].call(this, options);
}
},
// event binding and initial setup
events : function () {
var self = this;
$(this.scope)
.on('click.fndtn.clearing', 'ul[data-clearing] li',
function (e, current, target) {
var current = current || $(this),
target = target || current,
next = current.next('li'),
settings = self.get_data(current.parent()),
image = $(e.target);
e.preventDefault();
if (!settings) self.init();
// if clearing is open and the current image is
// clicked, go to the next image in sequence
if (target.hasClass('visible') &&
current[0] === target[0] &&
next.length > 0 && self.is_open(current)) {
target = next;
image = target.find('img');
}
// set current and target to the clicked li if not otherwise defined.
self.open(image, current, target);
self.update_paddles(target);
})
.on('click.fndtn.clearing', '.clearing-main-next',
function (e) { this.nav(e, 'next') }.bind(this))
.on('click.fndtn.clearing', '.clearing-main-prev',
function (e) { this.nav(e, 'prev') }.bind(this))
.on('click.fndtn.clearing', this.settings.close_selectors,
function (e) { Foundation.libs.clearing.close(e, this) })
.on('keydown.fndtn.clearing',
function (e) { this.keydown(e) }.bind(this));
$(window).on('resize.fndtn.clearing',
function () { this.resize() }.bind(this));
this.settings.init = true;
return this;
},
swipe_events : function () {
var self = this;
$(this.scope)
.on('touchstart.fndtn.clearing', '.visible-img', function(e) {
if (!e.touches) { e = e.originalEvent; }
var data = {
start_page_x: e.touches[0].pageX,
start_page_y: e.touches[0].pageY,
start_time: (new Date()).getTime(),
delta_x: 0,
is_scrolling: undefined
};
$(this).data('swipe-transition', data);
e.stopPropagation();
})
.on('touchmove.fndtn.clearing', '.visible-img', function(e) {
if (!e.touches) { e = e.originalEvent; }
// Ignore pinch/zoom events
if(e.touches.length > 1 || e.scale && e.scale !== 1) return;
var data = $(this).data('swipe-transition');
if (typeof data === 'undefined') {
data = {};
}
data.delta_x = e.touches[0].pageX - data.start_page_x;
if ( typeof data.is_scrolling === 'undefined') {
data.is_scrolling = !!( data.is_scrolling || Math.abs(data.delta_x) < Math.abs(e.touches[0].pageY - data.start_page_y) );
}
if (!data.is_scrolling && !data.active) {
e.preventDefault();
var direction = (data.delta_x < 0) ? 'next' : 'prev';
data.active = true;
self.nav(e, direction);
}
})
.on('touchend.fndtn.clearing', '.visible-img', function(e) {
$(this).data('swipe-transition', {});
e.stopPropagation();
});
},
assemble : function ($li) {
var $el = $li.parent();
$el.after('<div id="foundationClearingHolder"></div>');
var holder = $('#foundationClearingHolder'),
settings = this.get_data($el),
grid = $el.detach(),
data = {
grid: '<div class="carousel">' + this.outerHTML(grid[0]) + '</div>',
viewing: settings.templates.viewing
},
wrapper = '<div class="clearing-assembled"><div>' + data.viewing +
data.grid + '</div></div>';
return holder.after(wrapper).remove();
},
// event callbacks
open : function ($image, current, target) {
var root = target.closest('.clearing-assembled'),
container = root.find('div').first(),
visible_image = container.find('.visible-img'),
image = visible_image.find('img').not($image);
if (!this.locked()) {
// set the image to the selected thumbnail
image
.attr('src', this.load($image))
.css('visibility', 'hidden');
this.loaded(image, function () {
image.css('visibility', 'visible');
// toggle the gallery
root.addClass('clearing-blackout');
container.addClass('clearing-container');
visible_image.show();
this.fix_height(target)
.caption(visible_image.find('.clearing-caption'), $image)
.center(image)
.shift(current, target, function () {
target.siblings().removeClass('visible');
target.addClass('visible');
});
}.bind(this));
}
},
close : function (e, el) {
e.preventDefault();
var root = (function (target) {
if (/blackout/.test(target.selector)) {
return target;
} else {
return target.closest('.clearing-blackout');
}
}($(el))), container, visible_image;
if (el === e.target && root) {
container = root.find('div').first();
visible_image = container.find('.visible-img');
this.settings.prev_index = 0;
root.find('ul[data-clearing]')
.attr('style', '').closest('.clearing-blackout')
.removeClass('clearing-blackout');
container.removeClass('clearing-container');
visible_image.hide();
}
return false;
},
is_open : function (current) {
return current.parent().attr('style').length > 0;
},
keydown : function (e) {
var clearing = $('.clearing-blackout').find('ul[data-clearing]');
if (e.which === 39) this.go(clearing, 'next');
if (e.which === 37) this.go(clearing, 'prev');
if (e.which === 27) $('a.clearing-close').trigger('click');
},
nav : function (e, direction) {
var clearing = $('.clearing-blackout').find('ul[data-clearing]');
e.preventDefault();
this.go(clearing, direction);
},
resize : function () {
var image = $('.clearing-blackout .visible-img').find('img');
if (image.length) {
this.center(image);
}
},
// visual adjustments
fix_height : function (target) {
var lis = target.parent().children(),
self = this;
lis.each(function () {
var li = $(this),
image = li.find('img');
if (li.height() > self.outerHeight(image)) {
li.addClass('fix-height');
}
})
.closest('ul')
.width(lis.length * 100 + '%');
return this;
},
update_paddles : function (target) {
var visible_image = target
.closest('.carousel')
.siblings('.visible-img');
if (target.next().length > 0) {
visible_image
.find('.clearing-main-next')
.removeClass('disabled');
} else {
visible_image
.find('.clearing-main-next')
.addClass('disabled');
}
if (target.prev().length > 0) {
visible_image
.find('.clearing-main-prev')
.removeClass('disabled');
} else {
visible_image
.find('.clearing-main-prev')
.addClass('disabled');
}
},
center : function (target) {
if (!this.rtl) {
target.css({
marginLeft : -(this.outerWidth(target) / 2),
marginTop : -(this.outerHeight(target) / 2)
});
} else {
target.css({
marginRight : -(this.outerWidth(target) / 2),
marginTop : -(this.outerHeight(target) / 2)
});
}
return this;
},
// image loading and preloading
load : function ($image) {
if ($image[0].nodeName === "A") {
var href = $image.attr('href');
} else {
var href = $image.parent().attr('href');
}
this.preload($image);
if (href) return href;
return $image.attr('src');
},
preload : function ($image) {
this
.img($image.closest('li').next())
.img($image.closest('li').prev());
},
loaded : function (image, callback) {
// based on jquery.imageready.js
// @weblinc, @jsantell, (c) 2012
function loaded () {
callback();
}
function bindLoad () {
this.one('load', loaded);
if (/MSIE (\d+\.\d+);/.test(navigator.userAgent)) {
var src = this.attr( 'src' ),
param = src.match( /\?/ ) ? '&' : '?';
param += 'random=' + (new Date()).getTime();
this.attr('src', src + param);
}
}
if (!image.attr('src')) {
loaded();
return;
}
if (image[0].complete || image[0].readyState === 4) {
loaded();
} else {
bindLoad.call(image);
}
},
img : function (img) {
if (img.length) {
var new_img = new Image(),
new_a = img.find('a');
if (new_a.length) {
new_img.src = new_a.attr('href');
} else {
new_img.src = img.find('img').attr('src');
}
}
return this;
},
// image caption
caption : function (container, $image) {
var caption = $image.data('caption');
if (caption) {
container
.html(caption)
.show();
} else {
container
.text('')
.hide();
}
return this;
},
// directional methods
go : function ($ul, direction) {
var current = $ul.find('.visible'),
target = current[direction]();
if (target.length) {
target
.find('img')
.trigger('click', [current, target]);
}
},
shift : function (current, target, callback) {
var clearing = target.parent(),
old_index = this.settings.prev_index || target.index(),
direction = this.direction(clearing, current, target),
left = parseInt(clearing.css('left'), 10),
width = this.outerWidth(target),
skip_shift;
// we use jQuery animate instead of CSS transitions because we
// need a callback to unlock the next animation
if (target.index() !== old_index && !/skip/.test(direction)){
if (/left/.test(direction)) {
this.lock();
clearing.animate({left : left + width}, 300, this.unlock());
} else if (/right/.test(direction)) {
this.lock();
clearing.animate({left : left - width}, 300, this.unlock());
}
} else if (/skip/.test(direction)) {
// the target image is not adjacent to the current image, so
// do we scroll right or not
skip_shift = target.index() - this.settings.up_count;
this.lock();
if (skip_shift > 0) {
clearing.animate({left : -(skip_shift * width)}, 300, this.unlock());
} else {
clearing.animate({left : 0}, 300, this.unlock());
}
}
callback();
},
direction : function ($el, current, target) {
var lis = $el.find('li'),
li_width = this.outerWidth(lis) + (this.outerWidth(lis) / 4),
up_count = Math.floor(this.outerWidth($('.clearing-container')) / li_width) - 1,
target_index = lis.index(target),
response;
this.settings.up_count = up_count;
if (this.adjacent(this.settings.prev_index, target_index)) {
if ((target_index > up_count)
&& target_index > this.settings.prev_index) {
response = 'right';
} else if ((target_index > up_count - 1)
&& target_index <= this.settings.prev_index) {
response = 'left';
} else {
response = false;
}
} else {
response = 'skip';
}
this.settings.prev_index = target_index;
return response;
},
adjacent : function (current_index, target_index) {
for (var i = target_index + 1; i >= target_index - 1; i--) {
if (i === current_index) return true;
}
return false;
},
// lock management
lock : function () {
this.settings.locked = true;
},
unlock : function () {
this.settings.locked = false;
},
locked : function () {
return this.settings.locked;
},
// plugin management/browser quirks
outerHTML : function (el) {
// support FireFox < 11
return el.outerHTML || new XMLSerializer().serializeToString(el);
},
off : function () {
$(this.scope).off('.fndtn.clearing');
$(window).off('.fndtn.clearing');
this.remove_data(); // empty settings cache
this.settings.init = false;
},
reflow : function () {
this.init();
}
};
}(Foundation.zj, this, this.document));

74
docs/js/foundation/foundation.cookie.js vendored Normal file
View File

@ -0,0 +1,74 @@
/*!
* jQuery Cookie Plugin v1.3
* https://github.com/carhartl/jquery-cookie
*
* Copyright 2011, Klaus Hartl
* Dual licensed under the MIT or GPL Version 2 licenses.
* http://www.opensource.org/licenses/mit-license.php
* http://www.opensource.org/licenses/GPL-2.0
*
* Modified to work with Zepto.js by ZURB
*/
(function ($, document, undefined) {
var pluses = /\+/g;
function raw(s) {
return s;
}
function decoded(s) {
return decodeURIComponent(s.replace(pluses, ' '));
}
var config = $.cookie = function (key, value, options) {
// write
if (value !== undefined) {
options = $.extend({}, config.defaults, options);
if (value === null) {
options.expires = -1;
}
if (typeof options.expires === 'number') {
var days = options.expires, t = options.expires = new Date();
t.setDate(t.getDate() + days);
}
value = config.json ? JSON.stringify(value) : String(value);
return (document.cookie = [
encodeURIComponent(key), '=', config.raw ? value : encodeURIComponent(value),
options.expires ? '; expires=' + options.expires.toUTCString() : '', // use expires attribute, max-age is not supported by IE
options.path ? '; path=' + options.path : '',
options.domain ? '; domain=' + options.domain : '',
options.secure ? '; secure' : ''
].join(''));
}
// read
var decode = config.raw ? raw : decoded;
var cookies = document.cookie.split('; ');
for (var i = 0, l = cookies.length; i < l; i++) {
var parts = cookies[i].split('=');
if (decode(parts.shift()) === key) {
var cookie = decode(parts.join('='));
return config.json ? JSON.parse(cookie) : cookie;
}
}
return null;
};
config.defaults = {};
$.removeCookie = function (key, options) {
if ($.cookie(key) !== null) {
$.cookie(key, null, options);
return true;
}
return false;
};
})(Foundation.zj, document);

178
docs/js/foundation/foundation.dropdown.js vendored Normal file
View File

@ -0,0 +1,178 @@
/*jslint unparam: true, browser: true, indent: 2 */
;(function ($, window, document, undefined) {
'use strict';
Foundation.libs.dropdown = {
name : 'dropdown',
version : '4.2.0',
settings : {
activeClass: 'open',
is_hover: false,
opened: function(){},
closed: function(){}
},
init : function (scope, method, options) {
this.scope = scope || this.scope;
Foundation.inherit(this, 'throttle scrollLeft data_options');
if (typeof method === 'object') {
$.extend(true, this.settings, method);
}
if (typeof method !== 'string') {
if (!this.settings.init) {
this.events();
}
return this.settings.init;
} else {
return this[method].call(this, options);
}
},
events : function () {
var self = this;
$(this.scope)
.on('click.fndtn.dropdown', '[data-dropdown]', function (e) {
var settings = $.extend({}, self.settings, self.data_options($(this)));
e.preventDefault();
if (!settings.is_hover) self.toggle($(this));
})
.on('mouseenter', '[data-dropdown]', function (e) {
var settings = $.extend({}, self.settings, self.data_options($(this)));
if (settings.is_hover) self.toggle($(this));
})
.on('mouseleave', '[data-dropdown-content]', function (e) {
var target = $('[data-dropdown="' + $(this).attr('id') + '"]'),
settings = $.extend({}, self.settings, self.data_options(target));
if (settings.is_hover) self.close.call(self, $(this));
})
.on('opened.fndtn.dropdown', '[data-dropdown-content]', this.settings.opened)
.on('closed.fndtn.dropdown', '[data-dropdown-content]', this.settings.closed);
$('body').on('click.fndtn.dropdown', function (e) {
var parent = $(e.target).closest('[data-dropdown-content]');
if ($(e.target).data('dropdown')) {
return;
}
if (parent.length > 0 && ($(e.target).is('[data-dropdown-content]') || $.contains(parent.first()[0], e.target))) {
e.stopPropagation();
return;
}
self.close.call(self, $('[data-dropdown-content]'));
});
$(window).on('resize.fndtn.dropdown', self.throttle(function () {
self.resize.call(self);
}, 50)).trigger('resize');
this.settings.init = true;
},
close: function (dropdown) {
var self = this;
dropdown.each(function () {
if ($(this).hasClass(self.settings.activeClass)) {
$(this)
.css(Foundation.rtl ? 'right':'left', '-99999px')
.removeClass(self.settings.activeClass);
$(this).trigger('closed');
}
});
},
open: function (dropdown, target) {
this
.css(dropdown
.addClass(this.settings.activeClass), target);
dropdown.trigger('opened');
},
toggle : function (target) {
var dropdown = $('#' + target.data('dropdown'));
this.close.call(this, $('[data-dropdown-content]').not(dropdown));
if (dropdown.hasClass(this.settings.activeClass)) {
this.close.call(this, dropdown);
} else {
this.close.call(this, $('[data-dropdown-content]'))
this.open.call(this, dropdown, target);
}
},
resize : function () {
var dropdown = $('[data-dropdown-content].open'),
target = $("[data-dropdown='" + dropdown.attr('id') + "']");
if (dropdown.length && target.length) {
this.css(dropdown, target);
}
},
css : function (dropdown, target) {
var offset_parent = dropdown.offsetParent();
// temporary workaround until 4.2
if (offset_parent.length > 0 && /body/i.test(dropdown.offsetParent()[0].nodeName)) {
var position = target.offset();
position.top -= dropdown.offsetParent().offset().top;
position.left -= dropdown.offsetParent().offset().left;
} else {
var position = target.position();
}
if (this.small()) {
dropdown.css({
position : 'absolute',
width: '95%',
left: '2.5%',
'max-width': 'none',
top: position.top + this.outerHeight(target)
});
} else {
if (!Foundation.rtl && $(window).width() > this.outerWidth(dropdown) + target.offset().left) {
var left = position.left;
if (dropdown.hasClass('right')) {
dropdown.removeClass('right');
}
} else {
if (!dropdown.hasClass('right')) {
dropdown.addClass('right');
}
var left = position.left - (this.outerWidth(dropdown) - this.outerWidth(target));
}
dropdown.attr('style', '').css({
position : 'absolute',
top: position.top + this.outerHeight(target),
left: left
});
}
return dropdown;
},
small : function () {
return $(window).width() < 768 || $('html').hasClass('lt-ie9');
},
off: function () {
$(this.scope).off('.fndtn.dropdown');
$('html, body').off('.fndtn.dropdown');
$(window).off('.fndtn.dropdown');
$('[data-dropdown-content]').off('.fndtn.dropdown');
this.settings.init = false;
},
reflow : function () {}
};
}(Foundation.zj, this, this.document));

525
docs/js/foundation/foundation.forms.js vendored Normal file
View File

@ -0,0 +1,525 @@
(function ($, window, document, undefined) {
'use strict';
Foundation.libs.forms = {
name: 'forms',
version: '4.2.2',
cache: {},
settings: {
disable_class: 'no-custom',
last_combo : null
},
init: function (scope, method, options) {
if (typeof method === 'object') {
$.extend(true, this.settings, method);
}
if (typeof method !== 'string') {
if (!this.settings.init) {
this.events();
}
this.assemble();
return this.settings.init;
} else {
return this[method].call(this, options);
}
},
assemble: function () {
$('form.custom input[type="radio"]', $(this.scope))
.not('[data-customforms="disabled"]')
.not('.' + this.settings.disable_class)
.each(this.append_custom_markup);
$('form.custom input[type="checkbox"]', $(this.scope))
.not('[data-customforms="disabled"]')
.not('.' + this.settings.disable_class)
.each(this.append_custom_markup);
$('form.custom select', $(this.scope))
.not('[data-customforms="disabled"]')
.not('.' + this.settings.disable_class)
.not('[multiple=multiple]')
.each(this.append_custom_select);
},
events: function () {
var self = this;
$(this.scope)
.on('click.fndtn.forms', 'form.custom span.custom.checkbox', function (e) {
e.preventDefault();
e.stopPropagation();
self.toggle_checkbox($(this));
})
.on('click.fndtn.forms', 'form.custom span.custom.radio', function (e) {
e.preventDefault();
e.stopPropagation();
self.toggle_radio($(this));
})
.on('change.fndtn.forms', 'form.custom select', function (e, force_refresh) {
if (!$(this).not('[data-customforms="disabled"])')) return;
self.refresh_custom_select($(this), force_refresh);
})
.on('click.fndtn.forms', 'form.custom label', function (e) {
if ($(e.target).is('label')) {
var $associatedElement = $('#' + self.escape($(this).attr('for'))).not('[data-customforms="disabled"]'),
$customCheckbox,
$customRadio;
if ($associatedElement.length !== 0) {
if ($associatedElement.attr('type') === 'checkbox') {
e.preventDefault();
$customCheckbox = $(this).find('span.custom.checkbox');
//the checkbox might be outside after the label or inside of another element
if ($customCheckbox.length === 0) {
$customCheckbox = $associatedElement.add(this).siblings('span.custom.checkbox').first();
}
self.toggle_checkbox($customCheckbox);
} else if ($associatedElement.attr('type') === 'radio') {
e.preventDefault();
$customRadio = $(this).find('span.custom.radio');
//the radio might be outside after the label or inside of another element
if ($customRadio.length === 0) {
$customRadio = $associatedElement.add(this).siblings('span.custom.radio').first();
}
self.toggle_radio($customRadio);
}
}
}
})
.on('mousedown.fndtn.forms', 'form.custom div.custom.dropdown', function () {
return false;
})
.on('click.fndtn.forms', 'form.custom div.custom.dropdown a.current, form.custom div.custom.dropdown a.selector', function (e) {
var $this = $(this),
$dropdown = $this.closest('div.custom.dropdown'),
$select = getFirstPrevSibling($dropdown, 'select');
// make sure other dropdowns close
if (!$dropdown.hasClass('open')) $(self.scope).trigger('click');
e.preventDefault();
if (false === $select.is(':disabled')) {
$dropdown.toggleClass('open');
if ($dropdown.hasClass('open')) {
$(self.scope).on('click.fndtn.forms.customdropdown', function () {
$dropdown.removeClass('open');
$(self.scope).off('.fndtn.forms.customdropdown');
});
} else {
$(self.scope).on('.fndtn.forms.customdropdown');
}
return false;
}
})
.on('click.fndtn.forms touchend.fndtn.forms', 'form.custom div.custom.dropdown li', function (e) {
var $this = $(this),
$customDropdown = $this.closest('div.custom.dropdown'),
$select = getFirstPrevSibling($customDropdown, 'select'),
selectedIndex = 0;
e.preventDefault();
e.stopPropagation();
if (!$(this).hasClass('disabled')) {
$('div.dropdown').not($customDropdown).removeClass('open');
var $oldThis = $this.closest('ul')
.find('li.selected');
$oldThis.removeClass('selected');
$this.addClass('selected');
$customDropdown.removeClass('open')
.find('a.current')
.text($this.text());
$this.closest('ul').find('li').each(function (index) {
if ($this[0] === this) {
selectedIndex = index;
}
});
$select[0].selectedIndex = selectedIndex;
//store the old value in data
$select.data('prevalue', $oldThis.html());
$select.trigger('change');
}
});
$(window).on('keydown', function (e) {
var focus = document.activeElement,
self = Foundation.libs.forms,
dropdown = $('.custom.dropdown.open');
if (dropdown.length > 0) {
e.preventDefault();
if (e.which === 13) {
dropdown.find('li.selected').trigger('click');
}
if (e.which === 27) {
dropdown.removeClass('open');
}
if (e.which >= 65 && e.which <= 90) {
var next = self.go_to(dropdown, e.which),
current = dropdown.find('li.selected');
if (next) {
current.removeClass('selected');
self.scrollTo(next.addClass('selected'), 300);
}
}
if (e.which === 38) {
var current = dropdown.find('li.selected'),
prev = current.prev(':not(.disabled)');
if (prev.length > 0) {
prev.parent()[0].scrollTop = prev.parent().scrollTop() - self.outerHeight(prev);
current.removeClass('selected');
prev.addClass('selected');
}
} else if (e.which === 40) {
var current = dropdown.find('li.selected'),
next = current.next(':not(.disabled)');
if (next.length > 0) {
next.parent()[0].scrollTop = next.parent().scrollTop() + self.outerHeight(next);
current.removeClass('selected');
next.addClass('selected');
}
}
}
});
this.settings.init = true;
},
go_to: function (dropdown, character) {
var lis = dropdown.find('li'),
count = lis.length;
if (count > 0) {
for (var i = 0; i < count; i++) {
var first_letter = lis.eq(i).text().charAt(0).toLowerCase();
if (first_letter === String.fromCharCode(character).toLowerCase()) return lis.eq(i);
}
}
},
scrollTo: function (el, duration) {
if (duration < 0) return;
var parent = el.parent();
var li_height = this.outerHeight(el);
var difference = (li_height * (el.index())) - parent.scrollTop();
var perTick = difference / duration * 10;
this.scrollToTimerCache = setTimeout(function () {
if (!isNaN(parseInt(perTick, 10))) {
parent[0].scrollTop = parent.scrollTop() + perTick;
this.scrollTo(el, duration - 10);
}
}.bind(this), 10);
},
append_custom_markup: function (idx, sel) {
var $this = $(sel),
type = $this.attr('type'),
$span = $this.next('span.custom.' + type);
if (!$this.parent().hasClass('switch')) {
$this.addClass('hidden-field');
}
if ($span.length === 0) {
$span = $('<span class="custom ' + type + '"></span>').insertAfter($this);
}
$span.toggleClass('checked', $this.is(':checked'));
$span.toggleClass('disabled', $this.is(':disabled'));
},
append_custom_select: function (idx, sel) {
var self = Foundation.libs.forms,
$this = $(sel),
$customSelect = $this.next('div.custom.dropdown'),
$customList = $customSelect.find('ul'),
$selectCurrent = $customSelect.find(".current"),
$selector = $customSelect.find(".selector"),
$options = $this.find('option'),
$selectedOption = $options.filter(':selected'),
copyClasses = $this.attr('class') ? $this.attr('class').split(' ') : [],
maxWidth = 0,
liHtml = '',
$listItems,
$currentSelect = false;
if ($customSelect.length === 0) {
var customSelectSize = $this.hasClass('small') ? 'small' : $this.hasClass('medium') ? 'medium' : $this.hasClass('large') ? 'large' : $this.hasClass('expand') ? 'expand' : '';
$customSelect = $('<div class="' + ['custom', 'dropdown', customSelectSize].concat(copyClasses).filter(function (item, idx, arr) {
if (item === '') return false;
return arr.indexOf(item) === idx;
}).join(' ') + '"><a href="#" class="selector"></a><ul /></div>');
$selector = $customSelect.find(".selector");
$customList = $customSelect.find("ul");
liHtml = $options.map(function () {
var copyClasses = $(this).attr('class') ? $(this).attr('class') : '';
return "<li class='" + copyClasses + "'>" + $(this).html() + "</li>";
}).get().join('');
$customList.append(liHtml);
$currentSelect = $customSelect
.prepend('<a href="#" class="current">' + $selectedOption.html() + '</a>')
.find(".current");
$this.after($customSelect)
.addClass('hidden-field');
} else {
liHtml = $options.map(function () {
return "<li>" + $(this).html() + "</li>";
})
.get().join('');
$customList.html('')
.append(liHtml);
} // endif $customSelect.length === 0
self.assign_id($this, $customSelect);
$customSelect.toggleClass('disabled', $this.is(':disabled'));
$listItems = $customList.find('li');
// cache list length
self.cache[$customSelect.data('id')] = $listItems.length;
$options.each(function (index) {
if (this.selected) {
$listItems.eq(index).addClass('selected');
if ($currentSelect) {
$currentSelect.html($(this).html());
}
}
if ($(this).is(':disabled')) {
$listItems.eq(index).addClass('disabled');
}
});
//
// If we're not specifying a predetermined form size.
//
if (!$customSelect.is('.small, .medium, .large, .expand')) {
// ------------------------------------------------------------------------------------
// This is a work-around for when elements are contained within hidden parents.
// For example, when custom-form elements are inside of a hidden reveal modal.
//
// We need to display the current custom list element as well as hidden parent elements
// in order to properly calculate the list item element's width property.
// -------------------------------------------------------------------------------------
$customSelect.addClass('open');
//
// Quickly, display all parent elements.
// This should help us calcualate the width of the list item's within the drop down.
//
var self = Foundation.libs.forms;
self.hidden_fix.adjust($customList);
maxWidth = (self.outerWidth($listItems) > maxWidth) ? self.outerWidth($listItems) : maxWidth;
Foundation.libs.forms.hidden_fix.reset();
$customSelect.removeClass('open');
} // endif
},
assign_id: function ($select, $customSelect) {
var id = [+new Date(), Foundation.random_str(5)].join('-');
$select.attr('data-id', id);
$customSelect.attr('data-id', id);
},
refresh_custom_select: function ($select, force_refresh) {
var self = this;
var maxWidth = 0,
$customSelect = $select.next(),
$options = $select.find('option'),
$listItems = $customSelect.find('li');
if ($listItems.length !== this.cache[$customSelect.data('id')] || force_refresh) {
$customSelect.find('ul').html('');
$options.each(function () {
var $li = $('<li>' + $(this).html() + '</li>');
$customSelect.find('ul').append($li);
});
// re-populate
$options.each(function (index) {
if (this.selected) {
$customSelect.find('li').eq(index).addClass('selected');
$customSelect.find('.current').html($(this).html());
}
if ($(this).is(':disabled')) {
$customSelect.find('li').eq(index).addClass('disabled');
}
});
// fix width
$customSelect.removeAttr('style')
.find('ul').removeAttr('style');
$customSelect.find('li').each(function () {
$customSelect.addClass('open');
if (self.outerWidth($(this)) > maxWidth) {
maxWidth = self.outerWidth($(this));
}
$customSelect.removeClass('open');
});
$listItems = $customSelect.find('li');
// cache list length
this.cache[$customSelect.data('id')] = $listItems.length;
}
},
toggle_checkbox: function ($element) {
var $input = $element.prev(),
input = $input[0];
if (false === $input.is(':disabled')) {
input.checked = ((input.checked) ? false : true);
$element.toggleClass('checked');
$input.trigger('change');
}
},
toggle_radio: function ($element) {
var $input = $element.prev(),
$form = $input.closest('form.custom'),
input = $input[0];
if (false === $input.is(':disabled')) {
$form.find('input[type="radio"][name="' + this.escape($input.attr('name')) + '"]')
.next().not($element).removeClass('checked');
if (!$element.hasClass('checked')) {
$element.toggleClass('checked');
}
input.checked = $element.hasClass('checked');
$input.trigger('change');
}
},
escape: function (text) {
if (!text) return '';
return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
},
hidden_fix: {
/**
* Sets all hidden parent elements and self to visibile.
*
* @method adjust
* @param {jQuery Object} $child
*/
// We'll use this to temporarily store style properties.
tmp: [],
// We'll use this to set hidden parent elements.
hidden: null,
adjust: function ($child) {
// Internal reference.
var _self = this;
// Set all hidden parent elements, including this element.
_self.hidden = $child.parents();
_self.hidden = _self.hidden.add($child).filter(":hidden");
// Loop through all hidden elements.
_self.hidden.each(function () {
// Cache the element.
var $elem = $(this);
// Store the style attribute.
// Undefined if element doesn't have a style attribute.
_self.tmp.push($elem.attr('style'));
// Set the element's display property to block,
// but ensure it's visibility is hidden.
$elem.css({
'visibility': 'hidden',
'display': 'block'
});
});
}, // end adjust
/**
* Resets the elements previous state.
*
* @method reset
*/
reset: function () {
// Internal reference.
var _self = this;
// Loop through our hidden element collection.
_self.hidden.each(function (i) {
// Cache this element.
var $elem = $(this),
_tmp = _self.tmp[i]; // Get the stored 'style' value for this element.
// If the stored value is undefined.
if (_tmp === undefined)
// Remove the style attribute.
$elem.removeAttr('style');
else
// Otherwise, reset the element style attribute.
$elem.attr('style', _tmp);
});
// Reset the tmp array.
_self.tmp = [];
// Reset the hidden elements variable.
_self.hidden = null;
} // end reset
},
off: function () {
$(this.scope).off('.fndtn.forms');
},
reflow : function () {}
};
var getFirstPrevSibling = function($el, selector) {
var $el = $el.prev();
while ($el.length) {
if ($el.is(selector)) return $el;
$el = $el.prev();
}
return $();
};
}(Foundation.zj, this, this.document));

271
docs/js/foundation/foundation.interchange.js vendored Normal file
View File

@ -0,0 +1,271 @@
/*jslint unparam: true, browser: true, indent: 2 */
;(function ($, window, document, undefined) {
'use strict';
Foundation.libs.interchange = {
name : 'interchange',
version : '4.2.2',
cache : {},
settings : {
load_attr : 'interchange',
named_queries : {
'default' : 'only screen and (min-width: 1px)',
small : 'only screen and (min-width: 768px)',
medium : 'only screen and (min-width: 1280px)',
large : 'only screen and (min-width: 1440px)',
landscape : 'only screen and (orientation: landscape)',
portrait : 'only screen and (orientation: portrait)',
retina : 'only screen and (-webkit-min-device-pixel-ratio: 2),' +
'only screen and (min--moz-device-pixel-ratio: 2),' +
'only screen and (-o-min-device-pixel-ratio: 2/1),' +
'only screen and (min-device-pixel-ratio: 2),' +
'only screen and (min-resolution: 192dpi),' +
'only screen and (min-resolution: 2dppx)'
},
directives : {
replace : function (el, path) {
if (/IMG/.test(el[0].nodeName)) {
var path_parts = path.split('/'),
path_file = path_parts[path_parts.length - 1],
orig_path = el[0].src;
if (new RegExp(path_file, 'i').test(el[0].src)) return;
el[0].src = path;
return el.trigger('replace', [el[0].src, orig_path]);
}
}
}
},
init : function (scope, method, options) {
Foundation.inherit(this, 'throttle');
if (typeof method === 'object') {
$.extend(true, this.settings, method);
}
this.events();
this.images();
if (typeof method !== 'string') {
return this.settings.init;
} else {
return this[method].call(this, options);
}
},
events : function () {
var self = this;
$(window).on('resize.fndtn.interchange', self.throttle(function () {
self.resize.call(self);
}, 50));
},
resize : function () {
var cache = this.cache;
for (var uuid in cache) {
if (cache.hasOwnProperty(uuid)) {
var passed = this.results(uuid, cache[uuid]);
if (passed) {
this.settings.directives[passed
.scenario[1]](passed.el, passed.scenario[0]);
}
}
}
},
results : function (uuid, scenarios) {
var count = scenarios.length,
results_arr = [];
if (count > 0) {
var el = $('[data-uuid="' + uuid + '"]');
for (var i = count - 1; i >= 0; i--) {
var rule = scenarios[i][2];
if (this.settings.named_queries.hasOwnProperty(rule)) {
var mq = matchMedia(this.settings.named_queries[rule]);
} else {
var mq = matchMedia(scenarios[i][2]);
}
if (mq.matches) {
return {el: el, scenario: scenarios[i]};
}
}
}
return false;
},
images : function (force_update) {
if (typeof this.cached_images === 'undefined' || force_update) {
return this.update_images();
}
return this.cached_images;
},
update_images : function () {
var images = document.getElementsByTagName('img'),
count = images.length,
data_attr = 'data-' + this.settings.load_attr;
this.cached_images = [];
for (var i = count - 1; i >= 0; i--) {
this.loaded($(images[i]), (i === 0), function (image, last) {
if (image) {
var str = image.getAttribute(data_attr) || '';
if (str.length > 0) {
this.cached_images.push(image);
}
}
if (last) this.enhance();
}.bind(this));
}
return 'deferred';
},
// based on jquery.imageready.js
// @weblinc, @jsantell, (c) 2012
loaded : function (image, last, callback) {
function loaded () {
callback(image[0], last);
}
function bindLoad () {
this.one('load', loaded);
if (/MSIE (\d+\.\d+);/.test(navigator.userAgent)) {
var src = this.attr( 'src' ),
param = src.match( /\?/ ) ? '&' : '?';
param += 'random=' + (new Date()).getTime();
this.attr('src', src + param);
}
}
if (!image.attr('src')) {
loaded();
return;
}
if (image[0].complete || image[0].readyState === 4) {
loaded();
} else {
bindLoad.call(image);
}
},
enhance : function () {
var count = this.images().length;
for (var i = count - 1; i >= 0; i--) {
this._object($(this.images()[i]));
}
return $(window).trigger('resize');
},
parse_params : function (path, directive, mq) {
return [this.trim(path), this.convert_directive(directive), this.trim(mq)];
},
convert_directive : function (directive) {
var trimmed = this.trim(directive);
if (trimmed.length > 0) {
return trimmed;
}
return 'replace';
},
_object : function(el) {
var raw_arr = this.parse_data_attr(el),
scenarios = [], count = raw_arr.length;
if (count > 0) {
for (var i = count - 1; i >= 0; i--) {
var split = raw_arr[i].split(/\((.*?)(\))$/);
if (split.length > 1) {
var cached_split = split[0].split(','),
params = this.parse_params(cached_split[0],
cached_split[1], split[1]);
scenarios.push(params);
}
}
}
return this.store(el, scenarios);
},
uuid : function (separator) {
var delim = separator || "-";
function S4() {
return (((1 + Math.random()) * 0x10000) | 0).toString(16).substring(1);
}
return (S4() + S4() + delim + S4() + delim + S4()
+ delim + S4() + delim + S4() + S4() + S4());
},
store : function (el, scenarios) {
var uuid = this.uuid(),
current_uuid = el.data('uuid');
if (current_uuid) return this.cache[current_uuid];
el.attr('data-uuid', uuid);
return this.cache[uuid] = scenarios;
},
trim : function(str) {
if (typeof str === 'string') {
return $.trim(str);
}
return str;
},
parse_data_attr : function (el) {
var raw = el.data(this.settings.load_attr).split(/\[(.*?)\]/),
count = raw.length, output = [];
for (var i = count - 1; i >= 0; i--) {
if (raw[i].replace(/[\W\d]+/, '').length > 4) {
output.push(raw[i]);
}
}
return output;
},
reflow : function () {
this.images(true);
}
};
}(Foundation.zj, this, this.document));

844
docs/js/foundation/foundation.joyride.js vendored Normal file
View File

@ -0,0 +1,844 @@
/*jslint unparam: true, browser: true, indent: 2 */
(function ($, window, document, undefined) {
'use strict';
Foundation.libs.joyride = {
name: 'joyride',
version : '4.2.2',
defaults : {
expose : false, // turn on or off the expose feature
modal : false, // Whether to cover page with modal during the tour
tipLocation : 'bottom', // 'top' or 'bottom' in relation to parent
nubPosition : 'auto', // override on a per tooltip bases
scrollSpeed : 300, // Page scrolling speed in milliseconds, 0 = no scroll animation
timer : 0, // 0 = no timer , all other numbers = timer in milliseconds
startTimerOnClick : true, // true or false - true requires clicking the first button start the timer
startOffset : 0, // the index of the tooltip you want to start on (index of the li)
nextButton : true, // true or false to control whether a next button is used
tipAnimation : 'fade', // 'pop' or 'fade' in each tip
pauseAfter : [], // array of indexes where to pause the tour after
exposed : [], // array of expose elements
tipAnimationFadeSpeed: 300, // when tipAnimation = 'fade' this is speed in milliseconds for the transition
cookieMonster : false, // true or false to control whether cookies are used
cookieName : 'joyride', // Name the cookie you'll use
cookieDomain : false, // Will this cookie be attached to a domain, ie. '.notableapp.com'
cookieExpires : 365, // set when you would like the cookie to expire.
tipContainer : 'body', // Where will the tip be attached
postRideCallback : function (){}, // A method to call once the tour closes (canceled or complete)
postStepCallback : function (){}, // A method to call after each step
preStepCallback : function (){}, // A method to call before each step
preRideCallback : function (){}, // A method to call before the tour starts (passed index, tip, and cloned exposed element)
postExposeCallback : function (){}, // A method to call after an element has been exposed
template : { // HTML segments for tip layout
link : '<a href="#close" class="joyride-close-tip">&times;</a>',
timer : '<div class="joyride-timer-indicator-wrap"><span class="joyride-timer-indicator"></span></div>',
tip : '<div class="joyride-tip-guide"><span class="joyride-nub"></span></div>',
wrapper : '<div class="joyride-content-wrapper"></div>',
button : '<a href="#" class="small button joyride-next-tip"></a>',
modal : '<div class="joyride-modal-bg"></div>',
expose : '<div class="joyride-expose-wrapper"></div>',
exposeCover: '<div class="joyride-expose-cover"></div>'
},
exposeAddClass : '' // One or more space-separated class names to be added to exposed element
},
settings : {},
init : function (scope, method, options) {
this.scope = scope || this.scope;
Foundation.inherit(this, 'throttle data_options scrollTo scrollLeft delay');
if (typeof method === 'object') {
$.extend(true, this.settings, this.defaults, method);
} else {
$.extend(true, this.settings, this.defaults, options);
}
if (typeof method !== 'string') {
if (!this.settings.init) this.events();
return this.settings.init;
} else {
return this[method].call(this, options);
}
},
events : function () {
var self = this;
$(this.scope)
.on('click.joyride', '.joyride-next-tip, .joyride-modal-bg', function (e) {
e.preventDefault();
if (this.settings.$li.next().length < 1) {
this.end();
} else if (this.settings.timer > 0) {
clearTimeout(this.settings.automate);
this.hide();
this.show();
this.startTimer();
} else {
this.hide();
this.show();
}
}.bind(this))
.on('click.joyride', '.joyride-close-tip', function (e) {
e.preventDefault();
this.end();
}.bind(this));
$(window).on('resize.fndtn.joyride', self.throttle(function () {
if ($('[data-joyride]').length > 0 && self.settings.$next_tip) {
if (self.settings.exposed.length > 0) {
var $els = $(self.settings.exposed);
$els.each(function () {
var $this = $(this);
self.un_expose($this);
self.expose($this);
});
}
if (self.is_phone()) {
self.pos_phone();
} else {
self.pos_default(false, true);
}
}
}, 100));
this.settings.init = true;
},
start : function () {
var self = this,
$this = $(this.scope).find('[data-joyride]'),
integer_settings = ['timer', 'scrollSpeed', 'startOffset', 'tipAnimationFadeSpeed', 'cookieExpires'],
int_settings_count = integer_settings.length;
if (!this.settings.init) this.init();
// non configureable settings
this.settings.$content_el = $this;
this.settings.$body = $(this.settings.tipContainer);
this.settings.body_offset = $(this.settings.tipContainer).position();
this.settings.$tip_content = this.settings.$content_el.find('> li');
this.settings.paused = false;
this.settings.attempts = 0;
this.settings.tipLocationPatterns = {
top: ['bottom'],
bottom: [], // bottom should not need to be repositioned
left: ['right', 'top', 'bottom'],
right: ['left', 'top', 'bottom']
};
// can we create cookies?
if (typeof $.cookie !== 'function') {
this.settings.cookieMonster = false;
}
// generate the tips and insert into dom.
if (!this.settings.cookieMonster || this.settings.cookieMonster && $.cookie(this.settings.cookieName) === null) {
this.settings.$tip_content.each(function (index) {
var $this = $(this);
$.extend(true, self.settings, self.data_options($this));
// Make sure that settings parsed from data_options are integers where necessary
for (var i = int_settings_count - 1; i >= 0; i--) {
self.settings[integer_settings[i]] = parseInt(self.settings[integer_settings[i]], 10);
}
self.create({$li : $this, index : index});
});
// show first tip
if (!this.settings.startTimerOnClick && this.settings.timer > 0) {
this.show('init');
this.startTimer();
} else {
this.show('init');
}
}
},
resume : function () {
this.set_li();
this.show();
},
tip_template : function (opts) {
var $blank, content;
opts.tip_class = opts.tip_class || '';
$blank = $(this.settings.template.tip).addClass(opts.tip_class);
content = $.trim($(opts.li).html()) +
this.button_text(opts.button_text) +
this.settings.template.link +
this.timer_instance(opts.index);
$blank.append($(this.settings.template.wrapper));
$blank.first().attr('data-index', opts.index);
$('.joyride-content-wrapper', $blank).append(content);
return $blank[0];
},
timer_instance : function (index) {
var txt;
if ((index === 0 && this.settings.startTimerOnClick && this.settings.timer > 0) || this.settings.timer === 0) {
txt = '';
} else {
txt = this.outerHTML($(this.settings.template.timer)[0]);
}
return txt;
},
button_text : function (txt) {
if (this.settings.nextButton) {
txt = $.trim(txt) || 'Next';
txt = this.outerHTML($(this.settings.template.button).append(txt)[0]);
} else {
txt = '';
}
return txt;
},
create : function (opts) {
var buttonText = opts.$li.attr('data-button') || opts.$li.attr('data-text'),
tipClass = opts.$li.attr('class'),
$tip_content = $(this.tip_template({
tip_class : tipClass,
index : opts.index,
button_text : buttonText,
li : opts.$li
}));
$(this.settings.tipContainer).append($tip_content);
},
show : function (init) {
var $timer = null;
// are we paused?
if (this.settings.$li === undefined
|| ($.inArray(this.settings.$li.index(), this.settings.pauseAfter) === -1)) {
// don't go to the next li if the tour was paused
if (this.settings.paused) {
this.settings.paused = false;
} else {
this.set_li(init);
}
this.settings.attempts = 0;
if (this.settings.$li.length && this.settings.$target.length > 0) {
if (init) { //run when we first start
this.settings.preRideCallback(this.settings.$li.index(), this.settings.$next_tip);
if (this.settings.modal) {
this.show_modal();
}
}
this.settings.preStepCallback(this.settings.$li.index(), this.settings.$next_tip);
if (this.settings.modal && this.settings.expose) {
this.expose();
}
this.settings.tipSettings = $.extend(this.settings, this.data_options(this.settings.$li));
this.settings.timer = parseInt(this.settings.timer, 10);
this.settings.tipSettings.tipLocationPattern = this.settings.tipLocationPatterns[this.settings.tipSettings.tipLocation];
// scroll if not modal
if (!/body/i.test(this.settings.$target.selector)) {
this.scroll_to();
}
if (this.is_phone()) {
this.pos_phone(true);
} else {
this.pos_default(true);
}
$timer = this.settings.$next_tip.find('.joyride-timer-indicator');
if (/pop/i.test(this.settings.tipAnimation)) {
$timer.width(0);
if (this.settings.timer > 0) {
this.settings.$next_tip.show();
this.delay(function () {
$timer.animate({
width: $timer.parent().width()
}, this.settings.timer, 'linear');
}.bind(this), this.settings.tipAnimationFadeSpeed);
} else {
this.settings.$next_tip.show();
}
} else if (/fade/i.test(this.settings.tipAnimation)) {
$timer.width(0);
if (this.settings.timer > 0) {
this.settings.$next_tip
.fadeIn(this.settings.tipAnimationFadeSpeed)
.show();
this.delay(function () {
$timer.animate({
width: $timer.parent().width()
}, this.settings.timer, 'linear');
}.bind(this), this.settings.tipAnimationFadeSpeed);
} else {
this.settings.$next_tip.fadeIn(this.settings.tipAnimationFadeSpeed);
}
}
this.settings.$current_tip = this.settings.$next_tip;
// skip non-existant targets
} else if (this.settings.$li && this.settings.$target.length < 1) {
this.show();
} else {
this.end();
}
} else {
this.settings.paused = true;
}
},
is_phone : function () {
if (Modernizr) {
return Modernizr.mq('only screen and (max-width: 767px)') || $('.lt-ie9').length > 0;
}
return (this.settings.$window.width() < 767);
},
hide : function () {
if (this.settings.modal && this.settings.expose) {
this.un_expose();
}
if (!this.settings.modal) {
$('.joyride-modal-bg').hide();
}
this.settings.$current_tip.hide();
this.settings.postStepCallback(this.settings.$li.index(),
this.settings.$current_tip);
},
set_li : function (init) {
if (init) {
this.settings.$li = this.settings.$tip_content.eq(this.settings.startOffset);
this.set_next_tip();
this.settings.$current_tip = this.settings.$next_tip;
} else {
this.settings.$li = this.settings.$li.next();
this.set_next_tip();
}
this.set_target();
},
set_next_tip : function () {
this.settings.$next_tip = $(".joyride-tip-guide[data-index='" + this.settings.$li.index() + "']");
this.settings.$next_tip.data('closed', '');
},
set_target : function () {
var cl = this.settings.$li.attr('data-class'),
id = this.settings.$li.attr('data-id'),
$sel = function () {
if (id) {
return $(document.getElementById(id));
} else if (cl) {
return $('.' + cl).first();
} else {
return $('body');
}
};
this.settings.$target = $sel();
},
scroll_to : function () {
var window_half, tipOffset;
window_half = $(window).height() / 2;
tipOffset = Math.ceil(this.settings.$target.offset().top - window_half + this.outerHeight(this.settings.$next_tip));
if (tipOffset > 0) {
this.scrollTo($('html, body'), tipOffset, this.settings.scrollSpeed);
}
},
paused : function () {
return ($.inArray((this.settings.$li.index() + 1), this.settings.pauseAfter) === -1);
},
restart : function () {
this.hide();
this.settings.$li = undefined;
this.show('init');
},
pos_default : function (init, resizing) {
var half_fold = Math.ceil($(window).height() / 2),
tip_position = this.settings.$next_tip.offset(),
$nub = this.settings.$next_tip.find('.joyride-nub'),
nub_width = Math.ceil(this.outerWidth($nub) / 2),
nub_height = Math.ceil(this.outerHeight($nub) / 2),
toggle = init || false;
// tip must not be "display: none" to calculate position
if (toggle) {
this.settings.$next_tip.css('visibility', 'hidden');
this.settings.$next_tip.show();
}
if (typeof resizing === 'undefined') {
resizing = false;
}
if (!/body/i.test(this.settings.$target.selector)) {
if (this.bottom()) {
var leftOffset = this.settings.$target.offset().left;
if (Foundation.rtl) {
leftOffset = this.settings.$target.offset().width - this.settings.$next_tip.width() + leftOffset;
}
this.settings.$next_tip.css({
top: (this.settings.$target.offset().top + nub_height + this.outerHeight(this.settings.$target)),
left: leftOffset});
this.nub_position($nub, this.settings.tipSettings.nubPosition, 'top');
} else if (this.top()) {
var leftOffset = this.settings.$target.offset().left;
if (Foundation.rtl) {
leftOffset = this.settings.$target.offset().width - this.settings.$next_tip.width() + leftOffset;
}
this.settings.$next_tip.css({
top: (this.settings.$target.offset().top - this.outerHeight(this.settings.$next_tip) - nub_height),
left: leftOffset});
this.nub_position($nub, this.settings.tipSettings.nubPosition, 'bottom');
} else if (this.right()) {
this.settings.$next_tip.css({
top: this.settings.$target.offset().top,
left: (this.outerWidth(this.settings.$target) + this.settings.$target.offset().left + nub_width)});
this.nub_position($nub, this.settings.tipSettings.nubPosition, 'left');
} else if (this.left()) {
this.settings.$next_tip.css({
top: this.settings.$target.offset().top,
left: (this.settings.$target.offset().left - this.outerWidth(this.settings.$next_tip) - nub_width)});
this.nub_position($nub, this.settings.tipSettings.nubPosition, 'right');
}
if (!this.visible(this.corners(this.settings.$next_tip)) && this.settings.attempts < this.settings.tipSettings.tipLocationPattern.length) {
$nub.removeClass('bottom')
.removeClass('top')
.removeClass('right')
.removeClass('left');
this.settings.tipSettings.tipLocation = this.settings.tipSettings.tipLocationPattern[this.settings.attempts];
this.settings.attempts++;
this.pos_default();
}
} else if (this.settings.$li.length) {
this.pos_modal($nub);
}
if (toggle) {
this.settings.$next_tip.hide();
this.settings.$next_tip.css('visibility', 'visible');
}
},
pos_phone : function (init) {
var tip_height = this.outerHeight(this.settings.$next_tip),
tip_offset = this.settings.$next_tip.offset(),
target_height = this.outerHeight(this.settings.$target),
$nub = $('.joyride-nub', this.settings.$next_tip),
nub_height = Math.ceil(this.outerHeight($nub) / 2),
toggle = init || false;
$nub.removeClass('bottom')
.removeClass('top')
.removeClass('right')
.removeClass('left');
if (toggle) {
this.settings.$next_tip.css('visibility', 'hidden');
this.settings.$next_tip.show();
}
if (!/body/i.test(this.settings.$target.selector)) {
if (this.top()) {
this.settings.$next_tip.offset({top: this.settings.$target.offset().top - tip_height - nub_height});
$nub.addClass('bottom');
} else {
this.settings.$next_tip.offset({top: this.settings.$target.offset().top + target_height + nub_height});
$nub.addClass('top');
}
} else if (this.settings.$li.length) {
this.pos_modal($nub);
}
if (toggle) {
this.settings.$next_tip.hide();
this.settings.$next_tip.css('visibility', 'visible');
}
},
pos_modal : function ($nub) {
this.center();
$nub.hide();
this.show_modal();
},
show_modal : function () {
if (!this.settings.$next_tip.data('closed')) {
var joyridemodalbg = $('.joyride-modal-bg');
if (joyridemodalbg.length < 1) {
$('body').append(this.settings.template.modal).show();
}
if (/pop/i.test(this.settings.tipAnimation)) {
joyridemodalbg.show();
} else {
joyridemodalbg.fadeIn(this.settings.tipAnimationFadeSpeed);
}
}
},
expose : function () {
var expose,
exposeCover,
el,
origCSS,
origClasses,
randId = 'expose-'+Math.floor(Math.random()*10000);
if (arguments.length > 0 && arguments[0] instanceof $) {
el = arguments[0];
} else if(this.settings.$target && !/body/i.test(this.settings.$target.selector)){
el = this.settings.$target;
} else {
return false;
}
if(el.length < 1){
if(window.console){
console.error('element not valid', el);
}
return false;
}
expose = $(this.settings.template.expose);
this.settings.$body.append(expose);
expose.css({
top: el.offset().top,
left: el.offset().left,
width: this.outerWidth(el, true),
height: this.outerHeight(el, true)
});
exposeCover = $(this.settings.template.exposeCover);
origCSS = {
zIndex: el.css('z-index'),
position: el.css('position')
};
origClasses = el.attr('class') == null ? '' : el.attr('class');
el.css('z-index',parseInt(expose.css('z-index'))+1);
if (origCSS.position == 'static') {
el.css('position','relative');
}
el.data('expose-css',origCSS);
el.data('orig-class', origClasses);
el.attr('class', origClasses + ' ' + this.settings.exposeAddClass);
exposeCover.css({
top: el.offset().top,
left: el.offset().left,
width: this.outerWidth(el, true),
height: this.outerHeight(el, true)
});
this.settings.$body.append(exposeCover);
expose.addClass(randId);
exposeCover.addClass(randId);
el.data('expose', randId);
this.settings.postExposeCallback(this.settings.$li.index(), this.settings.$next_tip, el);
this.add_exposed(el);
},
un_expose : function () {
var exposeId,
el,
expose ,
origCSS,
origClasses,
clearAll = false;
if (arguments.length > 0 && arguments[0] instanceof $) {
el = arguments[0];
} else if(this.settings.$target && !/body/i.test(this.settings.$target.selector)){
el = this.settings.$target;
} else {
return false;
}
if(el.length < 1){
if (window.console) {
console.error('element not valid', el);
}
return false;
}
exposeId = el.data('expose');
expose = $('.' + exposeId);
if (arguments.length > 1) {
clearAll = arguments[1];
}
if (clearAll === true) {
$('.joyride-expose-wrapper,.joyride-expose-cover').remove();
} else {
expose.remove();
}
origCSS = el.data('expose-css');
if (origCSS.zIndex == 'auto') {
el.css('z-index', '');
} else {
el.css('z-index', origCSS.zIndex);
}
if (origCSS.position != el.css('position')) {
if(origCSS.position == 'static') {// this is default, no need to set it.
el.css('position', '');
} else {
el.css('position', origCSS.position);
}
}
origClasses = el.data('orig-class');
el.attr('class', origClasses);
el.removeData('orig-classes');
el.removeData('expose');
el.removeData('expose-z-index');
this.remove_exposed(el);
},
add_exposed: function(el){
this.settings.exposed = this.settings.exposed || [];
if (el instanceof $ || typeof el === 'object') {
this.settings.exposed.push(el[0]);
} else if (typeof el == 'string') {
this.settings.exposed.push(el);
}
},
remove_exposed: function(el){
var search, count;
if (el instanceof $) {
search = el[0]
} else if (typeof el == 'string'){
search = el;
}
this.settings.exposed = this.settings.exposed || [];
count = this.settings.exposed.length;
for (var i=0; i < count; i++) {
if (this.settings.exposed[i] == search) {
this.settings.exposed.splice(i, 1);
return;
}
}
},
center : function () {
var $w = $(window);
this.settings.$next_tip.css({
top : ((($w.height() - this.outerHeight(this.settings.$next_tip)) / 2) + $w.scrollTop()),
left : ((($w.width() - this.outerWidth(this.settings.$next_tip)) / 2) + this.scrollLeft($w))
});
return true;
},
bottom : function () {
return /bottom/i.test(this.settings.tipSettings.tipLocation);
},
top : function () {
return /top/i.test(this.settings.tipSettings.tipLocation);
},
right : function () {
return /right/i.test(this.settings.tipSettings.tipLocation);
},
left : function () {
return /left/i.test(this.settings.tipSettings.tipLocation);
},
corners : function (el) {
var w = $(window),
window_half = w.height() / 2,
//using this to calculate since scroll may not have finished yet.
tipOffset = Math.ceil(this.settings.$target.offset().top - window_half + this.settings.$next_tip.outerHeight()),
right = w.width() + this.scrollLeft(w),
offsetBottom = w.height() + tipOffset,
bottom = w.height() + w.scrollTop(),
top = w.scrollTop();
if (tipOffset < top) {
if (tipOffset < 0) {
top = 0;
} else {
top = tipOffset;
}
}
if (offsetBottom > bottom) {
bottom = offsetBottom;
}
return [
el.offset().top < top,
right < el.offset().left + el.outerWidth(),
bottom < el.offset().top + el.outerHeight(),
this.scrollLeft(w) > el.offset().left
];
},
visible : function (hidden_corners) {
var i = hidden_corners.length;
while (i--) {
if (hidden_corners[i]) return false;
}
return true;
},
nub_position : function (nub, pos, def) {
if (pos === 'auto') {
nub.addClass(def);
} else {
nub.addClass(pos);
}
},
startTimer : function () {
if (this.settings.$li.length) {
this.settings.automate = setTimeout(function () {
this.hide();
this.show();
this.startTimer();
}.bind(this), this.settings.timer);
} else {
clearTimeout(this.settings.automate);
}
},
end : function () {
if (this.settings.cookieMonster) {
$.cookie(this.settings.cookieName, 'ridden', { expires: this.settings.cookieExpires, domain: this.settings.cookieDomain });
}
if (this.settings.timer > 0) {
clearTimeout(this.settings.automate);
}
if (this.settings.modal && this.settings.expose) {
this.un_expose();
}
this.settings.$next_tip.data('closed', true);
$('.joyride-modal-bg').hide();
this.settings.$current_tip.hide();
this.settings.postStepCallback(this.settings.$li.index(), this.settings.$current_tip);
this.settings.postRideCallback(this.settings.$li.index(), this.settings.$current_tip);
$('.joyride-tip-guide').remove();
},
outerHTML : function (el) {
// support FireFox < 11
return el.outerHTML || new XMLSerializer().serializeToString(el);
},
off : function () {
$(this.scope).off('.joyride');
$(window).off('.joyride');
$('.joyride-close-tip, .joyride-next-tip, .joyride-modal-bg').off('.joyride');
$('.joyride-tip-guide, .joyride-modal-bg').remove();
clearTimeout(this.settings.automate);
this.settings = {};
},
reflow : function () {}
};
}(Foundation.zj, this, this.document));

447
docs/js/foundation/foundation.js vendored Normal file
View File

@ -0,0 +1,447 @@
/*
* Foundation Responsive Library
* http://foundation.zurb.com
* Copyright 2013, ZURB
* Free to use under the MIT license.
* http://www.opensource.org/licenses/mit-license.php
*/
/*jslint unparam: true, browser: true, indent: 2 */
// Accommodate running jQuery or Zepto in noConflict() mode by
// using an anonymous function to redefine the $ shorthand name.
// See http://docs.jquery.com/Using_jQuery_with_Other_Libraries
// and http://zeptojs.com/
var libFuncName = null;
if (typeof jQuery === "undefined" &&
typeof Zepto === "undefined" &&
typeof $ === "function") {
libFuncName = $;
} else if (typeof jQuery === "function") {
libFuncName = jQuery;
} else if (typeof Zepto === "function") {
libFuncName = Zepto;
} else {
throw new TypeError();
}
(function ($, window, document, undefined) {
'use strict';
/*
matchMedia() polyfill - Test a CSS media
type/query in JS. Authors & copyright (c) 2012:
Scott Jehl, Paul Irish, Nicholas Zakas.
Dual MIT/BSD license
https://github.com/paulirish/matchMedia.js
*/
window.matchMedia = window.matchMedia || (function( doc, undefined ) {
"use strict";
var bool,
docElem = doc.documentElement,
refNode = docElem.firstElementChild || docElem.firstChild,
// fakeBody required for <FF4 when executed in <head>
fakeBody = doc.createElement( "body" ),
div = doc.createElement( "div" );
div.id = "mq-test-1";
div.style.cssText = "position:absolute;top:-100em";
fakeBody.style.background = "none";
fakeBody.appendChild(div);
return function(q){
div.innerHTML = "&shy;<style media=\"" + q + "\"> #mq-test-1 { width: 42px; }</style>";
docElem.insertBefore( fakeBody, refNode );
bool = div.offsetWidth === 42;
docElem.removeChild( fakeBody );
return {
matches: bool,
media: q
};
};
}( document ));
// add dusty browser stuff
if (!Array.prototype.filter) {
Array.prototype.filter = function(fun /*, thisp */) {
"use strict";
if (this == null) {
throw new TypeError();
}
var t = Object(this),
len = t.length >>> 0;
if (typeof fun !== "function") {
return;
}
var res = [],
thisp = arguments[1];
for (var i = 0; i < len; i++) {
if (i in t) {
var val = t[i]; // in case fun mutates this
if (fun && fun.call(thisp, val, i, t)) {
res.push(val);
}
}
}
return res;
}
}
if (!Function.prototype.bind) {
Function.prototype.bind = function (oThis) {
if (typeof this !== "function") {
// closest thing possible to the ECMAScript 5 internal IsCallable function
throw new TypeError("Function.prototype.bind - what is trying to be bound is not callable");
}
var aArgs = Array.prototype.slice.call(arguments, 1),
fToBind = this,
fNOP = function () {},
fBound = function () {
return fToBind.apply(this instanceof fNOP && oThis
? this
: oThis,
aArgs.concat(Array.prototype.slice.call(arguments)));
};
fNOP.prototype = this.prototype;
fBound.prototype = new fNOP();
return fBound;
};
}
if (!Array.prototype.indexOf) {
Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
"use strict";
if (this == null) {
throw new TypeError();
}
var t = Object(this);
var len = t.length >>> 0;
if (len === 0) {
return -1;
}
var n = 0;
if (arguments.length > 1) {
n = Number(arguments[1]);
if (n != n) { // shortcut for verifying if it's NaN
n = 0;
} else if (n != 0 && n != Infinity && n != -Infinity) {
n = (n > 0 || -1) * Math.floor(Math.abs(n));
}
}
if (n >= len) {
return -1;
}
var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
for (; k < len; k++) {
if (k in t && t[k] === searchElement) {
return k;
}
}
return -1;
}
}
// fake stop() for zepto.
$.fn.stop = $.fn.stop || function() {
return this;
};
window.Foundation = {
name : 'Foundation',
version : '4.2.2',
cache : {},
init : function (scope, libraries, method, options, response, /* internal */ nc) {
var library_arr,
args = [scope, method, options, response],
responses = [],
nc = nc || false;
// disable library error catching,
// used for development only
if (nc) this.nc = nc;
// check RTL
this.rtl = /rtl/i.test($('html').attr('dir'));
// set foundation global scope
this.scope = scope || this.scope;
if (libraries && typeof libraries === 'string' && !/reflow/i.test(libraries)) {
if (/off/i.test(libraries)) return this.off();
library_arr = libraries.split(' ');
if (library_arr.length > 0) {
for (var i = library_arr.length - 1; i >= 0; i--) {
responses.push(this.init_lib(library_arr[i], args));
}
}
} else {
if (/reflow/i.test(libraries)) args[1] = 'reflow';
for (var lib in this.libs) {
responses.push(this.init_lib(lib, args));
}
}
// if first argument is callback, add to args
if (typeof libraries === 'function') {
args.unshift(libraries);
}
return this.response_obj(responses, args);
},
response_obj : function (response_arr, args) {
for (var i = 0, len = args.length; i < len; i++) {
if (typeof args[i] === 'function') {
return args[i]({
errors: response_arr.filter(function (s) {
if (typeof s === 'string') return s;
})
});
}
}
return response_arr;
},
init_lib : function (lib, args) {
return this.trap(function () {
if (this.libs.hasOwnProperty(lib)) {
this.patch(this.libs[lib]);
return this.libs[lib].init.apply(this.libs[lib], args);
}
else {
return function () {};
}
}.bind(this), lib);
},
trap : function (fun, lib) {
if (!this.nc) {
try {
return fun();
} catch (e) {
return this.error({name: lib, message: 'could not be initialized', more: e.name + ' ' + e.message});
}
}
return fun();
},
patch : function (lib) {
this.fix_outer(lib);
lib.scope = this.scope;
lib.rtl = this.rtl;
},
inherit : function (scope, methods) {
var methods_arr = methods.split(' ');
for (var i = methods_arr.length - 1; i >= 0; i--) {
if (this.lib_methods.hasOwnProperty(methods_arr[i])) {
this.libs[scope.name][methods_arr[i]] = this.lib_methods[methods_arr[i]];
}
}
},
random_str : function (length) {
var chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXTZabcdefghiklmnopqrstuvwxyz'.split('');
if (!length) {
length = Math.floor(Math.random() * chars.length);
}
var str = '';
for (var i = 0; i < length; i++) {
str += chars[Math.floor(Math.random() * chars.length)];
}
return str;
},
libs : {},
// methods that can be inherited in libraries
lib_methods : {
set_data : function (node, data) {
// this.name references the name of the library calling this method
var id = [this.name,+new Date(),Foundation.random_str(5)].join('-');
Foundation.cache[id] = data;
node.attr('data-' + this.name + '-id', id);
return data;
},
get_data : function (node) {
return Foundation.cache[node.attr('data-' + this.name + '-id')];
},
remove_data : function (node) {
if (node) {
delete Foundation.cache[node.attr('data-' + this.name + '-id')];
node.attr('data-' + this.name + '-id', '');
} else {
$('[data-' + this.name + '-id]').each(function () {
delete Foundation.cache[$(this).attr('data-' + this.name + '-id')];
$(this).attr('data-' + this.name + '-id', '');
});
}
},
throttle : function(fun, delay) {
var timer = null;
return function () {
var context = this, args = arguments;
clearTimeout(timer);
timer = setTimeout(function () {
fun.apply(context, args);
}, delay);
};
},
// parses data-options attribute on nodes and turns
// them into an object
data_options : function (el) {
var opts = {}, ii, p,
opts_arr = (el.attr('data-options') || ':').split(';'),
opts_len = opts_arr.length;
function isNumber (o) {
return ! isNaN (o-0) && o !== null && o !== "" && o !== false && o !== true;
}
function trim(str) {
if (typeof str === 'string') return $.trim(str);
return str;
}
// parse options
for (ii = opts_len - 1; ii >= 0; ii--) {
p = opts_arr[ii].split(':');
if (/true/i.test(p[1])) p[1] = true;
if (/false/i.test(p[1])) p[1] = false;
if (isNumber(p[1])) p[1] = parseInt(p[1], 10);
if (p.length === 2 && p[0].length > 0) {
opts[trim(p[0])] = trim(p[1]);
}
}
return opts;
},
delay : function (fun, delay) {
return setTimeout(fun, delay);
},
// animated scrolling
scrollTo : function (el, to, duration) {
if (duration < 0) return;
var difference = to - $(window).scrollTop();
var perTick = difference / duration * 10;
this.scrollToTimerCache = setTimeout(function() {
if (!isNaN(parseInt(perTick, 10))) {
window.scrollTo(0, $(window).scrollTop() + perTick);
this.scrollTo(el, to, duration - 10);
}
}.bind(this), 10);
},
// not supported in core Zepto
scrollLeft : function (el) {
if (!el.length) return;
return ('scrollLeft' in el[0]) ? el[0].scrollLeft : el[0].pageXOffset;
},
// test for empty object or array
empty : function (obj) {
if (obj.length && obj.length > 0) return false;
if (obj.length && obj.length === 0) return true;
for (var key in obj) {
if (hasOwnProperty.call(obj, key)) return false;
}
return true;
}
},
fix_outer : function (lib) {
lib.outerHeight = function (el, bool) {
if (typeof Zepto === 'function') {
return el.height();
}
if (typeof bool !== 'undefined') {
return el.outerHeight(bool);
}
return el.outerHeight();
};
lib.outerWidth = function (el) {
if (typeof Zepto === 'function') {
return el.width();
}
if (typeof bool !== 'undefined') {
return el.outerWidth(bool);
}
return el.outerWidth();
};
},
error : function (error) {
return error.name + ' ' + error.message + '; ' + error.more;
},
// remove all foundation events.
off: function () {
$(this.scope).off('.fndtn');
$(window).off('.fndtn');
return true;
},
zj : function () {
if (typeof Zepto !== 'undefined') {
return Zepto;
} else {
return jQuery;
}
}()
};
$.fn.foundation = function () {
var args = Array.prototype.slice.call(arguments, 0);
return this.each(function () {
Foundation.init.apply(Foundation, [this].concat(args));
return this;
});
};
}(libFuncName, this, this.document));

134
docs/js/foundation/foundation.magellan.js vendored Normal file
View File

@ -0,0 +1,134 @@
/*jslint unparam: true, browser: true, indent: 2 */
;(function ($, window, document, undefined) {
'use strict';
Foundation.libs.magellan = {
name : 'magellan',
version : '4.2.2',
settings : {
activeClass: 'active'
},
init : function (scope, method, options) {
this.scope = scope || this.scope;
Foundation.inherit(this, 'data_options');
if (typeof method === 'object') {
$.extend(true, this.settings, method);
}
if (typeof method !== 'string') {
if (!this.settings.init) {
this.fixed_magellan = $("[data-magellan-expedition]");
this.set_threshold();
this.last_destination = $('[data-magellan-destination]').last();
this.events();
}
return this.settings.init;
} else {
return this[method].call(this, options);
}
},
events : function () {
var self = this;
$(this.scope).on('arrival.fndtn.magellan', '[data-magellan-arrival]', function (e) {
var $destination = $(this),
$expedition = $destination.closest('[data-magellan-expedition]'),
activeClass = $expedition.attr('data-magellan-active-class')
|| self.settings.activeClass;
$destination
.closest('[data-magellan-expedition]')
.find('[data-magellan-arrival]')
.not($destination)
.removeClass(activeClass);
$destination.addClass(activeClass);
});
this.fixed_magellan
.on('update-position.fndtn.magellan', function(){
var $el = $(this);
// $el.data("magellan-fixed-position","");
// $el.data("magellan-top-offset", "");
})
.trigger('update-position');
$(window)
.on('resize.fndtn.magellan', function() {
this.fixed_magellan.trigger('update-position');
}.bind(this))
.on('scroll.fndtn.magellan', function() {
var windowScrollTop = $(window).scrollTop();
self.fixed_magellan.each(function() {
var $expedition = $(this);
if (typeof $expedition.data('magellan-top-offset') === 'undefined') {
$expedition.data('magellan-top-offset', $expedition.offset().top);
}
if (typeof $expedition.data('magellan-fixed-position') === 'undefined') {
$expedition.data('magellan-fixed-position', false)
}
var fixed_position = (windowScrollTop + self.settings.threshold) > $expedition.data("magellan-top-offset");
var attr = $expedition.attr('data-magellan-top-offset');
if ($expedition.data("magellan-fixed-position") != fixed_position) {
$expedition.data("magellan-fixed-position", fixed_position);
if (fixed_position) {
$expedition.addClass('fixed');
$expedition.css({position:"fixed", top:0});
} else {
$expedition.removeClass('fixed');
$expedition.css({position:"", top:""});
}
if (fixed_position && typeof attr != 'undefined' && attr != false) {
$expedition.css({position:"fixed", top:attr + "px"});
}
}
});
});
if (this.last_destination.length > 0) {
$(window).on('scroll.fndtn.magellan', function (e) {
var windowScrollTop = $(window).scrollTop(),
scrolltopPlusHeight = windowScrollTop + $(window).height(),
lastDestinationTop = Math.ceil(self.last_destination.offset().top);
$('[data-magellan-destination]').each(function () {
var $destination = $(this),
destination_name = $destination.attr('data-magellan-destination'),
topOffset = $destination.offset().top - windowScrollTop;
if (topOffset <= self.settings.threshold) {
$("[data-magellan-arrival='" + destination_name + "']").trigger('arrival');
}
// In large screens we may hit the bottom of the page and dont reach the top of the last magellan-destination, so lets force it
if (scrolltopPlusHeight >= $(self.scope).height() && lastDestinationTop > windowScrollTop && lastDestinationTop < scrolltopPlusHeight) {
$('[data-magellan-arrival]').last().trigger('arrival');
}
});
});
}
this.settings.init = true;
},
set_threshold : function () {
if (!this.settings.threshold) {
this.settings.threshold = (this.fixed_magellan.length > 0) ?
this.outerHeight(this.fixed_magellan, true) : 0;
}
},
off : function () {
$(this.scope).off('.fndtn.magellan');
},
reflow : function () {}
};
}(Foundation.zj, this, this.document));

390
docs/js/foundation/foundation.orbit.js vendored Normal file
View File

@ -0,0 +1,390 @@
;(function ($, window, document, undefined) {
'use strict';
Foundation.libs = Foundation.libs || {};
Foundation.libs.orbit = {
name: 'orbit',
version: '4.2.0',
settings: {
timer_speed: 10000,
pause_on_hover: true,
resume_on_mouseout: false,
animation_speed: 500,
bullets: true,
stack_on_small: true,
navigation_arrows: true,
slide_number: true,
container_class: 'orbit-container',
stack_on_small_class: 'orbit-stack-on-small',
next_class: 'orbit-next',
prev_class: 'orbit-prev',
timer_container_class: 'orbit-timer',
timer_paused_class: 'paused',
timer_progress_class: 'orbit-progress',
slides_container_class: 'orbit-slides-container',
bullets_container_class: 'orbit-bullets',
bullets_active_class: 'active',
slide_number_class: 'orbit-slide-number',
caption_class: 'orbit-caption',
active_slide_class: 'active',
orbit_transition_class: 'orbit-transitioning'
},
init: function (scope, method, options) {
var self = this;
Foundation.inherit(self, 'data_options');
if (typeof method === 'object') {
$.extend(true, self.settings, method);
}
if ($(scope).is('[data-orbit]')) {
var scoped_self = $.extend(true, {}, self);
scoped_self._init(idx, el);
}
$('[data-orbit]', scope).each(function(idx, el) {
var scoped_self = $.extend(true, {}, self);
scoped_self._init(idx, el);
});
},
_container_html: function() {
var self = this;
return '<div class="' + self.settings.container_class + '"></div>';
},
_bullets_container_html: function($slides) {
var self = this,
$list = $('<ol class="' + self.settings.bullets_container_class + '"></ol>');
$slides.each(function(idx, slide) {
var $item = $('<li data-orbit-slide-number="' + (idx+1) + '" class=""></li>');
if (idx === 0) {
$item.addClass(self.settings.bullets_active_class);
}
$list.append($item);
});
return $list;
},
_slide_number_html: function(slide_number, total_slides) {
var self = this,
$container = $('<div class="' + self.settings.slide_number_class + '"></div>');
$container.append('<span>' + slide_number + '</span> of <span>' + total_slides + '</span>');
return $container;
},
_timer_html: function() {
var self = this;
if (typeof self.settings.timer_speed === 'number' && self.settings.timer_speed > 0) {
return '<div class="' + self.settings.timer_container_class
+ '"><span></span><div class="' + self.settings.timer_progress_class
+ '"></div></div>';
} else {
return '';
}
},
_next_html: function() {
var self = this;
return '<a href="#" class="' + self.settings.next_class + '">Next <span></span></a>';
},
_prev_html: function() {
var self = this;
return '<a href="#" class="' + self.settings.prev_class + '">Prev <span></span></a>';
},
_init: function (idx, slider) {
var self = this,
$slides_container = $(slider),
$container = $slides_container.wrap(self._container_html()).parent(),
$slides = $slides_container.children();
$.extend(true, self.settings, self.data_options($slides_container));
if (self.settings.navigation_arrows) {
$container.append(self._prev_html());
$container.append(self._next_html());
}
$slides_container.addClass(self.settings.slides_container_class);
if (self.settings.stack_on_small) {
$container.addClass(self.settings.stack_on_small_class);
}
if (self.settings.slide_number) {
$container.append(self._slide_number_html(1, $slides.length));
}
$container.append(self._timer_html());
if (self.settings.bullets) {
$container.after(self._bullets_container_html($slides));
}
// To better support the "sliding" effect it's easier
// if we just clone the first and last slides
$slides_container.append($slides.first().clone().attr('data-orbit-slide',''));
$slides_container.prepend($slides.last().clone().attr('data-orbit-slide',''));
// Make the first "real" slide active
$slides_container.css(Foundation.rtl ? 'marginRight' : 'marginLeft', '-100%');
$slides.first().addClass(self.settings.active_slide_class);
self._init_events($slides_container);
self._init_dimensions($slides_container);
self._start_timer($slides_container);
},
_init_events: function ($slides_container) {
var self = this,
$container = $slides_container.parent();
$(window)
.on('load.fndtn.orbit', function() {
$slides_container.height('');
$slides_container.height($slides_container.height($container.height()));
$slides_container.trigger('orbit:ready');
})
.on('resize.fndtn.orbit', function() {
$slides_container.height('');
$slides_container.height($slides_container.height($container.height()));
});
$(document).on('click.fndtn.orbit', '[data-orbit-link]', function(e) {
e.preventDefault();
var id = $(e.currentTarget).attr('data-orbit-link'),
$slide = $slides_container.find('[data-orbit-slide=' + id + ']').first();
if ($slide.length === 1) {
self._reset_timer($slides_container, true);
self._goto($slides_container, $slide.index(), function() {});
}
});
$container.siblings('.' + self.settings.bullets_container_class)
.on('click.fndtn.orbit', '[data-orbit-slide-number]', function(e) {
e.preventDefault();
self._reset_timer($slides_container, true);
self._goto($slides_container, $(e.currentTarget).data('orbit-slide-number'),function() {});
});
$container
.on('mouseenter.fndtn.orbit', function(e) {
if (self.settings.pause_on_hover) {
self._stop_timer($slides_container);
}
})
.on('mouseleave.fndtn.orbit', function(e) {
if (self.settings.resume_on_mouseout) {
self._start_timer($slides_container);
}
})
.on('orbit:after-slide-change.fndtn.orbit', function(e, orbit) {
var $slide_number = $container.find('.' + self.settings.slide_number_class);
if ($slide_number.length === 1) {
$slide_number.replaceWith(self._slide_number_html(orbit.slide_number, orbit.total_slides));
}
})
.on('orbit:next-slide.fndtn.orbit click.fndtn.orbit', '.' + self.settings.next_class.split(" ").join("."), function(e) {
e.preventDefault();
self._reset_timer($slides_container, true);
self._goto($slides_container, 'next', function() {});
})
.on('orbit:prev-slide.fndtn.orbit click.fndtn.orbit', '.' + self.settings.prev_class.split(" ").join("."), function(e) {
e.preventDefault();
self._reset_timer($slides_container, true);
self._goto($slides_container, 'prev', function() {});
})
.on('orbit:toggle-play-pause.fndtn.orbit click.fndtn.orbit touchstart.fndtn.orbit', '.' + self.settings.timer_container_class, function(e) {
e.preventDefault();
var $timer = $(e.currentTarget).toggleClass(self.settings.timer_paused_class),
$slides_container = $timer.closest('.' + self.settings.container_class)
.find('.' + self.settings.slides_container_class);
if ($timer.hasClass(self.settings.timer_paused_class)) {
self._stop_timer($slides_container);
} else {
self._start_timer($slides_container);
}
})
.on('touchstart.fndtn.orbit', function(e) {
if (!e.touches) { e = e.originalEvent; }
var data = {
start_page_x: e.touches[0].pageX,
start_page_y: e.touches[0].pageY,
start_time: (new Date()).getTime(),
delta_x: 0,
is_scrolling: undefined
};
$container.data('swipe-transition', data);
e.stopPropagation();
})
.on('touchmove.fndtn.orbit', function(e) {
if (!e.touches) { e = e.originalEvent; }
// Ignore pinch/zoom events
if(e.touches.length > 1 || e.scale && e.scale !== 1) return;
var data = $container.data('swipe-transition');
if (typeof data === 'undefined') {
data = {};
}
data.delta_x = e.touches[0].pageX - data.start_page_x;
if ( typeof data.is_scrolling === 'undefined') {
data.is_scrolling = !!( data.is_scrolling || Math.abs(data.delta_x) < Math.abs(e.touches[0].pageY - data.start_page_y) );
}
if (!data.is_scrolling && !data.active) {
e.preventDefault();
self._stop_timer($slides_container);
var direction = (data.delta_x < 0) ? 'next' : 'prev';
data.active = true;
self._goto($slides_container, direction, function() {});
}
})
.on('touchend.fndtn.orbit', function(e) {
$container.data('swipe-transition', {});
e.stopPropagation();
});
},
_init_dimensions: function ($slides_container) {
var $container = $slides_container.parent(),
$slides = $slides_container.children();
$slides_container.css('width', $slides.length * 100 + '%');
$slides.css('width', 100 / $slides.length + '%');
$slides_container.height($container.height());
$slides_container.css('width', $slides.length * 100 + '%');
},
_start_timer: function ($slides_container) {
var self = this,
$container = $slides_container.parent();
var callback = function() {
self._reset_timer($slides_container, false);
self._goto($slides_container, 'next', function() {
self._start_timer($slides_container);
});
};
var $timer = $container.find('.' + self.settings.timer_container_class),
$progress = $timer.find('.' + self.settings.timer_progress_class),
progress_pct = ($progress.width() / $timer.width()),
delay = self.settings.timer_speed - (progress_pct * self.settings.timer_speed);
$progress.animate({'width': '100%'}, delay, 'linear', callback);
$slides_container.trigger('orbit:timer-started');
},
_stop_timer: function ($slides_container) {
var self = this,
$container = $slides_container.parent(),
$timer = $container.find('.' + self.settings.timer_container_class),
$progress = $timer.find('.' + self.settings.timer_progress_class),
progress_pct = $progress.width() / $timer.width();
self._rebuild_timer($container, progress_pct * 100 + '%');
// $progress.stop();
$slides_container.trigger('orbit:timer-stopped');
$timer = $container.find('.' + self.settings.timer_container_class);
$timer.addClass(self.settings.timer_paused_class);
},
_reset_timer: function($slides_container, is_paused) {
var self = this,
$container = $slides_container.parent();
self._rebuild_timer($container, '0%');
if (typeof is_paused === 'boolean' && is_paused) {
var $timer = $container.find('.' + self.settings.timer_container_class);
$timer.addClass(self.settings.timer_paused_class);
}
},
_rebuild_timer: function ($container, width_pct) {
// Zepto is unable to stop animations since they
// are css-based. This is a workaround for that
// limitation, which rebuilds the dom element
// thus stopping the animation
var self = this,
$timer = $container.find('.' + self.settings.timer_container_class),
$new_timer = $(self._timer_html()),
$new_timer_progress = $new_timer.find('.' + self.settings.timer_progress_class);
if (typeof Zepto === 'function') {
$timer.remove();
$container.append($new_timer);
$new_timer_progress.css('width', width_pct);
} else if (typeof jQuery === 'function') {
var $progress = $timer.find('.' + self.settings.timer_progress_class);
$progress.css('width', width_pct);
$progress.stop();
}
},
_goto: function($slides_container, index_or_direction, callback) {
var self = this,
$container = $slides_container.parent(),
$slides = $slides_container.children(),
$active_slide = $slides_container.find('.' + self.settings.active_slide_class),
active_index = $active_slide.index(),
margin_position = Foundation.rtl ? 'marginRight' : 'marginLeft';
if ($container.hasClass(self.settings.orbit_transition_class)) {
return false;
}
if (index_or_direction === 'prev') {
if (active_index === 0) {
active_index = $slides.length - 1;
}
else {
active_index--;
}
}
else if (index_or_direction === 'next') {
active_index = (active_index+1) % $slides.length;
}
else if (typeof index_or_direction === 'number') {
active_index = (index_or_direction % $slides.length);
}
if (active_index === ($slides.length - 1) && index_or_direction === 'next') {
$slides_container.css(margin_position, '0%');
active_index = 1;
}
else if (active_index === 0 && index_or_direction === 'prev') {
$slides_container.css(margin_position, '-' + ($slides.length - 1) * 100 + '%');
active_index = $slides.length - 2;
}
// Start transition, make next slide active
$container.addClass(self.settings.orbit_transition_class);
$active_slide.removeClass(self.settings.active_slide_class);
$($slides[active_index]).addClass(self.settings.active_slide_class);
// Make next bullet active
var $bullets = $container.siblings('.' + self.settings.bullets_container_class);
if ($bullets.length === 1) {
$bullets.children().removeClass(self.settings.bullets_active_class);
$($bullets.children()[active_index-1]).addClass(self.settings.bullets_active_class);
}
var new_margin_left = '-' + (active_index * 100) + '%';
// Check to see if animation will occur, otherwise perform
// callbacks manually
$slides_container.trigger('orbit:before-slide-change');
if ($slides_container.css(margin_position) === new_margin_left) {
$container.removeClass(self.settings.orbit_transition_class);
$slides_container.trigger('orbit:after-slide-change', [{slide_number: active_index, total_slides: $slides_container.children().length - 2}]);
callback();
} else {
var properties = {};
properties[margin_position] = new_margin_left;
$slides_container.animate(properties, self.settings.animation_speed, 'linear', function() {
$container.removeClass(self.settings.orbit_transition_class);
$slides_container.trigger('orbit:after-slide-change', [{slide_number: active_index, total_slides: $slides_container.children().length - 2}]);
callback();
});
}
}
};
}(Foundation.zj, this, this.document));

179
docs/js/foundation/foundation.placeholder.js vendored Normal file
View File

@ -0,0 +1,179 @@
/*! http://mths.be/placeholder v2.0.7 by @mathias
Modified to work with Zepto.js by ZURB
*/
;(function(window, document, $) {
var isInputSupported = 'placeholder' in document.createElement('input'),
isTextareaSupported = 'placeholder' in document.createElement('textarea'),
prototype = $.fn,
valHooks = $.valHooks,
hooks,
placeholder;
if (isInputSupported && isTextareaSupported) {
placeholder = prototype.placeholder = function() {
return this;
};
placeholder.input = placeholder.textarea = true;
} else {
placeholder = prototype.placeholder = function() {
var $this = this;
$this
.filter((isInputSupported ? 'textarea' : ':input') + '[placeholder]')
.not('.placeholder')
.bind({
'focus.placeholder': clearPlaceholder,
'blur.placeholder': setPlaceholder
})
.data('placeholder-enabled', true)
.trigger('blur.placeholder');
return $this;
};
placeholder.input = isInputSupported;
placeholder.textarea = isTextareaSupported;
hooks = {
'get': function(element) {
var $element = $(element);
return $element.data('placeholder-enabled') && $element.hasClass('placeholder') ? '' : element.value;
},
'set': function(element, value) {
var $element = $(element);
if (!$element.data('placeholder-enabled')) {
return element.value = value;
}
if (value == '') {
element.value = value;
// Issue #56: Setting the placeholder causes problems if the element continues to have focus.
if (element != document.activeElement) {
// We can't use `triggerHandler` here because of dummy text/password inputs :(
setPlaceholder.call(element);
}
} else if ($element.hasClass('placeholder')) {
clearPlaceholder.call(element, true, value) || (element.value = value);
} else {
element.value = value;
}
// `set` can not return `undefined`; see http://jsapi.info/jquery/1.7.1/val#L2363
return $element;
}
};
isInputSupported || (valHooks.input = hooks);
isTextareaSupported || (valHooks.textarea = hooks);
$(function() {
// Look for forms
$(document).delegate('form', 'submit.placeholder', function() {
// Clear the placeholder values so they don't get submitted
var $inputs = $('.placeholder', this).each(clearPlaceholder);
setTimeout(function() {
$inputs.each(setPlaceholder);
}, 10);
});
});
// Clear placeholder values upon page reload
$(window).bind('beforeunload.placeholder', function() {
$('.placeholder').each(function() {
this.value = '';
});
});
}
function args(elem) {
// Return an object of element attributes
var newAttrs = {},
rinlinejQuery = /^jQuery\d+$/;
$.each(elem.attributes, function(i, attr) {
if (attr.specified && !rinlinejQuery.test(attr.name)) {
newAttrs[attr.name] = attr.value;
}
});
return newAttrs;
}
function clearPlaceholder(event, value) {
var input = this,
$input = $(input);
if (input.value == $input.attr('placeholder') && $input.hasClass('placeholder')) {
if ($input.data('placeholder-password')) {
$input = $input.hide().next().show().attr('id', $input.removeAttr('id').data('placeholder-id'));
// If `clearPlaceholder` was called from `$.valHooks.input.set`
if (event === true) {
return $input[0].value = value;
}
$input.focus();
} else {
input.value = '';
$input.removeClass('placeholder');
input == document.activeElement && input.select();
}
}
}
function setPlaceholder() {
var $replacement,
input = this,
$input = $(input),
$origInput = $input,
id = this.id;
if (input.value == '') {
if (input.type == 'password') {
if (!$input.data('placeholder-textinput')) {
try {
$replacement = $input.clone().attr({ 'type': 'text' });
} catch(e) {
$replacement = $('<input>').attr($.extend(args(this), { 'type': 'text' }));
}
$replacement
.removeAttr('name')
.data({
'placeholder-password': true,
'placeholder-id': id
})
.bind('focus.placeholder', clearPlaceholder);
$input
.data({
'placeholder-textinput': $replacement,
'placeholder-id': id
})
.before($replacement);
}
$input = $input.removeAttr('id').hide().prev().attr('id', id).show();
// Note: `$input[0] != input` now!
}
$input.addClass('placeholder');
$input[0].value = $input.attr('placeholder');
} else {
$input.removeClass('placeholder');
}
}
}(this, document, Foundation.zj));
;(function ($, window, document, undefined) {
'use strict';
Foundation.libs.placeholder = {
name : 'placeholder',
version : '4.2.2',
init : function (scope, method, options) {
this.scope = scope || this.scope;
if (typeof method !== 'string') {
window.onload = function () {
$('input, textarea').placeholder();
}
}
}
};
}(Foundation.zj, this, this.document));

330
docs/js/foundation/foundation.reveal.js vendored Normal file
View File

@ -0,0 +1,330 @@
/*jslint unparam: true, browser: true, indent: 2 */
;(function ($, window, document, undefined) {
'use strict';
Foundation.libs.reveal = {
name: 'reveal',
version : '4.2.2',
locked : false,
settings : {
animation: 'fadeAndPop',
animationSpeed: 250,
closeOnBackgroundClick: true,
closeOnEsc: true,
dismissModalClass: 'close-reveal-modal',
bgClass: 'reveal-modal-bg',
open: function(){},
opened: function(){},
close: function(){},
closed: function(){},
bg : $('.reveal-modal-bg'),
css : {
open : {
'opacity': 0,
'visibility': 'visible',
'display' : 'block'
},
close : {
'opacity': 1,
'visibility': 'hidden',
'display': 'none'
}
}
},
init : function (scope, method, options) {
Foundation.inherit(this, 'data_options delay');
if (typeof method === 'object') {
$.extend(true, this.settings, method);
} else if (typeof options !== 'undefined') {
$.extend(true, this.settings, options);
}
if (typeof method !== 'string') {
this.events();
return this.settings.init;
} else {
return this[method].call(this, options);
}
},
events : function () {
var self = this;
$(this.scope)
.off('.fndtn.reveal')
.on('click.fndtn.reveal', '[data-reveal-id]', function (e) {
e.preventDefault();
if (!self.locked) {
var element = $(this),
ajax = element.data('reveal-ajax');
self.locked = true;
if (typeof ajax === 'undefined') {
self.open.call(self, element);
} else {
var url = ajax === true ? element.attr('href') : ajax;
self.open.call(self, element, {url: url});
}
}
})
.on('click.fndtn.reveal', this.close_targets(), function (e) {
e.preventDefault();
if (!self.locked) {
var settings = $.extend({}, self.settings, self.data_options($('.reveal-modal.open')));
if ($(e.target)[0] === $('.' + settings.bgClass)[0] && !settings.closeOnBackgroundClick) {
return;
}
self.locked = true;
self.close.call(self, $(this).closest('.reveal-modal'));
}
})
.on('open.fndtn.reveal', '.reveal-modal', this.settings.open)
.on('opened.fndtn.reveal', '.reveal-modal', this.settings.opened)
.on('opened.fndtn.reveal', '.reveal-modal', this.open_video)
.on('close.fndtn.reveal', '.reveal-modal', this.settings.close)
.on('closed.fndtn.reveal', '.reveal-modal', this.settings.closed)
.on('closed.fndtn.reveal', '.reveal-modal', this.close_video);
$( 'body' ).bind( 'keyup.reveal', function ( event ) {
var open_modal = $('.reveal-modal.open'),
settings = $.extend({}, self.settings, self.data_options(open_modal));
if ( event.which === 27 && settings.closeOnEsc) { // 27 is the keycode for the Escape key
open_modal.foundation('reveal', 'close');
}
});
return true;
},
open : function (target, ajax_settings) {
if (target) {
if (typeof target.selector !== 'undefined') {
var modal = $('#' + target.data('reveal-id'));
} else {
var modal = $(this.scope);
ajax_settings = target;
}
} else {
var modal = $(this.scope);
}
if (!modal.hasClass('open')) {
var open_modal = $('.reveal-modal.open');
if (typeof modal.data('css-top') === 'undefined') {
modal.data('css-top', parseInt(modal.css('top'), 10))
.data('offset', this.cache_offset(modal));
}
modal.trigger('open');
if (open_modal.length < 1) {
this.toggle_bg(modal);
}
if (typeof ajax_settings === 'undefined' || !ajax_settings.url) {
this.hide(open_modal, this.settings.css.close);
this.show(modal, this.settings.css.open);
} else {
var self = this,
old_success = typeof ajax_settings.success !== 'undefined' ? ajax_settings.success : null;
$.extend(ajax_settings, {
success: function (data, textStatus, jqXHR) {
if ( $.isFunction(old_success) ) {
old_success(data, textStatus, jqXHR);
}
modal.html(data);
$(modal).foundation('section', 'reflow');
self.hide(open_modal, self.settings.css.close);
self.show(modal, self.settings.css.open);
}
});
$.ajax(ajax_settings);
}
}
},
close : function (modal) {
var modal = modal && modal.length ? modal : $(this.scope),
open_modals = $('.reveal-modal.open');
if (open_modals.length > 0) {
this.locked = true;
modal.trigger('close');
this.toggle_bg(modal);
this.hide(open_modals, this.settings.css.close);
}
},
close_targets : function () {
var base = '.' + this.settings.dismissModalClass;
if (this.settings.closeOnBackgroundClick) {
return base + ', .' + this.settings.bgClass;
}
return base;
},
toggle_bg : function (modal) {
if ($('.reveal-modal-bg').length === 0) {
this.settings.bg = $('<div />', {'class': this.settings.bgClass})
.appendTo('body');
}
if (this.settings.bg.filter(':visible').length > 0) {
this.hide(this.settings.bg);
} else {
this.show(this.settings.bg);
}
},
show : function (el, css) {
// is modal
if (css) {
if (/pop/i.test(this.settings.animation)) {
css.top = $(window).scrollTop() - el.data('offset') + 'px';
var end_css = {
top: $(window).scrollTop() + el.data('css-top') + 'px',
opacity: 1
};
return this.delay(function () {
return el
.css(css)
.animate(end_css, this.settings.animationSpeed, 'linear', function () {
this.locked = false;
el.trigger('opened');
}.bind(this))
.addClass('open');
}.bind(this), this.settings.animationSpeed / 2);
}
if (/fade/i.test(this.settings.animation)) {
var end_css = {opacity: 1};
return this.delay(function () {
return el
.css(css)
.animate(end_css, this.settings.animationSpeed, 'linear', function () {
this.locked = false;
el.trigger('opened');
}.bind(this))
.addClass('open');
}.bind(this), this.settings.animationSpeed / 2);
}
return el.css(css).show().css({opacity: 1}).addClass('open').trigger('opened');
}
// should we animate the background?
if (/fade/i.test(this.settings.animation)) {
return el.fadeIn(this.settings.animationSpeed / 2);
}
return el.show();
},
hide : function (el, css) {
// is modal
if (css) {
if (/pop/i.test(this.settings.animation)) {
var end_css = {
top: - $(window).scrollTop() - el.data('offset') + 'px',
opacity: 0
};
return this.delay(function () {
return el
.animate(end_css, this.settings.animationSpeed, 'linear', function () {
this.locked = false;
el.css(css).trigger('closed');
}.bind(this))
.removeClass('open');
}.bind(this), this.settings.animationSpeed / 2);
}
if (/fade/i.test(this.settings.animation)) {
var end_css = {opacity: 0};
return this.delay(function () {
return el
.animate(end_css, this.settings.animationSpeed, 'linear', function () {
this.locked = false;
el.css(css).trigger('closed');
}.bind(this))
.removeClass('open');
}.bind(this), this.settings.animationSpeed / 2);
}
return el.hide().css(css).removeClass('open').trigger('closed');
}
// should we animate the background?
if (/fade/i.test(this.settings.animation)) {
return el.fadeOut(this.settings.animationSpeed / 2);
}
return el.hide();
},
close_video : function (e) {
var video = $(this).find('.flex-video'),
iframe = video.find('iframe');
if (iframe.length > 0) {
iframe.attr('data-src', iframe[0].src);
iframe.attr('src', 'about:blank');
video.hide();
}
},
open_video : function (e) {
var video = $(this).find('.flex-video'),
iframe = video.find('iframe');
if (iframe.length > 0) {
var data_src = iframe.attr('data-src');
if (typeof data_src === 'string') {
iframe[0].src = iframe.attr('data-src');
} else {
var src = iframe[0].src;
iframe[0].src = undefined;
iframe[0].src = src;
}
video.show();
}
},
cache_offset : function (modal) {
var offset = modal.show().height() + parseInt(modal.css('top'), 10);
modal.hide();
return offset;
},
off : function () {
$(this.scope).off('.fndtn.reveal');
},
reflow : function () {}
};
}(Foundation.zj, this, this.document));

417
docs/js/foundation/foundation.section.js vendored Normal file
View File

@ -0,0 +1,417 @@
/*jslint unparam: true, browser: true, indent: 2 */
;(function ($, window, document, undefined) {
'use strict';
Foundation.libs.section = {
name: 'section',
version : '4.2.2',
settings : {
deep_linking: false,
small_breakpoint: 768,
one_up: true,
section_selector : '[data-section]',
region_selector : 'section, .section, [data-section-region]',
title_selector : '.title, [data-section-title]',
active_region_selector : 'section.active, .section.active, .active[data-section-region]',
content_selector : '.content, [data-section-content]',
nav_selector : '[data-section="vertical-nav"], [data-section="horizontal-nav"]',
callback: function (){}
},
init : function (scope, method, options) {
var self = this;
Foundation.inherit(this, 'throttle data_options position_right offset_right');
if (typeof method === 'object') {
$.extend(true, self.settings, method);
}
if (typeof method !== 'string') {
this.set_active_from_hash();
this.events();
return true;
} else {
return this[method].call(this, options);
}
},
events : function () {
var self = this;
$(this.scope)
.on('click.fndtn.section', '[data-section] .title, [data-section] [data-section-title]', function (e) {
var $this = $(this),
section = $this.closest(self.settings.region_selector);
if (section.children(self.settings.content_selector).length > 0) {
self.toggle_active.call(this, e, self);
self.reflow();
}
});
$(window)
.on('resize.fndtn.section', self.throttle(function () {
self.resize.call(this);
}, 30))
.on('hashchange', function () {
if (!self.settings.toggled){
self.set_active_from_hash();
$(this).trigger('resize');
}
}).trigger('resize');
$(document)
.on('click.fndtn.section', function (e) {
if ($(e.target).closest(self.settings.title_selector).length < 1) {
$(self.settings.nav_selector)
.children(self.settings.region_selector)
.removeClass('active')
.attr('style', '');
}
});
},
toggle_active : function (e, self) {
var $this = $(this),
self = Foundation.libs.section,
region = $this.closest(self.settings.region_selector),
content = $this.siblings(self.settings.content_selector),
parent = region.parent(),
settings = $.extend({}, self.settings, self.data_options(parent)),
prev_active_section = parent
.children(self.settings.active_region_selector);
self.settings.toggled = true;
if (!settings.deep_linking && content.length > 0) {
e.preventDefault();
}
if (region.hasClass('active')) {
// this is causing the style flash.
if (self.small(parent)
|| self.is_vertical_nav(parent)
|| self.is_horizontal_nav(parent)
|| self.is_accordion(parent)) {
if (prev_active_section[0] !== region[0]
|| (prev_active_section[0] === region[0] && !settings.one_up)) {
region
.removeClass('active')
.attr('style', '');
}
}
} else {
var prev_active_section = parent
.children(self.settings.active_region_selector),
title_height = self.outerHeight(region
.children(self.settings.title_selector));
if (self.small(parent) || settings.one_up) {
if (self.small(parent)) {
prev_active_section.attr('style', '');
} else {
prev_active_section.attr('style',
'visibility: hidden; padding-top: '+title_height+'px;');
}
}
if (self.small(parent)) {
region.attr('style', '');
} else {
region.css('padding-top', title_height);
}
region.addClass('active');
if (prev_active_section.length > 0) {
prev_active_section
.removeClass('active')
.attr('style', '');
}
// Toggle the content display attribute. This is done to
// ensure accurate outerWidth measurements that account for
// the scrollbar.
if (self.is_vertical_tabs(parent)) {
content.css('display', 'block');
if (prev_active_section !== null) {
prev_active_section
.children(self.settings.content_selector)
.css('display', 'none');
}
}
}
setTimeout(function () {
self.settings.toggled = false;
}, 300);
settings.callback();
},
resize : function () {
var self = Foundation.libs.section,
sections = $(self.settings.section_selector);
sections.each(function() {
var $this = $(this),
active_section = $this
.children(self.settings.active_region_selector),
settings = $.extend({}, self.settings, self.data_options($this));
if (active_section.length > 1) {
active_section
.not(':first')
.removeClass('active')
.attr('style', '');
} else if (active_section.length < 1
&& !self.is_vertical_nav($this)
&& !self.is_horizontal_nav($this)
&& !self.is_accordion($this)) {
var first = $this.children(self.settings.region_selector).first();
if (settings.one_up || !self.small($this)) {
first.addClass('active');
}
if (self.small($this)) {
first.attr('style', '');
} else {
first.css('padding-top', self.outerHeight(first
.children(self.settings.title_selector)));
}
}
if (self.small($this)) {
active_section.attr('style', '');
} else {
active_section.css('padding-top', self.outerHeight(active_section
.children(self.settings.title_selector)));
}
self.position_titles($this);
if ( (self.is_horizontal_nav($this) && !self.small($this))
|| self.is_vertical_tabs($this) && !self.small($this)) {
self.position_content($this);
} else {
self.position_content($this, false);
}
});
},
is_vertical_nav : function (el) {
return /vertical-nav/i.test(el.data('section'));
},
is_horizontal_nav : function (el) {
return /horizontal-nav/i.test(el.data('section'));
},
is_accordion : function (el) {
return /accordion/i.test(el.data('section'));
},
is_horizontal_tabs : function (el) {
return /^tabs$/i.test(el.data('section'));
},
is_vertical_tabs : function (el) {
return /vertical-tabs/i.test(el.data('section'));
},
set_active_from_hash : function () {
var hash = window.location.hash.substring(1),
sections = $('[data-section]'),
self = this;
sections.each(function () {
var section = $(this),
settings = $.extend({}, self.settings, self.data_options(section));
if (hash.length > 0 && settings.deep_linking) {
var regions = section
.children(self.settings.region_selector)
.attr('style', '')
.removeClass('active');
var hash_regions = regions.map(function () {
var content = $(self.settings.content_selector, this),
content_slug = content.data('slug');
if (new RegExp(content_slug, 'i').test(hash))
return content;
});
var count = hash_regions.length;
for (var i = count - 1; i >= 0; i--) {
$(hash_regions[i]).parent().addClass('active');
}
}
});
},
position_titles : function (section, off) {
var self = this,
titles = section
.children(this.settings.region_selector)
.map(function () {
return $(this).children(self.settings.title_selector);
}),
previous_width = 0,
previous_height = 0,
self = this;
if (typeof off === 'boolean') {
titles.attr('style', '');
} else {
titles.each(function () {
if (self.is_vertical_tabs(section)) {
$(this).css('top', previous_height);
previous_height += self.outerHeight($(this));
} else {
if (!self.rtl) {
$(this).css('left', previous_width);
} else {
$(this).css('right', previous_width);
}
previous_width += self.outerWidth($(this));
}
});
}
},
position_content : function (section, off) {
var self = this,
regions = section.children(self.settings.region_selector),
titles = regions
.map(function () {
return $(this).children(self.settings.title_selector);
}),
content = regions
.map(function () {
return $(this).children(self.settings.content_selector);
});
if (typeof off === 'boolean') {
content.attr('style', '');
section.attr('style', '');
} else {
if (self.is_vertical_tabs(section)
&& !self.small(section)) {
var content_min_height = 0,
content_min_width = Number.MAX_VALUE,
title_width = null;
regions.each(function () {
var region = $(this),
title = region.children(self.settings.title_selector),
content = region.children(self.settings.content_selector),
content_width = 0;
title_width = self.outerWidth(title);
content_width = self.outerWidth(section) - title_width;
if (content_width < content_min_width) {
content_min_width = content_width;
}
// Increment the minimum height of the content region
// to align with the height of the titles.
content_min_height += self.outerHeight(title);
// Set all of the inactive tabs to 'display: none'
// The CSS sets all of the tabs as 'display: block'
// in order to account for scrollbars when measuring the width
// of the content regions.
if (!$(this).hasClass('active')) {
content.css('display', 'none');
}
});
regions.each(function () {
var content = $(this).children(self.settings.content_selector);
content.css('minHeight', content_min_height);
// Remove 2 pixels to account for the right-shift in the CSS
content.css('maxWidth', content_min_width - 2);
});
} else {
regions.each(function () {
var region = $(this),
title = region.children(self.settings.title_selector),
content = region.children(self.settings.content_selector);
if (!self.rtl) {
content
.css({left: title.position().left - 1,
top: self.outerHeight(title) - 2});
} else {
content
.css({right: self.position_right(title) + 1,
top: self.outerHeight(title) - 2});
}
});
// temporary work around for Zepto outerheight calculation issues.
if (typeof Zepto === 'function') {
section.height(this.outerHeight($(titles[0])));
} else {
section.height(this.outerHeight($(titles[0])) - 2);
}
}
}
},
position_right : function (el) {
var self = this,
section = el.closest(this.settings.section_selector),
regions = section.children(this.settings.region_selector),
section_width = el.closest(this.settings.section_selector).width(),
offset = regions
.map(function () {
return $(this).children(self.settings.title_selector);
}).length;
return (section_width - el.position().left - el.width() * (el.index() + 1) - offset);
},
reflow : function (scope) {
var scope = scope || document;
$(this.settings.section_selector, scope).trigger('resize');
},
small : function (el) {
var settings = $.extend({}, this.settings, this.data_options(el));
if (this.is_horizontal_tabs(el)) {
return false;
}
if (el && this.is_accordion(el)) {
return true;
}
if ($('html').hasClass('lt-ie9')) {
return true;
}
if ($('html').hasClass('ie8compat')) {
return true;
}
return $(this.scope).width() < settings.small_breakpoint;
},
off : function () {
$(this.scope).off('.fndtn.section');
$(window).off('.fndtn.section');
$(document).off('.fndtn.section')
}
};
}(Foundation.zj, this, this.document));

208
docs/js/foundation/foundation.tooltips.js vendored Normal file
View File

@ -0,0 +1,208 @@
/*jslint unparam: true, browser: true, indent: 2 */
;(function ($, window, document, undefined) {
'use strict';
Foundation.libs.tooltips = {
name: 'tooltips',
version : '4.2.2',
settings : {
selector : '.has-tip',
additionalInheritableClasses : [],
tooltipClass : '.tooltip',
appendTo: 'body',
'disable-for-touch': false,
tipTemplate : function (selector, content) {
return '<span data-selector="' + selector + '" class="'
+ Foundation.libs.tooltips.settings.tooltipClass.substring(1)
+ '">' + content + '<span class="nub"></span></span>';
}
},
cache : {},
init : function (scope, method, options) {
Foundation.inherit(this, 'data_options');
var self = this;
if (typeof method === 'object') {
$.extend(true, this.settings, method);
} else if (typeof options !== 'undefined') {
$.extend(true, this.settings, options);
}
if (typeof method !== 'string') {
if (Modernizr.touch) {
$(this.scope)
.on('click.fndtn.tooltip touchstart.fndtn.tooltip touchend.fndtn.tooltip',
'[data-tooltip]', function (e) {
var settings = $.extend({}, self.settings, self.data_options($(this)));
if (!settings['disable-for-touch']) {
e.preventDefault();
$(settings.tooltipClass).hide();
self.showOrCreateTip($(this));
}
})
.on('click.fndtn.tooltip touchstart.fndtn.tooltip touchend.fndtn.tooltip',
this.settings.tooltipClass, function (e) {
e.preventDefault();
$(this).fadeOut(150);
});
} else {
$(this.scope)
.on('mouseenter.fndtn.tooltip mouseleave.fndtn.tooltip',
'[data-tooltip]', function (e) {
var $this = $(this);
if (/enter|over/i.test(e.type)) {
self.showOrCreateTip($this);
} else if (e.type === 'mouseout' || e.type === 'mouseleave') {
self.hide($this);
}
});
}
// $(this.scope).data('fndtn-tooltips', true);
} else {
return this[method].call(this, options);
}
},
showOrCreateTip : function ($target) {
var $tip = this.getTip($target);
if ($tip && $tip.length > 0) {
return this.show($target);
}
return this.create($target);
},
getTip : function ($target) {
var selector = this.selector($target),
tip = null;
if (selector) {
tip = $('span[data-selector="' + selector + '"]' + this.settings.tooltipClass);
}
return (typeof tip === 'object') ? tip : false;
},
selector : function ($target) {
var id = $target.attr('id'),
dataSelector = $target.attr('data-tooltip') || $target.attr('data-selector');
if ((id && id.length < 1 || !id) && typeof dataSelector != 'string') {
dataSelector = 'tooltip' + Math.random().toString(36).substring(7);
$target.attr('data-selector', dataSelector);
}
return (id && id.length > 0) ? id : dataSelector;
},
create : function ($target) {
var $tip = $(this.settings.tipTemplate(this.selector($target), $('<div></div>').html($target.attr('title')).html())),
classes = this.inheritable_classes($target);
$tip.addClass(classes).appendTo(this.settings.appendTo);
if (Modernizr.touch) {
$tip.append('<span class="tap-to-close">tap to close </span>');
}
$target.removeAttr('title').attr('title','');
this.show($target);
},
reposition : function (target, tip, classes) {
var width, nub, nubHeight, nubWidth, column, objPos;
tip.css('visibility', 'hidden').show();
width = target.data('width');
nub = tip.children('.nub');
nubHeight = this.outerHeight(nub);
nubWidth = this.outerHeight(nub);
objPos = function (obj, top, right, bottom, left, width) {
return obj.css({
'top' : (top) ? top : 'auto',
'bottom' : (bottom) ? bottom : 'auto',
'left' : (left) ? left : 'auto',
'right' : (right) ? right : 'auto',
'width' : (width) ? width : 'auto'
}).end();
};
objPos(tip, (target.offset().top + this.outerHeight(target) + 10), 'auto', 'auto', target.offset().left, width);
if ($(window).width() < 767) {
objPos(tip, (target.offset().top + this.outerHeight(target) + 10), 'auto', 'auto', 12.5, $(this.scope).width());
tip.addClass('tip-override');
objPos(nub, -nubHeight, 'auto', 'auto', target.offset().left);
} else {
var left = target.offset().left;
if (Foundation.rtl) {
left = target.offset().left + target.offset().width - this.outerWidth(tip);
}
objPos(tip, (target.offset().top + this.outerHeight(target) + 10), 'auto', 'auto', left, width);
tip.removeClass('tip-override');
if (classes && classes.indexOf('tip-top') > -1) {
objPos(tip, (target.offset().top - this.outerHeight(tip)), 'auto', 'auto', left, width)
.removeClass('tip-override');
} else if (classes && classes.indexOf('tip-left') > -1) {
objPos(tip, (target.offset().top + (this.outerHeight(target) / 2) - nubHeight*2.5), 'auto', 'auto', (target.offset().left - this.outerWidth(tip) - nubHeight), width)
.removeClass('tip-override');
} else if (classes && classes.indexOf('tip-right') > -1) {
objPos(tip, (target.offset().top + (this.outerHeight(target) / 2) - nubHeight*2.5), 'auto', 'auto', (target.offset().left + this.outerWidth(target) + nubHeight), width)
.removeClass('tip-override');
}
}
tip.css('visibility', 'visible').hide();
},
inheritable_classes : function (target) {
var inheritables = ['tip-top', 'tip-left', 'tip-bottom', 'tip-right', 'noradius'].concat(this.settings.additionalInheritableClasses),
classes = target.attr('class'),
filtered = classes ? $.map(classes.split(' '), function (el, i) {
if ($.inArray(el, inheritables) !== -1) {
return el;
}
}).join(' ') : '';
return $.trim(filtered);
},
show : function ($target) {
var $tip = this.getTip($target);
this.reposition($target, $tip, $target.attr('class'));
$tip.fadeIn(150);
},
hide : function ($target) {
var $tip = this.getTip($target);
$tip.fadeOut(150);
},
// deprecate reload
reload : function () {
var $self = $(this);
return ($self.data('fndtn-tooltips')) ? $self.foundationTooltips('destroy').foundationTooltips('init') : $self.foundationTooltips('init');
},
off : function () {
$(this.scope).off('.fndtn.tooltip');
$(this.settings.tooltipClass).each(function (i) {
$('[data-tooltip]').get(i).attr('title', $(this).text());
}).remove();
},
reflow : function () {}
};
}(Foundation.zj, this, this.document));

297
docs/js/foundation/foundation.topbar.js vendored Normal file
View File

@ -0,0 +1,297 @@
/*jslint unparam: true, browser: true, indent: 2 */
;(function ($, window, document, undefined) {
'use strict';
Foundation.libs.topbar = {
name : 'topbar',
version : '4.2.2',
settings : {
index : 0,
stickyClass : 'sticky',
custom_back_text: true,
back_text: 'Back',
is_hover: true,
scrolltop : true, // jump to top when sticky nav menu toggle is clicked
init : false
},
init : function (section, method, options) {
Foundation.inherit(this, 'data_options');
var self = this;
if (typeof method === 'object') {
$.extend(true, this.settings, method);
} else if (typeof options !== 'undefined') {
$.extend(true, this.settings, options);
}
if (typeof method !== 'string') {
$('.top-bar, [data-topbar]').each(function () {
$.extend(true, self.settings, self.data_options($(this)));
self.settings.$w = $(window);
self.settings.$topbar = $(this);
self.settings.$section = self.settings.$topbar.find('section');
self.settings.$titlebar = self.settings.$topbar.children('ul').first();
self.settings.$topbar.data('index', 0);
var breakpoint = $("<div class='top-bar-js-breakpoint'/>").insertAfter(self.settings.$topbar);
self.settings.breakPoint = breakpoint.width();
breakpoint.remove();
self.assemble();
if (self.settings.$topbar.parent().hasClass('fixed')) {
$('body').css('padding-top', self.outerHeight(self.settings.$topbar));
}
});
if (!self.settings.init) {
this.events();
}
return this.settings.init;
} else {
// fire method
return this[method].call(this, options);
}
},
events : function () {
var self = this;
var offst = this.outerHeight($('.top-bar, [data-topbar]'));
$(this.scope)
.off('.fndtn.topbar')
.on('click.fndtn.topbar', '.top-bar .toggle-topbar, [data-topbar] .toggle-topbar', function (e) {
var topbar = $(this).closest('.top-bar, [data-topbar]'),
section = topbar.find('section, .section'),
titlebar = topbar.children('ul').first();
e.preventDefault();
if (self.breakpoint()) {
if (!self.rtl) {
section.css({left: '0%'});
section.find('>.name').css({left: '100%'});
} else {
section.css({right: '0%'});
section.find('>.name').css({right: '100%'});
}
section.find('li.moved').removeClass('moved');
topbar.data('index', 0);
topbar
.toggleClass('expanded')
.css('max-height', '');
}
if (!topbar.hasClass('expanded')) {
if (topbar.hasClass('fixed')) {
topbar.parent().addClass('fixed');
topbar.removeClass('fixed');
$('body').css('padding-top',offst);
}
} else if (topbar.parent().hasClass('fixed')) {
topbar.parent().removeClass('fixed');
topbar.addClass('fixed');
$('body').css('padding-top','0');
if (self.settings.scrolltop) {
window.scrollTo(0,0);
}
}
})
.on('mouseenter mouseleave', '.top-bar li', function (e) {
if (!self.settings.is_hover) return;
if (/enter|over/i.test(e.type)) {
$(this).addClass('hover');
} else {
$(this).removeClass('hover');
}
})
.on('click.fndtn.topbar', '.top-bar li.has-dropdown', function (e) {
if (self.breakpoint()) return;
var li = $(this),
target = $(e.target),
topbar = li.closest('[data-topbar], .top-bar'),
is_hover = topbar.data('topbar');
if (self.settings.is_hover && !Modernizr.touch) return;
e.stopImmediatePropagation();
if (target[0].nodeName === 'A' && target.parent().hasClass('has-dropdown')) {
e.preventDefault();
}
if (li.hasClass('hover')) {
li
.removeClass('hover')
.find('li')
.removeClass('hover');
} else {
li.addClass('hover');
}
})
.on('click.fndtn.topbar', '.top-bar .has-dropdown>a, [data-topbar] .has-dropdown>a', function (e) {
if (self.breakpoint()) {
e.preventDefault();
var $this = $(this),
topbar = $this.closest('.top-bar, [data-topbar]'),
section = topbar.find('section, .section'),
titlebar = topbar.children('ul').first(),
dropdownHeight = $this.next('.dropdown').outerHeight(),
$selectedLi = $this.closest('li');
topbar.data('index', topbar.data('index') + 1);
$selectedLi.addClass('moved');
if (!self.rtl) {
section.css({left: -(100 * topbar.data('index')) + '%'});
section.find('>.name').css({left: 100 * topbar.data('index') + '%'});
} else {
section.css({right: -(100 * topbar.data('index')) + '%'});
section.find('>.name').css({right: 100 * topbar.data('index') + '%'});
}
topbar.css('max-height', self.height($this.siblings('ul')) + self.outerHeight(titlebar, true));
}
});
$(window).on('resize.fndtn.topbar', function () {
if (!self.breakpoint()) {
$('.top-bar, [data-topbar]')
.css('max-height', '')
.removeClass('expanded')
.find('li')
.removeClass('hover');
}
}.bind(this));
$('body').on('click.fndtn.topbar', function (e) {
var parent = $(e.target).closest('[data-topbar], .top-bar');
if (parent.length > 0) {
return;
}
$('.top-bar li, [data-topbar] li').removeClass('hover');
});
// Go up a level on Click
$(this.scope).on('click.fndtn', '.top-bar .has-dropdown .back, [data-topbar] .has-dropdown .back', function (e) {
e.preventDefault();
var $this = $(this),
topbar = $this.closest('.top-bar, [data-topbar]'),
titlebar = topbar.children('ul').first(),
section = topbar.find('section, .section'),
$movedLi = $this.closest('li.moved'),
$previousLevelUl = $movedLi.parent();
topbar.data('index', topbar.data('index') - 1);
if (!self.rtl) {
section.css({left: -(100 * topbar.data('index')) + '%'});
section.find('>.name').css({left: 100 * topbar.data('index') + '%'});
} else {
section.css({right: -(100 * topbar.data('index')) + '%'});
section.find('>.name').css({right: 100 * topbar.data('index') + '%'});
}
if (topbar.data('index') === 0) {
topbar.css('max-height', '');
} else {
topbar.css('max-height', self.height($previousLevelUl) + self.outerHeight(titlebar, true));
}
setTimeout(function () {
$movedLi.removeClass('moved');
}, 300);
});
},
breakpoint : function () {
return $(document).width() <= this.settings.breakPoint || $('html').hasClass('lt-ie9');
},
assemble : function () {
var self = this;
// Pull element out of the DOM for manipulation
this.settings.$section.detach();
this.settings.$section.find('.has-dropdown>a').each(function () {
var $link = $(this),
$dropdown = $link.siblings('.dropdown'),
url = $link.attr('href');
if (url && url.length > 1) {
var $titleLi = $('<li class="title back js-generated"><h5><a href="#"></a></h5></li><li><a class="parent-link js-generated" href="' + url + '">' + $link.text() +'</a></li>');
} else {
var $titleLi = $('<li class="title back js-generated"><h5><a href="#"></a></h5></li>');
}
// Copy link to subnav
if (self.settings.custom_back_text == true) {
$titleLi.find('h5>a').html('&laquo; ' + self.settings.back_text);
} else {
$titleLi.find('h5>a').html('&laquo; ' + $link.html());
}
$dropdown.prepend($titleLi);
});
// Put element back in the DOM
this.settings.$section.appendTo(this.settings.$topbar);
// check for sticky
this.sticky();
},
height : function (ul) {
var total = 0,
self = this;
ul.find('> li').each(function () { total += self.outerHeight($(this), true); });
return total;
},
sticky : function () {
var klass = '.' + this.settings.stickyClass;
if ($(klass).length > 0) {
var distance = $(klass).length ? $(klass).offset().top: 0,
$window = $(window);
var offst = this.outerHeight($('.top-bar'));
$window.scroll(function() {
if ($window.scrollTop() >= (distance)) {
$(klass).addClass("fixed");
$('body').css('padding-top',offst);
}
else if ($window.scrollTop() < distance) {
$(klass).removeClass("fixed");
$('body').css('padding-top','0');
}
});
}
},
off : function () {
$(this.scope).off('.fndtn.topbar');
$(window).off('.fndtn.topbar');
},
reflow : function () {}
};
}(Foundation.zj, this, this.document));

4
docs/js/jquery-1.7.min.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

114
docs/js/jquery.cookie.js Normal file
View File

@ -0,0 +1,114 @@
/*!
* jQuery Cookie Plugin v1.4.1
* https://github.com/carhartl/jquery-cookie
*
* Copyright 2006, 2014 Klaus Hartl
* Released under the MIT license
*/
(function (factory) {
if (typeof define === 'function' && define.amd) {
// AMD (Register as an anonymous module)
define(['jquery'], factory);
} else if (typeof exports === 'object') {
// Node/CommonJS
module.exports = factory(require('jquery'));
} else {
// Browser globals
factory(jQuery);
}
}(function ($) {
var pluses = /\+/g;
function encode(s) {
return config.raw ? s : encodeURIComponent(s);
}
function decode(s) {
return config.raw ? s : decodeURIComponent(s);
}
function stringifyCookieValue(value) {
return encode(config.json ? JSON.stringify(value) : String(value));
}
function parseCookieValue(s) {
if (s.indexOf('"') === 0) {
// This is a quoted cookie as according to RFC2068, unescape...
s = s.slice(1, -1).replace(/\\"/g, '"').replace(/\\\\/g, '\\');
}
try {
// Replace server-side written pluses with spaces.
// If we can't decode the cookie, ignore it, it's unusable.
// If we can't parse the cookie, ignore it, it's unusable.
s = decodeURIComponent(s.replace(pluses, ' '));
return config.json ? JSON.parse(s) : s;
} catch(e) {}
}
function read(s, converter) {
var value = config.raw ? s : parseCookieValue(s);
return $.isFunction(converter) ? converter(value) : value;
}
var config = $.cookie = function (key, value, options) {
// Write
if (arguments.length > 1 && !$.isFunction(value)) {
options = $.extend({}, config.defaults, options);
if (typeof options.expires === 'number') {
var days = options.expires, t = options.expires = new Date();
t.setMilliseconds(t.getMilliseconds() + days * 864e+5);
}
return (document.cookie = [
encode(key), '=', stringifyCookieValue(value),
options.expires ? '; expires=' + options.expires.toUTCString() : '', // use expires attribute, max-age is not supported by IE
options.path ? '; path=' + options.path : '',
options.domain ? '; domain=' + options.domain : '',
options.secure ? '; secure' : ''
].join(''));
}
// Read
var result = key ? undefined : {},
// To prevent the for loop in the first place assign an empty array
// in case there are no cookies at all. Also prevents odd result when
// calling $.cookie().
cookies = document.cookie ? document.cookie.split('; ') : [],
i = 0,
l = cookies.length;
for (; i < l; i++) {
var parts = cookies[i].split('='),
name = decode(parts.shift()),
cookie = parts.join('=');
if (key === name) {
// If second argument (value) is a function it's a converter...
result = read(cookie, value);
break;
}
// Prevent storing a cookie that we couldn't decode.
if (!key && (cookie = read(cookie)) !== undefined) {
result[name] = cookie;
}
}
return result;
};
config.defaults = {};
$.removeCookie = function (key, options) {
// Must not alter options, thus extending a fresh object...
$.cookie(key, '', $.extend({}, options, { expires: -1 }));
return !$.cookie(key);
};
}));

1
docs/js/jquery.githubRepoWidget.min.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

26
docs/js/prism-ruby-language.js Normal file
View File

@ -0,0 +1,26 @@
(function(){
if(!window.Prism) {
return;
}
Prism.languages.ruby = {
'comment': /#[^\r\n]*(\r?\n|$)/g,
'string': /("|')(\\?.)*?\1/g,
'regex': {
pattern: /(^|[^/])\/(?!\/)(\[.+?]|\\.|[^/\r\n])+\/[gim]{0,3}(?=\s*($|[\r\n,.;})]))/g,
lookbehind: true
},
'keyword': /\b(alias|and|BEGIN|begin|break|case|class|def|define_method|defined|do|each|else|elsif|END|end|ensure|false|for|if|in|module|new|next|nil|not|or|raise|redo|rescue|retry|return|self|super|then|throw|true|undef|unless|until|when|while|yield|desc|task|on|within|as|with|capture|execute|test|role|server)\b/g,
'builtin': /\b(Array|Bignum|Binding|Class|Continuation|Dir|Exception|FalseClass|File|Stat|File|Fixnum|Fload|Hash|Integer|IO|MatchData|Method|Module|NilClass|Numeric|Object|Proc|Range|Regexp|String|Struct|TMS|Symbol|ThreadGroup|Thread|Time|TrueClass)\b/,
'boolean': /\b(true|false)\b/g,
'number': /\b-?(0x)?\d*\.?\d+\b/g,
'operator': /[-+]{1,2}|!|=?&lt;|=?&gt;|={1,2}|(&amp;){1,2}|\|?\||\?|\*|\//g,
'inst-var': /[@&]\b[a-zA-Z_][a-zA-Z_0-9]*[?!]?\b/g,
'symbol': /:\b[a-zA-Z_][a-zA-Z_0-9]*[?!]?\b/g,
'const': /\b[A-Z][a-zA-Z_0-9]*[?!]?\b/g,
'ignore': /&(lt|gt|amp);/gi,
'punctuation': /[{}[\];(),.:]/g
};
})();

10
docs/js/prism.js Normal file
View File

@ -0,0 +1,10 @@
/**
* Prism: Lightweight, robust, elegant syntax highlighting
* MIT license http://www.opensource.org/licenses/mit-license.php/
* @author Lea Verou http://lea.verou.me
*/(function(){var e=/\blang(?:uage)?-(?!\*)(\w+)\b/i,t=self.Prism={util:{type:function(e){return Object.prototype.toString.call(e).match(/\[object (\w+)\]/)[1]},clone:function(e){var n=t.util.type(e);switch(n){case"Object":var r={};for(var i in e)e.hasOwnProperty(i)&&(r[i]=t.util.clone(e[i]));return r;case"Array":return e.slice()}return e}},languages:{extend:function(e,n){var r=t.util.clone(t.languages[e]);for(var i in n)r[i]=n[i];return r},insertBefore:function(e,n,r,i){i=i||t.languages;var s=i[e],o={};for(var u in s)if(s.hasOwnProperty(u)){if(u==n)for(var a in r)r.hasOwnProperty(a)&&(o[a]=r[a]);o[u]=s[u]}return i[e]=o},DFS:function(e,n){for(var r in e){n.call(e,r,e[r]);t.util.type(e)==="Object"&&t.languages.DFS(e[r],n)}}},highlightAll:function(e,n){var r=document.querySelectorAll('code[class*="language-"], [class*="language-"] code, code[class*="lang-"], [class*="lang-"] code');for(var i=0,s;s=r[i++];)t.highlightElement(s,e===!0,n)},highlightElement:function(r,i,s){var o,u,a=r;while(a&&!e.test(a.className))a=a.parentNode;if(a){o=(a.className.match(e)||[,""])[1];u=t.languages[o]}if(!u)return;r.className=r.className.replace(e,"").replace(/\s+/g," ")+" language-"+o;a=r.parentNode;/pre/i.test(a.nodeName)&&(a.className=a.className.replace(e,"").replace(/\s+/g," ")+" language-"+o);var f=r.textContent;if(!f)return;f=f.replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/\u00a0/g," ");var l={element:r,language:o,grammar:u,code:f};t.hooks.run("before-highlight",l);if(i&&self.Worker){var c=new Worker(t.filename);c.onmessage=function(e){l.highlightedCode=n.stringify(JSON.parse(e.data),o);t.hooks.run("before-insert",l);l.element.innerHTML=l.highlightedCode;s&&s.call(l.element);t.hooks.run("after-highlight",l)};c.postMessage(JSON.stringify({language:l.language,code:l.code}))}else{l.highlightedCode=t.highlight(l.code,l.grammar,l.language);t.hooks.run("before-insert",l);l.element.innerHTML=l.highlightedCode;s&&s.call(r);t.hooks.run("after-highlight",l)}},highlight:function(e,r,i){return n.stringify(t.tokenize(e,r),i)},tokenize:function(e,n,r){var i=t.Token,s=[e],o=n.rest;if(o){for(var u in o)n[u]=o[u];delete n.rest}e:for(var u in n){if(!n.hasOwnProperty(u)||!n[u])continue;var a=n[u],f=a.inside,l=!!a.lookbehind,c=0;a=a.pattern||a;for(var h=0;h<s.length;h++){var p=s[h];if(s.length>e.length)break e;if(p instanceof i)continue;a.lastIndex=0;var d=a.exec(p);if(d){l&&(c=d[1].length);var v=d.index-1+c,d=d[0].slice(c),m=d.length,g=v+m,y=p.slice(0,v+1),b=p.slice(g+1),w=[h,1];y&&w.push(y);var E=new i(u,f?t.tokenize(d,f):d);w.push(E);b&&w.push(b);Array.prototype.splice.apply(s,w)}}}return s},hooks:{all:{},add:function(e,n){var r=t.hooks.all;r[e]=r[e]||[];r[e].push(n)},run:function(e,n){var r=t.hooks.all[e];if(!r||!r.length)return;for(var i=0,s;s=r[i++];)s(n)}}},n=t.Token=function(e,t){this.type=e;this.content=t};n.stringify=function(e,r,i){if(typeof e=="string")return e;if(Object.prototype.toString.call(e)=="[object Array]")return e.map(function(t){return n.stringify(t,r,e)}).join("");var s={type:e.type,content:n.stringify(e.content,r,i),tag:"span",classes:["token",e.type],attributes:{},language:r,parent:i};s.type=="comment"&&(s.attributes.spellcheck="true");t.hooks.run("wrap",s);var o="";for(var u in s.attributes)o+=u+'="'+(s.attributes[u]||"")+'"';return"<"+s.tag+' class="'+s.classes.join(" ")+'" '+o+">"+s.content+"</"+s.tag+">"};if(!self.document){self.addEventListener("message",function(e){var n=JSON.parse(e.data),r=n.language,i=n.code;self.postMessage(JSON.stringify(t.tokenize(i,t.languages[r])));self.close()},!1);return}var r=document.getElementsByTagName("script");r=r[r.length-1];if(r){t.filename=r.src;document.addEventListener&&!r.hasAttribute("data-manual")&&document.addEventListener("DOMContentLoaded",t.highlightAll)}})();;
Prism.languages.markup={comment:/&lt;!--[\w\W]*?-->/g,prolog:/&lt;\?.+?\?>/,doctype:/&lt;!DOCTYPE.+?>/,cdata:/&lt;!\[CDATA\[[\w\W]*?]]>/i,tag:{pattern:/&lt;\/?[\w:-]+\s*(?:\s+[\w:-]+(?:=(?:("|')(\\?[\w\W])*?\1|\w+))?\s*)*\/?>/gi,inside:{tag:{pattern:/^&lt;\/?[\w:-]+/i,inside:{punctuation:/^&lt;\/?/,namespace:/^[\w-]+?:/}},"attr-value":{pattern:/=(?:('|")[\w\W]*?(\1)|[^\s>]+)/gi,inside:{punctuation:/=|>|"/g}},punctuation:/\/?>/g,"attr-name":{pattern:/[\w:-]+/g,inside:{namespace:/^[\w-]+?:/}}}},entity:/&amp;#?[\da-z]{1,8};/gi};Prism.hooks.add("wrap",function(e){e.type==="entity"&&(e.attributes.title=e.content.replace(/&amp;/,"&"))});;
Prism.languages.clike={comment:{pattern:/(^|[^\\])(\/\*[\w\W]*?\*\/|(^|[^:])\/\/.*?(\r?\n|$))/g,lookbehind:!0},string:/("|')(\\?.)*?\1/g,"class-name":{pattern:/((?:class|interface|extends|implements|trait|instanceof|new)\s+)[a-z0-9_\.\\]+/ig,lookbehind:!0,inside:{punctuation:/(\.|\\)/}},keyword:/\b(if|else|while|do|for|return|in|instanceof|function|new|try|catch|finally|null|break|continue)\b/g,"boolean":/\b(true|false)\b/g,"function":{pattern:/[a-z0-9_]+\(/ig,inside:{punctuation:/\(/}},number:/\b-?(0x[\dA-Fa-f]+|\d*\.?\d+([Ee]-?\d+)?)\b/g,operator:/[-+]{1,2}|!|=?&lt;|=?&gt;|={1,2}|(&amp;){1,2}|\|?\||\?|\*|\/|\~|\^|\%/g,ignore:/&(lt|gt|amp);/gi,punctuation:/[{}[\];(),.:]/g};;
Prism.languages.bash=Prism.languages.extend("clike",{comment:{pattern:/(^|[^"{\\])(#.*?(\r?\n|$))/g,lookbehind:!0},string:{pattern:/("|')(\\?[\s\S])*?\1/g,inside:{property:/\$([a-zA-Z0-9_#\?\-\*!@]+|\{[^\}]+\})/g}},keyword:/\b(if|then|else|elif|fi|for|break|continue|while|in|case|function|select|do|done|until|echo|exit|return|set|declare)\b/g});Prism.languages.insertBefore("bash","keyword",{property:/\$([a-zA-Z0-9_#\?\-\*!@]+|\{[^}]+\})/g});Prism.languages.insertBefore("bash","comment",{important:/(^#!\s*\/bin\/bash)|(^#!\s*\/bin\/sh)/g});
;
Prism.languages.http={"request-line":{pattern:/^(POST|GET|PUT|DELETE|OPTIONS)\b\shttps?:\/\/\S+\sHTTP\/[0-9.]+/g,inside:{property:/^\b(POST|GET|PUT|DELETE|OPTIONS)\b/g,"attr-name":/:\w+/g}},"response-status":{pattern:/^HTTP\/1.[01] [0-9]+.*/g,inside:{property:/[0-9]+[A-Z\s-]+$/g}},keyword:/^[\w-]+:(?=.+)/gm};var httpLanguages={"application/json":Prism.languages.javascript,"application/xml":Prism.languages.markup,"text/xml":Prism.languages.markup,"text/html":Prism.languages.markup};for(var contentType in httpLanguages){if(httpLanguages[contentType]){var options={};options[contentType]={pattern:new RegExp("(content-type:\\s*"+contentType+"[\\w\\W]*?)\\n\\n[\\w\\W]*","gi"),lookbehind:true,inside:{rest:httpLanguages[contentType]}};Prism.languages.insertBefore("http","keyword",options)}};

18
docs/js/prism.ruby.js Normal file
View File

@ -0,0 +1,18 @@
Prism.languages.ruby = {
'comment': /#[^\r\n]*(\r?\n|$)/g,
'string': /("|')(\\?.)*?\1/g,
'regex': {
pattern: /(^|[^/])\/(?!\/)(\[.+?]|\\.|[^/\r\n])+\/[gim]{0,3}(?=\s*($|[\r\n,.;})]))/g,
lookbehind: true
},
'keyword': /\b(alias|and|BEGIN|begin|break|case|class|def|define_method|defined|do|each|else|elsif|END|end|ensure|false|for|if|in|module|new|next|nil|not|or|raise|redo|rescue|retry|return|self|super|then|throw|true|undef|unless|until|when|while|yield|task|desc|on|execute|info)\b/g,
'builtin': /\b(Array|Bignum|Binding|Class|Continuation|Dir|Exception|FalseClass|File|Stat|File|Fixnum|Fload|Hash|Integer|IO|MatchData|Method|Module|NilClass|Numeric|Object|Proc|Range|Regexp|String|Struct|TMS|Symbol|ThreadGroup|Thread|Time|TrueClass)\b/,
'boolean': /\b(true|false)\b/g,
'number': /\b-?(0x)?\d*\.?\d+\b/g,
'operator': /[-+]{1,2}|!|=?&lt;|=?&gt;|={1,2}|(&amp;){1,2}|\|?\||\?|\*|\//g,
'inst-var': /[@&]\b[a-zA-Z_][a-zA-Z_0-9]*[?!]?\b/g,
'symbol': /:\b[a-zA-Z_][a-zA-Z_0-9]*[?!]?\b/g,
'const': /\b[A-Z][a-zA-Z_0-9]*[?!]?\b/g,
'ignore': /&(lt|gt|amp);/gi,
'punctuation': /[{}[\];(),.:]/g
};

43
docs/js/rainbow-custom.min.js vendored Normal file
View File

@ -0,0 +1,43 @@
/* Rainbow v1.2 rainbowco.de | included languages: c, shell, java, d, coffeescript, generic, scheme, javascript, r, haskell, python, html, smalltalk, csharp, go, php, ruby, lua, css */
var k=!0;
window.Rainbow=function(){function r(a){var b,c=a.getAttribute&&a.getAttribute("data-language")||0;if(!c){a=a.attributes;for(b=0;b<a.length;++b)if("data-language"===a[b].nodeName)return a[b].nodeValue}return c}function C(a){var b=r(a)||r(a.parentNode);if(!b){var c=/\blang(?:uage)?-(\w+)/;(a=a.className.match(c)||a.parentNode.className.match(c))&&(b=a[1])}return b}function D(a,b){for(var c in f[d]){c=parseInt(c,10);if(a==c&&b==f[d][c]?0:a<=c&&b>=f[d][c])delete f[d][c],delete j[d][c];if(a>=c&&a<f[d][c]||
b>c&&b<f[d][c])return k}return!1}function s(a,b){return'<span class="'+a.replace(/\./g," ")+(m?" "+m:"")+'">'+b+"</span>"}function t(a,b,c,i){var e=a.exec(c);if(e){++u;!b.name&&"string"==typeof b.matches[0]&&(b.name=b.matches[0],delete b.matches[0]);var l=e[0],g=e.index,v=e[0].length+g,h=function(){function e(){t(a,b,c,i)}u%100>0?e():setTimeout(e,0)};if(D(g,v))h();else{var n=w(b.matches),m=function(a,c,i){if(a>=c.length)i(l);else{var d=e[c[a]];if(d){var g=b.matches[c[a]],f=g.language,h=g.name&&g.matches?
g.matches:g,j=function(b,d,g){var f;f=0;var h;for(h=1;h<c[a];++h)e[h]&&(f=f+e[h].length);d=g?s(g,d):d;l=l.substr(0,f)+l.substr(f).replace(b,d);m(++a,c,i)};f?o(d,f,function(a){j(d,a)}):typeof g==="string"?j(d,d,g):x(d,h.length?h:[h],function(a){j(d,a,g.matches?g.name:0)})}else m(++a,c,i)}};m(0,n,function(a){b.name&&(a=s(b.name,a));if(!j[d]){j[d]={};f[d]={}}j[d][g]={replace:e[0],"with":a};f[d][g]=v;h()})}}else i()}function w(a){var b=[],c;for(c in a)a.hasOwnProperty(c)&&b.push(c);return b.sort(function(a,
b){return b-a})}function x(a,b,c){function i(b,l){l<b.length?t(b[l].pattern,b[l],a,function(){i(b,++l)}):E(a,function(a){delete j[d];delete f[d];--d;c(a)})}++d;i(b,0)}function E(a,b){function c(a,b,i,f){if(i<b.length){++y;var h=b[i],m=j[d][h],a=a.substr(0,h)+a.substr(h).replace(m.replace,m["with"]),h=function(){c(a,b,++i,f)};0<y%250?h():setTimeout(h,0)}else f(a)}var i=w(j[d]);c(a,i,0,b)}function o(a,b,c){var d=n[b]||[],e=n[z]||[],b=A[b]?d:d.concat(e);x(a.replace(/</g,"&lt;").replace(/>/g,"&gt;").replace(/&(?![\w\#]+;)/g,
"&amp;"),b,c)}function p(a,b,c){if(b<a.length){var d=a[b],e=C(d);return!(-1<(" "+d.className+" ").indexOf(" rainbow "))&&e?(e=e.toLowerCase(),d.className+=d.className?" rainbow":"rainbow",o(d.innerHTML,e,function(l){d.innerHTML=l;j={};f={};q&&q(d,e);setTimeout(function(){p(a,++b,c)},0)})):p(a,++b,c)}c&&c()}function B(a,b){var a=a&&"function"==typeof a.getElementsByTagName?a:document,c=a.getElementsByTagName("pre"),d=a.getElementsByTagName("code"),e,f=[],g=[];for(e=0;e<c.length;++e)c[e].getElementsByTagName("code").length?
c[e].innerHTML=c[e].innerHTML.replace(/^\s+/,"").replace(/\s+$/,""):f.push(c[e]);for(e=0;e<d.length;++e)g.push(d[e]);p(g.concat(f),0,b)}var j={},f={},n={},A={},d=0,z=0,u=0,y=0,m,q;return{extend:function(a,b,c){1==arguments.length&&(b=a,a=z);A[a]=c;n[a]=b.concat(n[a]||[])},c:function(a){q=a},a:function(a){m=a},color:function(a,b,c){if("string"==typeof a)return o(a,b,c);if("function"==typeof a)return B(0,a);B(a,b)}}}();
document.addEventListener?document.addEventListener("DOMContentLoaded",Rainbow.color,!1):window.attachEvent("onload",Rainbow.color);Rainbow.onHighlight=Rainbow.c;Rainbow.addClass=Rainbow.a;Rainbow.extend("c",[{name:"meta.preprocessor",matches:{1:[{matches:{1:"keyword.define",2:"entity.name"},pattern:/(\w+)\s(\w+)\b/g},{name:"keyword.define",pattern:/endif/g},{name:"constant.numeric",pattern:/\d+/g},{matches:{1:"keyword.include",2:"string"},pattern:/(include)\s(.*?)$/g}]},pattern:/\#([\S\s]*?)$/gm},{name:"keyword",pattern:/\b(do|goto|typedef)\b/g},{name:"entity.label",pattern:/\w+:/g},{matches:{1:"storage.type",3:"storage.type",4:"entity.name.function"},pattern:/\b((un)?signed|const)? ?(void|char|short|int|long|float|double)\*? +((\w+)(?= ?\())?/g},
{matches:{2:"entity.name.function"},pattern:/(\w|\*) +((\w+)(?= ?\())/g},{name:"storage.modifier",pattern:/\b(static|extern|auto|register|volatile|inline)\b/g},{name:"support.type",pattern:/\b(struct|union|enum)\b/g}]);Rainbow.extend("shell",[{name:"shell",matches:{1:{language:"shell"}},pattern:/\$\(([\s\S]*?)\)/gm},{matches:{2:"string"},pattern:/(\(|\s|\[|\=)(('|")[\s\S]*?(\3))/gm},{name:"keyword.operator",pattern:/&lt;|&gt;|&amp;/g},{name:"comment",pattern:/\#[\s\S]*?$/gm},{name:"storage.function",pattern:/(.+?)(?=\(\)\s{0,}\{)/g},{name:"support.command",pattern:/\b(echo|rm|ls|(mk|rm)dir|cd|find|cp|exit|pwd|exec|trap|source|shift|unset)/g},{matches:{1:"keyword"},pattern:/\b(break|case|continue|do|done|elif|else|esac|eval|export|fi|for|function|if|in|local|return|set|then|unset|until|while)(?=\(|\b)/g}],
k);Rainbow.extend("java",[{name:"constant",pattern:/\b(false|null|true|[A-Z_]+)\b/g},{b:{1:"keyword",2:"support.namespace"},pattern:/(import|package)\s(.+)/g},{name:"keyword",pattern:/\b(abstract|assert|boolean|break|byte|case|catch|char|class|const|continue|default|do|double|else|enum|extends|final|finally|float|for|goto|if|implements|import|instanceof|int|interface|long|native|new|package|private|protected|public|return|short|static|strictfp|super|switch|synchronized|this|throw|throws|transient|try|void|volatile|while)\b/g},
{name:"string",pattern:/(".*?")/g},{name:"char",pattern:/(')(.|\\.|\\u[\dA-Fa-f]{4})\1/g},{name:"integer",pattern:/\b(0x[\da-f]+|\d+)L?\b/g},{name:"comment",pattern:/\/\*[\s\S]*?\*\/|(\/\/).*?$/gm},{name:"support.annotation",pattern:/@\w+/g},{b:{1:"entity.function"},pattern:/([^@\.\s]+)\(/g},{name:"entity.class",pattern:/\b([A-Z]\w*)\b/g},{name:"operator",pattern:/(\+{1,2}|-{1,2}|~|!|\*|\/|%|(?:&lt;){1,2}|(?:&gt;){1,3}|instanceof|(?:&amp;){1,2}|\^|\|{1,2}|\?|:|(?:=|!|\+|-|\*|\/|%|\^|\||(?:&lt;){1,2}|(?:&gt;){1,3})?=)/g}],
k);Rainbow.extend("d",[{name:"constant",pattern:/\b(false|null|true)\b/g},{name:"keyword",pattern:/\b(abstract|alias|align|asm|assert|auto|body|bool|break|byte|case|cast|catch|cdouble|cent|cfloat|char|class|const|continue|creal|dchar|debug|default|delegate|delete|deprecated|do|double|else|enum|export|extern|false|final|finally|float|for|foreach|foreach_reverse|function|goto|idouble|if|ifloat|immutable|import|in|inout|int|interface|invariant|ireal|is|lazy|long|macro|mixin|module|new|nothrow|null|out|override|package|pragma|private|protected|public|pure|real|ref|return|scope|shared|short|size_t|static|string|struct|super|switch|synchronized|template|this|throw|true|try|typedef|typeid|typeof|ubyte|ucent|uint|ulong|union|unittest|ushort|version|void|volatile|wchar|while|with|__FILE__|__LINE__|__gshared|__traits|__vector|__parameters)\b/g},
{matches:{1:"keyword",2:{name:"support.class",pattern:/\w+/g}},pattern:/(typeof)\s([^\$].*?)(\)|;)/g},{matches:{1:"keyword.namespace",2:{name:"support.namespace",pattern:/\w+/g}},pattern:/\b(namespace)\s(.*?);/g},{matches:{1:"storage.modifier",2:"storage.class",3:"entity.name.class",4:"storage.modifier.extends",5:"entity.other.inherited-class"},pattern:/\b(abstract|sealed)?\s?(class)\s(\w+)(\sextends\s)?([\w\\]*)?\s?\{?(\n|\})/g},{name:"keyword.static",pattern:/\b(static)\b/g},{matches:{1:"keyword.new",
2:{name:"support.class",pattern:/\w+/g}},pattern:/\b(new)\s([^\$].*?)(?=\)|\(|;|&)/g},{name:"string",pattern:/("|')(.*?)\1/g},{name:"integer",pattern:/\b(0x[\da-f]+|\d+)\b/g},{name:"comment",pattern:/\/\*[\s\S]*?\*\/|\/\+[\s\S]*?\+\/|(\/\/)[\s\S]*?$/gm},{name:"operator",pattern:/(\/|\/=|.|..|...|&amp;|&amp;=|&amp;&amp;|\||\|=|\|\||\-|\-=|\-\-|\+|\+=|\+\+|&lt;|&lt;=|&lt;&lt;|&lt;&lt;=|&lt;&gt;|&lt;&gt;=|&gt;|&gt;=|&gt;&gt;=|&gt;&gt;&gt;=|&gt;&gt;|&gt;&gt;&gt;|!|!=|!&lt;&gt;|!&lt;&gt;=|!&lt;|!&lt;=|!&gt;|!&gt;=|\(|\)|[|]|\{|\}|\?|,|;|:|\$|=|==|\*|\*=|%|%=|\^|\^=|\^\^|\^\^=|~|~=|@|=&gt;|\#)/g}],
k);Rainbow.extend("coffeescript",[{name:"comment.block",pattern:/(\#{3})[\s\S]*\1/gm},{name:"string.block",pattern:/('{3}|"{3})[\s\S]*\1/gm},{name:"string.regex",matches:{2:{name:"comment",pattern:/\#(.*?)\n/g}},pattern:/(\/{3})([\s\S]*)\1/gm},{matches:{1:"keyword"},pattern:/\b(in|when|is|isnt|of|not|unless|until|super)(?=\b)/gi},{name:"keyword.operator",pattern:/\?/g},{name:"constant.language",pattern:/\b(undefined|yes|on|no|off)\b/g},{name:"keyword.variable.coffee",pattern:/@(\w+)/gi},{name:"reset",
pattern:/object|class|print/gi},{matches:{1:"entity.name.function",2:"keyword.operator",3:{name:"function.argument.coffee",pattern:/([\@\w]+)/g},4:"keyword.function"},pattern:/(\w+)\s{0,}(=|:)\s{0,}\((.*?)((-|=)&gt;)/gi},{matches:{1:{name:"function.argument.coffee",pattern:/([\@\w]+)/g},2:"keyword.function"},pattern:/\s\((.*?)\)\s{0,}((-|=)&gt;)/gi},{matches:{1:"entity.name.function",2:"keyword.operator",3:"keyword.function"},pattern:/(\w+)\s{0,}(=|:)\s{0,}((-|=)&gt;)/gi},{matches:{1:"storage.class",
2:"entity.name.class",3:"storage.modifier.extends",4:"entity.other.inherited-class"},pattern:/\b(class)\s(\w+)(\sextends\s)?([\w\\]*)?\b/g},{matches:{1:"keyword.new",2:{name:"support.class",pattern:/\w+/g}},pattern:/\b(new)\s(.*?)(?=\s)/g}]);Rainbow.extend([{matches:{1:{name:"keyword.operator",pattern:/\=/g},2:{name:"string",matches:{name:"constant.character.escape",pattern:/\\('|"){1}/g}}},pattern:/(\(|\s|\[|\=|:)(('|")([^\\\1]|\\.)*?(\3))/gm},{name:"comment",pattern:/\/\*[\s\S]*?\*\/|(\/\/|\#)[\s\S]*?$/gm},{name:"constant.numeric",pattern:/\b(\d+(\.\d+)?(e(\+|\-)?\d+)?(f|d)?|0x[\da-f]+)\b/gi},{matches:{1:"keyword"},pattern:/\b(and|array|as|b(ool(ean)?|reak)|c(ase|atch|har|lass|on(st|tinue))|d(ef|elete|o(uble)?)|e(cho|lse(if)?|xit|xtends|xcept)|f(inally|loat|or(each)?|unction)|global|if|import|int(eger)?|long|new|object|or|pr(int|ivate|otected)|public|return|self|st(ring|ruct|atic)|switch|th(en|is|row)|try|(un)?signed|var|void|while)(?=\(|\b)/gi},
{name:"constant.language",pattern:/true|false|null/g},{name:"keyword.operator",pattern:/\+|\!|\-|&(gt|lt|amp);|\||\*|\=/g},{matches:{1:"function.call"},pattern:/(\w+?)(?=\()/g},{matches:{1:"storage.function",2:"entity.name.function"},pattern:/(function)\s(.*?)(?=\()/g}]);Rainbow.extend("scheme",[{name:"plain",pattern:/&gt;|&lt;/g},{name:"comment",pattern:/;.*$/gm},{name:"constant.language",pattern:/#t|#f|'\(\)/g},{name:"constant.symbol",pattern:/'[^()\s#]+/g},{name:"constant.number",pattern:/\b\d+(?:\.\d*)?\b/g},{name:"string",pattern:/".+?"/g},{matches:{1:"storage.function",2:"variable"},pattern:/\(\s*(define)\s+\(?(\S+)/g},{matches:{1:"keyword"},pattern:/\(\s*(begin|define\-syntax|if|lambda|quasiquote|quote|set!|syntax\-rules|and|and\-let\*|case|cond|delay|do|else|or|let|let\*|let\-syntax|letrec|letrec\-syntax)(?=[\]()\s#])/g},
{matches:{1:"entity.function"},pattern:/\(\s*(eqv\?|eq\?|equal\?|number\?|complex\?|real\?|rational\?|integer\?|exact\?|inexact\?|=|<|>|<=|>=|zero\?|positive\?|negative\?|odd\?|even\?|max|min|\+|\-|\*|\/|abs|quotient|remainder|modulo|gcd|lcm|numerator|denominator|floor|ceiling|truncate|round|rationalize|exp|log|sin|cos|tan|asin|acos|atan|sqrt|expt|make\-rectangular|make\-polar|real\-part|imag\-part|magnitude|angle|exact\->inexact|inexact\->exact|number\->string|string\->number|not|boolean\?|pair\?|cons|car|cdr|set\-car!|set\-cdr!|caar|cadr|cdar|cddr|caaar|caadr|cadar|caddr|cdaar|cdadr|cddar|cdddr|caaaar|caaadr|caadar|caaddr|cadaar|cadadr|caddar|cadddr|cdaaar|cdaadr|cdadar|cdaddr|cddaar|cddadr|cdddar|cddddr|null\?|list\?|list|length|append|reverse|list\-tail|list\-ref|memq|memv|member|assq|assv|assoc|symbol\?|symbol\->string|string\->symbol|char\?|char=\?|char<\?|char>\?|char<=\?|char>=\?|char\-ci=\?|char\-ci<\?|char\-ci>\?|char\-ci<=\?|char\-ci>=\?|char\-alphabetic\?|char\-numeric\?|char\-whitespace\?|char\-upper\-case\?|char\-lower\-case\?|char\->integer|integer\->char|char\-upcase|char\-downcase|string\?|make\-string|string|string\-length|string\-ref|string\-set!|string=\?|string\-ci=\?|string<\?|string>\?|string<=\?|string>=\?|string\-ci<\?|string\-ci>\?|string\-ci<=\?|string\-ci>=\?|substring|string\-append|string\->list|list\->string|string\-copy|string\-fill!|vector\?|make\-vector|vector|vector\-length|vector\-ref|vector\-set!|vector\->list|list\->vector|vector\-fill!|procedure\?|apply|map|for\-each|force|call\-with\-current\-continuation|call\/cc|values|call\-with\-values|dynamic\-wind|eval|scheme\-report\-environment|null\-environment|interaction\-environment|call\-with\-input\-file|call\-with\-output\-file|input\-port\?|output\-port\?|current\-input\-port|current\-output\-port|with\-input\-from\-file|with\-output\-to\-file|open\-input\-file|open\-output\-file|close\-input\-port|close\-output\-port|read|read\-char|peek\-char|eof\-object\?|char\-ready\?|write|display|newline|write\-char|load|transcript\-on|transcript\-off)(?=[\]()\s#])/g}],
k);Rainbow.extend("javascript",[{name:"selector",pattern:/(\s|^)\$(?=\.|\()/g},{name:"support",pattern:/\b(window|document)\b/g},{matches:{1:"support.property"},pattern:/\.(length|node(Name|Value))\b/g},{matches:{1:"support.function"},pattern:/(setTimeout|setInterval)(?=\()/g},{matches:{1:"support.method"},pattern:/\.(getAttribute|push|getElementById|getElementsByClassName|log|setTimeout|setInterval)(?=\()/g},{matches:{1:"support.tag.script",2:[{name:"string",pattern:/('|")(.*?)(\1)/g},{name:"entity.tag.script",
pattern:/(\w+)/g}],3:"support.tag.script"},pattern:/(&lt;\/?)(script.*?)(&gt;)/g},{name:"string.regexp",matches:{1:"string.regexp.open",2:{name:"constant.regexp.escape",pattern:/\\(.){1}/g},3:"string.regexp.close",4:"string.regexp.modifier"},pattern:/(\/)(?!\*)(.+)(\/)([igm]{0,3})/g},{matches:{1:"storage",3:"entity.function"},pattern:/(var)?(\s|^)(\S*)(?=\s?=\s?function\()/g},{matches:{1:"keyword",2:"entity.function"},pattern:/(new)\s+(.*)(?=\()/g},{name:"entity.function",pattern:/(\w+)(?=:\s{0,}function)/g}]);Rainbow.extend("r",[{matches:{1:{name:"keyword.operator",pattern:/\=|<\-|&lt;-/g},2:{name:"string",matches:{name:"constant.character.escape",pattern:/\\('|"){1}/g}}},pattern:/(\(|\s|\[|\=|:)(('|")([^\\\1]|\\.)*?(\3))/gm},{matches:{1:"constant.language"},pattern:/\b(NULL|NA|TRUE|FALSE|T|F|NaN|Inf|NA_integer_|NA_real_|NA_complex_|NA_character_)\b/g},{matches:{1:"constant.symbol"},pattern:/[^0-9a-zA-Z\._](LETTERS|letters|month\.(abb|name)|pi)/g},{name:"keyword.operator",pattern:/&lt;-|<-|-|==|&lt;=|<=|&gt;>|>=|<|>|&amp;&amp;|&&|&amp;|&|!=|\|\|?|\*|\+|\^|\/|%%|%\/%|\=|%in%|%\*%|%o%|%x%|\$|:|~|\[{1,2}|\]{1,2}/g},
{matches:{1:"storage",3:"entity.function"},pattern:/(\s|^)(.*)(?=\s?=\s?function\s\()/g},{matches:{1:"storage.function"},pattern:/[^a-zA-Z0-9._](function)(?=\s*\()/g},{matches:{1:"namespace",2:"keyword.operator",3:"function.call"},pattern:/([a-zA-Z][a-zA-Z0-9._]+)([:]{2,3})([.a-zA-Z][a-zA-Z0-9._]*(?=\s*\())\b/g},{name:"support.function",pattern:/(^|[^0-9a-zA-Z\._])(array|character|complex|data\.frame|double|integer|list|logical|matrix|numeric|vector)(?=\s*\()/g}]);Rainbow.extend("haskell",[{name:"comment",pattern:/\{\-\-[\s\S(\w+)]+[\-\-][\}$]/gm},{name:"comment",pattern:/\-\-(.*)/g},{matches:{1:"keyword",2:"support.namespace"},pattern:/\b(module)\s(\w+)\s[\(]?(\w+)?[\)?]\swhere/g},{name:"keyword.operator",pattern:/\+|\!|\-|&(gt|lt|amp);|\/\=|\||\@|\:|\.|\+{2}|\:|\*|\=|#|\.{2}|(\\)[a-zA-Z_]/g},{name:"keyword",pattern:/\b(case|class|foreign|hiding|qualified|data|family|default|deriving|do|else|if|import|in|infix|infixl|infixr|instance|let|in|otherwise|module|newtype|of|then|type|where)\b/g},
{name:"keyword",pattern:/[\`][a-zA-Z_']*?[\`]/g},{matches:{1:"keyword",2:"keyword.operator"},pattern:/\b(infix|infixr|infixl)+\s\d+\s(\w+)*/g},{name:"entity.class",pattern:/\b([A-Z][A-Za-z0-9_']*)/g},{name:"meta.preprocessor",matches:{1:[{matches:{1:"keyword.define",2:"entity.name"},pattern:/(\w+)\s(\w+)\b/g},{name:"keyword.define",pattern:/endif/g},{name:"constant.numeric",pattern:/\d+/g},{matches:{1:"keyword.include",2:"string"},pattern:/(include)\s(.*?)$/g}]},pattern:/^\#([\S\s]*?)$/gm}]);Rainbow.extend("python",[{name:"variable.self",pattern:/self/g},{name:"constant.language",pattern:/None|True|False|NotImplemented|\.\.\./g},{name:"support.object",pattern:/object/g},{name:"support.function.python",pattern:/\b(bs|divmod|input|open|staticmethod|all|enumerate|int|ord|str|any|eval|isinstance|pow|sum|basestring|execfile|issubclass|print|super|bin|file|iter|property|tuple|bool|filter|len|range|type|bytearray|float|list|raw_input|unichr|callable|format|locals|reduce|unicode|chr|frozenset|long|reload|vars|classmethod|getattr|map|repr|xrange|cmp|globals|max|reversed|zip|compile|hasattr|memoryview|round|__import__|complex|hash|min|set|apply|delattr|help|next|setattr|buffer|dict|hex|object|slice|coerce|dir|id|oct|sorted|intern)(?=\()/g},
{matches:{1:"keyword"},pattern:/\b(pass|lambda|with|is|not|in|from|elif|raise|del)(?=\(|\b)/g},{matches:{1:"storage.class",2:"entity.name.class",3:"entity.other.inherited-class"},pattern:/(class)\s+(\w+)\((\w+?)\)/g},{matches:{1:"storage.function",2:"support.magic"},pattern:/(def)\s+(__\w+)(?=\()/g},{name:"support.magic",pattern:/__(name)__/g},{matches:{1:"keyword.control",2:"support.exception.type"},pattern:/(except) (\w+):/g},{matches:{1:"storage.function",2:"entity.name.function"},pattern:/(def)\s+(\w+)(?=\()/g},
{name:"entity.name.function.decorator",pattern:/@([\w\.]+)/g},{name:"comment.docstring",pattern:/('{3}|"{3})[\s\S]*?\1/gm}]);Rainbow.extend("html",[{name:"source.php.embedded",matches:{2:{language:"php"}},pattern:/&lt;\?=?(?!xml)(php)?([\s\S]*?)(\?&gt;)/gm},{name:"source.css.embedded",matches:{"0":{language:"css"}},pattern:/&lt;style(.*?)&gt;([\s\S]*?)&lt;\/style&gt;/gm},{name:"source.js.embedded",matches:{"0":{language:"javascript"}},pattern:/&lt;script(?! src)(.*?)&gt;([\s\S]*?)&lt;\/script&gt;/gm},{name:"comment.html",pattern:/&lt;\!--[\S\s]*?--&gt;/g},{matches:{1:"support.tag.open",2:"support.tag.close"},pattern:/(&lt;)|(\/?\??&gt;)/g},
{name:"support.tag",matches:{1:"support.tag",2:"support.tag.special",3:"support.tag-name"},pattern:/(&lt;\??)(\/|\!?)(\w+)/g},{matches:{1:"support.attribute"},pattern:/([a-z-]+)(?=\=)/gi},{matches:{1:"support.operator",2:"string.quote",3:"string.value",4:"string.quote"},pattern:/(=)('|")(.*?)(\2)/g},{matches:{1:"support.operator",2:"support.value"},pattern:/(=)([a-zA-Z\-0-9]*)\b/g},{matches:{1:"support.attribute"},pattern:/\s(\w+)(?=\s|&gt;)(?![\s\S]*&lt;)/g}],k);Rainbow.extend("smalltalk",[{name:"keyword.pseudovariable",pattern:/self|thisContext/g},{name:"keyword.constant",pattern:/false|nil|true/g},{name:"string",pattern:/'([^']|'')*'/g},{name:"string.symbol",pattern:/#\w+|#'([^']|'')*'/g},{name:"string.character",pattern:/\$\w+/g},{name:"comment",pattern:/"([^"]|"")*"/g},{name:"constant.numeric",pattern:/-?\d+(\.\d+)?((r-?|s)[A-Za-z0-9]+|e-?[0-9]+)?/g},{name:"entity.name.class",pattern:/\b[A-Z]\w*/g},{name:"entity.name.function",pattern:/\b[a-z]\w*:?/g},
{name:"entity.name.binary",pattern:/(&lt;|&gt;|&amp;|[=~\|\\\/!@*\-_+])+/g},{name:"operator.delimiter",pattern:/;[\(\)\[\]\{\}]|#\[|#\(^\./g}],k);Rainbow.extend("csharp",[{name:"constant",pattern:/\b(false|null|true)\b/g},{name:"keyword",pattern:/\b(abstract|add|alias|ascending|as|base|bool|break|byte|case|catch|char|checked|class|const|continue|decimal|default|delegate|descending|double|do|dynamic|else|enum|event|explicit|extern|false|finally|fixed|float|foreach|for|from|get|global|goto|group|if|implicit|int|interface|internal|into|in|is|join|let|lock|long|namespace|new|object|operator|orderby|out|override|params|partial|private|protected|public|readonly|ref|remove|return|sbyte|sealed|select|set|short|sizeof|stackalloc|static|string|struct|switch|this|throw|try|typeof|uint|unchecked|ulong|unsafe|ushort|using|value|var|virtual|void|volatile|where|while|yield)\b/g},
{matches:{1:"keyword",2:{name:"support.class",pattern:/\w+/g}},pattern:/(typeof)\s([^\$].*?)(\)|;)/g},{matches:{1:"keyword.namespace",2:{name:"support.namespace",pattern:/\w+/g}},pattern:/\b(namespace)\s(.*?);/g},{matches:{1:"storage.modifier",2:"storage.class",3:"entity.name.class",4:"storage.modifier.extends",5:"entity.other.inherited-class"},pattern:/\b(abstract|sealed)?\s?(class)\s(\w+)(\sextends\s)?([\w\\]*)?\s?\{?(\n|\})/g},{name:"keyword.static",pattern:/\b(static)\b/g},{matches:{1:"keyword.new",
2:{name:"support.class",pattern:/\w+/g}},pattern:/\b(new)\s([^\$].*?)(?=\)|\(|;|&)/g},{name:"string",pattern:/(")(.*?)\1/g},{name:"integer",pattern:/\b(0x[\da-f]+|\d+)\b/g},{name:"comment",pattern:/\/\*[\s\S]*?\*\/|(\/\/)[\s\S]*?$/gm},{name:"operator",pattern:/(\+\+|\+=|\+|--|-=|-|&lt;&lt;=|&lt;&lt;|&lt;=|=&gt;|&gt;&gt;=|&gt;&gt;|&gt;=|!=|!|~|\^|\|\||&amp;&amp;|&amp;=|&amp;|\?\?|::|:|\*=|\*|\/=|%=|\|=|==|=)/g},{name:"preprocessor",pattern:/(\#if|\#else|\#elif|\#endif|\#define|\#undef|\#warning|\#error|\#line|\#region|\#endregion|\#pragma)[\s\S]*?$/gm}],
k);Rainbow.extend("go",[{matches:{1:{name:"keyword.operator",pattern:/\=/g},2:{name:"string",matches:{name:"constant.character.escape",pattern:/\\(`|"){1}/g}}},pattern:/(\(|\s|\[|\=|:)((`|")([^\\\1]|\\.)*?(\3))/gm},{name:"comment",pattern:/\/\*[\s\S]*?\*\/|(\/\/)[\s\S]*?$/gm},{name:"constant.numeric",pattern:/\b(\d+(\.\d+)?(e(\+|\-)?\d+)?(f|d)?|0x[\da-f]+)\b/gi},{matches:{1:"keyword"},pattern:/\b(break|c(ase|onst|ontinue)|d(efault|efer)|else|fallthrough|for|go(to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)(?=\(|\b)/gi},
{name:"constant.language",pattern:/true|false|null|string|byte|rune|u?int(8|16|32|64)?|float(32|64)|complex(64|128)/g},{name:"keyword.operator",pattern:/\+|\!|\-|&(gt|lt|amp);|\||\*|\:?=/g},{matches:{1:"function.call"},pattern:/(\w+?)(?=\()/g},{matches:{1:"storage.function",2:"entity.name.function"},pattern:/(func)\s(.*?)(?=\()/g}]);Rainbow.extend("php",[{name:"support",pattern:/\becho\b/g},{matches:{1:"variable.dollar-sign",2:"variable"},pattern:/(\$)(\w+)\b/g},{name:"constant.language",pattern:/true|false|null/ig},{name:"constant",pattern:/\b[A-Z0-9_]{2,}\b/g},{name:"keyword.dot",pattern:/\./g},{name:"keyword",pattern:/\b(die|end(for(each)?|switch|if)|case|require(_once)?|include(_once)?)(?=\(|\b)/g},{matches:{1:"keyword",2:{name:"support.class",pattern:/\w+/g}},pattern:/(instanceof)\s([^\$].*?)(\)|;)/g},{matches:{1:"support.function"},
pattern:/\b(array(_key_exists|_merge|_keys|_shift)?|isset|count|empty|unset|printf|is_(array|string|numeric|object)|sprintf|each|date|time|substr|pos|str(len|pos|tolower|_replace|totime)?|ord|trim|in_array|implode|end|preg_match|explode|fmod|define|link|list|get_class|serialize|file|sort|mail|dir|idate|log|intval|header|chr|function_exists|dirname|preg_replace|file_exists)(?=\()/g},{name:"variable.language.php-tag",pattern:/(&lt;\?(php)?|\?&gt;)/g},{matches:{1:"keyword.namespace",2:{name:"support.namespace",
pattern:/\w+/g}},pattern:/\b(namespace|use)\s(.*?);/g},{matches:{1:"storage.modifier",2:"storage.class",3:"entity.name.class",4:"storage.modifier.extends",5:"entity.other.inherited-class",6:"storage.modifier.extends",7:"entity.other.inherited-class"},pattern:/\b(abstract|final)?\s?(class|interface|trait)\s(\w+)(\sextends\s)?([\w\\]*)?(\simplements\s)?([\w\\]*)?\s?\{?(\n|\})/g},{name:"keyword.static",pattern:/self::|static::/g},{matches:{1:"storage.function",2:"support.magic"},pattern:/(function)\s(__.*?)(?=\()/g},
{matches:{1:"keyword.new",2:{name:"support.class",pattern:/\w+/g}},pattern:/\b(new)\s([^\$].*?)(?=\)|\(|;)/g},{matches:{1:{name:"support.class",pattern:/\w+/g},2:"keyword.static"},pattern:/([\w\\]*?)(::)(?=\b|\$)/g},{matches:{2:{name:"support.class",pattern:/\w+/g}},pattern:/(\(|,\s?)([\w\\]*?)(?=\s\$)/g}]);Rainbow.extend("ruby",[{name:"string",matches:{1:"string.open",2:{name:"string.keyword",pattern:/(\#\{.*?\})/g},3:"string.close"},pattern:/("|`)(.*?[^\\\1])?(\1)/g},{name:"string",pattern:/('|"|`)([^\\\1\n]|\\.)*\1/g},{name:"string",pattern:/%[qQ](?=(\(|\[|\{|&lt;|.)(.*?)(?:'|\)|\]|\}|&gt;|\1))(?:\(\2\)|\[\2\]|\{\2\}|\&lt;\2&gt;|\1\2\1)/g},{matches:{1:"string",2:"string",3:"string"},pattern:/(&lt;&lt;)(\w+).*?$([\s\S]*?^\2)/gm},{matches:{1:"string",2:"string",3:"string"},pattern:/(&lt;&lt;\-)(\w+).*?$([\s\S]*?\2)/gm},
{name:"string.regexp",matches:{1:"string.regexp",2:{name:"string.regexp",pattern:/\\(.){1}/g},3:"string.regexp",4:"string.regexp"},pattern:/(\/)(.*?)(\/)([a-z]*)/g},{name:"string.regexp",matches:{1:"string.regexp",2:{name:"string.regexp",pattern:/\\(.){1}/g},3:"string.regexp",4:"string.regexp"},pattern:/%r(?=(\(|\[|\{|&lt;|.)(.*?)('|\)|\]|\}|&gt;|\1))(?:\(\2\)|\[\2\]|\{\2\}|\&lt;\2&gt;|\1\2\1)([a-z]*)/g},{name:"comment",pattern:/#.*$/gm},{name:"comment",pattern:/^\=begin[\s\S]*?\=end$/gm},{matches:{1:"constant"},
pattern:/(\w+:)[^:]/g},{matches:{1:"constant.symbol"},pattern:/[^:](:(?:\w+|(?=['"](.*?)['"])(?:"\2"|'\2')))/g},{name:"constant.numeric",pattern:/\b(0x[\da-f]+|\d+)\b/g},{name:"support.class",pattern:/\b[A-Z]\w*(?=((\.|::)[A-Za-z]|\[))/g},{name:"constant",pattern:/\b[A-Z]\w*\b/g},{matches:{1:"storage.class",2:"entity.name.class",3:"entity.other.inherited-class"},pattern:/\s*(class)\s+((?:(?:::)?[A-Z]\w*)+)(?:\s+&lt;\s+((?:(?:::)?[A-Z]\w*)+))?/g},{matches:{1:"storage.module",2:"entity.name.class"},
pattern:/\s*(module)\s+((?:(?:::)?[A-Z]\w*)+)/g},{name:"variable.global",pattern:/\$([a-zA-Z_]\w*)\b/g},{name:"variable.class",pattern:/@@([a-zA-Z_]\w*)\b/g},{name:"variable.instance",pattern:/@([a-zA-Z_]\w*)\b/g},{matches:{1:"keyword.control"},pattern:/[^\.]\b(BEGIN|begin|case|class|do|else|elsif|END|end|ensure|for|if|in|module|rescue|then|unless|until|when|while)\b(?![?!])/g},{matches:{1:"keyword.control.pseudo-method"},pattern:/[^\.]\b(alias|alias_method|break|next|redo|retry|return|super|undef|yield)\b(?![?!])|\bdefined\?|\bblock_given\?/g},
{matches:{1:"constant.language"},pattern:/\b(nil|true|false)\b(?![?!])/g},{matches:{1:"variable.language"},pattern:/\b(__(FILE|LINE)__|self)\b(?![?!])/g},{matches:{1:"keyword.special-method"},pattern:/\b(require|gem|initialize|new|loop|include|extend|raise|attr_reader|attr_writer|attr_accessor|attr|catch|throw|private|module_function|public|protected)\b(?![?!])/g},{name:"keyword.operator",pattern:/\s\?\s|=|&lt;&lt;|&lt;&lt;=|%=|&=|\*=|\*\*=|\+=|\-=|\^=|\|{1,2}=|&lt;&lt;|&lt;=&gt;|&lt;(?!&lt;|=)|&gt;(?!&lt;|=|&gt;)|&lt;=|&gt;=|===|==|=~|!=|!~|%|&amp;|\*\*|\*|\+|\-|\/|\||~|&gt;&gt;/g},
{matches:{1:"keyword.operator.logical"},pattern:/[^\.]\b(and|not|or)\b/g},{matches:{1:"storage.function",2:"entity.name.function"},pattern:/(def)\s(.*?)(?=(\s|\())/g}],k);Rainbow.extend("lua",[{matches:{1:{name:"keyword.operator",pattern:/\=/g},2:{name:"string",matches:{name:"constant.character.escape",pattern:/\\('|"){1}/g}}},pattern:/(\(|\s|\[|\=)(('|")([^\\\1]|\\.)*?(\3))/gm},{name:"comment",pattern:/\-{2}\[{2}\-{2}[\s\S]*?\-{2}\]{2}\-{2}|(\-{2})[\s\S]*?$/gm},{name:"constant.numeric",pattern:/\b(\d+(\.\d+)?(e(\+|\-)?\d+)?(f|d)?|0x[\da-f]+)\b/gi},{matches:{1:"keyword"},pattern:/\b((a|e)nd|in|repeat|break|local|return|do|for|then|else(if)?|function|not|if|or|until|while)(?=\(|\b)/gi},
{name:"constant.language",pattern:/true|false|nil/g},{name:"keyword.operator",pattern:/\+|\!|\-|&(gt|lt|amp);|\||\*|\=|#|\.{2}/g},{matches:{1:"storage.function",2:"entity.name.function"},pattern:/(function)\s+(\w+[\:|\.]?\w+?)(?=\()/g},{matches:{1:"support.function"},pattern:/\b(print|require|module|\w+\.\w+)(?=\()/g}],k);Rainbow.extend("css",[{name:"comment",pattern:/\/\*[\s\S]*?\*\//gm},{name:"constant.hex-color",pattern:/#([a-f0-9]{3}|[a-f0-9]{6})(?=;|\s|,|\))/gi},{matches:{1:"constant.numeric",2:"keyword.unit"},pattern:/(\d+)(px|em|cm|s|%)?/g},{name:"string",pattern:/('|")(.*?)\1/g},{name:"support.css-property",matches:{1:"support.vendor-prefix"},pattern:/(-o-|-moz-|-webkit-|-ms-)?[\w-]+(?=\s?:)(?!.*\{)/g},{matches:{1:[{name:"entity.name.sass",pattern:/&amp;/g},{name:"direct-descendant",pattern:/&gt;/g},{name:"entity.name.class",
pattern:/\.[\w\-_]+/g},{name:"entity.name.id",pattern:/\#[\w\-_]+/g},{name:"entity.name.pseudo",pattern:/:[\w\-_]+/g},{name:"entity.name.tag",pattern:/\w+/g}]},pattern:/([\w\ ,:\.\#\&\;\-_]+)(?=.*\{)/g},{matches:{2:"support.vendor-prefix",3:"support.css-value"},pattern:/(:|,)\s*(-o-|-moz-|-webkit-|-ms-)?([a-zA-Z-]*)(?=\b)(?!.*\{)/g},{matches:{1:"support.tag.style",2:[{name:"string",pattern:/('|")(.*?)(\1)/g},{name:"entity.tag.style",pattern:/(\w+)/g}],3:"support.tag.style"},pattern:/(&lt;\/?)(style.*?)(&gt;)/g}],
k);