Class: ShowoffUtils
- Inherits:
-
Object
- Object
- ShowoffUtils
- Defined in:
- lib/showoff_utils.rb
Constant Summary collapse
- HEROKU_PROCFILE =
'Procfile'
- HEROKU_GEMS_FILE =
'Gemfile'
- HEROKU_CONFIG_FILE =
'config.ru'
- TYPES =
{ :default => lambda { |t,size,source,type| (t,"#{size} #{type}",source) }, 'title' => lambda { |t,size,dontcare| (t,size) }, 'bullets' => lambda { |t,size,dontcare| (t,"#{size} bullets incremental",["bullets","go","here"])}, 'smbullets' => lambda { |t,size,dontcare| (t,"#{size} smbullets incremental",["bullets","go","here","and","here"])}, 'code' => lambda { |t,size,src| (t,size,blank?(src) ? " @@@ Ruby\n code_here()" : src) }, 'commandline' => lambda { |t,size,dontcare| (t,"#{size} commandline"," $ command here\n output here")}, 'full-page' => lambda { |t,size,dontcare| (t,"#{size} full-page","![Image Description](image/ref.png)")}, }
- EXTENSIONS =
{ 'pl' => 'perl', 'rb' => 'ruby', 'erl' => 'erlang', # so not exhaustive, but probably good enough for now }
- REQUIRED_GEMS =
%w(redcarpet showoff heroku)
Class Method Summary collapse
-
.add_new_dir(dir) ⇒ Object
Adds the given directory to this presentation, appending it to the end of showoff.json as well.
-
.add_slide(options) ⇒ Object
Adds a new slide to a given dir, giving it a number such that it falls after all slides in that dir.
-
.adjust_size(lines, width) ⇒ Object
Determines a more optimal value for the size (e.g. small vs. smaller) based upon the size of the code being formatted.
- .blank?(string) ⇒ Boolean
-
.clone(url, branch = nil, path = nil) ⇒ Object
clone a repo url, then run a provided block.
- .command(command, error = 'command failed') ⇒ Object
- .create(dirname, create_samples, dirs = 'one') ⇒ Object
-
.create_file_if_needed(filename, force) ⇒ Object
Creates the given filename if it doesn’t exist or if force is true.
-
.create_gems_file(filename, password, force, formatter, header = nil) ⇒ Object
Creates the file that lists the gems for heroku.
- .default_style(dir = '.') ⇒ Object
- .default_style?(style, dir = '.') ⇒ Boolean
- .determine_filename(slide_dir, slide_name, number) ⇒ Object
- .determine_size_and_source(code) ⇒ Object
- .determine_title(title, slide_name, code) ⇒ Object
-
.find_next_number(slide_dir) ⇒ Object
Finds the next number in the given dir to name a slide as the last slide in the dir.
- .get_config_option(dir, option, default = nil) ⇒ Object
-
.github ⇒ Object
generate a static version of the site into the gh-pages branch.
-
.heroku(name, force = false, password = nil) ⇒ Object
name - String containing heroku name force - boolean if .gems/Gemfile and config.ru should be overwritten if they don’t exist password - String containing password to protect your heroku site; nil means no password protection.
- .info(config, json = false) ⇒ Object
- .lang(source_file) ⇒ Object
-
.make_slide(title, classes = "", content = nil) ⇒ Object
Makes a slide as a string.
-
.parse_options(option_string = "") ⇒ Object
Helper method to parse a comma separated options string and stores the result in a dictionrary.
- .pause_msg(dir = '.') ⇒ Object
- .presentation_config_file ⇒ Object
- .presentation_config_file=(filename) ⇒ Object
-
.read_code(source_file) ⇒ Object
Reads the code from the source file, returning the code, indented for markdown, as well as the number of lines and the width of the largest line.
- .showoff_legacy_sections(dir, data) ⇒ Object
- .showoff_markdown(dir = ".") ⇒ Object
- .showoff_pdf_options(dir = '.') ⇒ Object
- .showoff_renderer_options(dir = '.', default_options = MarkdownConfig::defaults(dir)) ⇒ Object
- .showoff_sections(dir, data = nil, logger = nil) ⇒ Object
- .showoff_slide_files(dir, data = nil, logger = nil) ⇒ Object
- .showoff_title(dir = '.') ⇒ Object
- .skeleton(config) ⇒ Object
-
.update(verbose = false) ⇒ Object
just update the repo in cwd.
- .validate(config) ⇒ Object
- .write_file(filename, slide) ⇒ Object
Class Method Details
.add_new_dir(dir) ⇒ Object
Adds the given directory to this presentation, appending it to the end of showoff.json as well
325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/showoff_utils.rb', line 325 def self.add_new_dir(dir) puts "Creating #{dir}..." Dir.mkdir dir showoff_json = JSON.parse(File.read(ShowoffUtils.presentation_config_file)) showoff_json["section"] = dir File.open(ShowoffUtils.presentation_config_file,'w') do |file| file.puts JSON.generate(showoff_json) end puts "#{ShowoffUtils.presentation_config_file} updated" end |
.add_slide(options) ⇒ Object
Adds a new slide to a given dir, giving it a number such that it falls after all slides in that dir. Options are:
- :dir
-
dir where we put the slide (if omitted, slide is output to $stdout)
-
- :name
-
name of the file, without the number prefix. (if omitted, a default is used)
-
- :title
-
title in the slide. If not specified the source file name is used. If THAT is not specified, uses the value of
:name
. If THAT is not specified, a suitable default is used
-
- :code
-
path to a source file to use as content (force :type to be ‘code’)
-
- :number
-
true if numbering should be done, false if not
-
- :type
-
the type of slide to create
-
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
# File 'lib/showoff_utils.rb', line 299 def self.() add_new_dir([:dir]) if [:dir] && !File.exist?([:dir]) [:type] = 'code' if [:code] title = determine_title([:title],[:name],[:code]) [:name] = 'new_slide' if ![:name] size,source = determine_size_and_source([:code]) type = [:type] || :default = TYPES[type].call(title,size,source) if [:name] filename = determine_filename([:dir],[:name],[:number]) write_file(filename,) else puts puts end end |
.adjust_size(lines, width) ⇒ Object
Determines a more optimal value for the size (e.g. small vs. smaller) based upon the size of the code being formatted.
398 399 400 401 402 403 404 405 406 407 408 |
# File 'lib/showoff_utils.rb', line 398 def self.adjust_size(lines,width) size = "" # These values determined empircally size = "small" if width > 50 size = "small" if lines > 15 size = "smaller" if width > 57 size = "smaller" if lines > 19 puts "WARNING: some lines are too long and might be truncated" if width > 65 puts "WARNING: your code is too long and may not fit on a slide" if lines > 23 size end |
.blank?(string) ⇒ Boolean
337 338 339 |
# File 'lib/showoff_utils.rb', line 337 def self.blank?(string) string.nil? || string.strip.length == 0 end |
.clone(url, branch = nil, path = nil) ⇒ Object
clone a repo url, then run a provided block
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/showoff_utils.rb', line 235 def self.clone(url, branch=nil, path=nil) require 'tmpdir' Dir.mktmpdir do |dir| if branch system('git', 'clone', '-b', branch, '--single-branch', '--depth', '1', url, dir) else system('git', 'clone', '--depth', '1', url, dir) end dir = File.join(dir, path) if path Dir.chdir dir do yield if block_given? end end end |
.command(command, error = 'command failed') ⇒ Object
662 663 664 665 |
# File 'lib/showoff_utils.rb', line 662 def self.command(command, error='command failed') puts "Running '#{command}'..." system(command) or raise error end |
.create(dirname, create_samples, dirs = 'one') ⇒ Object
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 |
# File 'lib/showoff_utils.rb', line 34 def self.create(dirname,create_samples,dirs='one') FileUtils.mkdir_p(dirname) Dir.chdir(dirname) do dirs = dirs.split(',') if create_samples dirs.each do |dir| # create section FileUtils.mkdir_p(dir) # create markdown file File.open("#{dir}/00_section.md", 'w+') do |f| f.puts ("Section Header", "center subsection") end File.open("#{dir}/01_slide.md", 'w+') do |f| f.puts ("My Presentation") end File.open("#{dir}/02_slide.md", 'w+') do |f| f.puts ("Bullet Points","bullets incremental",["first point","second point","third point"]) end end end # Create asset directories FileUtils.mkdir_p('_files/share') FileUtils.mkdir_p('_images') # create showoff.json File.open(ShowoffUtils.presentation_config_file, 'w+') do |f| sections = dirs.collect {|dir| {"section" => dir} } f.puts JSON.pretty_generate({ "name" => "My Preso", "sections" => sections }) end end end |
.create_file_if_needed(filename, force) ⇒ Object
Creates the given filename if it doesn’t exist or if force is true
filename - String name of the file to create force - if true, the file will always be created, if false, only create
if it's not there
block - takes a block that will be given the file handle to write
data into the file IF it's being created
Examples
create_file_if_needed("config.ru",false) do |file|
file.puts "require 'showoff'"
file.puts "run Showoff.new"
end
Returns true if the file was created
650 651 652 653 654 655 656 657 658 659 660 |
# File 'lib/showoff_utils.rb', line 650 def self.create_file_if_needed(filename,force) if !File.exist?(filename) || force File.open(filename, 'w+') do |f| yield f end true else puts "#{filename} exists; not overwriting (see showoff help heroku)" false end end |
.create_gems_file(filename, password, force, formatter, header = nil) ⇒ Object
Creates the file that lists the gems for heroku
filename - String name of the file password - Boolean to indicate if we are setting a password force - Boolean to indicate if we should overwrite the existing file formatter - Proc/lambda that takes 1 argument, the gem name, and formats it for the file
This is so we can support both the old .gems and the new bundler Gemfile
header - Proc/lambda that creates any header information in the file
Returns a boolean indicating that we had to create the file or not.
626 627 628 629 630 631 632 |
# File 'lib/showoff_utils.rb', line 626 def self.create_gems_file(filename,password,force,formatter,header=nil) create_file_if_needed(filename,force) do |file| file.puts header.call unless header.nil? REQUIRED_GEMS.each { |gem| file.puts formatter.call(gem) } file.puts formatter.call("rack") if password end end |
.default_style(dir = '.') ⇒ Object
563 564 565 |
# File 'lib/showoff_utils.rb', line 563 def self.default_style(dir = '.') get_config_option(dir, 'style', '') end |
.default_style?(style, dir = '.') ⇒ Boolean
567 568 569 570 |
# File 'lib/showoff_utils.rb', line 567 def self.default_style?(style, dir = '.') default = default_style(dir) style.split('/').last.sub(/\.css$/, '') == default end |
.determine_filename(slide_dir, slide_name, number) ⇒ Object
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 |
# File 'lib/showoff_utils.rb', line 358 def self.determine_filename(,,number) raise "Slide name is required" unless if number next_num = find_next_number() = "#{next_num}_#{}" end if filename = "#{}/#{}.md" else filename = "#{}.md" end filename end |
.determine_size_and_source(code) ⇒ Object
341 342 343 344 345 346 347 348 349 |
# File 'lib/showoff_utils.rb', line 341 def self.determine_size_and_source(code) size = "" source = "" if code source,lines,width = read_code(code) size = adjust_size(lines,width) end [size,source] end |
.determine_title(title, slide_name, code) ⇒ Object
387 388 389 390 391 392 393 394 |
# File 'lib/showoff_utils.rb', line 387 def self.determine_title(title,,code) if blank?(title) title = title = File.basename(code) if code end title = "Title here" if blank?(title) title end |
.find_next_number(slide_dir) ⇒ Object
Finds the next number in the given dir to name a slide as the last slide in the dir.
377 378 379 380 381 382 383 384 385 |
# File 'lib/showoff_utils.rb', line 377 def self.find_next_number() ||= '.' max = Dir.glob("#{}/*.md").collect do |f| next unless f =~ /^#{}\/(\d+)/ $1.to_i end.compact.max || 0 sprintf("%02d", max+1) end |
.get_config_option(dir, option, default = nil) ⇒ Object
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'lib/showoff_utils.rb', line 586 def self.get_config_option(dir, option, default = nil) index = File.join(dir, ShowoffUtils.presentation_config_file) if File.exist?(index) data = JSON.parse(File.read(index)) if data.is_a?(Hash) if default.is_a?(Hash) default.merge(data[option] || {}) else data[option] || default end end else default end end |
.github ⇒ Object
generate a static version of the site into the gh-pages branch
221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/showoff_utils.rb', line 221 def self.github Showoff.do_static(nil) FileUtils.touch 'static/.nojekyll' `git add -f static` sha = `git write-tree`.chomp tree_sha = `git rev-parse #{sha}:static`.chomp `git read-tree HEAD` # reset staging to last-commit ghp_sha = `git rev-parse gh-pages 2>/dev/null`.chomp extra = ghp_sha != 'gh-pages' ? "-p #{ghp_sha}" : '' commit_sha = `echo 'static presentation' | git commit-tree #{tree_sha} #{extra}`.chomp `git update-ref refs/heads/gh-pages #{commit_sha}` end |
.heroku(name, force = false, password = nil) ⇒ Object
name - String containing heroku name force - boolean if .gems/Gemfile and config.ru should be overwritten if they don’t exist password - String containing password to protect your heroku site; nil means no password protection
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 |
# File 'lib/showoff_utils.rb', line 189 def self.heroku(name, force = false, password = nil) modified_something = create_gems_file(HEROKU_GEMS_FILE, !password.nil?, force, lambda{ |gem| "gem '#{gem}'" }, lambda{ "source :rubygems" }) create_file_if_needed(HEROKU_PROCFILE,force) do |file| modified_something = true file.puts 'bundle exec thin start -R config.ru -e production -p $PORT' end create_file_if_needed(HEROKU_CONFIG_FILE,force) do |file| modified_something = true file.puts 'require "showoff"' file.puts 'require "showoff/version"' if password.nil? file.puts 'run Showoff.new' else file.puts 'require "rack"' file.puts 'showoff_app = Showoff.new' file.puts 'protected_showoff = Rack::Auth::Basic.new(showoff_app) do |username, password|' file.puts "\tpassword == '#{password}'" file.puts 'end' file.puts 'run protected_showoff' end end modified_something end |
.info(config, json = false) ⇒ Object
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 |
# File 'lib/showoff_utils.rb', line 102 def self.info(config, json = false) ShowoffUtils.presentation_config_file = config showoff = Showoff.new! content = showoff.(false, true) dom = Nokogiri::HTML(content) data = {} data['files'] = self.('.') data['images'] = dom.css('img').map {|img| img[:src].sub(/.\/image\/+/,'') } data['styles'] = Dir.glob('*.css') data['scripts'] = Dir.glob('*.js') # now grep through the styles and identify referenced images data['styles'].each do |style| File.readlines(style).each do |line| next unless line =~ /url\(\'(\S+)\'\)/ data['images'] << $1 end end if json puts JSON.pretty_generate(data) else data.each do |key, list| puts "#{key.capitalize}:" list.each {|file| puts " * #{file}" } puts end end end |
.lang(source_file) ⇒ Object
609 610 611 612 |
# File 'lib/showoff_utils.rb', line 609 def self.lang(source_file) ext = File.extname(source_file).gsub(/^\./,'') EXTENSIONS[ext] || ext end |
.make_slide(title, classes = "", content = nil) ⇒ Object
Makes a slide as a string.
- title
-
title of the slide
- classes
-
any “classes” to include, such as ‘smaller’, ‘transition’, etc.
- content
-
slide content. Currently, if this is an array, it will make a bullet list. Otherwise the string value of this will be put in the slide as-is
263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/showoff_utils.rb', line 263 def self.(title,classes="",content=nil) = "<!SLIDE #{classes}>\n" << "# #{title}\n" << "\n" if content if content.kind_of? Array content.each { |x| << "* #{x.to_s}\n" } else << content.to_s end end end |
.parse_options(option_string = "") ⇒ Object
Helper method to parse a comma separated options string and stores the result in a dictionrary
Example:
"tpl=hpi,title=Over the rainbow"
will be stored as
{ "tpl" => "hpi", "title" => "Over the rainbow" }
13 14 15 16 17 18 19 20 21 22 23 24 |
# File 'lib/showoff_utils.rb', line 13 def self.(option_string="") result = {} if option_string option_string.split(",").each do |element| pair = element.split("=") result[pair[0]] = pair.size > 1 ? pair[1] : nil end end result end |
.pause_msg(dir = '.') ⇒ Object
559 560 561 |
# File 'lib/showoff_utils.rb', line 559 def self.pause_msg(dir = '.') get_config_option(dir, 'pause_msg', 'PAUSED') end |
.presentation_config_file ⇒ Object
26 27 28 |
# File 'lib/showoff_utils.rb', line 26 def self.presentation_config_file @presentation_config_file ||= 'showoff.json' end |
.presentation_config_file=(filename) ⇒ Object
30 31 32 |
# File 'lib/showoff_utils.rb', line 30 def self.presentation_config_file=(filename) @presentation_config_file = filename end |
.read_code(source_file) ⇒ Object
Reads the code from the source file, returning the code, indented for markdown, as well as the number of lines and the width of the largest line
413 414 415 416 417 418 419 420 421 422 423 424 425 |
# File 'lib/showoff_utils.rb', line 413 def self.read_code(source_file) code = " @@@ #{lang(source_file)}\n" lines = 0 width = 0 File.open(source_file) do |code_file| code_file.readlines.each do |line| code += " #{line}" lines += 1 width = line.length if line.length > width end end [code,lines,width] end |
.showoff_legacy_sections(dir, data) ⇒ Object
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 |
# File 'lib/showoff_utils.rb', line 477 def self.showoff_legacy_sections(dir, data) # each entry in sections can be: # - "filename.md" # - { "section": "filename.md" } # - { "section": "directory" } # - { "section": [ "array.md, "of.md, "files.md"] } # - { "include": "sections.json" } sections = {} counters = {} lastpath = nil data.map do |entry| next entry if entry.is_a? String next nil unless entry.is_a? Hash next entry['section'] if entry.include? 'section' section = nil if entry.include? 'include' file = entry['include'] path = File.dirname(file) data = JSON.parse(File.read(file)) if data.is_a? Array if path == '.' section = data else section = data.map do |source| "#{path}/#{source}" end end end end section end.flatten.compact.each do |entry| # We do this in two passes simply because most of it was already done # and I don't want to waste time on legacy functionality. # Normalize to a proper path from presentation root filename = File.(entry).sub(/^#{dir}\//, '') # and then strip out the locale directory, if there is one filename.sub!(/^(locales\/[\w-]+\/)/, '') locale = $1 if File.directory? filename path = entry sections[path] ||= [] Dir.glob("#{filename}/**/*.md").sort.each do || fullpath = locale.nil? ? : "#{locale}/#{}" sections[path] << fullpath end else path = File.dirname(entry) # this lastpath business allows us to reference files in a directory that aren't # necessarily contiguous. if path != lastpath counters[path] ||= 0 counters[path] += 1 end # now record the last path we've seen lastpath = path # and if there are more than one disparate occurences of path, add a counter to this string path = "#{path} (#{counters[path]})" unless counters[path] == 1 sections[path] ||= [] sections[path] << filename end end sections end |
.showoff_markdown(dir = ".") ⇒ Object
577 578 579 |
# File 'lib/showoff_utils.rb', line 577 def self.showoff_markdown(dir = ".") get_config_option(dir, "markdown", "redcarpet") end |
.showoff_pdf_options(dir = '.') ⇒ Object
572 573 574 575 |
# File 'lib/showoff_utils.rb', line 572 def self.(dir = '.') opts = get_config_option(dir, 'pdf_options', {:page_size => 'Letter', :orientation => 'Landscape', :print_media_type => true}) Hash[opts.map {|k, v| [k.to_sym, v]}] # keys must be symbols end |
.showoff_renderer_options(dir = '.', default_options = MarkdownConfig::defaults(dir)) ⇒ Object
581 582 583 584 |
# File 'lib/showoff_utils.rb', line 581 def self.(dir = '.', = MarkdownConfig::defaults(dir)) opts = get_config_option(dir, showoff_markdown(dir), ) Hash[opts.map {|k, v| [k.to_sym, v]}] if opts # keys must be symbols end |
.showoff_sections(dir, data = nil, logger = nil) ⇒ Object
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 |
# File 'lib/showoff_utils.rb', line 427 def self.showoff_sections(dir, data = nil, logger = nil) unless logger logger = Logger.new(STDOUT) logger.level = Logger::WARN end begin unless data index = File.join(dir, ShowoffUtils.presentation_config_file) data = JSON.parse(File.read(index)) rescue ["."] # default boring showoff.json end logger.debug data if data.is_a?(Hash) # dup so we don't overwrite the original data structure and make it impossible to re-localize sections = data['sections'].dup else sections = data.dup end if sections.is_a? Array sections = showoff_legacy_sections(dir, sections) elsif sections.is_a? Hash raise "Named sections are unsupported on Ruby versions less than 1.9." if RUBY_VERSION.start_with? '1.8' sections.each do |key, value| next if value.is_a? Array cwd = File.(dir) path = File.dirname(value) data = JSON.parse(File.read(value)) raise "The section file #{value} must contain an array of filenames." unless data.is_a? Array # get relative paths to each slide in the array sections[key] = data.map do |filename| File.("#{path}/#{filename}").sub(/^#{cwd}\//, '') end end else raise "The `sections` key must be an Array or Hash, not a #{sections.class}." end rescue => e logger.error "There was a problem with the presentation file #{index}" logger.error e. logger.debug e.backtrace sections = {} end sections end |
.showoff_slide_files(dir, data = nil, logger = nil) ⇒ Object
550 551 552 553 |
# File 'lib/showoff_utils.rb', line 550 def self.(dir, data = nil, logger = nil) data = showoff_sections(dir, data, logger) data.map { |key, value| value }.flatten end |
.showoff_title(dir = '.') ⇒ Object
555 556 557 |
# File 'lib/showoff_utils.rb', line 555 def self.showoff_title(dir = '.') get_config_option(dir, 'name', "Presentation") end |
.skeleton(config) ⇒ Object
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 |
# File 'lib/showoff_utils.rb', line 69 def self.skeleton(config) if config unless File.(config) == File.(File.basename(config),'.') FileUtils.cp(config, '.') end ShowoffUtils.presentation_config_file = File.basename(config) end # Create asset directories FileUtils.mkdir_p('_files/share') FileUtils.mkdir_p('_images') self.('.').each do |filename| next if File.exist? filename puts "Creating: #{filename}" if filename.downcase.end_with? '.md' FileUtils.mkdir_p File.dirname(filename) File.open(filename, 'w+') do |f| if filename =~ /section/i # kind of looks like a section slide f.puts ("#{filename.sub(/\.md$/, '')}", "center subsection") else f.puts ("#{filename.sub(/\.md$/, '')}") end end else FileUtils.mkdir_p filename end end end |
.update(verbose = false) ⇒ Object
just update the repo in cwd
252 253 254 255 |
# File 'lib/showoff_utils.rb', line 252 def self.update(verbose=false) puts "Updating presentation repository..." if verbose system('git', 'pull') end |
.validate(config) ⇒ Object
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 |
# File 'lib/showoff_utils.rb', line 133 def self.validate(config) showoff = Showoff.new!(:pres_file => config) validators = showoff.settings.showoff_config['validators'] || {} files = [] errors = [] # get a list of actual filenames files = self.('.') files.each do |filename| unless File.exist? filename errors << "Missing path: #{filename}" next end if filename.downcase.end_with? '.md' print '.' showoff.(filename.sub('.md',''), 'all', false).each_with_index do |block, index| lang, code, classes = block validator = validators[lang] if classes.include? 'no-validate' print '-' next elsif validator # write out a tempfile because many validators require files to work with Tempfile.open('showoff-validation') do |f| File.write(f.path, code) unless system("#{validator} #{f.path}", :out => File::NULL, :err => File::NULL) print 'F' errors << "Invalid #{lang} code on #{filename} [#{index}]" end end end end end end puts puts "Found #{errors.size} errors." unless errors.empty? errors.each { |err| puts " * #{err}" } exit! end end |
.write_file(filename, slide) ⇒ Object
351 352 353 354 355 356 |
# File 'lib/showoff_utils.rb', line 351 def self.write_file(filename,) File.open(filename,'w') do |file| file.puts end puts "Wrote #{filename}" end |