parade 0.9.0 → 0.9.1

data/README.md

@@ -25,8 +25,8 @@ Parade has over presentational software:
 
 * Code Execution
 
-    > Slides are able to provide execution and show results for javascript,
-    Coffeescript, and Ruby live within the browser. Allowing for live
+    > Slides are able to provide execution and show results for JavaScript,
+    and Coffeescript live within the browser. Allowing for live
     demonstrations of code.
 
 * Web
@@ -301,7 +301,7 @@ Parade defines a number of special CSS classes:
 > make all slide text 70%
 >
 > ### execute
-> on Javascript, Coffeescript and Ruby highlighted code slides, you can
+> on Javascript and Coffeescript highlighted code slides, you can
 > click on the code to execute it and display the results on the slide
 
 
@@ -513,6 +513,27 @@ Serves the parade presentation in the current directory
 >
 > parade serve
 
+## parade static html [path/to/parade/file]
+
+Generates a static html representation of the presentation.
+
+> ### Options
+>
+> These options are specified *after* the command.
+>
+> *-o, --output=file* Presentation output file
+
+## parade static pdf [path/to/parade/file]
+
+Generates a pdf representation of the presentation.
+
+> ### Options
+>
+> These options are specified *after* the command.
+>
+> *-o, --output=file* Presentation output file
+
+
 # Future Plans
 
 I really want this to evolve into a dynamic presentation software server,

data/bin/parade

@@ -54,7 +54,7 @@ command [:s,:serve,:server] do |c|
     puts "
 -------------------------
 
-Your Parade presentation is now starting up.
+yourr Parade presentation is now starting up.
 
 To view it plainly, visit [ #{url} ]
 
@@ -86,6 +86,9 @@ command [:static] do |c|
   c.desc "Force creation of the asset, even if one already exists with a similar name"
   c.switch [:f, :force]
 
+  c.desc 'Output file'
+  c.flag [:o,:output]
+
   c.action do |global,local,args|
 
     format_type = args.shift

data/lib/parade/commands/static_html.rb

@@ -5,9 +5,9 @@ module Parade
 
     #
     # Saves an html representation of the presentation to a single HTML file.
-    # 
+    #
     # @see HtmlOutput
-    # 
+    #
     class StaticHtml
       include RenderFromTemplate
 

data/lib/parade/commands/static_pdf.rb

@@ -5,7 +5,7 @@ module Parade
 
     #
     # Saves a PDF version of the presentation that is from the HtmlOutput
-    # 
+    #
     class StaticPdf
 
       def description

data/lib/parade/server.rb

@@ -2,10 +2,6 @@ require_relative 'section'
 require_relative "parsers/dsl"
 require_relative 'renderers/update_image_paths'
 
-require_relative 'features/live_ruby'
-require_relative 'features/pdf_presentation'
-require_relative 'features/preshow'
-
 require_relative 'slide_post_renderers'
 require_relative 'slide_pre_renderers'
 
@@ -13,18 +9,17 @@ module Parade
 
   class Server < Sinatra::Application
 
-    def initialize(app=nil)
-      super(app)
-      require_ruby_files
-    end
 
-    def require_ruby_files
-      Dir.glob("#{settings.presentation_directory}/*.rb").map { |path| require path }
+    def self.views_path
+      File.dirname(__FILE__) + '/../views'
     end
 
-    set :views, File.dirname(__FILE__) + '/../views'
-    set :public_folder, File.dirname(__FILE__) + '/../public'
+    def self.public_path
+      File.dirname(__FILE__) + '/../public'
+    end
 
+    set :views, views_path
+    set :public_folder, public_path
     set :verbose, false
 
     set :presentation_directory do
@@ -32,9 +27,56 @@ module Parade
     end
 
     set :presentation_file, 'parade'
-
     set :default_presentation_files, [ 'parade', 'parade.json' ]
 
+
+    #
+    # Includes the specified module into the server to grant the server additional
+    # functionality.
+    #
+    def self.register(server_module)
+      include server_module
+    end
+
+    #
+    # Register a javascript file that will be loaded after the code javscript
+    #
+    def self.register_javascript(js_file)
+      plugin_javascript_files.push js_file
+    end
+
+    #
+    # @return the javascript files that have been registered by plugins
+    #
+    def self.plugin_javascript_files
+      @javscript_files ||= []
+    end
+
+    def self.register_stylesheet(css_file)
+      plugin_stylesheet_files.push css_file
+    end
+
+    def self.plugin_stylesheet_files
+      @css_files ||= []
+    end
+
+    def self.register_command(input,description)
+      plugin_commands.push OpenStruct.new(:input => input,:description => description)
+    end
+
+    def self.plugin_commands
+      @plugin_commands ||= []
+    end
+
+    def initialize(app=nil)
+      super(app)
+      require_ruby_files
+    end
+
+    def require_ruby_files
+      Dir.glob("#{settings.presentation_directory}/*.rb").map { |path| require path }
+    end
+
     def presentation_files
       (Array(settings.presentation_file) + settings.default_presentation_files).compact.uniq
     end
@@ -82,6 +124,18 @@ module Parade
         end
       end
 
+      def plugin_css_files
+        self.class.plugin_stylesheet_files.map do |path|
+          "<style>\n#{File.read(path)}\n</style>"
+        end.join("\n")
+      end
+
+      def plugin_js_files
+        self.class.plugin_javascript_files.map do |path|
+          "<script type='text/javascript'>#{File.read(path)}</script>"
+        end.join("\n")
+      end
+
       #
       # Create resources links to all the Javascript files found at the root of
       # presentation directory.
@@ -92,6 +146,10 @@ module Parade
         end
       end
 
+      def plugin_commands
+        self.class.plugin_commands
+      end
+
       def presentation
         load_presentation
       end
@@ -134,10 +192,6 @@ module Parade
       erb :onepage
     end
 
-    include LiveRuby
-    include PDFPresentation
-    include Preshow
-
   end
 
-end
+end

data/lib/parade/version.rb

@@ -1,3 +1,3 @@
 module Parade
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

data/lib/public/css/parade.css

@@ -270,7 +270,6 @@ pre { margin: 1em 40px; padding: .25em; }
 .offscreen { position:absolute; top:0; left:-9999px; overflow:hidden; }
 #debugInfo { margin-left: 30px; }
 #notesInfo { margin-left: 30px; display: none }
-#preshow { display: none; }
 
 #help {
     background: #9f9;
@@ -389,7 +388,7 @@ a.fg-button { float:left; }
   cursor: pointer;
 }
 
-#tips, #preshow_timer {
+#tips {
   display:inline;
   background-color:#000;
   color:#fff;
@@ -407,10 +406,6 @@ a.fg-button { float:left; }
   text-align:right;
 }
 
-#preshow_timer {
-  bottom: 0px;
-}
-
 /** Print **/
 @media print {
   body {

data/lib/public/js/parade-code-execution.js

@@ -1,5 +1,8 @@
 window.CodeExecutor = Spine.Class.create({
   init: function() {
+    this.visibleCodeBlocks = {};
+    this.executeCodeFor = {}
+
     $.subscribe("code:execute",$.proxy(function(e,code) {
       this.executeCode(code);
     },this));
@@ -7,10 +10,9 @@ window.CodeExecutor = Spine.Class.create({
       this.executeVisibleCode();
     },this));
   },
-  visibleCodeBlocks: function() {
-    return { ruby : $('.execute .ruby pre:visible'),
-      js : $('.execute .javascript pre:visible'),
-      coffee : $('.execute .coffeescript pre:visible') }
+  registerVisibleCodeBlock: function(language,elements,execution) {
+    this.visibleCodeBlocks[language] = elements;
+    this.executeCodeFor[language] = execution;
   },
   executeVisibleCode: function() {
 
@@ -32,35 +34,7 @@ window.CodeExecutor = Spine.Class.create({
     codeExecutor(code['code']);
   },
   executorForLanguage: function(language) {
-    return this.supportedLanguages()[language];
-  },
-  supportedLanguages: function() {
-    return { ruby : this.executeRuby,
-      js : this.executeJavaScript,
-      coffee : this.executeCoffee };
-  },
-  executeJavaScript: function(code) {
-    var result = eval(code);
-    setTimeout(function() { $.publish('code:execution:finished'); }, 250 );
-    if (result != null) { $.publish('code:execution:results',result); }
-  },
-  executeRuby: function(code) {
-    $.get('/eval_ruby', { code: code }, function(result) {
-      if (result != null) { $.publish('code:execution:results',result); }
-      $.publish('code:execution:finished');
-    });
-  },
-  executeCoffee: function(code) {
-    // When Coffeescript completes it's work the final result is encapsulated
-    // within it. To get around it, the result of the last evaluation needs to
-    // be assigned to the window, which we can then use for the purposes of
-    // displaying the results.
-
-    var codeWithAssignmentToResults = code + ';window.result=result;'
-    eval(CoffeeScript.compile(codeWithAssignmentToResults));
-
-    setTimeout(function() { $.publish('code:execution:finished'); }, 250 );
-    if (result != null) { $.publish('code:execution:results',result); }
+    return this.executeCodeFor[language];
   }
 });
 
@@ -104,14 +78,28 @@ $(document).ready(function() {
   codeExecutor = new CodeExecutor;
   codeViewer = new CodeViewer;
 
+  codeExecutor.registerVisibleCodeBlock('js',$('.execute .javascript pre:visible'),function(code) {
+    var result = eval(code);
+    setTimeout(function() { $.publish('code:execution:finished'); }, 250 );
+    if (result != null) { $.publish('code:execution:results',result); }
+  });
+
   $('.execute pre.javascript').live("click", function() {
     var code = $(this).text();
     $.publish('code:execute',{ lang: 'js', code: code, elem: $(this) });
   });
 
-  $('.execute pre.ruby').live("click", function() {
-    var code = $(this).text();
-    $.publish('code:execute',{ lang: 'ruby', code: code, elem: $(this) });
+  codeExecutor.registerVisibleCodeBlock('coffee',$('.execute .coffeescript pre:visible'),  function(code) {
+    // When Coffeescript completes it's work the final result is encapsulated
+    // within it. To get around it, the result of the last evaluation needs to
+    // be assigned to the window, which we can then use for the purposes of
+    // displaying the results.
+
+    var codeWithAssignmentToResults = code + ';window.result=result;'
+    eval(CoffeeScript.compile(codeWithAssignmentToResults));
+
+    setTimeout(function() { $.publish('code:execution:finished'); }, 250 );
+    if (result != null) { $.publish('code:execution:results',result); }
   });
 
   $('.execute pre.coffeescript').live("click", function() {

data/lib/public/js/parade-keyboard-input.js

@@ -42,10 +42,6 @@ $(document).ready(function() {
     $.publish("presentation:pause:toggle");
   });
 
-  MainKeyboard.on('p', function(){
-    $.publish("presentation:preshow:toggle");
-  });
-
   MainKeyboard.on('enter', function(){
     $.publish("code:execute:visible")
   });

data/lib/public/js/parade.js

@@ -1,153 +1,5 @@
 $(document).ready(function() {
 
-  window.Preshow = Spine.Class.create({
-    init: function() {
-      this.element = $(arguments[0]);
-      this.secondsToRun = parseFloat(arguments[1] * 60);
-
-      $.subscribe("presentation:preshow:toggle",$.proxy(function() {
-        this.toggle();
-      },this));
-
-    },
-    preshowRunning: false,
-    start: function() {
-
-      if (this.preshowIntervalReference) {
-        return;
-      }
-
-      this.preservePresentationSpace();
-
-      this.load();
-
-      this.images = this.element.children("img");
-
-      this.currentImageIndex = 0;
-      this.totalImages = this.images.size();
-
-
-      this.preshowRunning = true;
-
-      $.publish("presentation:preshow:start");
-
-      this.currentRunTime = 0;
-      this.currentRemainingTime = this.secondsToRun;
-
-      this.nextImage();
-      this.preshowIntervalReference = setInterval($.proxy(this.perform,this),1000);
-
-    },
-    preservePresentationSpace: function() {
-      this.storedPresentationSpace = this.element.html();
-    },
-    restorePresentationSpace: function() {
-      this.element.empty();
-      this.element.html(this.storedPresentationSpace);
-    },
-    displayImagesInterval: 5,
-    perform: function() {
-      this.currentRunTime ++;
-      this.currentRemainingTime --;
-
-      time = this.secondsToTime(this.currentRemainingTime);
-
-      $('#preshow_timer').text(time + ' to go-time')
-      var description = this.preshowDescription && this.preshowDescription[tmpImg.attr("ref")]
-
-      if(description) {
-        $('#tips').show();
-        $('#tips').text(description);
-      } else {
-        $('#tips').hide();
-      }
-
-      if ((this.currentRunTime % this.displayImagesInterval) == 0) {
-        this.nextImage();
-      }
-
-      this.preshowTip();
-
-      if (this.currentRemainingTime <= 0) {
-        this.stop();
-      }
-
-    },
-    stop: function() {
-
-      if (!this.preshowIntervalReference) {
-        return;
-      }
-
-      this.preshowRunning = false;
-      window.clearInterval(this.preshowIntervalReference);
-      this.preshowIntervalReference = undefined;
-
-      $('#preshow').remove();
-      $('#tips').remove();
-      $('#preshow_timer').remove();
-
-      this.restorePresentationSpace();
-
-      $.publish("presentation:preshow:stop");
-
-    },
-    toggle: function() {
-
-      if (this.preshowIntervalReference) {
-        this.stop();
-      } else {
-        this.start();
-      }
-
-    },
-    preshowPath: "preshow",
-    load: function() {
-
-      $.getJSON(this.preshowPath, false, $.proxy(function(data) {
-
-        this.element.after("<div id='preshow'></div><div id='tips'></div><div id='preshow_timer'></div>")
-
-        $.each(data, $.proxy(function(i, n) {
-          if(n == "preshow.json") {
-            // has a descriptions file
-            $.getJSON("/file/preshow/preshow.json", false, function(data) {
-              this.preshowDescription = data;
-            })
-          } else {
-            $('#preshow').append('<img ref="' + n + '" src="/file/preshow/' + n + '"/>');
-            this.images = $("#preshow > img");
-            this.totalImages = this.images.size();
-          }
-        },this));
-
-      },this));
-
-    },
-    nextImage: function() {
-      this.currentImageIndex ++;
-      if((this.currentImageIndex + 1) > this.totalImages) {
-        this.currentImageIndex = 0;
-      }
-
-      this.element.empty();
-      tmpImg = this.images.eq(this.currentImageIndex).clone();
-      $(tmpImg).attr('width', '1020');
-      this.element.html(tmpImg);
-    },
-    preshowTip: function() {
-
-    },
-    secondsToTime: function(seconds) {
-      minutes = Math.floor(seconds / 60)
-      seconds = seconds - (minutes * 60)
-      if(seconds < 10) {
-        seconds = "0" + seconds
-      }
-      return minutes + ":" + seconds
-    }
-  });
-
   window.ToggleView = Spine.Class.create({
     init: function () {
 
@@ -513,23 +365,6 @@ $(document).ready(function() {
         this.showSlide()
       },this));
 
-      $.subscribe("presentation:preshow:start",$.proxy(function() {
-        this.footer.hide();
-      },this));
-
-      $.subscribe("presentation:preshow:stop",$.proxy(function() {
-        this.footer.show();
-
-        // Returning from a presentation requires the presentation frame to
-        // be rebuilt.
-
-        this.presentationFrame.cycle({
-          timeout: 0
-        });
-        this.showSlide();
-
-      },this));
-
     },
     centerSlides: function() {
       var presentation = this;
@@ -718,8 +553,6 @@ $(document).ready(function() {
   var locationWatcher = new LocationWatcher();
   locationWatcher.start();
 
-  preshow = new Preshow("#preso",0.25);
-
   // bind event handlers
   /* window.onresize  = resized; */
   /* window.onscroll = scrolled; */

data/lib/views/header.erb

@@ -71,5 +71,8 @@
 
   <%= css 'default.css' %>
 
+  <%= plugin_css_files %>
   <%= custom_css_files %>
-  <%= custom_js_files %>
+
+  <%= plugin_js_files %>
+  <%= custom_js_files %>

data/lib/views/index.erb

@@ -23,7 +23,11 @@
     <tr><td class="key">f</td><td>toggle footer</td></tr>
     <tr><td class="key">r</td><td>reload slides</td></tr>
     <tr><td class="key">n</td><td>toggle notes</td></tr>
-    <tr><td class="key">p</td><td>run preshow</td></tr>
+
+    <% plugin_commands.each do |command| %>
+      <tr><td class="key"><%= command.input %></td><td><%= command.description %></td></tr>
+    <% end %>
+
   </table>
 </div>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parade
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
   prerelease: 
 platform: ruby
 authors:
@@ -198,9 +198,6 @@ files:
 - lib/parade/commands/static_html.rb
 - lib/parade/commands/static_pdf.rb
 - lib/parade/commands/unknown.rb
-- lib/parade/features/live_ruby.rb
-- lib/parade/features/pdf_presentation.rb
-- lib/parade/features/preshow.rb
 - lib/parade/helpers/encode_image.rb
 - lib/parade/helpers/template_generator.rb
 - lib/parade/metadata/assignment.rb
@@ -231,7 +228,6 @@ files:
 - lib/parade/version.rb
 - lib/parade.rb
 - lib/public/css/960.css
-- lib/public/css/default.css
 - lib/public/css/fg.menu.css
 - lib/public/css/ghf_marked.css
 - lib/public/css/jquery-terminal.css

data/lib/parade/features/live_ruby.rb

@@ -1,18 +0,0 @@
-module Parade
-
-  module LiveRuby
-
-    def self.included(server)
-      server.get '/eval_ruby' do
-        eval_ruby(params[:code])
-      end
-    end
-
-    def eval_ruby(code)
-      eval(code).to_s
-    rescue => exception
-      exception.message
-    end
-  end
-
-end

data/lib/parade/features/pdf_presentation.rb

@@ -1,24 +0,0 @@
-module Parade
-  module PDFPresentation
-    def self.included(server)
-
-      server.get '/pdf' do
-        
-        # TODO: Find the presentation file and/or regenerate it every time
-        
-        template_options = {  'erb_template_file' => File.join(File.dirname(__FILE__), "..", "..", "views", "pdf.erb"),
-                              'custom_asset_path' => settings.presentation_directory,
-                              'slides' => slides }
-        
-        html_content = TemplateGenerator.new(template_options).render
-        
-        # TODO the image references here are not full filepaths. creating issues
-
-        kit = PDFKit.new(html_content,:page_size => 'Letter', :orientation => 'Landscape')
-
-        send_file kit.to_file('presentation.pdf')
-      end
-
-    end
-  end
-end

data/lib/parade/features/preshow.rb

@@ -1,11 +0,0 @@
-module Parade
-  module Preshow
-    def self.included(server)
-
-      server.get "/preshow" do
-        Dir.glob("#{settings.presentation_directory}/preshow/*").map { |path| File.basename(path) }.to_json
-      end
-
-    end
-  end
-end

data/lib/public/css/default.css

@@ -1,3 +0,0 @@
-@media screen {
-
-}