-
Notifications
You must be signed in to change notification settings - Fork 14
/
index.coffee
250 lines (217 loc) · 6.63 KB
/
index.coffee
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
path = require 'path'
fs = require 'fs'
W = require 'when'
nodefn = require 'when/node'
guard = require 'when/guard'
keys = require 'when/keys'
_ = require 'lodash'
readdirp = require 'readdirp'
GithubApi = require 'github'
minimatch = require 'minimatch'
file_map = require 'file-map'
module.exports = (root, config) ->
d = W.defer()
config.ignore = _.compact([
'.gitignore',
'.git{/**,}',
'**/node_modules{/**,}'].concat(config.ignore))
repo_user = config.repo.split('/')[0]
repo_name = config.repo.split('/')[1]
gh = new GithubApi(version: "3.0.0", debug: false)
ctx =
root: root
gh: gh
config: config
user: repo_user
repo: repo_name
branch: config.branch or 'gh-pages'
authenticate.call(ctx).with(ctx)
.then(get_latest_commit)
.then(build_tree)
.then(create_commit)
.then(update_gh_pages_branch)
.done ->
d.resolve
deployer: 'gh-pages'
url: "http://#{repo_user}.github.io/#{repo_name}"
destroy: destroy.bind(@)
, d.reject
return d.promise
module.exports.config =
required: ['username', 'password', 'repo']
optional: ['ignore']
###*
* Authenticates with github using the provided credentials
* @return {Promise} - completed authentication, if incorrect, errors come later
###
authenticate = ->
@gh.authenticate
type: 'basic'
username: @config.username
password: @config.password
W.resolve()
###*
* Grabs the latest commit from the github pages branch. If this doesn't exist,
* creates the branch with a commit for a basic readme.
*
* @return {Promise} a promise for the sha of the latest commit
###
get_latest_commit = ->
nodefn.call @gh.repos.getCommits,
user: @user
repo: @repo
sha: @branch
.then (res) -> res[0].sha
.catch (err) =>
msg = JSON.parse(err.message).message
if msg == 'Git Repository is empty.'
return create_initial_commit.call(@)
if msg == 'Not Found'
return create_branch.call(@)
throw err
###*
* If a repo is empty, a commit needs to be created before trees can be pushed.
* This method creates
* @return {Promise} a promise for the sha of the newly created commit
###
create_initial_commit = ->
nodefn.call @gh.repos.createFile,
user: @user
repo: @repo
branch: @branch
message: 'initial commit'
path: 'README.md'
content: new Buffer("#{@user}/#{@repo}").toString('base64')
.then (res) -> res.sha
create_branch = ->
get_default_branch.call(@).then (branch) =>
nodefn.call @gh.gitdata.createReference,
user: @user
repo: @repo
ref: "refs/heads/#{@branch}"
sha: branch.commit.sha
get_default_branch = ->
nodefn.call @gh.repos.getBranches,
user: @user
repo: @repo
.then (res) -> res[0]
###*
* Runs through the root and recrusively builds up the structure in the format
* that github needs it. Creates blobs for files and trees at every folder
* level, nesting them inside each other and returning a single tree object with
* SHA's from github, ready to be committed.
*
* @return {Object} github-formatted tree object
###
build_tree = ->
i = @config.ignore
file_map(@root, { file_ignores: i, directory_ignores: i })
.then (tree) => format_tree.call(@, path: '', children: tree)
###*
* This is the real workhorse. This method recurses through a given directory,
* grabbing the files and folders and creating blobs and trees, nested properly,
* through github's API.
*
* @param {Object} root - a directory object provided by file-map
* @return {Promise} a promise for a github-formatted tree object
###
format_tree = (root) ->
dirs = _.where(root.children, { type: 'directory' })
files = _.where(root.children, { type: 'file' })
if dirs.length
W.map(dirs, format_tree.bind(@))
.then (dir_objects) =>
W.map(files, create_blob.bind(@))
.then (file_objects) -> dir_objects.concat(file_objects)
.then(create_tree.bind(@, root))
else
W.map(files, create_blob.bind(@))
.then(create_tree.bind(@, root))
###*
* Creates a blob through github's API, given a file.
*
* @param {Object} file - file object via file-map
* @return {Promise} promise for a github-formatted file object with the sha
###
create_blob = (file) ->
nodefn.call(fs.readFile, file.full_path)
.then(get_blob_sha.bind(@))
.then (sha) ->
path: path.basename(file.path)
mode: '100644'
type: 'blob'
sha: sha
###*
* Creates a tree through github's API, given an array of contents.
*
* @param {Object} root - directory object via file-map of the tree's root dir
* @param {Array} tree - array of github-formatted tree and/or blob objects
* @return {Promise} promise for a github-formatted tree object with the sha
###
create_tree = (root, tree) ->
get_tree_sha.call(@, tree)
.then (sha) ->
path: path.basename(root.path)
mode: '040000'
type: 'tree'
sha: sha
###*
* Given a file's content, creates a blob through github and returns the sha.
*
* @param {String} content - the content of a file, as a utf8 string
* @return {Promise} promise for a string representing the blob's sha
###
get_blob_sha = (content) ->
nodefn.call @gh.gitdata.createBlob.bind(@gh),
user: @user
repo: @repo
content: content.toString('base64')
encoding: 'base64'
.then (res) -> res.sha
###*
* Given a tree array, creates a tree through github and returns the sha.
*
* @param {Array} tree - array containing tree and/or blob objects
* @return {Promise} promise for a string representing the tree's sha
###
get_tree_sha = (tree) ->
nodefn.call @gh.gitdata.createTree.bind(@gh),
user: @user
repo: @repo
tree: tree
.then (res) -> res.sha
###*
* Given a tree, creates a new commit pointing to that tree.
*
* @param {Object} tree - github-formatted tree object
* @return {Promise} promise for github api's response to creating the commit
###
create_commit = (tree) ->
get_latest_commit.call(@)
.then (sha) => nodefn.call @gh.gitdata.createCommit,
user: @user
repo: @repo
parents: [sha]
tree: tree.sha
message: "deploy from ship"
###*
* Points the deploy target branch's HEAD to the sha of a given commit.
*
* @param {Object} commit - github api representation of a commit
* @return {Promise} promise for the github api's response to updating the ref
###
update_gh_pages_branch = (commit) ->
nodefn.call @gh.gitdata.updateReference,
user: @user
repo: @repo
ref: "heads/#{@branch}"
sha: commit.sha
force: true
###*
* Removes the deploy target branch, undoing the deploy.
###
destroy = ->
nodefn.call @gh.gitdata.deleteReference,
user: @user
repo: @repo
ref: "heads/#{@branch}"