Class: ShowOffUtils

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

Constant Summary collapse

SHOWOFF_JSON_FILE = 
'showoff.json'
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(bluecloth nokogiri showoff gli)

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



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

def self.add_new_dir(dir)
  puts "Creating #{dir}..."
  Dir.mkdir dir

  showoff_json = JSON.parse(File.read(SHOWOFF_JSON_FILE))
  showoff_json["section"] = dir
  File.open(SHOWOFF_JSON_FILE,'w') do |file|
    file.puts JSON.generate(showoff_json)
  end
  puts "#{SHOWOFF_JSON_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



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

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.



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

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) 


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

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

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



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

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(SHOWOFF_JSON_FILE, 'w+') do |f|
      f.puts "{ \"name\": \"My Preso\", \"sections\": [ {\"section\":\"#{dir}\"} ]}"
    end

    if create_samples
      puts "done. run 'showoff serve' in #{dirname}/ dir to see slideshow"
    else
      puts "done. add slides, modify #{SHOWOFF_JSON_FILE} and then run 'showoff serve' in #{dirname}/ dir to see slideshow"
    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



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

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.



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

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

.determine_filename(slide_dir, slide_name, number) ⇒ Object 



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

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 



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

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 



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

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.



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

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

.github ⇒ Object

generate a static version of the site into the gh-pages branch



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/showoff_utils.rb', line 95

def self.github
  puts "Generating static content"
  ShowOff.do_static(nil)
  `git add 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}`
  puts "I've updated your 'gh-pages' branch with the static version of your presentation."
  puts "Push it to GitHub to publish it. Probably something like:"
  puts
  puts "  git push origin gh-pages"
  puts
end

.heroku(name, force, password, use_dot_gems) ⇒ 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 - boolea that, if true, indicates we should use the old, deprecated .gems file instead of Bundler



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

def self.heroku(name,force,password,use_dot_gems)
  if !File.exists?(SHOWOFF_JSON_FILE)
    puts "fail. not a showoff directory"
    return false
  end

  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

  if modified_something
    puts "herokuized. run something like this to launch your heroku presentation:

    heroku create #{name}"

    if use_dot_gems
    puts "        git add #{HEROKU_GEMS_FILE} #{HEROKU_CONFIG_FILE}"
    else
    puts "      bundle install
    git add Gemfile.lock #{HEROKU_GEMS_FILE} #{HEROKU_CONFIG_FILE}"
    end
    puts "      git commit -m 'herokuized'
    git push heroku master
    "
  end
end

.lang(source_file) ⇒ Object 



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

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



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

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

.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



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

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_sections(dir = '.') ⇒ Object 



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/showoff_utils.rb', line 277

def self.showoff_sections(dir = '.')
  index = File.join(dir, ShowOffUtils::SHOWOFF_JSON_FILE )
  order = nil
  if File.exists?(index)
    data = JSON.parse(File.read(index))
    pp data
    if data.is_a?(Hash)
      order = data['sections']
    else
      order = data
    end
    order = order.map { |s| s['section'] }
  end
  order
end

.showoff_title(dir = '.') ⇒ Object 



293
294
295
296
297
298
299
300
 
# File 'lib/showoff_utils.rb', line 293

def self.showoff_title(dir = '.')
  index = File.join(dir, ShowOffUtils::SHOWOFF_JSON_FILE )
  order = nil
  if File.exists?(index)
    data = JSON.parse(File.read(index))
    data.is_a?(Hash) && data['name'] || "Presentation"
  end
end

.write_file(filename, slide) ⇒ Object 



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

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