Class: ShowOffUtils

Inherits:
Object
  • Object
show all
Defined in:
lib/showoff_utils.rb

Constant Summary collapse

HEROKU_GEMS_FILE = 
'.gems'
HEROKU_BUNDLER_GEMS_FILE = 
'Gemfile'
HEROKU_CONFIG_FILE = 
'config.ru'
TYPES = 
{
  :default => lambda { |t,size,source,type| make_slide(t,"#{size} #{type}",source) },
  'title' => lambda { |t,size,dontcare| make_slide(t,size) },
  'bullets' => lambda { |t,size,dontcare| make_slide(t,"#{size} bullets incremental",["bullets","go","here"])},
  'smbullets' => lambda { |t,size,dontcare| make_slide(t,"#{size} smbullets incremental",["bullets","go","here","and","here"])},
  'code' => lambda { |t,size,src| make_slide(t,size,blank?(src) ? "    @@@ Ruby\n    code_here()" : src) },
  'commandline' => lambda { |t,size,dontcare| make_slide(t,"#{size} commandline","    $ command here\n    output here")},
  'full-page' => lambda { |t,size,dontcare| make_slide(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

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



179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/showoff_utils.rb', line 179

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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/showoff_utils.rb', line 153

def self.add_slide(options)

  add_new_dir(options[:dir]) if options[:dir] && !File.exists?(options[:dir])

  options[:type] = 'code' if options[:code]

  title = determine_title(options[:title],options[:name],options[:code])

  options[:name] = 'new_slide' if !options[:name]

  size,source = determine_size_and_source(options[:code])
  type = options[:type] || :default
  slide = TYPES[type].call(title,size,source)

  if options[:dir]
    filename = determine_filename(options[:dir],options[:name],options[:number])
    write_file(filename,slide)
  else
    puts slide
    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.



247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/showoff_utils.rb', line 247

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 the code may be cut off" if width > 65
  puts "warning, your code is too long and the code may be cut off" if lines > 23
  size
end

.blank?(string) ⇒ Boolean

Returns:

  • (Boolean) 


191
192
193
 
# File 'lib/showoff_utils.rb', line 191

def self.blank?(string)
  string.nil? || string.strip.length == 0
end

.create(dirname, create_samples, dir = 'one') ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/showoff_utils.rb', line 34

def self.create(dirname,create_samples,dir='one')
  Dir.mkdir(dirname) if !File.exists?(dirname)
  Dir.chdir(dirname) do
    if create_samples
      # create section
      Dir.mkdir(dir)

      # create markdown file
      File.open("#{dir}/01_slide.md", 'w+') do |f|
        f.puts make_slide("My Presentation")
        f.puts make_slide("Bullet Points","bullets incremental",["first point","second point","third point"])
      end
    end

    # create showoff.json
    File.open(ShowOffUtils.presentation_config_file, 'w+') do |f|
      f.puts "{ \"name\": \"My Preso\", \"sections\": [ {\"section\":\"#{dir}\"} ]}"
    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



395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/showoff_utils.rb', line 395

def self.create_file_if_needed(filename,force)
  if !File.exists?(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.



371
372
373
374
375
376
377
 
# File 'lib/showoff_utils.rb', line 371

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 



308
309
310
 
# File 'lib/showoff_utils.rb', line 308

def self.default_style(dir = '.')
  get_config_option(dir, 'style', '')
end

.default_style?(style, dir = '.') ⇒ Boolean

Returns:

  • (Boolean) 


312
313
314
315
 
# File 'lib/showoff_utils.rb', line 312

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 



212
213
214
215
216
217
218
219
 
# File 'lib/showoff_utils.rb', line 212

def self.determine_filename(slide_dir,slide_name,number)
  filename = "#{slide_dir}/#{slide_name}.md"
  if number
    max = find_next_number(slide_dir)
    filename = "#{slide_dir}/#{max}_#{slide_name}.md"
  end
  filename
end

.determine_size_and_source(code) ⇒ Object 



195
196
197
198
199
200
201
202
203
 
# File 'lib/showoff_utils.rb', line 195

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 



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

def self.determine_title(title,slide_name,code)
  if blank?(title)
    title = slide_name
    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.



223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/showoff_utils.rb', line 223

def self.find_next_number(slide_dir)
  max = 0
  Dir.open(slide_dir).each do |file|
    if file =~ /(\d+).*\.md/
      num = $1.to_i
      max = num if num > max
    end
  end
  max += 1
  max = "0#{max}" if max < 10
  max
end

.get_config_option(dir, option, default = nil) ⇒ Object 



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/showoff_utils.rb', line 331

def self.get_config_option(dir, option, default = nil)
  index = File.join(dir, ShowOffUtils.presentation_config_file)
  if File.exists?(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



100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/showoff_utils.rb', line 100

def self.github
  ShowOff.do_static(nil)
  `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, use_dot_gems = false) ⇒ 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 use_dot_gems - boolean that, if true, indicates we should use the old, deprecated .gems file instead of Bundler



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
 
# File 'lib/showoff_utils.rb', line 65

def self.heroku(name, force = false, password = nil, use_dot_gems = false)
  modified_something = false

  if use_dot_gems
    modified_something = create_gems_file(HEROKU_GEMS_FILE,
                                          !password.nil?,
                                          force,
                                          lambda{ |gem| gem })
  else
    modified_something = create_gems_file(HEROKU_BUNDLER_GEMS_FILE,
                                          !password.nil?,
                                          force,
                                          lambda{ |gem| "gem '#{gem}'" },
                                          lambda{ "source :rubygems" })
  end

  create_file_if_needed(HEROKU_CONFIG_FILE,force) do |file|
    modified_something = true
    file.puts 'require "showoff"'
    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

.lang(source_file) ⇒ Object 



354
355
356
357
 
# File 'lib/showoff_utils.rb', line 354

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



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/showoff_utils.rb', line 117

def self.make_slide(title,classes="",content=nil)
  slide = "!SLIDE #{classes}\n"
  slide << "# #{title} #\n"
  slide << "\n"
  if content
    if content.kind_of? Array
      content.each { |x| slide << "* #{x.to_s}\n" }
    else
      slide << content.to_s
    end
  end
  slide
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.parse_options(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 



304
305
306
 
# File 'lib/showoff_utils.rb', line 304

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



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/showoff_utils.rb', line 262

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_markdown(dir = ".") ⇒ Object 



322
323
324
 
# File 'lib/showoff_utils.rb', line 322

def self.showoff_markdown(dir = ".")
  get_config_option(dir, "markdown", "redcarpet")
end

.showoff_pdf_options(dir = '.') ⇒ Object 



317
318
319
320
 
# File 'lib/showoff_utils.rb', line 317

def self.showoff_pdf_options(dir = '.')
  opts = get_config_option(dir, 'pdf_options', {:page_size => 'Letter', :orientation => 'Landscape'})
  Hash[opts.map {|k, v| [k.to_sym, v]}] # keys must be symbols
end

.showoff_renderer_options(dir = '.', default_options = MarkdownConfig::defaults(dir)) ⇒ Object 



326
327
328
329
 
# File 'lib/showoff_utils.rb', line 326

def self.showoff_renderer_options(dir = '.', default_options = MarkdownConfig::defaults(dir))
  opts = get_config_option(dir, showoff_markdown(dir), default_options)
  Hash[opts.map {|k, v| [k.to_sym, v]}] if opts    # keys must be symbols
end

.showoff_sections(dir, logger) ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/showoff_utils.rb', line 276

def self.showoff_sections(dir,logger)
  index = File.join(dir, ShowOffUtils.presentation_config_file)
  sections = nil
  if File.exists?(index)
    data = JSON.parse(File.read(index))
    logger.debug data
    if data.is_a?(Hash)
      sections = data['sections']
    else
      sections = data
    end
    sections = sections.map do |s|
      if s.is_a? Hash
        s['section']
      else
        s
      end
    end
  else
    sections = ["."] # if there's no showoff.json file, make a boring one
  end
  sections
end

.showoff_title(dir = '.') ⇒ Object 



300
301
302
 
# File 'lib/showoff_utils.rb', line 300

def self.showoff_title(dir = '.')
  get_config_option(dir, 'name', "Presentation")
end

.write_file(filename, slide) ⇒ Object 



205
206
207
208
209
210
 
# File 'lib/showoff_utils.rb', line 205

def self.write_file(filename,slide)
  File.open(filename,'w') do |file|
    file.puts slide
  end
  puts "Wrote #{filename}"
end