Class: ReVIEW::Init

Inherits:
Object show all
Defined in:
lib/review/init.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Init

Returns a new instance of Init.



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/review/init.rb', line 21

def initialize
  @tex_documentclass_opts = {
    'review-jsbook' => 'media=print,paper=a5',
    'review-jlreq' => 'media=print,paper=a5'
  }

  @template = 'review-jsbook'
  @logger = ReVIEW.logger
  @review_dir = File.dirname(File.expand_path('..', __dir__))
end

Class Method Details

.execute(*args) ⇒ Object 



17
18
19
 
# File 'lib/review/init.rb', line 17

def self.execute(*args)
  new.execute(*args)
end

Instance Method Details

#download_and_extract_archive(dir, filename) ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/review/init.rb', line 252

def download_and_extract_archive(dir, filename)
  begin
    require 'zip'
  rescue LoadError
    @logger.error 'extracting needs rubyzip.'
    exit 1
  end

  if %r{\Ahttps?://}.match?(filename)
    begin
      @logger.info "Downloading from #{filename}"
      zipdata = Net::HTTP.get(URI.parse(filename))
    rescue StandardError => e
      @logger.error "Failed to download #{filename}: #{e.message}"
      exit 1
    end

    Tempfile.create('reviewinit') do |f|
      zipfilename = f.path
      f.write zipdata

      extract_archive(dir, zipfilename, filename)
    end
  else
    unless File.readable?(filename)
      @logger.error "Failed to open #{filename}"
      exit 1
    end
    extract_archive(dir, filename, filename)
  end
end

#execute(*args) ⇒ Object 



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
 
# File 'lib/review/init.rb', line 32

def execute(*args)
  initdir = parse_options(args)

  if @webui
    start_webui
    unless @web_result
      @logger.error 'Aborted.'
      exit 1
    end
    @template = @web_result[0]
    @tex_documentclass_opts[@template] = @web_result[1]
  end

  generate_dir(initdir) do |dir|
    generate_catalog_file(dir)
    generate_sample(dir)
    generate_images_dir(dir)
    generate_cover_image(dir)
    generate_style(dir)
    generate_texmacro(dir)
    generate_config(dir)
    generate_gitignore(dir)
    generate_locale(dir) if @locale
    generate_rakefile(dir)
    generate_gemfile(dir)
    generate_doc(dir) unless @without_doc
    download_and_extract_archive(dir, @archive) if @archive
  end
end

#extract_archive(dir, filename, originalfilename) ⇒ Object 



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/review/init.rb', line 284

def extract_archive(dir, filename, originalfilename)
  made = nil
  begin
    Zip::File.open(filename) do |zip|
      zip.each do |entry|
        fname = entry.name.tr('\\', '/')
        if fname =~ /__MACOSX/ || fname =~ /\.DS_Store/
          next
        end

        if fname.start_with?('/') || fname =~ /\.\./ # simple fool proof
          made = nil
          break
        end

        # `true' means override
        entry.extract(File.join(dir, fname)) { true }
      end
      made = true
    end
    raise Zip::Error unless made
  rescue Zip::Error => e
    @logger.error "#{originalfilename} seems invalid or broken zip file: #{e.message}"
  end
end

#generate_catalog_file(dir) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/review/init.rb', line 135

def generate_catalog_file(dir)
  File.write(File.join(dir, 'catalog.yml'), <<-EOS)
PREDEF:

CHAPS:
  - #{File.basename(dir)}.re

APPENDIX:

POSTDEF:

EOS
end

#generate_config(dir) ⇒ Object 



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
 
# File 'lib/review/init.rb', line 160

def generate_config(dir)
  today = Time.now.strftime('%Y-%m-%d')
  content = File.read(File.join(@review_dir, 'doc/config.yml.sample'), encoding: 'utf-8')
  content.gsub!(/^#\s*coverimage:.*$/, 'coverimage: cover.jpg')
  content.gsub!(/^  #\s*coverimage:.*$/, '  coverimage: cover-a5.ai')
  content.gsub!(/^#\s*date:.*$/, "date: #{today}")
  content.gsub!(/^#\s*history:.*$/, %Q(history: [["#{today}"]]))
  content.gsub!(/^#\s*texstyle:.*$/, 'texstyle: ["reviewmacro"]')
  content.gsub!(/^(#\s*)?stylesheet:.*$/, %Q(stylesheet: ["style.css"]))
  if @epub_version.to_i == 2
    content.gsub!(/^#.*epubversion:.*$/, 'epubversion: 2')
    content.gsub!(/^#.*htmlversion:.*$/, 'htmlversion: 4')
  end

  if @tex_documentclass_opts[@template]
    content.gsub!(/^#\s*texdocumentclass:.*$/, %Q(texdocumentclass: ["#{@template}", "#{@tex_documentclass_opts[@template]}"]))
  end

  if @without_config_comment
    content = content.split("\n").delete_if { |l| l.strip.start_with?('#') || l.strip.empty? }.join("\n")
  end

  File.write(File.join(dir, 'config.yml'), content)
  if @webui && !@web_result[2].empty?
    File.open(File.join(dir, 'config-ebook.yml'), 'w') do |f|
      f.puts <<EOT
# for ebook PDF
# REVIEW_CONFIG_FILE=config-ebook.yml rake pdf
inherit: ["config.yml"]
# bookname: book-ebook
texdocumentclass: ["#{@web_result[0]}", "#{@web_result[2]}"]
EOT
    end
  end
end

#generate_cover_image(dir) ⇒ Object 



153
154
155
156
157
158
 
# File 'lib/review/init.rb', line 153

def generate_cover_image(dir)
  FileUtils.cp(File.join(@review_dir, 'samples/sample-book/src/images/cover.jpg'),
               File.join(dir, 'images'))
  FileUtils.cp(File.join(@review_dir, 'samples/sample-book/src/images/cover-a5.ai'),
               File.join(dir, 'images'))
end

#generate_dir(dir) {|dir| ... } ⇒ Object

Yields:

  • (dir) 


120
121
122
123
124
125
126
127
 
# File 'lib/review/init.rb', line 120

def generate_dir(dir)
  if File.exist?(dir) && !@force
    @logger.error "#{dir} already exists."
    exit 1
  end
  FileUtils.mkdir_p(dir)
  yield dir
end

#generate_doc(dir) ⇒ Object 



245
246
247
248
249
250
 
# File 'lib/review/init.rb', line 245

def generate_doc(dir)
  docdir = File.join(dir, 'doc')
  FileUtils.mkdir_p(docdir)
  md_files = Dir.glob(File.join(@review_dir, 'doc/*.md')).map.to_a
  FileUtils.cp(md_files, docdir)
end

#generate_gemfile(dir) ⇒ Object 



236
237
238
239
240
241
242
243
 
# File 'lib/review/init.rb', line 236

def generate_gemfile(dir)
  File.write(File.join(dir, 'Gemfile'), <<-EOS)
source 'https://rubygems.org'

gem 'rake'
gem 'review', '#{ReVIEW::VERSION}'
EOS
end

#generate_gitignore(dir) ⇒ Object 



196
197
198
 
# File 'lib/review/init.rb', line 196

def generate_gitignore(dir)
  FileUtils.cp(File.join(@review_dir, 'samples/sample-book/src/.gitignore'), dir)
end

#generate_images_dir(dir) ⇒ Object 



149
150
151
 
# File 'lib/review/init.rb', line 149

def generate_images_dir(dir)
  FileUtils.mkdir_p(File.join(dir, 'images'))
end

#generate_locale(dir) ⇒ Object 



232
233
234
 
# File 'lib/review/init.rb', line 232

def generate_locale(dir)
  FileUtils.cp(File.join(@review_dir, 'lib/review/i18n.yml'), File.join(dir, 'locale.yml'))
end

#generate_rakefile(dir) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/review/init.rb', line 219

def generate_rakefile(dir)
  FileUtils.mkdir_p(File.join(dir, 'lib/tasks'))

  File.write(File.join(dir, 'Rakefile'), <<-EOS)
Dir.glob('lib/tasks/*.rake').sort.each do |file|
  load(file)
end
EOS

  FileUtils.cp(File.join(@review_dir, 'samples/sample-book/src/lib/tasks/review.rake'),
               File.join(dir, 'lib/tasks/review.rake'))
end

#generate_sample(dir) ⇒ Object 



129
130
131
132
133
 
# File 'lib/review/init.rb', line 129

def generate_sample(dir)
  unless @force
    File.write(File.join(dir, "#{File.basename(dir)}.re"), '= ')
  end
end

#generate_style(dir) ⇒ Object 



200
201
202
 
# File 'lib/review/init.rb', line 200

def generate_style(dir)
  FileUtils.cp(File.join(@review_dir, 'samples/sample-book/src/style.css'), dir)
end

#generate_texmacro(dir) ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/review/init.rb', line 204

def generate_texmacro(dir)
  texmacrodir = File.join(dir, 'sty')
  FileUtils.mkdir_p(texmacrodir)
  tdir = File.join(@review_dir, 'templates/latex', @template)
  @logger.error "#{tdir} not found." unless File.exist?(tdir)
  FileUtils.cp(Dir.glob(File.join(tdir, '*.*')), texmacrodir)

  if @template == 'review-jsbook'
    # provide jsbook from vendor/. current version is 2020/10/09
    FileUtils.cp(File.join(@review_dir, 'vendor/jsclasses/jsbook.cls'), File.join(texmacrodir, 'jsbook.cls'))
    # provide gentombow from vendor/. current version is 2019/07/21 v0.9k
    FileUtils.cp(File.join(@review_dir, 'vendor/gentombow/gentombow.sty'), File.join(texmacrodir, 'gentombow.sty'))
  end
end

#parse_options(args) ⇒ Object 



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
 
# File 'lib/review/init.rb', line 62

def parse_options(args)
  @port = 18000
  @bind = '0.0.0.0'

  opts = OptionParser.new
  opts.version = ReVIEW::VERSION
  opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [option] dirname"
  opts.on('-h', '--help', 'print this message and quit.') do
    puts opts.help
    exit 0
  end
  opts.on('-f', '--force', 'generate files (except *.re) if directory has already existed.') do
    @force = true
  end
  opts.on('-l', '--locale', 'generate locale.yml file.') do
    @locale = true
  end
  opts.on('-t', '--latex-template name', 'specify LaTeX template name. (default: review-jsbook)') do |tname|
    @template = tname
  end
  opts.on('', '--epub-version VERSION', 'define EPUB version.') do |version|
    @epub_version = version
  end
  opts.on('', '--without-config-comment', "don't include comments in config.yml.") do
    @without_config_comment = true
  end
  opts.on('', '--without-doc', "don't generate doc files.") do
    @without_doc = true
  end
  opts.on('-p', '--package archivefile', 'extract from local or network archive.') do |archive|
    @archive = archive
  end
  opts.on('-w', '--wizard', 'launch Web based layout configuration.') do
    @webui = true
  end
  opts.on('', '--port port', 'port to use for Web based layout configuration. (default: 18000)') do |port|
    @port = port
  end
  opts.on('', '--bind bindaddress', 'address to use for Web based layout configuration. (default: 0.0.0.0 (any))') do |bind|
    @bind = bind
  end

  begin
    opts.parse!(args)
  rescue OptionParser::ParseError => e
    @logger.error e.message
    $stderr.puts opts.help
    exit 1
  end

  if args.empty?
    $stderr.puts opts.help
    exit 1
  end

  File.expand_path(args[0])
end

#start_webui ⇒ Object 



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/review/init.rb', line 310

def start_webui
  begin
    require 'webrick'
  rescue LoadError
    @logger.error 'not found webrick. Please install webrick gem.'
    exit 1
  end
  web_config = {
    BindAddress: @bind,
    Port: @port,
    HTTPVersion: WEBrick::HTTPVersion.new('1.1'),
    AccessLog: [[File.open(IO::NULL, 'w'), '']]
  }

  bind_address = (@bind == '0.0.0.0') ? '<thishost>' : @bind
  puts "Please access http://#{bind_address}:#{web_config[:Port]} from Web browser."
  begin
    @web_server = WEBrick::HTTPServer.new(web_config)
  rescue StandardError => e
    @logger.error "Error: #{e}"
    exit 1
  end

  @web_result = nil
  web_mounts

  trap(:INT) { @web_server.shutdown }
  @web_server.start

  # validation
  if @web_result
    @web_result.each do |s|
      unless /\A[a-z0-9=_,.-]*\Z/i.match?(s)
        @web_result = nil
        break
      end
    end
  end
end

#web_mounts ⇒ Object 



350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/review/init.rb', line 350

def web_mounts
  htmldir = File.join(@review_dir, 'lib', 'review', 'init-web')
  @web_server.mount('/', WEBrick::HTTPServlet::FileHandler, File.join(htmldir, 'index.html'))
  @web_server.mount('/review-layout-design.js', WEBrick::HTTPServlet::FileHandler, File.join(htmldir, 'review-layout-design.js'))

  @web_server.mount_proc('/finish') do |req, res|
    @web_result = [req.query['cls'], req.query['result_print'], req.query['result_ebook']]
    res.content_type = 'text/html'
    res.body = File.read(File.join(htmldir, 'finish.html'))
    @web_server.shutdown
  end
end