goncalossilva-showoff 0.4.2

data/lib/showoff_utils.rb

@@ -0,0 +1,361 @@
+class ShowOffUtils
+  SHOWOFF_JSON_FILE = 'showoff.json'
+
+  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
+
+  HEROKU_GEMS_FILE = '.gems'
+  HEROKU_BUNDLER_GEMS_FILE = 'Gemfile'
+  HEROKU_CONFIG_FILE = 'config.ru'
+
+	# Setup presentation to run on Heroku
+  #
+  # 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
+  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
+
+  # generate a static version of the site into the gh-pages branch
+  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
+
+  # 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
+  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
+
+  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)")},
+  }
+
+
+  # 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
+  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
+
+  # Adds the given directory to this presentation, appending it to
+  # the end of showoff.json as well
+  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
+
+  def self.blank?(string)
+    string.nil? || string.strip.length == 0
+  end
+
+  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
+
+  def self.write_file(filename,slide)
+    File.open(filename,'w') do |file|
+      file.puts slide
+    end
+    puts "Wrote #{filename}"
+  end
+
+  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
+
+  # Finds the next number in the given dir to
+  # name a slide as the last slide in the dir.
+  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
+
+  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
+
+  # Determines a more optimal value for the size (e.g. small vs. smaller)
+  # based upon the size of the code being formatted.
+  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
+
+  # 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
+  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
+
+  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
+
+  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
+
+  EXTENSIONS =  {
+    'pl' => 'perl',
+    'rb' => 'ruby',
+    'erl' => 'erlang',
+    # so not exhaustive, but probably good enough for now
+  }
+
+  def self.lang(source_file)
+    ext = File.extname(source_file).gsub(/^\./,'')
+    EXTENSIONS[ext] || ext
+  end
+
+  REQUIRED_GEMS = %w(bluecloth nokogiri showoff gli)
+
+  # 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.
+  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
+
+  # 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
+  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
+end

data/public/css/fg.menu.css

@@ -0,0 +1,114 @@
+/* Styles for jQuery menu widget
+Author:	Maggie Wachs, maggie@filamentgroup.com
+Date:		September 2008
+*/
+
+
+/* REQUIRED STYLES - the menus will only render correctly with these rules */	
+
+.fg-menu-container { position: absolute; top:0; left:-999px; padding: .4em;  overflow: hidden; }
+.fg-menu-container.fg-menu-flyout { overflow: visible; }
+
+.fg-menu, .fg-menu ul { list-style-type:none; padding: 0; margin:0; }
+
+.fg-menu { position:relative; }
+.fg-menu-flyout .fg-menu { position:static; }
+
+.fg-menu ul { position:absolute; top:0; }
+.fg-menu ul ul { top:-1px; }
+
+.fg-menu-container.fg-menu-ipod .fg-menu-content, 
+.fg-menu-container.fg-menu-ipod .fg-menu-content ul { background: none !important; }
+
+.fg-menu.fg-menu-scroll,
+.fg-menu ul.fg-menu-scroll { overflow: scroll;  overflow-x: hidden; }
+
+.fg-menu li { clear:both; float:left; width:100%; margin: 0; padding:0; border: 0; }	
+.fg-menu li li { font-size:1em; } /* inner li font size must be reset so that they don't blow up */
+
+.fg-menu-flyout ul ul { padding: .4em; }
+.fg-menu-flyout li { position:relative; }
+
+.fg-menu-scroll { overflow: scroll; overflow-x: hidden; }
+
+.fg-menu-breadcrumb { margin: 0; padding: 0; }
+
+.fg-menu-footer {  margin-top: .4em; padding: .4em; }
+.fg-menu-header {  margin-bottom: .4em; padding: .4em; }
+
+.fg-menu-breadcrumb li { float: left; list-style: none; margin: 0; padding: 0 .2em; font-size: .9em; opacity: .7; }
+.fg-menu-breadcrumb li.fg-menu-prev-list,
+.fg-menu-breadcrumb li.fg-menu-current-crumb { clear: left; float: none; opacity: 1; }
+.fg-menu-breadcrumb li.fg-menu-current-crumb { padding-top: .2em; }
+
+.fg-menu-breadcrumb a, 
+.fg-menu-breadcrumb span { float: left; }
+
+.fg-menu-footer a:link,
+.fg-menu-footer a:visited { float:left; width:100%; text-decoration: none; }
+.fg-menu-footer a:hover,
+.fg-menu-footer a:active {  }
+
+.fg-menu-footer a span { float:left; cursor: pointer; }
+
+.fg-menu-breadcrumb .fg-menu-prev-list a:link,
+.fg-menu-breadcrumb .fg-menu-prev-list a:visited,
+.fg-menu-breadcrumb .fg-menu-prev-list a:hover,
+.fg-menu-breadcrumb .fg-menu-prev-list a:active { background-image: none; text-decoration:none; }
+	
+.fg-menu-breadcrumb .fg-menu-prev-list a { float: left; padding-right: .4em; }
+.fg-menu-breadcrumb .fg-menu-prev-list a .ui-icon { float: left; }
+	
+.fg-menu-breadcrumb .fg-menu-current-crumb a:link,
+.fg-menu-breadcrumb .fg-menu-current-crumb a:visited,
+.fg-menu-breadcrumb .fg-menu-current-crumb a:hover,
+.fg-menu-breadcrumb .fg-menu-current-crumb a:active { display:block; background-image:none; font-size:1.3em; text-decoration:none; }
+
+
+
+/* REQUIRED LINK STYLES: links are "display:block" by default; if the menu options are split into 
+	selectable node links and 'next' links, the script floats the node links left and floats the 'next' links to the right	*/
+
+.fg-menu a:link,
+.fg-menu a:visited,
+.fg-menu a:hover,
+.fg-menu a:active { float:left; width:92%; padding:.3em 3%; text-decoration:none; outline: 0 !important; }
+
+.fg-menu a { border: 1px dashed transparent; }
+
+.fg-menu a.ui-state-default:link,
+.fg-menu a.ui-state-default:visited,
+.fg-menu a.ui-state-default:hover,
+.fg-menu a.ui-state-default:active,
+.fg-menu a.ui-state-hover:link,
+.fg-menu a.ui-state-hover:visited,
+.fg-menu a.ui-state-hover:hover,
+.fg-menu a.ui-state-hover:active,
+ .fg-menu a.ui-state-active:link,
+ .fg-menu a.ui-state-active:visited,
+ .fg-menu a.ui-state-active:hover,
+.fg-menu a.ui-state-active:active { border-style: solid; font-weight: normal; }
+
+.fg-menu a span { display:block; cursor:pointer; }
+
+
+ /* SUGGESTED STYLES - for use with jQuery UI Themeroller CSS */	
+ 
+.fg-menu-indicator span { float:left; }
+.fg-menu-indicator span.ui-icon { float:right; }
+
+.fg-menu-content.ui-widget-content, 
+.fg-menu-content ul.ui-widget-content { border:0; }
+
+
+/* ICONS AND DIVIDERS */
+
+.fg-menu.fg-menu-has-icons a:link,
+.fg-menu.fg-menu-has-icons a:visited,
+.fg-menu.fg-menu-has-icons a:hover,
+.fg-menu.fg-menu-has-icons a:active { padding-left:20px; }
+
+.fg-menu .horizontal-divider hr, .fg-menu .horizontal-divider span { padding:0; margin:5px .6em; }
+.fg-menu .horizontal-divider hr { border:0; height:1px; }
+.fg-menu .horizontal-divider span { font-size:.9em; text-transform: uppercase; padding-left:.2em; }
+