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
|
#! /usr/bin/env ruby
#
# Copyright (c) 2001 by Jim Menard <jimm@io.com>
#
# Released under the same license as Ruby. See
# http://www.ruby-lang.org/en/LICENSE.txt.
#
# This script gathers everything needed to release NQXML into one directory
# and, if requested, publishes the contents to the NQXML Web site.
#
# usage:
#
# release.rb [--publish, -p]
#
# Specifying --publish or -p causes the resulting files to be published
# to the Web site.
#
require 'net/ftp'
require 'ftools' # For makedirs and install
require 'generateManifest' # For--you guessed it--generating the Manifest
# Start looking for NQXML classes in this directory.
# This forces us to use the local copy of NQXML, even if there is
# a previously installed version out there somewhere.
$LOAD_PATH[0, 0] = '.'
require 'nqxml/info' # For Version string
FILE_PERMISSION = 0644
DIR_PERMISSION = 0755
IMAGES_DIR_NAME = 'stylesheet-images'
PUBLISH_FLAG = '-p'
NQXML_DIR = 'nqxml'
DOCS_DIR = './docs'
DOCS_HTML_DIR = "#{DOCS_DIR}/README"
DOCS_HTML_IMAGES_DIR = "#{DOCS_HTML_DIR}/#{IMAGES_DIR_NAME}"
EXAMPLES_DIR = './examples'
NQXML_DIR_WITH_VERSION = "#{NQXML_DIR}-#{NQXML::Version}"
RELEASE_DIR = "/tmp/#{NQXML_DIR_WITH_VERSION}_release"
RELEASE_HTML_DIR = "#{RELEASE_DIR}/README"
RELEASE_HTML_IMAGES_DIR = "#{RELEASE_HTML_DIR}/#{IMAGES_DIR_NAME}"
DOWNLOAD_FILE = "#{DOCS_DIR}/index.html"
DOCBOOK_FILE = "#{DOCS_DIR}/README.sgml"
WEB_SITE = 'io.com'
WEB_DIR = 'public-web/downloads/nqxml'
# Copies all files from `fromDir' into the release directory. Sets the
# permissions of all files to 0644. We don't want scripts to be executable
# because they are only examples we are putting up on the Web site.
def copyFiles(fromDir, toDir, match=nil)
Dir.foreach(fromDir) { | f |
next if f =~ /^\.\.?/ || (!match.nil? && !(f =~ match))
File.install("#{fromDir}/#{f}", toDir, FILE_PERMISSION)
}
end
# Recursively removes the contents of a directory.
def rmDirectory(dirName)
return unless File.exists?(dirName)
Dir.foreach(dirName) { | f |
next if f =~ /^\.\.?/
path = "#{dirName}/#{f}"
rmDirectory(path) if File.directory?(path)
File.delete(path) if !File.directory?(path)
}
end
# Recursively sends files and directories.
def sendToWebSite(ftp, releaseDir, webDir)
ftp.chdir(webDir)
Dir.foreach(releaseDir) { | f |
next if f =~ /^\.\.?/
path = "#{releaseDir}/#{f}"
if File.directory?(path)
begin
ftp.mkdir(f)
rescue Net::FTPPermError
# ignore; it's OK if the directory already exists
end
sendToWebSite(ftp, path, f)
ftp.chdir('..')
else
ftp.putbinaryfile(path, f)
end
}
end
def ensureVersionInFile(fileName, regex)
lines = File.open(fileName).grep(regex)
found = lines.detect { | line | line =~ /#{NQXML::Version}/o }
if !found
$stderr.puts "Warning: it looks like the #{fileName} version number" +
" is incorrect"
end
end
# ================================================================
# main
# ================================================================
# Make sure the docs mention the correct version number.
ensureVersionInFile(DOWNLOAD_FILE, /Download the latest/)
ensureVersionInFile(DOCBOOK_FILE, /releaseinfo/)
# Empty release dir if it already exists.
rmDirectory(RELEASE_DIR)
# (Re)create release dir. This makes RELEASE_HTML_IMAGES_DIR, whose parent
# is RELEASE_DIR. Therefore, RELEASE_DIR is created as well.
File.makedirs(RELEASE_HTML_IMAGES_DIR)
# Recreate the full documentation (creating README and docs/README) and copy
# the HTML files to the release directory. Finally, clean up the docs
# directory.
system("cd #{DOCS_DIR} && make")
copyFiles(DOCS_DIR, RELEASE_DIR, /\.html$/)
copyFiles(DOCS_HTML_DIR, RELEASE_HTML_DIR, /\.html$/)
copyFiles(DOCS_HTML_IMAGES_DIR, RELEASE_HTML_IMAGES_DIR, /\.gif$/)
system("cd #{DOCS_DIR} && make clean")
# Copy examples to release dir.
copyFiles(EXAMPLES_DIR, RELEASE_DIR)
# Generate the Manifest file.
generateManifest()
# Create .tar.gz file. We temporarily rename the NQXML folder to
# "nqxml-X.Y.Z", tar and gzip that directory, then restore its original
# name.
Dir.chdir('..')
File.rename(NQXML_DIR, NQXML_DIR_WITH_VERSION)
system("tar -czf #{RELEASE_DIR}/#{NQXML_DIR_WITH_VERSION}.tar.gz " +
NQXML_DIR_WITH_VERSION)
File.chmod(FILE_PERMISSION, "#{RELEASE_DIR}/#{NQXML_DIR_WITH_VERSION}.tar.gz")
File.rename(NQXML_DIR_WITH_VERSION, NQXML_DIR)
# ftp files if requested
if !ARGV.empty? && ARGV[0] == PUBLISH_FLAG
require 'net/ftp'
# Ask for ftp username and password
guess = ENV['LOGNAME'] || ENV['USER']
print "username [#{guess}]: "
username = $stdin.gets().chomp()
username = guess if username.empty?
print "password: "
password = $stdin.gets().chomp()
# ftp files to web site
ftp = Net::FTP.open(WEB_SITE, username, password)
sendToWebSite(ftp, RELEASE_DIR, WEB_DIR)
ftp.close()
end
|
