trickster 0.0.4

data/js/trickster.js

@@ -0,0 +1,216 @@
+var TricksterDefaultConfig = {
+  /** Padding between max width and max font size */
+  padding:          128,
+  /** Time, in ms, to transition between slides */
+  transitionTime:   200,
+  /** Time, in ms, that it should take to type each command */
+  typingTime:       1000,
+  /** Keycodes that advance to the next slide */
+  advanceKeycodes: [74,  // j
+                    39,  // right arrow
+                    34,  // Kensington presenter right arrow
+                    32], // space bar
+  /** Keycodes that go back to the previous slide */
+  backKeycodes:    [75,  // k
+                    37,  // left arrow
+                    33,  // Kensington presenter left arrow
+                    8],  // delete
+  startOverKeycodes: [66], // Kensington presenter down/stop
+  /** These keycodes, if encountered, will not be sent along
+      to the browser.  Useful if there might be some vertical
+      scrolling and 32/33/34 would otherwise scroll */
+  keyCodesPreventingDefault: [ 34, 32, 33 ]
+};
+/** Loads Trickster.
+ * config: configuration, or TricksterDefaultConfig to get the defaults
+ * functions: override helper functions
+ */
+var TricksterLoader = function(config,functions) {
+  var slides = Utils.fOr(functions.slides,function() {
+    return $("section");
+  });
+  var browserWindow = Utils.fOr(functions.browserWindow,function() {
+    return {
+      width: $(window).width(),
+      height: $(window).height()
+    };
+  });
+  var keyboardBindings = Utils.fOr(functions.keyboardBindings,function() {
+    return $(window);
+  });
+
+  var strikeThroughCode = Utils.fOr(functions.strikeThroughCode,function() {
+    $("code").each(function() {
+      if ($(this).attr("data-strikeouts")) {
+        var strikes = $(this).attr("data-strikeouts").split(",");
+        for(var index in strikes) {
+          var line = parseInt(strikes[index]) - 1;
+          $(this).find(".line-" + line).css("text-decoration","line-through");
+        }
+      }
+    });
+  });
+
+  var syntaxHighlighter = Utils.fOr(functions.syntaxHighlighter,function() {
+    return {
+      highlight: function() {
+        hljs.lineNodes = true;
+        hljs.initHighlighting();
+        strikeThroughCode();
+      }
+    }
+  });
+  var bindKeys = Utils.fOr(functions.bindKeys,function(keyCodes,f) {
+    $(window).keyup(function(event) {
+      if (keyCodes.indexOf(event.which) != -1) {
+        f();
+      }
+    });
+  });
+  var preventDefaultKeyCodeAction = Utils.fOr(functions.preventDefaultKeyCodeAction,function(keyCodes) {
+    $(window).keydown(function(event) {
+      if (keyCodes.indexOf(event.which) != -1) {
+        event.preventDefault();
+      }
+    });
+  });
+
+  function currentSlide(whichSlide) {
+    if (typeof whichSlide === "undefined") {
+      whichSlide = Trickster.currentSlide;
+    }
+    return slides().eq(whichSlide);
+  };
+
+  function initCurrentSlide() {
+    var slideNumber = 0;
+    if (document.location.hash !== "") {
+      slideNumber = parseInt(document.location.hash.replace("#",""));
+      Trickster.currentSlide = slideNumber;
+    }
+    applySlideClassToBody(currentSlide(slideNumber));
+  };
+
+  function applySlideClassToBody(slide) {
+    $("body").attr("class",slide.attr("class"));
+    if (slide.attr("data-background")) {
+      $("body").css("background","#" + slide.attr("data-background"));
+    }
+    else {
+      $("body").css("background","");
+    }
+  }
+
+  function changeSlides(nextSlide,afterChanges) {
+    if ((nextSlide != 0) && (nextSlide != Trickster.previousSlide)){
+      Trickster.previousSlide = Trickster.currentSlide;
+    }
+    afterChanges = Utils.f(afterChanges);
+    var transitionTime = config.transitionTime / 2;
+    if (currentSlide().attr("data-transition")) {
+      transitionTime = parseInt(currentSlide().attr("data-transitionTime"));
+    }
+    currentSlide().fadeOut(transitionTime, function() {
+      applySlideClassToBody(currentSlide(nextSlide));
+      currentSlide(nextSlide).fadeIn(transitionTime, function() {
+        Trickster.currentSlide = nextSlide;
+        window.history.replaceState({},"",document.URL.replace(/#.*$/,"") + "#" + Trickster.currentSlide);
+        afterChanges();
+      });
+    });
+  };
+
+  function sizeAllToFit() {
+    slides().each(function(index,element) {
+      // Order matters here
+      var sizeToFit = Sizer.sizeFunction(browserWindow().width,browserWindow().height);
+      sizeToFit($(element));
+    });
+  }
+
+  function setupKeyBindings() {
+    bindKeys(config.advanceKeycodes,Trickster.advance);
+    bindKeys(config.backKeycodes,Trickster.back);
+    bindKeys(config.startOverKeycodes,Trickster.startOver);
+    preventDefaultKeyCodeAction(config.keyCodesPreventingDefault);
+    bindKeys([189],Trickster.shrink);   // -
+    bindKeys([187],Trickster.embiggen); // +
+  }
+
+  function hideAllSlides() {
+    $("section").css("display","none");
+    $("li").css("visibility","hidden");
+    $("section.COMMANDLINE .cli-element").css("display","none");
+  }
+
+  var Bullets = TricksterBullets(currentSlide,config);
+  return {
+    /** State */
+    currentSlide:  0,
+    totalSlides:   1,
+    previousSlide: 0,
+
+    /** Set everything up for the slideshow */
+    load: function() {
+      // Order matters here
+      Trickster.totalSlides = slides().length;
+      initCurrentSlide();
+      setupKeyBindings();
+      syntaxHighlighter().highlight();
+      sizeAllToFit();
+      hideAllSlides();
+      currentSlide().fadeIn(config.transitionTime / 2);
+    },
+
+    /** Reduce the font-size of the current slide slightly */
+    shrink: function() {
+      var currentSize = parseInt(currentSlide().css("font-size"));
+      currentSlide().css("font-size",currentSize - 4);
+      if (currentSlide().hasClass("CODE") || currentSlide().hasClass("COMMANDLINE")) {
+        currentSlide().css("margin-top",-1 * (currentSize - 4));
+      }
+    },
+    /** Increase the font-size of the current slide slightly */
+    embiggen: function() {
+      var currentSize = parseInt(currentSlide().css("font-size"));
+      currentSlide().css("font-size",currentSize + 4);
+      if (currentSlide().hasClass("CODE") || currentSlide().hasClass("COMMANDLINE")) {
+        currentSlide().css("margin-top",-1 * (currentSize - 4));
+      }
+    },
+
+    startOver: function() {
+      if (Trickster.currentSlide == 0)  {
+        changeSlides(Trickster.previousSlide, Bullets.rehideBullets());
+      }
+      else {
+        changeSlides(0,Bullets.rehideBullets());
+      }
+    },
+
+    /** Move forward one slide */
+    advance: function() {
+      if (Bullets.hasBulletsToAdvanceFirst()) {
+        Bullets.advanceToNextBullet();
+      }
+      else {
+        var nextSlide = Trickster.currentSlide + 1;
+        if (nextSlide >= Trickster.totalSlides) {
+          nextSlide = 0;
+        }
+        changeSlides(nextSlide, Bullets.rehideBullets());
+      }
+    },
+
+    /** Move back one slide */
+    back: function() {
+      var nextSlide = Trickster.currentSlide - 1;
+      if (nextSlide < 0) {
+        nextSlide = Trickster.totalSlides - 1;
+      }
+      changeSlides(nextSlide, Bullets.rehideBullets());
+    }
+  };
+};
+// 66 - Kensington down/stop
+// 116 - Kensington up/laser

data/js/utils.js

@@ -0,0 +1,19 @@
+var Utils = function() {
+  /** If possibleFunction is undefined, use otherFunction */
+  function fOr(possibleFunction,otherFunction) {
+    if (typeof possibleFunction != "undefined") {
+      return possibleFunction;
+    }
+    else {
+      return otherFunction;
+    }
+  };
+  /** Turn possibly-undefined into a function */
+  function f(possibleFunction) {
+    return fOr(possibleFunction,function() {});
+  };
+  return {
+    f:   f,
+    fOr: fOr
+  };
+}();

data/lib/trickster/file_copier.rb

@@ -0,0 +1,25 @@
+module Trickster
+  class FileCopier
+    # install_root:: where the root of trickster's install is, to find files to copy
+    # destination_root:: root of where we are copying to
+    def initialize(install_root,destination_root)
+      @install_root     = install_root
+      @destination_root = destination_root
+    end
+
+    # Shallow copies all files from +from+ with the given extension
+    #
+    # from:: location, relative to @install_root where files are copied from
+    # extension:: extension of files to copy
+    # options:: options to control the copy.  Currently recognized keys:
+    #           :except:: array of filenames to skip
+    def copy_files(from,extension,options={})
+      dest_dir = File.join(@destination_root,from)
+      FileUtils.mkdir(dest_dir) unless File.exists?(dest_dir)
+      Dir["#{@install_root}/#{from}/*.#{extension}"].each do |file|
+        next if Array(options[:except]).include?(File.basename(file))
+        FileUtils.cp file,dest_dir
+      end
+    end
+  end
+end

data/lib/trickster/renderer/bullets_renderer.rb

@@ -0,0 +1,12 @@
+module Trickster
+  module Renderer
+    class BulletsRenderer
+      def render(io,content,options)
+        io.puts "<h1>#{content[0]}</h1>"
+        io.puts "<ul>"
+        io.puts((content[1..-1].map { |_| "<li>" + _.gsub(/^[*+-o] /,'') + "</li>\n" }).join(""))
+        io.puts "</ul>"
+      end
+    end
+  end
+end

data/lib/trickster/renderer/code_renderer.rb

@@ -0,0 +1,47 @@
+module Trickster
+  module Renderer
+    class CodeRenderer
+      def render(io,content,options)
+        content = read_file_if_content_is_filename(content)
+        io.puts "<pre><code #{language(options)}data-strikeouts='#{strikes(options)}' data-callout-lines='#{callouts(options)}'>#{content[0]}"
+        content[1..-2].each { |line| io.puts line }
+        io.puts "#{content[-1]}</code></pre>"
+      end
+
+    private
+
+    def read_file_if_content_is_filename(content)
+      if content[0] =~ /file:\/\/(.*$)/
+        File.open($1).readlines.map(&:chomp)
+      else
+        content
+      end
+    end
+    
+      def language(options)
+        language = ''
+        if options =~/language=([^\s]+)/
+          language = "class='#{$1}' "
+        end
+        language
+      end
+
+      def callout_option(options)
+        if options =~ /callout=([^\s]+)/
+          callouts = $1
+          callouts.split(/,/).map(&:to_i)
+        else
+          []
+        end
+      end
+
+      def callouts(options)
+        callout_option(options).map(&:abs).join(',')
+      end
+
+      def strikes(options)
+        callout_option(options).select { |_| _ < 0 }.map(&:abs).join(',')
+      end
+    end
+  end
+end

data/lib/trickster/renderer/commandline_renderer.rb

@@ -0,0 +1,35 @@
+module Trickster
+  module Renderer
+    class CommandlineRenderer
+      def render(io,content,options)
+        io.print "<pre><code class='no-highlight'>"
+        content = split_by_commands_and_results(content)
+        content.each do |(prompt,command,result)|
+          io.puts "<span class='cli-prompt'>#{prompt}</span> <span class='cli-element cli-command cli-line'>#{command}</span>"
+          unless result.empty?
+            io.puts "<span class='cli-element cli-result'>#{result.join("\n")}</span>"
+          end
+        end
+        io.puts "</code></pre>"
+      end
+
+    private 
+
+      def split_by_commands_and_results(content)
+        results = []
+        current_command_response = []
+        content.each do |line|
+          if line =~ /^([>%#])(.*)$/
+            prompt = $1
+            command = $2
+            results << current_command_response unless current_command_response.empty?
+            current_command_response = [prompt.gsub(">","&gt;"),command,[]]
+          else
+            current_command_response[2] << "<span class='cli-line'>#{line}</span>"
+          end
+        end
+        results << current_command_response unless current_command_response.empty?
+      end
+    end
+  end
+end

data/lib/trickster/renderer/image_renderer.rb

@@ -0,0 +1,9 @@
+module Trickster
+  module Renderer
+    class ImageRenderer
+      def render(io,content,options)
+        io.puts "<img src='#{content[0]}'>"
+      end
+    end
+  end
+end

data/lib/trickster/renderer/normal_renderer.rb

@@ -0,0 +1,11 @@
+module Trickster
+  module Renderer
+    class NormalRenderer
+      def render(io,content,options)
+        io.puts "<h1>#{content[0]}</h1>"
+        io.puts "<h2>#{content[1]}</h2>" unless content[1].nil? || content[1] == ''
+        io.puts "<h3>#{content[2]}</h3>" unless content[2].nil? || content[2] == ''
+      end
+    end
+  end
+end

data/lib/trickster/slide_parser.rb

@@ -0,0 +1,34 @@
+module Trickster
+  class SlideParser
+    attr_reader :title
+    def initialize(lines,renderer)
+      @lines = lines
+      @renderer = renderer
+      @title = @lines.shift
+    end
+
+    def body
+      each_slide do |slide_type,content|
+        @renderer.render_slide(slide_type,content)
+      end
+      @renderer.content
+    end
+
+  private
+
+    def each_slide(&block)
+      content = []
+      slide_type = nil
+      @lines.each do |line|
+        if line =~/^!(.*)$/
+          block.call(slide_type,content) unless slide_type.nil?
+          slide_type = $1
+          content = []
+        else
+          content << line
+        end
+      end
+      block.call(slide_type,content)
+    end
+  end
+end

data/lib/trickster/slide_renderer.rb

@@ -0,0 +1,51 @@
+require 'stringio'
+module Trickster
+  class SlideRenderer
+    def initialize
+      @body_io = StringIO.new
+    end
+
+    def render_slide(slide_type,content)
+      write_slide(slide_type,content,@body_io)
+    end
+
+    def content
+      @body_io.string
+    end
+
+  private
+    RENDERERS = Hash.new { 
+      Renderer::NormalRenderer.new
+    }.tap { |hash|
+      hash["IMAGE"] = Renderer::ImageRenderer.new
+      hash["COMMANDLINE"] = Renderer::CommandlineRenderer.new
+      hash["BULLETS"] = Renderer::BulletsRenderer.new
+      hash["CODE"] = Renderer::CodeRenderer.new
+    }.freeze
+
+    def write_slide(slide_type,content,slide)
+      slide_type,options = slide_type.split(/:/)
+
+      content = content[0..-2] if content[-1] =~ /^\s*$/
+      slide.puts "<section class='#{slide_type}'#{background_data(options)}#{transition_data(options)}>"
+      RENDERERS[slide_type].render(slide,content,options)
+      slide.puts "</section>"
+    end
+
+    def transition_data(options)
+      data_attribute('transition',options)
+    end
+
+    def background_data(options)
+      data_attribute('background',options)
+    end
+
+    def data_attribute(attribute,options)
+      attribute_element = ''
+      if options =~ /#{attribute}=([^\s]+)/
+        attribute_element = " data-#{attribute}='#{$1}'"
+      end
+      attribute_element
+    end
+  end
+end

data/lib/trickster/version.rb

@@ -0,0 +1,3 @@
+module Trickster
+  VERSION = '0.0.4'
+end

data/lib/trickster.rb

@@ -0,0 +1,9 @@
+require 'trickster/version'
+require 'trickster/slide_parser'
+require 'trickster/renderer/code_renderer'
+require 'trickster/renderer/bullets_renderer'
+require 'trickster/renderer/commandline_renderer'
+require 'trickster/renderer/normal_renderer'
+require 'trickster/renderer/image_renderer'
+require 'trickster/slide_renderer'
+require 'trickster/file_copier'

data/trickster.rdoc

@@ -0,0 +1,69 @@
+== trickster - Bootstrap, generate, and manage your trickster presentation
+
+v0.0.4
+
+=== Global Options
+=== --help
+Show this message
+
+
+
+
+=== --version
+
+
+
+
+
+=== Commands
+==== build [slides_file]
+Generate the presentation from your slides
+
+
+Given your slides_file (defaults to 'slides' in current directory), generates an HTML
+file (based on --output-file) that, when loaded, can be used to play your presentation.
+
+Any .scss files found in the css/ directory will be run through SASS to be converted.
+
+Note that currently, the CSS and JS files included are fixed, so keep all your customizations
+to styles.css/styles.scss and custom.js (these files will not be overwritten when
+you do a trickster update).
+===== Options
+===== -o file
+
+Name of the generated HTML file
+
+[Aliases] --output-file
+[Default Value] index.html
+
+
+==== help command
+Shows a list of commands or help for one command
+
+
+Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function
+==== init dir_name
+Create a new trickster presentation
+
+
+This will create a completely self-contained presentation that can be run just from the files
+in the directory you name.  It will have a static copy of the JavaScript files, JavaScript third-party
+libraries and CSS files you need to run your trickster application.
+
+You can examine the file `slides` to see some examples of how to format your
+presentation.  You can run `trickster build` in the directory to create the HTML
+file from your slides.
+
+Note that if you upgrade trickster, you should run `tricksterd update` in your slide directory
+to get the latest JavaScript and CSS files.
+==== update [dir_name]
+Update an existing slideshow with the latest Trickster JS/CSS files
+
+
+Run this after you've upgraded trickster and want to get the latest features.  Since your 
+slideshow is entirely self-contained, when you upgrade tricksterd, your static JavaScript and
+CSS files will be out of date.
+
+Note that `styles.css`, which was provided by trickster as a basis for styling, will not
+be touched, and your customizations will remain. All other files that trickster gave you
+when you ran `trickster init` will be overwritten.