jacktang-hacker-slides 1.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Jack Tang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.textile

@@ -0,0 +1,58 @@
+h1. Story About HackerSlides
+
+Well, I am one not-well-paid programmer undex linux and far far way from such amazing presentation software -- Apple's keynotes. And I meet some other hackers weekly and exchange the industry news and ideas, of course, by presentation. Meanwhile,I'd like my presentation can be pushed to the git repository so that I might refine some great ideas step by step. I am familiar with S5, but tired to write HTML code. To me, Textile syntax is easy to me. So the project launched...
+
+h1. Install It!
+
+ * Install from source
+ 
+<pre>
+    git clone git://github.com/jacktang/hacker-slides.git
+    rake install
+</pre>
+
+ * Install through Gem directory
+
+<pre>   
+    gem sources -a http://gems.github.com
+    sudo gem install sudo gem install jacktang-hacker-slides
+</pre>
+
+h1. Sample Slides
+
+ * "HackerSlides":http://jacktang.github.com/hackerslides/sample/
+
+h1. Amazing? Use It
+
+ * Create slides from sketch
+
+     hacker-slides --sketch sample.textile
+
+ * Convert Textile to S5 slides
+    
+     hacker-slides sample.textile -o slides -b s5-simple
+
+ * List all bundles/themes
+    
+     hacker-slides -l
+
+
+h1. Emacs & HackerSlides
+
+ * Textile mode for Emacs (todo)
+ * Generate slide in Emacs (todo) 
+
+
+
+h1. Always Thanks Designers
+
+ * "S5: iBook-compatible themes":http://www.ibiblio.org/mcmahon/s5-iBook/index.html
+ * "Presentations S5":http://www.jesusda.com/projects/presentaciones_s5
+ * "Windgazer styles":http://www.windgazer.nl/projects/jsrepository/S5.wgd/
+ * "Glossdeck, A New Presentation Theme for S5":http://blog.jm3.net/2007/03/18/glossdeck-a-presentation-theme/
+ * "Microformats":http://theryanking.com/presentations/
+ * http://freshfoo.com/presentations/PyCon-Italia-Due/slides/
+ * http://www.forusers.com/static/html/sample.html
+ * http://alice.wu-wien.ac.at:8000/s5/presentation?slideshow=1&style=flower
+ * http://atuan.com/s5/
+ * http://python.net/~goodger/projects/pycon/2007/idiomatic/presentation.html

data/bin/hacker-slides

@@ -0,0 +1,137 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'ostruct'
+require 'optparse'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'highline/import'
+require 'hacker_slides'
+
+module HackerSlides
+  class Command
+
+    def run(args) 
+
+      opts = OpenStruct.new
+      
+      opt_parser = OptionParser.new do |cmd|
+        
+        cmd.banner = "Usage: slideshow [options] name"
+        
+        cmd.on( '-o', '--output PATH', 'Output Path' ) do |path| 
+          opts.output = path
+        end
+        
+        cmd.on( "-b", "--bundle NAME", "Template Bundle" ) do |name|
+          opts.bundle = name
+        end
+        
+        cmd.on( "-s", "--sketch", "Create Slides From Sketch" ) do |sketch|
+          opts.sketch = true
+        end
+        
+        cmd.on( '-f', '--fetch URI', 'Fetch Bundle' ) do |url|
+          opts.fetch_uri = url
+        end
+        
+        cmd.on( '-l', '--list', 'List Installed Bundles' ) do 
+          opts.list = true
+        end
+
+        cmd.on( '-r', '--remote URL', 'Remote Bundle Source' ) do |remote_src| 
+          opts.remote_src = remote_src
+        end
+
+        cmd.on( '-i', '--install BUNDLE', 'Bundle to Install' ) do |install_bundle| 
+          opts.install_bundle = install_bundle
+        end
+
+        
+        # todo: find different letter for debug trace switch (use v for version?)
+        cmd.on( "-v", "--verbose", "Show debug trace" ) do
+          #logger.datetime_format = "%H:%H:%S"
+          #logger.level = Logger::DEBUG
+        end
+        
+        cmd.on_tail( "-h", "--help", "Show this message" ) do
+          puts "HackerSlides: dead simple slides creator for lazy hackers"
+          puts
+          puts cmd.help
+          puts
+          puts "Examples:"
+          puts " hacker-slides -S sample.textile"
+          puts " hacker-slides -o slides sample.textile"
+          puts " hacker-slides -b s5-simple sample.textile"
+          puts " hacker-slides -l"
+          puts " hacker-slides -s http://example.com/bundles/ -i s5-simple"
+          puts 
+          puts "Further information:"
+          puts " http://www.github.com/jacktang/hacker-slides"
+          puts
+          exit
+        end
+      end
+      
+      opt_parser.parse!( args )
+      
+      puts "HackerSlides Version: #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+ 
+      if opts.list
+        builtin_bundles, usr_bundles = HackerSlides::Bundle.list_bundles
+        
+        if(not usr_bundles.empty?)
+          puts 
+          puts 'User bundles:'
+          usr_bundles.each do |bundle|
+            puts "  * #{bundle}"
+          end
+        end
+        puts 
+        puts 'Built-in bundles:'
+        builtin_bundles.each do |bundle|
+          puts "  * #{bundle}"
+        end
+        puts
+      elsif opts.install_bundle
+        src = opts.remote_src || './'
+        bundle = opts.install_bundle
+        puts "install #{bundle.inspect} bundle from #{src}"
+        HackerSlides::Bundle.install(src, bundle)
+
+      elsif opts.sketch
+        engine = HackerSlides::SlidesEngine.new 
+        args.each do |arg|
+          file = File.expand_path(arg)
+          if(! File.exist?(file) || (File.exist?(file) && 
+            agree("This task will overwrite the #{arg} file. Are you sure you want to continue? [yn] ")))
+            engine.sketch_slides(arg)
+            puts "create #{arg} from sketch"
+            puts 
+          end
+        end
+      else
+        engine = HackerSlides::SlidesEngine.new
+        bundle_name = opts.bundle || 's5-simple'
+        output_dir = opts.output_dir || 'slides/'
+
+        args.each do |arg|
+          bundle_category = bundle_name.split('-').first
+          if(bundle_category == 's5')
+            HackerSlides::SlidesEngine.send(:include, HackerSlides::S5SlidesGenerator)
+          end
+          start_here = engine.create_slides(arg, bundle_name, output_dir)
+          if(start_here)
+            puts "slides are created"
+            puts "please check the link: #{start_here}"
+            puts
+          end
+        end
+      end
+    end
+  end
+end
+
+
+HackerSlides::Command.new.run(ARGV)

data/lib/hacker_slides.rb

@@ -0,0 +1,2 @@
+require 'hacker_slides/bundle'
+require 'hacker_slides/engine'

data/lib/hacker_slides/bundle.rb

@@ -0,0 +1,114 @@
+require 'rubygems'
+require 'zlib'
+require 'open-uri'
+require 'fileutils'
+
+require 'minitar'
+
+module HackerSlides
+  class Bundle
+    class << self
+
+      # install remote/local bundle 
+      def install(src, bundle)
+        
+        bundle = "#{bundle}.bundle" if(File.extname(bundle) != '.bundle')
+        
+        if(src)
+          bundle_path = File.join(src, bundle)
+        else
+          bundle_path = File.expand_path(bundle)
+        end
+        dest = File.join(usr_bundle_dir, bundle)
+        open(bundle_path) do |stream|
+          File.open(dest, 'wb') do |f|
+            f.write(stream.read)
+          end
+        end
+
+      end
+
+      def list_bundles
+        builtin_bundles = []
+        usr_bundles = []
+
+        Dir.glob(File.join(usr_bundle_dir, '*')).each do |bundle|
+          bundle_name = File.basename(bundle, '.*')
+          usr_bundles << bundle_name 
+        end
+
+        Dir.glob(File.join(builtin_bundle_dir, '*')).each do |bundle|
+          bundle_name = File.basename(bundle, '.*')
+          builtin_bundles << bundle_name 
+        end
+        return builtin_bundles, usr_bundles
+      end
+
+      def builtin_bundle_dir
+        return File.expand_path(File.dirname(__FILE__) + '/../../bundles')
+      end
+
+      def usr_bundle_dir
+        bundle_dir = File.join(cache_dir, 'bundles')
+        unless File.exists?(bundle_dir)
+          FileUtils.mkdir(bundle_dir)
+        end
+        return bundle_dir
+      end
+
+      def lookup_bundle_path(bundle_name)
+        bundle = File.join(usr_bundle_dir, "#{bundle_name}.bundle")
+        if(File.exists?(bundle))
+          return bundle
+        else
+          bundle = File.join(builtin_bundle_dir, "#{bundle_name}.bundle") 
+          return bundle if(File.exists?(bundle))
+        end
+      end
+
+      def cache_dir
+        if(PLATFORM =~ /win32/)
+          dir = File.join(ENV['USERPROFILE'], '.hackerslides')
+        else
+          dir = File.join(File.expand_path("~"), ".hackerslides")
+        end
+
+        unless File.exist?(dir)
+          FileUtils.mkdir(dir)
+        end
+        return dir
+      end
+      
+      def extract_files_from_bundle(bundle, files, dest)
+        Zlib::GzipReader.open(bundle) do |tgz|
+          Archive::Tar::Minitar.unpack(tgz, dest, files)
+        end
+      end
+
+      def load_manifest(bundle)
+        Zlib::GzipReader.open(bundle) do |tgz|
+          Archive::Tar::Minitar::Input.open(tgz) do |stream|
+            stream.each do |entry|
+              if(entry.name == 'MANIFEST')
+                manifest = []
+                entry.read.split(/\n/).each_with_index do |line,i|
+                  case line
+                  when /^\s*$/
+                    # skip empty lines
+                  when /^\s*#.*$/
+                    # skip comment lines
+                  else       
+                    manifest << line.strip
+                  end
+                end
+                return manifest
+              end
+            end
+          end
+        end
+        return nil
+      end
+
+    end
+  end
+end

data/lib/hacker_slides/engine.rb

@@ -0,0 +1,5 @@
+require 'hacker_slides/presentation'
+require 'hacker_slides/engine/base'
+require 'hacker_slides/engine/slides_engine'
+require 'hacker_slides/engine/markup_engine'
+require 'hacker_slides/engine/s5_slides_generator'

data/lib/hacker_slides/engine/base.rb

@@ -0,0 +1,6 @@
+module HackerSlides
+  module Engine
+    class Base
+    end
+  end
+end

data/lib/hacker_slides/engine/markup_engine.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'redcloth'
+require 'bluecloth'
+
+module HackerSlides
+  class MarkupEngine < Engine::Base
+
+    def to_html(content)
+      raise NotImplementedError, 'implmenent the method in subclass'
+    end
+  end
+
+  class TextileMarkupEngine < MarkupEngine
+    def self.support_extnames
+      ['.textile', '.t']
+    end
+
+    def to_html(content)
+      # turn off hard line breaks
+      # turn off span caps (see http://rubybook.ca/2008/08/16/redcloth)
+      red = RedCloth.new(content, [:no_span_caps])
+      red.hard_breaks = false
+      return red.to_html
+    end
+  end
+
+  class MarkdownMarkupEngine < MarkupEngine
+    def self.support_extnames
+      ['.markdown', '.m', '.mark', '.mkdn', '.md', '.txt', '.text']
+    end
+
+    def to_html(content)
+      return BlueCloth.new( content ).to_html
+    end
+  end
+end

data/lib/hacker_slides/engine/render_engine.rb

@@ -0,0 +1,12 @@
+module HackerSlides
+  module Engine
+    class RenderEngine
+      
+    end
+    
+    class ERbRenderEngine < RenderEngine
+      
+    end
+  end
+end
+

data/lib/hacker_slides/engine/s5_slides_generator.rb

@@ -0,0 +1,33 @@
+module HackerSlides
+  module S5SlidesGenerator
+
+    def post_processing(content)
+      # create s5 slides
+      slide_counter = 0
+      result = ''
+
+      company = @presentation.meta[:company]
+      website = @presentation.meta[:website]
+
+      preface = "<div class=\"slide\">\n"
+      preface << "<h1>#{@presentation.title}</h1>\n"
+      preface << "<h3>#{@presentation.author}</h3>\n"
+      preface << "<h4><a href=\"#{website}\">#{company}</a></h4>" if(company)
+      preface << "</div>"
+
+      result << preface
+
+      # wrap h1's in slide divs; note use just <h1 since some processors add ids e.g. <h1 id='x'>
+      content.each_line do |line|
+        if line.include?( '<h1' ) then
+          result << "\n\n</div>" if slide_counter > 0
+          result << "<div class='slide'>\n"
+          slide_counter += 1
+        end
+        result << line
+      end
+      result << "\n</div>" if slide_counter > 0
+      return result
+    end
+  end
+end

data/lib/hacker_slides/engine/slides_engine.rb

@@ -0,0 +1,157 @@
+require 'rubygems'
+require 'erb'
+require 'fileutils'
+require 'highline/import'
+
+require 'hacker_slides/bundle'
+require 'hacker_slides/helper'
+require 'hacker_slides/engine/base'
+require 'hacker_slides/engine/markup_engine'
+
+module HackerSlides
+  class SlidesEngine < Engine::Base
+    include HackerSlides::ContentHelper
+
+    attr_reader :presentation
+
+    # Create one SlidesEngine instance 
+    #
+    def initialize
+      @presentation = HackerSlides::Presentation.new
+    end
+
+
+    # 
+    #
+    def create_slides(input, bundle_name, output_dir)
+
+      dirname = File.dirname(input)
+      basename = File.basename(input, '.*')
+      extname = File.extname(input)
+
+      input_file = File.expand_path(input)
+      if(not File.exist?(input_file))
+        if(agree("Could you like to create the presentation from sketch [yn] "))
+          sketch_slides(input_file)
+          puts "generate #{input_file} from sketch"
+          return
+        end
+      end
+
+      output_dir = File.expand_path(File.join(output_dir, basename))
+      FileUtils.mkdir_p(output_dir) unless File.directory?(output_dir) 
+
+      bundle_path = HackerSlides::Bundle.lookup_bundle_path(bundle_name)
+
+      manifest = HackerSlides::Bundle.load_manifest(bundle_path)
+      
+      content_with_metas = File.read(input_file)
+
+      # read source document; split off optional header from source
+      # strip leading optional headers (key/value pairs) including optional empty lines
+      read_metas = true
+      content = ''
+
+      content_with_metas.each do |line|
+        if read_metas && line =~ /^\s*(\w[\w-]*)[ \t]*:[ \t]*(.*)/
+          name = $1.downcase
+          value = $2.strip
+          if(name == 'title')
+            @presentation.title = value
+          else
+            @presentation.meta[name.to_sym] = value
+          end
+        elsif line =~ /^\s*$/
+          content << line unless read_metas
+        else
+          read_metas = false
+          content << line
+        end
+      end
+
+      # ruby note: .*? is non-greedy (shortest-possible) regex match
+      content.gsub!(/__SKIP__.*?__END__/m, '')
+      content.sub!(/__END__.*/m, '')
+
+      # you can use the meta
+      content = ERB.new(content).result(binding)
+
+      case markup_type(extname)
+      when :textile
+        markup_engine = HackerSlides::TextileMarkupEngine.new          
+      when :markdown
+        markup_engine = HackerSlides::MarkdownMarkupEngine.new
+      else
+        puts "only textile and markdown markup supported"
+        puts "#{extname.inspect} doesn't support util now."
+      end
+      
+      content = markup_engine.to_html(content) if(markup_engine)
+
+      # implement in 
+      slides = post_processing(content) if defined?(:post_processing)
+
+      start_here = nil
+      static_files = []
+
+      # copy manifest files
+      manifest.each do |file|
+        if(File.extname(file) == '.erb')
+          template_file = File.basename(file)
+          if(template_file == 'template.html.erb')
+            outname = 'index.html'
+            start_here = with_output_path(outname, output_dir)
+          else
+            outname = File.basename(file, '.*')
+          end
+          File.open(with_output_path(outname, output_dir), "w+") do |out|
+            Zlib::GzipReader.open(bundle_path) do |tgz|
+              Archive::Tar::Minitar::Input.open(tgz) do |stream|
+                stream.each { |entry| out.puts render_erb_template(entry.read, binding) if(entry.full_name == file )}
+              end
+            end
+          end
+        else
+          static_files << file
+        end
+
+        HackerSlides::Bundle.extract_files_from_bundle(bundle_path, static_files, output_dir)
+      end
+
+      return start_here
+    end
+
+    def sketch_slides(input_file)
+      extname = File.extname(input_file)
+      case markup_type(extname)
+      when :textile
+        sample_file = File.join(File.dirname(__FILE__) + '/../../../samples/sample.textile')
+      when :markdown
+        sample_file = File.join(File.dirname(__FILE__) + '/../../../samples/sample.markdown') 
+      else
+        puts "only textile and markdown markup supported"
+        puts "#{extname.inspect} doesn't support util now."        
+      end
+      FileUtils.cp(sample_file, input_file)
+    end
+
+    def markup_type(extname)
+      if(HackerSlides::TextileMarkupEngine.support_extnames.include?(extname))
+        return :textile
+      end
+
+      if(HackerSlides::MarkdownMarkupEngine.support_extnames.include?(extname))
+        return :markdown
+      end
+    end
+
+    def with_output_path(output_file, output_dir)
+      return File.expand_path(File.join(output_dir, output_file))
+    end
+
+    def render_erb_template(content, the_binding)
+      ERB.new(content).result(the_binding)
+    end
+
+  end
+end