showoff 0.3.3 → 0.3.4

data/README.rdoc

@@ -276,6 +276,7 @@ added where your cursor was.  Binding this to a keybinding can allow you to add
 [<tt>create</tt>] Create new showoff presentation
 [<tt>help</tt>] Shows list of commands or help for one command
 [<tt>heroku</tt>] Setup your presentation to serve on Heroku
+[<tt>github</tt>] Setup your presentation to serve on GitHub Pages
 [<tt>serve</tt>] Serves the showoff presentation in the current directory
 [<tt>static</tt>] Generate static version of presentation
 
@@ -320,6 +321,10 @@ Setup your presentation to serve on Heroku
 
 Creates the Gemfile and config.ru file needed to push a showoff pres to heroku.  It will then run heroku create for you to register the new project on heroku and add the remote for you.  Then all you need to do is commit the new created files and run git push heroku to deploy.
 
+=== <tt>github</tt>
+
+Generates a static version of your site and puts it in a gh-pages branch for static serving on GitHub.
+
 ==== Options
 These options are specified *after* the command.
 

data/bin/showoff

@@ -7,6 +7,14 @@ require 'gli'
 
 include GLI
 
+desc 'Show ShowOff version'
+long_desc 'This command shows the currently installed version of ShowOff'
+command [:version] do |c|
+  c.action do |global_options,options,args|
+    puts "ShowOff Version " + ShowOff::Version
+  end
+end
+
 desc 'Create new showoff presentation'
 arg_name 'dir_name'
 long_desc 'This command helps start a new showoff presentation by setting up the proper directory structure for you.  It takes the directory name you would like showoff to create for you.'
@@ -25,6 +33,14 @@ command [:create,:init] do |c|
   end
 end
 
+desc 'Puts your showoff presentation into a gh-pages branch'
+long_desc 'Generates a static version of your presentation into your gh-pages branch for publishing to GitHub Pages'
+command :github do |c|
+  c.action do |global_options,options,args|
+    ShowOffUtils.github
+  end
+end
+
 desc 'Serves the showoff presentation in the current directory'
 desc 'Setup your presentation to serve on Heroku'
 arg_name 'heroku_name'

data/lib/showoff.rb

@@ -9,13 +9,13 @@ require 'fileutils'
 begin
   require 'RMagick'
 rescue LoadError
-  puts 'image sizing disabled - install RMagick'
+  $stderr.puts 'image sizing disabled - install RMagick'
 end
 
 begin
   require 'pdfkit'
 rescue LoadError
-  puts 'pdf generation disabled - install PDFKit'
+  $stderr.puts 'pdf generation disabled - install PDFKit'
 end
 
 begin
@@ -26,9 +26,10 @@ rescue LoadError
 end
 require 'pp'
 
-
 class ShowOff < Sinatra::Application
 
+  Version = VERSION = '0.3.4'
+
   attr_reader :cached_image_size
 
   set :views, File.dirname(__FILE__) + '/../views'
@@ -125,7 +126,7 @@ class ShowOff < Sinatra::Application
       paths.pop
       path = paths.join('/')
       replacement_prefix = static ?
-        %(img src="file://#{options.pres_dir}/#{path}) :
+        %(img src="./file/#{path}) :
         %(img src="/image/#{path})
       slide.gsub(/img src=\"(.*?)\"/) do |s|
         img_path = File.join(path, $1)
@@ -241,7 +242,7 @@ class ShowOff < Sinatra::Application
       if static
         @title = ShowOffUtils.showoff_title
         @slides = get_slides_html(static)
-        @asset_path = "."
+        @asset_path = "./"
       end
       erb :index
     end
@@ -273,14 +274,14 @@ class ShowOff < Sinatra::Application
         href = clean_link(link['src'])
         assets << href if href
       end
-      
+
       css = Dir.glob("#{options.public}/**/*.css").map { |path| path.gsub(options.public + '/', '') }
       assets << css
 
       js = Dir.glob("#{options.public}/**/*.js").map { |path| path.gsub(options.public + '/', '') }
       assets << js
 
-      assets.uniq.join("\n")      
+      assets.uniq.join("\n")
     end
 
     def slides(static=false)
@@ -325,7 +326,7 @@ class ShowOff < Sinatra::Application
       else
         out  = "#{path}/#{name}/static"
         # First make a directory
-        FileUtils.makedirs("#{out}")
+        FileUtils.makedirs(out)
         # Then write the html
         file = File.new("#{out}/index.html", "w")
         file.puts(data)
@@ -342,6 +343,23 @@ class ShowOff < Sinatra::Application
           next unless File.directory?(subpath) || base.match(/\.(css|js)$/)
           FileUtils.copy_entry(subpath, "#{out}/#{base}")
         }
+
+        # Set up file dir
+        file_dir = File.join(out, 'file')
+        FileUtils.makedirs(file_dir)
+        pres_dir = showoff.options.pres_dir
+
+        # ..., copy all user-defined styles and javascript files
+        Dir.glob("#{pres_dir}/*.{css,js}").each { |path|
+          FileUtils.copy(path, File.join(file_dir, File.basename(path)))
+        }
+
+        # ... and copy all needed image files
+        data.scan(/img src=\".\/file\/(.*?)\"/).flatten.each do |path|
+          dir = File.dirname(path)
+          FileUtils.makedirs(File.join(file_dir, dir))
+          FileUtils.copy(File.join(pres_dir, path), File.join(file_dir, path))
+        end
       end
     end
 

data/lib/showoff_utils.rb

@@ -91,6 +91,25 @@ class ShowOffUtils
     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.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: showoff
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Scott Chacon